Skip to content

TogetherOS/cicada

Repository files navigation


Build Status QQ群


Lightweight HTTP service framework.

简介

基于 Netty4 实现的快速、轻量级 WEB 框架;没有过多的依赖,核心 jar 包仅 30KB

特性

  • 代码简洁,没有过多依赖。
  • 一行代码即可启动 HTTP 服务。
  • 自定义拦截器。
  • 灵活的传参方式。
  • json 响应格式。
  • 基于 jar 启动。
  • 多种路由风格。
  • HTTP 支持。
  • Cookie 支持。
  • 文件上传。

快速启动

创建一个 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

创建业务 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;
    }

}

启动应用访问 http://127.0.0.1:7317/cicada-example/demoAction?name=12345&id=10

自定义拦截器

实现 top.crossoverjie.cicada.example.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);
    }
}

拦截适配器

同样也可以只实现其中一个方法,只需要继承 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());
    }

}

性能测试

测试条件:300 并发连续压测两轮;1G 内存、单核 CPU、1Mbps。

联系作者

crossoverJie#gmail.com