docs/netty/cicada.md
📘特性 |🌁快速启动 | 🏖性能测试 | 🌈更新记录 | 💡 联系作者|🇦🇺English
</div>基于 Netty4 实现的快速、轻量级 WEB 框架;没有过多的依赖,核心 jar 包仅 30KB。
如果你感兴趣,请点 Star。
json 响应格式。IOC 容器。Cookie 支持。创建一个 maven 项目,引入核心依赖。
<dependency>
<groupId>top.crossoverjie.opensource</groupId>
<artifactId>cicada-core</artifactId>
<version>x.y.z</version>
</dependency>
启动类:
public class MainStart {
public static void main(String[] args) throws InterruptedException {
CicadaServer.start(MainStart.class,"/cicada-example") ;
}
}
@CicadaAction("routeAction")
public class RouteAction {
private static final Logger LOGGER = LoggerBuilder.getLogger(RouteAction.class);
@CicadaRoute("getUser")
public void getUser(DemoReq req){
LOGGER.info(req.toString());
WorkRes<DemoReq> reqWorkRes = new WorkRes<>() ;
reqWorkRes.setMessage("hello =" + req.getName());
CicadaContext.getContext().json(reqWorkRes) ;
}
@CicadaRoute("getInfo")
public void getInfo(DemoReq req){
WorkRes<DemoReq> reqWorkRes = new WorkRes<>() ;
reqWorkRes.setMessage("getInfo =" + req.toString());
CicadaContext.getContext().json(reqWorkRes) ;
}
@CicadaRoute("getReq")
public void getReq(CicadaContext context,DemoReq req){
WorkRes<DemoReq> reqWorkRes = new WorkRes<>() ;
reqWorkRes.setMessage("getReq =" + req.toString());
context.json(reqWorkRes) ;
}
}
启动应用访问 http://127.0.0.1:5688/cicada-example/routeAction/getUser?id=1234&name=zhangsan
{"message":"hello =zhangsan"}
通过 context.json(),context.text() 方法可以选择不同的响应方式。
@CicadaAction("routeAction")
public class RouteAction {
private static final Logger LOGGER = LoggerBuilder.getLogger(RouteAction.class);
@CicadaRoute("getUser")
public void getUser(DemoReq req){
LOGGER.info(req.toString());
WorkRes<DemoReq> reqWorkRes = new WorkRes<>() ;
reqWorkRes.setMessage("hello =" + req.getName());
CicadaContext.getContext().json(reqWorkRes) ;
}
@CicadaRoute("hello")
public void hello() throws Exception {
CicadaContext context = CicadaContext.getContext();
String url = context.request().getUrl();
String method = context.request().getMethod();
context.text("hello world url=" + url + " method=" + method);
}
}
Cookie cookie = new Cookie() ;
cookie.setName("cookie");
cookie.setValue("value");
CicadaContext.getResponse().setCookie(cookie);
Cookie cookie = CicadaContext.getRequest().getCookie("cookie");
logger.info("cookie = " + cookie.toString());
cicada 默认会读取 classpath 下的 application.properties 配置文件。
同时也可以自定义配置文件。
只需要继承 top.crossoverjie.cicada.server.configuration.AbstractCicadaConfiguration
并传入配置文件名称即可。比如:
public class RedisConfiguration extends AbstractCicadaConfiguration {
public RedisConfiguration() {
super.setPropertiesName("redis.properties");
}
}
public class KafkaConfiguration extends AbstractCicadaConfiguration {
public KafkaConfiguration() {
super.setPropertiesName("kafka.properties");
}
}
按照如下方式即可获取自定义配置:
KafkaConfiguration configuration = (KafkaConfiguration) getConfiguration(KafkaConfiguration.class);
RedisConfiguration redisConfiguration = (RedisConfiguration) ConfigurationHolder.getConfiguration(RedisConfiguration.class);
ApplicationConfiguration applicationConfiguration = (ApplicationConfiguration) ConfigurationHolder.getConfiguration(ApplicationConfiguration.class);
String brokerList = configuration.get("kafka.broker.list");
String redisHost = redisConfiguration.get("redis.host");
String port = applicationConfiguration.get("cicada.port");
LOGGER.info("Configuration brokerList=[{}],redisHost=[{}] port=[{}]",brokerList,redisHost,port);
当然在特殊环境中(dev/test/pro)也可以读取外置配置文件。只需要加上启动参数,保证参数名称和文件名一致即可。
-Dapplication.properties=/xx/application.properties
-Dkafka.properties=/xx/kakfa.properties
-Dredis.properties=/xx/redis.properties
实现 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 boolean before(Param param) {
start = System.currentTimeMillis();
return true;
}
@Override
public void after(Param param) {
end = System.currentTimeMillis();
LOGGER.info("cast [{}] times", end - start);
}
}
测试条件:100 threads and 100 connections ;1G RAM/4 CPU。
每秒将近 10W 请求。
CookiecrossoverJie#gmail.com