摘要：前言俗話(huà)說(shuō)不要重復(fù)造輪子，關(guān)于是否有必要不再本次討論范圍。我把他定義為一個(gè)快速輕量級(jí)框架沒(méi)有過(guò)多的依賴(lài)，核心包僅。只需要?jiǎng)?chuàng)建一個(gè)項(xiàng)目，并引入核心包。在測(cè)試條件為并發(fā)連續(xù)壓測(cè)兩輪內(nèi)存單核。

俗話(huà)說(shuō) 「不要重復(fù)造輪子」，關(guān)于是否有必要不再本次討論范圍。

創(chuàng)建這個(gè)項(xiàng)目的主要目的還是提升自己，看看和知名類(lèi)開(kāi)源項(xiàng)目的差距以及學(xué)習(xí)優(yōu)秀的開(kāi)源方式。

好了，現(xiàn)在著重來(lái)談?wù)?cicada 這個(gè)項(xiàng)目的核心功能。

我把他定義為一個(gè)快速、輕量級(jí) WEB 框架；沒(méi)有過(guò)多的依賴(lài)，核心 jar 包僅 30KB。

也僅需要一行代碼即可啟動(dòng)一個(gè) HTTP 服務(wù)。

現(xiàn)在來(lái)談?wù)勚匾膸讉€(gè)特性。

當(dāng)前版本主要實(shí)現(xiàn)了基本的請(qǐng)求、響應(yīng)、自定義參數(shù)以及攔截器功能。

功能雖少，但五臟俱全。

在今后的迭代過(guò)程中會(huì)逐漸完善上圖功能，有好的想法也歡迎提 https://github.com/crossoverJie/cicada/issues。

下面來(lái)看看如何快速啟動(dòng)一個(gè) HTTP 服務(wù)。

只需要?jiǎng)?chuàng)建一個(gè) Maven 項(xiàng)目，并引入核心包。

    top.crossoverjie.opensource
    cicada-core
    1.0.0

如上圖所示，再配置一個(gè)啟動(dòng)類(lèi)即可。

public class MainStart {

    public static void main(String[] args) throws InterruptedException {
        CicadaServer.start(MainStart.class,"/cicada-example") ;
    }
}

當(dāng)然我們還需要一個(gè)實(shí)現(xiàn)業(yè)務(wù)邏輯的地方。cicada 提供了一個(gè)接口，只需要實(shí)現(xiàn)該接口即可實(shí)現(xiàn)具體邏輯。

創(chuàng)建業(yè)務(wù) Action 實(shí)現(xiàn) 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 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 res = new WorkRes();
        res.setCode(StatusEnum.SUCCESS.getCode());
        res.setMessage(StatusEnum.SUCCESS.getMessage());
        res.setDataBody(demoResVO) ;
        return res;
    }

}

同時(shí)需要再自定義類(lèi)中加上 @CicadaAction 注解，并需要指定一個(gè) value，該 value 主要是為了在請(qǐng)求路由時(shí)能找到業(yè)務(wù)類(lèi)。

這樣啟動(dòng)應(yīng)用并訪問(wèn)

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

便能執(zhí)行業(yè)務(wù)邏輯同時(shí)得到服務(wù)端的返回。

目前默認(rèn)支持的是 json 響應(yīng)，后期也會(huì)加上模板解析。

服務(wù)中也會(huì)打印相關(guān)日志。

這里所有的請(qǐng)求參數(shù)都封裝在 Param 中，可以利用其中的各種 API 獲取請(qǐng)求數(shù)據(jù)。

之所以是靈活的：我們甚至可以這樣請(qǐng)求：

http://127.0.0.1:7317/cicada-example/demoAction?jsonData="info": {
    "age": 22,
    "name": "zhangsan"
  }

這樣就可以傳遞任意結(jié)構(gòu)的數(shù)據(jù)，只要業(yè)務(wù)處理時(shí)進(jìn)行解析即可。

攔截器是一個(gè)框架的基本功能，可以利用攔截器實(shí)現(xiàn)日志記錄、事務(wù)提交等通用工作。

為此 cicada 提供一個(gè)接口: top.crossoverjie.cicada.server.intercept.CicadaInterceptor。

我們只需要實(shí)現(xiàn)該接口即可編寫(xiě)攔截功能：

@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 的執(zhí)行時(shí)間。

目前默認(rèn)只實(shí)現(xiàn)了 action 的攔截，后期也會(huì)加入自定義攔截器。

雖說(shuō)在攔截器中提供了 before/after 兩個(gè)方法，但也不是所有的方法都需要實(shí)現(xiàn)。

因此 cicada 提供了一個(gè)適配器：

top.crossoverjie.cicada.server.intercept.AbstractCicadaInterceptorAdapter

我們需要繼承他便可按需實(shí)現(xiàn)其中的某個(gè)方法，如下所示：

@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());
    }

}

既然是一個(gè) HTTP 服務(wù)框架，那性能自然也得保證。

在測(cè)試條件為：300 并發(fā)連續(xù)壓測(cè)兩輪；1G 內(nèi)存、單核 CPU、1Mbps。用 Jmeter 壓測(cè)情況如下：

同樣的服務(wù)器用 Tomcat 來(lái)壓測(cè)看看結(jié)果。

Tomcat 的線程池配置:

我這里請(qǐng)求的是 Tomcat 的一個(gè) doc 目錄，雖說(shuō)結(jié)果看似 cicada 的性能比 Tomcat 還強(qiáng)。

但其實(shí)這個(gè)對(duì)比過(guò)程中的變量并沒(méi)有完全控制好，Tomcat 所返回的是 HTML，而 cicada 僅僅返回了 json，當(dāng)然問(wèn)題也不止這些。

但還是能說(shuō)明 cicada 目前的性能還是不錯(cuò)的。

本文沒(méi)有過(guò)多討論 cicada 實(shí)現(xiàn)原理，感興趣的可以看看源碼，都比較簡(jiǎn)單。

在后續(xù)的更新中會(huì)仔細(xì)探討這塊內(nèi)容。

同時(shí)不出意外 cicada 會(huì)持續(xù)更新，未來(lái)也會(huì)加入更多實(shí)用的功能。

甚至我會(huì)在適當(dāng)?shù)臅r(shí)機(jī)將它應(yīng)用于我的生產(chǎn)項(xiàng)目，也希望更多朋友能參與進(jìn)來(lái)一起把這個(gè)「輪子」做的更好。

項(xiàng)目地址：https://github.com/crossoverJie/cicada

你的點(diǎn)贊與轉(zhuǎn)發(fā)是最大的支持。