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

前言

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

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

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

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

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

---

特性

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

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

功能虽少，但五脏俱全。

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

快速启动

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

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

<dependency>
    <groupid>top.crossoverjie.opensource</groupid>
    <artifactid>cicada-core</artifactid>
    <version>1.0.0</version>
</dependency>

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

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<demoresvo> 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<demoresvo> 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 的线程池配置:

<executor name="tomcatthreadpool" nameprefix="consumer-exec-"
        maxthreads="510" minsparethreads="10"/>

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

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

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

总结

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

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

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

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

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

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