聲明本文轉載自:https://my.oschina.net/crossoverjie/blog/1941207
前言
俗話說 「不要重復造輪子」,關於是否有必要不再本次討論范圍。
創建這個項目的主要目的還是提升自己,看看和知名類開源項目的差距以及學習優秀的開源方式。
好了,現在着重來談談 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
會持續更新,未來也會加入更多實用的功能。
甚至我會在適當的時機將它應用於我的生產項目,也希望更多朋友能參與進來一起把這個「輪子」做的更好。