前言

两天前写了文章《「造个轮子」——cicada(轻量级 WEB 框架)》 向大家介绍了 cicada 之后收到很多反馈,也有许多不错的建议。

同时在 GitHub 也收获了 80 几颗 小♥♥(绝对不是刷的。。)

也有朋友希望能出一个源码介绍,本文就目前的 v1.0.1 版本来一起分析分析。

没有看错,刚发布就修复了一个 bug,想要试用的请升级到 1.0.1 吧。

技术选型

一般在做一个新玩意之前都会有技术选型的过程,但这点在做 cicada 的时候却异常简单。

因为我的需求是想提供一个高性能的 HTTP 服务,纵观整个开源界其实选择不多。

加上最近我在做 Netty 相关的开发,所以自然而然就选择了它。

同时 Netty 自带了对 HTTP 协议的编解码器,可以非常简单快速的开发一个 HTTP 服务器。我只需要把精力放在参数处理、路由等业务处理上即可。

同时 Netty 也是基于 NIO 实现,性能上也有保证。关于 Netty 相关内容可以参考这里

下面来重点分析其中的各个过程。

路由规则

最核心的自然就是 HTTP 的处理 handle,对应的就是 HttpHandle 类。

查看源码其实很容易看出具体的步骤,注释也很明显。

这里只分析重点功能。

先来考虑下需求。

首先作为一个 HTTP 框架,自然是得让使用者能有地方来实现业务代码;就像咱们现在使用 SpringMVC 时写的 controller 一样。

其实当时考虑过三种方案:

  • 像 SpringMVC 一样定义注解,只要声明了对应注解我就认为这是一个业务类。
  • 用过 Struts2 的同学应该有印象,它的业务类 Action 都是配置到一个 XML 中;在里面配置接口对应的业务处理类。
  • 同样的思路,只是把 XML 文件换成 properties 配置文件,在里面编写 JSON 格式的对应关系。

这时就得分析各个方案的优缺点了。

方案二和三其实就是 XML 和 json 的对比了;XML 会让维护者感到结构清晰,同时便于维护和新增。

JSON 就不太方便处理了,并且在这样的场景并不用于传输自然也发挥不出优势。

最后考虑到现在流行的 SpringBoot 都在去 XML,要是再搞一个依赖于 XML 的东西也跟不上大家的使用习惯。

于是就采用类似于 SpringMVC 这样的注解形式。

既然采用了注解,那框架怎么知道用户访问某个接口时能对应到业务类呢?

所以首先第一步自然是需要将加有注解的类全部扫描一遍,放到一个本地缓存中。

这样才能方便后续的路由定位。

路由策略

其中核心的源码在 routeAction 方法中。

首先会全局扫描使用了 @CicadaAction 的注解,然后再根据请求地址找到对应的业务类。

全局扫描代码:

首先是获取到项目中自定义的所有类,然后判断是否加有 @CicadaAction 注解。

是目标类则把他缓存到一个本地 Map 中,方便下次访问时可以不再扫描直接从缓存中获取即可(反射很耗性能)。

执行完 routeAction 后会获得真正的业务类类型。

Class<?> actionClazz = routeAction(queryStringDecoder, appConfig);

传参方式

拿到业务类的类类型之后就成功一大半了,只需要反射生成它的对象然后执行方法即可。

在执行方法之前又要涉及到一个问题,参数我该怎么传递呢?

考虑到灵活性我采用了最简答 Map 方式。

因此定义了一个通用的 Param 接口并继承了 Map 接口。

public interface Param extends Map<String, Object> {

    /**
* get String
* @param param
* @return
*/
String getString(String param); /**
* get Integer
* @param param
* @return
*/
Integer getInteger(String param); /**
* get Long
* @param param
* @return
*/
Long getLong(String param); /**
* get Double
* @param param
* @return
*/
Double getDouble(String param); /**
* get Float
* @param param
* @return
*/
Float getFloat(String param); /**
* get Boolean
* @param param
* @return
*/
Boolean getBoolean(String param) ;
}

其中封装了几种基本类型的获取方式。

同时在 buildParamMap() 方法中,将接口中的参数封装到这个 Map 中。

Param paramMap = buildParamMap(queryStringDecoder);

业务执行

最后只需要执行业务即可;由于在上文已经获取到业务类的类类型,所以这里通过反射即可调用。

同时也定义了一个业务类需要实现的一个通用接口 WorkAction,想要实现具体业务只要实现它就行。

而这里的方法参数自然就是刚才定义的参数接口 Param

由于所有的业务类都是实现了 WorkAction,所以在反射时都可以定义为 WorkAction 对象。

WorkAction action = (WorkAction) actionClazz.newInstance();
WorkRes execute = action.execute(paramMap);

最后将构建好的参数 map 传入即可。

响应返回

有了请求那自然也得有响应,观察刚才定义的 WorkAction 接口可以发现其实定义了一个 WorkRes 响应类。

所有的响应数据都需要封装到这个对象中。

这个没啥好说的,都是一些基本数据。

最后在 responseMsg() 方法中将响应数据编码为 JSON 输出即可。

拦截器设计

拦截器也是一个框架基本的功能,用处非常多。

cicada 的实现原理非常简单,就是在 WorkAction 接口执行业务逻辑之前调用一个方法、执行完毕之后调用另一个方法。

也是同样的思路需要定义一个接口 CicadaInterceptor,其中有两个方法。

看方法名字自然也能看出具体作用。

同时在这两个方法中执行具体的调用。

这里重点要看看 interceptorBefore 方法。

其中也是加入了一个缓存,尽量的减少反射操作。

适配器

就这样的拦截器接口是够用了,但并不是所有的业务都需要实现两个接口。

因此也提供了一个适配器 AbstractCicadaInterceptorAdapter

它作为一个抽象类实现了 CicadaInterceptor 接口,这样后续的拦截业务也可继承该接口选择性的实现方法即可。

类似于这样:

总结

v1.0.1 版本的 cicada 就介绍完毕了,其中的原理和源码都比较简单。

大量使用了反射和一些设计模式、多态等应用,这方面经验较少的朋友可以参考下。

同时也有很多不足;比如传参后续会考虑更加优雅的方式、拦截器目前写的比较死,后续会利用动态代理实现自定义拦截。

其实 cicada 只是利用周末两天时间做的,bug 肯定少不了;也欢迎大家在 GitHub 上提 issue 参与。

最后贴下项目地址:

https://github.com/TogetherOS/cicada

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

「造个轮子」——cicada 源码分析的更多相关文章

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

    前言 在前两次的 cicada 版本中其实还不支持读取配置文件,比如对端口.路由的配置. 因此我按照自己的想法创建了一个 issue ,也收集到了一些很不错的建议. 最终其实还是按照我之前的想法来做了 ...

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

    前言 俗话说 「不要重复造轮子」,关于是否有必要不再本次讨论范围. 创建这个项目的主要目的还是提升自己,看看和知名类开源项目的差距以及学习优秀的开源方式. 好了,现在着重来谈谈 cicada 这个项目 ...

  3. 「从零单排canal 03」 canal源码分析大纲

    在前面两篇中,我们从基本概念理解了canal是一个什么项目,能应用于什么场景,然后通过一个demo体验,有了基本的体感和认识. 从这一篇开始,我们将从源码入手,深入学习canal的实现方式.了解can ...

  4. 「造个轮子」——设计 HTTP 请求全局上下文

    前言 本次 Cicada 已经更新到了 v1.0.3. 主要是解决了两个 issue,#9(Boss线程数好像设置有误 ) #8(怎么返回纯字符串内容不要JSON格式?). 所以本次的主要更新为: C ...

  5. 🏆【Alibaba微服务技术系列】「Dubbo3.0技术专题」回顾Dubbo2.x的技术原理和功能实现及源码分析(温故而知新)

    RPC服务 什么叫RPC? RPC[Remote Procedure Call]是指远程过程调用,是一种进程间通信方式,他是一种技术的思想,而不是规范.它允许程序调用另一个地址空间(通常是共享网络的另 ...

  6. 【SpringCloud技术专题】「Eureka源码分析」从源码层面让你认识Eureka工作流程和运作机制(上)

    前言介绍 了解到了SpringCloud,大家都应该知道注册中心,而对于我们从过去到现在,SpringCloud中用的最多的注册中心就是Eureka了,所以深入Eureka的原理和源码,接下来我们要进 ...

  7. HashMap与TreeMap源码分析

    1. 引言     在红黑树--算法导论(15)中学习了红黑树的原理.本来打算自己来试着实现一下,然而在看了JDK(1.8.0)TreeMap的源码后恍然发现原来它就是利用红黑树实现的(很惭愧学了Ja ...

  8. jQuery.lazyload使用及源码分析

    前言: 貌似以前自己也写过图片懒加载插件,但是新公司使用的是jQuery.lazyload插件,为了更好的运用,自己还是把源码看了遍,分别记录了如何使用, 插件原理,各个配置属性的完整解释,demo实 ...

  9. dubbo源码分析5-dubbo的扩展点机制

    dubbo源码分析1-reference bean创建 dubbo源码分析2-reference bean发起服务方法调用 dubbo源码分析3-service bean的创建与发布 dubbo源码分 ...

随机推荐

  1. 随笔【js】

    1.js是大小写敏感的 2. 区别 getElementBy ID , getElementsBy Name,  getElementsBy TagName以人来举例说明,人有能标识身份的身份证,有姓 ...

  2. Oracle:select into 查询没有记录的解决办法

    在数据库编程中,select into 语句可以将数据库的某些值赋值给程序的变量,使用起来非常方便.但很多时候也会遇到查询出来没有记录的情况,这时程序会出错. 可以使用 exception when ...

  3. ArcGIS Server学习之问题:ArcGIS Server10.5发布地图显示空白

    一.安装ArcGIS10.5 参考ArcGIS 10.5 for Desktop 完整安装教程(含win7/8/10 32/64位+下载地址+亲测可用) | 麻辣GIS 二.安装ArcGIS Serv ...

  4. XAML控件不可访问,它具有一定的保护级别

    其它namespace的代码访问控件时会出现这个问题 需要把控件状态由protected改为public <TextBlock x:FieldModifier="public" ...

  5. DCDC设计指南二

    DCDC电源设计指导:二 这一讲以一款SOP-8封装的Synchronous Step-Down Converter(同步降压转换器)电源IC为例,讲下电源的PCB设计. 如第一讲中所说,开始设计时就 ...

  6. Vue.js的安装及简单使用

    一.Vue简介 二.Vue.js的安装 2.1.npm安装 2.1.1.node.js介绍及安装 简介: 简单的说 Node.js 就是运行在服务端的 JavaScript. Node.js 是一个基 ...

  7. linux仅修改文件夹权限 分别批量修改文件和文件夹权限

    比如我想把/var/www/html下的文件全部改成664,文件夹改成775,怎么做呢 方法一: 先把所有文件及文件夹改成664,然后把所有文件夹改成775 chmod -R 664 ./ find ...

  8. TCP协议中是如何保证报文可靠传输的

    1.什么是TCP的可靠传输 它向应用层提供的数据是无差错的.有序的.无丢失的,换言之就是:TCP最终递交给应用层的数据和发送者发送的数据是一模一样的. 2.TCP保证可靠传输的办法有哪些? TCP采用 ...

  9. JUC

    1.Java JUC简介 在Java5.0提供了java.util.concurrent(简称JUC)包,在此包中增加了在并发编程中很常用的实用工具类,用于定义类似于线程的自定义子系统,包括线程池.异 ...

  10. MongoDB 用Robomong可视化工具操作的 一些简单语句

    一.数据更新 db.getCollection('表名').update({ "字段":{$in:["值"]} }, //更新条件 {$set:{ " ...