「造個輪子」——cicada(輕量級 WEB 框架)

来源:https://www.cnblogs.com/crossoverJie/archive/2018/09/03/9576812.html
-Advertisement-
Play Games

俗話說 「不要重覆造輪子」,關於是否有必要不再本次討論範圍。 創建這個項目的主要目的還是提升自己,看看和知名類開源項目的差距以及學習優秀的開源方式。 ...


前言

俗話說 「不要重覆造輪子」,關於是否有必要不再本次討論範圍。

創建這個項目的主要目的還是提升自己,看看和知名類開源項目的差距以及學習優秀的開源方式。

好了,現在著重來談談 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 會持續更新,未來也會加入更多實用的功能。

甚至我會在適當的時機將它應用於我的生產項目,也希望更多朋友能參與進來一起把這個「輪子」做的更好。

項目地址:https://github.com/crossoverJie/cicada

你的點贊與轉發是最大的支持。


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 以面向對象的方式實現無線輪播效果組件預覽地址:https://evenyao.github.io/carousel-jQuery/ 邏輯圖 我們的demo輪播為四張圖,如有多張圖,邏輯是一樣的 當初始化之前,CSS中如果撤除 overflow: hidden; ,即可看到該樣式,即四張圖排列在一起( ...
  • 載入並全屏輪播載入的其他網站的頁面 一、 設計思路 1、使用iframe標簽載入其他網站頁面 2、通過js替換iframe的載入鏈接 3、通過js的定時器實現輪播 4、通過js實現全屏 二、代碼小解 1、載入頁面 <iframe src="https://www.baidu.com" width=' ...
  • 一,easyui datagrid綁定數據的簡單測試: 1.資料庫中的UserInfo表及數據測試: 2.DAL層: //分頁,模糊查詢(pageNum-1)*pageSize+1 從第幾條數據開始,pageNum*pageSize 查詢到那一條結束 //查詢總的條數 3.一般處理程式(UserIn ...
  • JavaScript 的核心概念主要由 語法、變數、數據類型 、操作符、語句、函數組成,這篇文章主要講解的是前面三個,後面三個下一篇文章再講解。 01 語法 熟悉 JavaScript 歷史的人應該都知道,JavaScript 的很多語法和 Java、C 語言類似,所以一些做後端的程式員上手前端很快 ...
  • 原文鏈接:http://blog.csdn.net/zhangerqing 設計模式(Design pattern)是一套被反覆使用、多數人知曉的、經過分類編目的、代碼設計經驗的總結。使用設計模式是為了可重用代碼、讓代碼更容易被他人理解、保證代碼可靠性。 毫無疑問,設計模式於己於他人於系統都是多贏的 ...
  • ThreadLocal 概述 ThreadLocal實例僅作為線程局部變數的==操作類==,以及==線程存儲局部變數時的Key==。真正的線程局部變數是存儲在各自線程的本地,通過Thread類中的 進行存儲。 若希望線上程本地存儲多個局部變數需要使用多個ThreadLocal實例進行操作。 Thre ...
  • https://www.cnblogs.com/jiahaoJAVA/p/6244278.html 1 什麼是redis? Redis 是一個基於記憶體的高性能key-value資料庫。 (有空再補充,有理解錯誤或不足歡迎指正) 2 Reids的特點 Redis本質上是一個Key-Value類型的記憶體 ...
  • 題意 約翰要帶N(1≤N≤100000)只牛去參加集會裡的展示活動,這些牛可以是牡牛,也可以是牝牛.牛們要站成一排.但是牡牛是好鬥的,為了避免牡牛鬧出亂子,約翰決定任意兩隻牡牛之間至少要有K(O≤K<N)只牝牛. 請計算一共有多少種排隊的方法.所有牡牛可以看成是相同的,所有牝牛也一樣.答案對5000 ...
一周排行
    -Advertisement-
    Play Games
  • 示例項目結構 在 Visual Studio 中創建一個 WinForms 應用程式後,項目結構如下所示: MyWinFormsApp/ │ ├───Properties/ │ └───Settings.settings │ ├───bin/ │ ├───Debug/ │ └───Release/ ...
  • [STAThread] 特性用於需要與 COM 組件交互的應用程式,尤其是依賴單線程模型(如 Windows Forms 應用程式)的組件。在 STA 模式下,線程擁有自己的消息迴圈,這對於處理用戶界面和某些 COM 組件是必要的。 [STAThread] static void Main(stri ...
  • 在WinForm中使用全局異常捕獲處理 在WinForm應用程式中,全局異常捕獲是確保程式穩定性的關鍵。通過在Program類的Main方法中設置全局異常處理,可以有效地捕獲並處理未預見的異常,從而避免程式崩潰。 註冊全局異常事件 [STAThread] static void Main() { / ...
  • 前言 給大家推薦一款開源的 Winform 控制項庫,可以幫助我們開發更加美觀、漂亮的 WinForm 界面。 項目介紹 SunnyUI.NET 是一個基於 .NET Framework 4.0+、.NET 6、.NET 7 和 .NET 8 的 WinForm 開源控制項庫,同時也提供了工具類庫、擴展 ...
  • 說明 該文章是屬於OverallAuth2.0系列文章,每周更新一篇該系列文章(從0到1完成系統開發)。 該系統文章,我會儘量說的非常詳細,做到不管新手、老手都能看懂。 說明:OverallAuth2.0 是一個簡單、易懂、功能強大的許可權+可視化流程管理系統。 有興趣的朋友,請關註我吧(*^▽^*) ...
  • 一、下載安裝 1.下載git 必須先下載並安裝git,再TortoiseGit下載安裝 git安裝參考教程:https://blog.csdn.net/mukes/article/details/115693833 2.TortoiseGit下載與安裝 TortoiseGit,Git客戶端,32/6 ...
  • 前言 在項目開發過程中,理解數據結構和演算法如同掌握蓋房子的秘訣。演算法不僅能幫助我們編寫高效、優質的代碼,還能解決項目中遇到的各種難題。 給大家推薦一個支持C#的開源免費、新手友好的數據結構與演算法入門教程:Hello演算法。 項目介紹 《Hello Algo》是一本開源免費、新手友好的數據結構與演算法入門 ...
  • 1.生成單個Proto.bat內容 @rem Copyright 2016, Google Inc. @rem All rights reserved. @rem @rem Redistribution and use in source and binary forms, with or with ...
  • 一:背景 1. 講故事 前段時間有位朋友找到我,說他的窗體程式在客戶這邊出現了卡死,讓我幫忙看下怎麼回事?dump也生成了,既然有dump了那就上 windbg 分析吧。 二:WinDbg 分析 1. 為什麼會卡死 窗體程式的卡死,入口門檻很低,後續往下分析就不一定了,不管怎麼說先用 !clrsta ...
  • 前言 人工智慧時代,人臉識別技術已成為安全驗證、身份識別和用戶交互的關鍵工具。 給大家推薦一款.NET 開源提供了強大的人臉識別 API,工具不僅易於集成,還具備高效處理能力。 本文將介紹一款如何利用這些API,為我們的項目添加智能識別的亮點。 項目介紹 GitHub 上擁有 1.2k 星標的 C# ...