「造个轮子」——cicada(轻量级 WEB 框架)

caohaoyu 发布于2019-08-19 11:05 / 2270人阅读

摘要：前言俗话说不要重复造轮子，关于是否有必要不再本次讨论范围。我把他定义为一个快速轻量级框架没有过多的依赖，核心包仅。只需要创建一个项目，并引入核心包。在测试条件为并发连续压测两轮内存单核。

前言

俗话说「不要重复造轮子」，关于是否有必要不再本次讨论范围。

创建这个项目的主要目的还是提升自己，看看和知名类开源项目的差距以及学习优秀的开源方式。

好了，现在着重来谈谈 cicada 这个项目的核心功能。

我把他定义为一个快速、轻量级 WEB 框架；没有过多的依赖，核心 jar 包仅 30KB。

也仅需要一行代码即可启动一个 HTTP 服务。

特性

现在来谈谈重要的几个特性。

当前版本主要实现了基本的请求、响应、自定义参数以及拦截器功能。

功能虽少，但五脏俱全。

在今后的迭代过程中会逐渐完善上图功能，有好的想法也欢迎提 https://github.com/crossoverJie/cicada/issues。

快速启动

下面来看看如何快速启动一个 HTTP 服务。

只需要创建一个 Maven 项目，并引入核心包。


    top.crossoverjie.opensource
    cicada-core
    1.0.0

如上图所示，再配置一个启动类即可。

public class MainStart {

    public static void main(String[] args) throws InterruptedException {
        CicadaServer.start(MainStart.class,"/cicada-example") ;
    }
}

配置业务 Action

当然我们还需要一个实现业务逻辑的地方。cicada 提供了一个接口，只需要实现该接口即可实现具体逻辑。

创建业务 Action 实现 top.crossoverjie.cicada.server.action.WorkAction 接口。

@CicadaAction(value = "demoAction")
public class DemoAction implements WorkAction {


    private static final Logger LOGGER = LoggerBuilder.getLogger(DemoAction.class) ;

    private static AtomicLong index = new AtomicLong() ;

    @Override
    public WorkRes execute(Param paramMap) throws Exception {
        String name = paramMap.getString("name");
        Integer id = paramMap.getInteger("id");
        LOGGER.info("name=[{}],id=[{}]" , name,id);

        DemoResVO demoResVO = new DemoResVO() ;
        demoResVO.setIndex(index.incrementAndGet());
        WorkRes res = new WorkRes();
        res.setCode(StatusEnum.SUCCESS.getCode());
        res.setMessage(StatusEnum.SUCCESS.getMessage());
        res.setDataBody(demoResVO) ;
        return res;
    }

}

同时需要再自定义类中加上 @CicadaAction 注解，并需要指定一个 value，该 value 主要是为了在请求路由时能找到业务类。

这样启动应用并访问

http://127.0.0.1:7317/cicada-example/demoAction?name=12345&id=10

便能执行业务逻辑同时得到服务端的返回。

目前默认支持的是 json 响应，后期也会加上模板解析。

服务中也会打印相关日志。

灵活的参数配置

这里所有的请求参数都封装在 Param 中，可以利用其中的各种 API 获取请求数据。

之所以是灵活的：我们甚至可以这样请求：

http://127.0.0.1:7317/cicada-example/demoAction?jsonData="info": {
    "age": 22,
    "name": "zhangsan"
  }

这样就可以传递任意结构的数据，只要业务处理时进行解析即可。

自定义拦截器

拦截器是一个框架的基本功能，可以利用拦截器实现日志记录、事务提交等通用工作。

为此 cicada 提供一个接口: top.crossoverjie.cicada.server.intercept.CicadaInterceptor。

我们只需要实现该接口即可编写拦截功能：

@Interceptor(value = "executeTimeInterceptor")
public class ExecuteTimeInterceptor implements CicadaInterceptor {

    private static final Logger LOGGER = LoggerBuilder.getLogger(ExecuteTimeInterceptor.class);

    private Long start;

    private Long end;

    @Override
    public void before(Param param) {
        start = System.currentTimeMillis();
    }

    @Override
    public void after(Param param) {
        end = System.currentTimeMillis();

        LOGGER.info("cast [{}] times", end - start);
    }
}

这里演示的是记录所有 action 的执行时间。

目前默认只实现了 action 的拦截，后期也会加入自定义拦截器。

拦截适配器

虽说在拦截器中提供了 before/after 两个方法，但也不是所有的方法都需要实现。

因此 cicada 提供了一个适配器：

top.crossoverjie.cicada.server.intercept.AbstractCicadaInterceptorAdapter

我们需要继承他便可按需实现其中的某个方法，如下所示：

@Interceptor(value = "loggerInterceptor")
public class LoggerInterceptorAbstract extends AbstractCicadaInterceptorAdapter {

    private static final Logger LOGGER = LoggerBuilder.getLogger(LoggerInterceptorAbstract.class) ;

    @Override
    public void before(Param param) {
        LOGGER.info("logger param=[{}]",param.toString());
    }

}

性能测试

既然是一个 HTTP 服务框架，那性能自然也得保证。

在测试条件为：300 并发连续压测两轮；1G 内存、单核 CPU、1Mbps。用 Jmeter 压测情况如下：

同样的服务器用 Tomcat 来压测看看结果。

Tomcat 的线程池配置:

我这里请求的是 Tomcat 的一个 doc 目录，虽说结果看似 cicada 的性能比 Tomcat 还强。

但其实这个对比过程中的变量并没有完全控制好，Tomcat 所返回的是 HTML，而 cicada 仅仅返回了 json，当然问题也不止这些。

但还是能说明 cicada 目前的性能还是不错的。

总结

本文没有过多讨论 cicada 实现原理，感兴趣的可以看看源码，都比较简单。

在后续的更新中会仔细探讨这块内容。

同时不出意外 cicada 会持续更新，未来也会加入更多实用的功能。

甚至我会在适当的时机将它应用于我的生产项目，也希望更多朋友能参与进来一起把这个「轮子」做的更好。

项目地址：https://github.com/crossoverJie/cicada

你的点赞与转发是最大的支持。

超融合服务器私有云轻量级框架 php轻量级框架轻量级java 框架 java的轻量级框架

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/76962.html

「造个轮子」——cicada 设计一个配置模块

摘要：同时也新增了一个。将不同的配置文件用不同的对象进行管理。由于需要支持多个配置文件，所有需要定义一个抽象类供所有的配置管理实现。其实就是一个结构的缓存，用于存放所有的配置。总结这就是本次中的升级内容，包含了配置支持以及代码重构。 showImg(https://segmentfault.com/img/remote/1460000016392132?w=2048&h=1365); 前言 ...

fsmStudy 2019-08-19 11:09 评论0 收藏0
设计一个百万级的消息推送系统

摘要：所以本次分享的内容不但可以满足物联网领域同时还支持以下场景基于的聊天系统点对点群聊。基于的消息推送平台。因此我觉得最好是在满足业务需求的情况下定制自己的私有协议，在我这个场景下其实有标准的物联网协议。 showImg(https://segmentfault.com/img/remote/1460000016504224?w=4900&h=2613); 前言首先迟到的祝大家中秋快...

Rindia 2019-08-06 10:46 评论0 收藏0
造个轮子，基于 Laravel5.4 的下一代 PHP 开发框架（API/SPA/Vue2/iVi

摘要：像操作系统一样，你可以通过安装软件，成为适用于你的电脑。先进的技术方案，使得你无需担心后期功能拓展与迭代问题，大大降低了维护成本。对于一个超过三年生命周期的项目来说，最适合不过。总之，是新的技术方向标，能让每个艺术家像构建工程一样构建程序。这是我们团队的一个非盈利项目，以Apache2.0协议开源...不限制商用 Notadd是什么 Notadd 是基于Laravel 和 Vue 的...

Rocture 2019-06-27 16:29 评论0 收藏0
用Vue自己造个组件轮子，以及实践背后带来的思考

摘要：用造个组件轮子吧闰土大叔如果你掌握了的组件知识，相关的指令事件，花点时间你也可以造出这么个入门级的小轮子。接下来，抛出造轮子实践背后带来的一些思考。以上三部分内容构成了的整个执行过程。 showImg(https://segmentfault.com/img/bV1Tnu?w=754&h=500); 前言首先，向大家说声抱歉。由于之前的井底之蛙，误认为Vue.js还远没有覆盖到二三线...

icyfire 2019-08-22 13:45 评论0 收藏0
我厌倦了 Redux，那就造个轮子 Rectx：第三集

摘要：呵呵，你没想到吧，这玩意儿竟然有第三集我靠，我自己都没想到，让我们悄悄的回顾一下前两集完全没想到，竟然会有第二集我厌倦了，那就造个轮子第二集痛点分析第一集在这里我厌倦了，那就造个轮子算了，我都懒得写了，自己看吧，当然不看也无所谓，正式开始。仓库：215566435/rectx 前言麻烦快去我的仓库里面喷：老子学不动了，求不要更新。呵呵，你没想到吧，这玩意儿竟然有第三集！我靠，我...

adam1q84 2019-08-02 16:31 评论0 收藏0