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

简介:

前言

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

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

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

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

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

6985c4014c7af0bec1546f82b7693ee19a245c78

特性

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

ce7f13703085d0ac6cc232dd4bd3aede581bea51

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

功能虽少,但五脏俱全。

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

快速启动

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

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

 
  1. <dependency>

  2. <groupId>top.crossoverjie.opensource</groupId>

  3. <artifactId>cicada-core</artifactId>

  4. <version>1.0.0</version>

  5. </dependency>

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

 
  1. public class MainStart {

  2. public static void main(String[] args) throws InterruptedException {

  3. CicadaServer.start(MainStart.class,"/cicada-example") ;

  4. }

  5. }

配置业务 Action

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

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

 
  1. @CicadaAction(value = "demoAction")

  2. public class DemoAction implements WorkAction {

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

  4. private static AtomicLong index = new AtomicLong() ;

  5. @Override

  6. public WorkRes<DemoResVO> execute(Param paramMap) throws Exception {

  7. String name = paramMap.getString("name");

  8. Integer id = paramMap.getInteger("id");

  9. LOGGER.info("name=[{}],id=[{}]" , name,id);

  10. DemoResVO demoResVO = new DemoResVO() ;

  11. demoResVO.setIndex(index.incrementAndGet());

  12. WorkRes<DemoResVO> res = new WorkRes();

  13. res.setCode(StatusEnum.SUCCESS.getCode());

  14. res.setMessage(StatusEnum.SUCCESS.getMessage());

  15. res.setDataBody(demoResVO) ;

  16. return res;

  17. }

  18. }

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

这样启动应用并访问

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

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

35a579f635273a7e9e9ac13e05361d2d407e7854

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

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

6cb4f4849aae9eb13885f6fb4bcb4f8831a01866

灵活的参数配置

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

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

 
  1. http://127.0.0.1:7317/cicada-example/demoAction?jsonData="info": {

  2. "age": 22,

  3. "name": "zhangsan"

  4. }

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

自定义拦截器

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

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

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

 
  1. @Interceptor(value = "executeTimeInterceptor")

  2. public class ExecuteTimeInterceptor implements CicadaInterceptor {

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

  4. private Long start;

  5. private Long end;

  6. @Override

  7. public void before(Param param) {

  8. start = System.currentTimeMillis();

  9. }

  10. @Override

  11. public void after(Param param) {

  12. end = System.currentTimeMillis();

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

  14. }

  15. }

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

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

拦截适配器

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

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

top.crossoverjie.cicada.server.intercept.AbstractCicadaInterceptorAdapter

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

 
  1. @Interceptor(value = "loggerInterceptor")

  2. public class LoggerInterceptorAbstract extends AbstractCicadaInterceptorAdapter {

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

  4. @Override

  5. public void before(Param param) {

  6. LOGGER.info("logger param=[{}]",param.toString());

  7. }

  8. }

性能测试

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

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

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

Tomcat 的线程池配置:

 
  1. <Executor name="tomcatThreadPool" namePrefix="consumer-exec-"

  2. maxThreads="510" minSpareThreads="10"/>


9a6382828ab04955c283aafac1ba8b6ae460baef

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

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

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

总结

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

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

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

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


原文发布时间为:2018-09-3

本文来自云栖社区合作伙伴“crossoverJie”,了解相关信息可以关注“crossoverJie”。

相关实践学习
通过性能测试PTS对云服务器ECS进行规格选择与性能压测
本文为您介绍如何利用性能测试PTS对云服务器ECS进行规格选择与性能压测。
相关文章
|
3天前
|
中间件 Go API
【Go 语言专栏】Go 语言中的 Web 框架比较与选择
【4月更文挑战第30天】本文对比了Go语言中的四个常见Web框架:功能全面的Beego、轻量级高性能的Gin、简洁高效的Echo,以及各自的性能、功能特性、社区支持。选择框架时需考虑项目需求、性能要求、团队经验和社区生态。开发者应根据具体情况进行权衡,以找到最适合的框架。
|
3天前
|
存储 前端开发 数据库
搭建轻量级Web应用
【4月更文挑战第14天】本文介绍了使用Flask快速搭建轻量级Web应用的步骤。首先,通过`pip install Flask`安装Flask,然后创建基础应用结构,包含路由和简单的Hello, Flask!页面。接着,学习如何添加更多页面、使用模板引擎(如Jinja2)和处理表单。此外,文章还涉及管理静态文件、集成SQLite数据库、进行数据库迁移以及添加用户认证功能,使用Flask-Login实现登录和登出。通过这些步骤,读者能掌握构建完整Flask应用的基本知识,了解其灵活性和扩展性。
12 0
|
3天前
|
机器学习/深度学习 前端开发 数据可视化
数据分析web可视化神器---streamlit框架,无需懂前端也能搭建出精美的web网站页面
数据分析web可视化神器---streamlit框架,无需懂前端也能搭建出精美的web网站页面
|
3天前
|
开发框架 前端开发 JavaScript
学会Web UI框架--Bootstrap,快速搭建出漂亮的前端界面
学会Web UI框架--Bootstrap,快速搭建出漂亮的前端界面
|
4天前
|
缓存 前端开发 安全
Python web框架fastapi中间件的使用,CORS跨域详解
Python web框架fastapi中间件的使用,CORS跨域详解
|
4天前
|
API 数据库 Python
Python web框架fastapi数据库操作ORM(二)增删改查逻辑实现方法
Python web框架fastapi数据库操作ORM(二)增删改查逻辑实现方法
|
4天前
|
关系型数据库 MySQL API
Python web框架fastapi数据库操作ORM(一)
Python web框架fastapi数据库操作ORM(一)
|
4天前
|
Python
python web框架fastapi模板渲染--Jinja2使用技巧总结
python web框架fastapi模板渲染--Jinja2使用技巧总结
|
4天前
|
开发框架 网络协议 前端开发
Python高性能web框架--Fastapi快速入门
Python高性能web框架--Fastapi快速入门
|
4天前
|
网络协议 数据库 开发者
构建高效Python Web应用:异步编程与Tornado框架
【4月更文挑战第29天】在Web开发领域,响应时间和并发处理能力是衡量应用性能的关键指标。Python作为一种广泛使用的编程语言,其异步编程特性为创建高性能Web服务提供了可能。本文将深入探讨Python中的异步编程概念,并介绍Tornado框架如何利用这一机制来提升Web应用的性能。通过实例分析,我们将了解如何在实际应用中实现高效的请求处理和I/O操作,以及如何优化数据库查询,以支持更高的并发用户数和更快的响应时间。