給你介紹下，Hippo4J 動態線程池基礎架構

作者：龍臺 2021-11-07 22:21:18

開發架構

經過 200+ 的 Commit，也是快要能發布 1.0.0 正式版本，今天就寫一篇文章正式介紹下 Hippo4J 的項目架構.

[[433702]]

很多小伙伴知道小編從今年六月份開始，陸陸續續開始提交 Hippo4J 動態線程池項目

經過 200+ 的 Commit，也是快要能發布 1.0.0 正式版本，今天就寫一篇文章正式介紹下 Hippo4J 的項目架構

Hippo4J GitHub[1]：https://github.com/acmenlt/dynamic-threadpool

小伙伴如果訪問 GitHub 速度慢，可以通過改 Host 的方式提高訪問速度，修改 Host 方案[2]

1. 架構設計

簡單來說，Hippo4J 從部署的角度上分為兩種角色：Server 端和 Client 端

Server 端是 Hippo4J 項目打包出的 Java 進程，功能包括用戶權限、線程池監控以及執行持久化的動作

Client 端指的是我們 SpringBoot 應用，通過引入 Hippo4J Starter Jar 包負責與 Server 端進行交互

比如拉取 Server 端線程池數據、動態更新線程池配置以及采集上報線程池運行時數據等

2. 基礎組件

2.1 配置中心(Config)

配置中心位于 Server 端，它的主要作用是監控 Server 端線程池配置變更，實時通知到 Client 實例執行線程池變更流程

代碼設計基于 Nacos 1.x 版本的長輪詢以及異步 Servlet 機制實現

2.2 注冊中心(Discovery)

負責管理 Client 端(單機或集群)注冊到 Server 端的實例，包括不限于實例注冊、續約、過期剔除等操作，代碼基于 Eureka 源碼實現

上面的配置中心很容易理解，動態線程池參數變更的根本。但是注冊中心是用來做什么的?

注冊中心管理 Client 端注冊的實例，通過這些實例可以實時獲取線程池的運行時參數信息目前的設計是如此，不排除后續基于 Discovery 做更多的擴展

2.3 控制臺(Console)

對接前端項目，包括不限于以下模塊管理

2.4 抽象工具(Tools)

顧名思義就是將某些工具單獨抽象出來，并以 Module 的形式進行展現，這樣的拆分方式有兩點好處：一是更符合職責分離特性，二是需要用到某塊功能，做到拿來即用

目前已集成兩塊內容：

log-record-tool：基于 mzt-biz-log[3] 的操作日志變更記錄組件

open-change-tool：監控 Hippo4J 項目在 GitHub 的 Star Fork 變更，默認五分鐘內有變更則通知

3. 消息通知(Notify)

Hippo4J 內置了很多需要通知的事件，比如：線程池參數變更通知、線程池活躍度報警、拒絕策略執行報警以及阻塞隊列容量報警等

目前 Notify 已經接入了釘釘，后續持續集成企業微信、郵件、短信等通知渠道;并且，Notify 模塊提供了消息事件的 SPI 方案，可以接受三方自定義的推送

4. Hippo4j-Spring-Boot-Starter

熟悉 SpringBoot 的小伙伴對 Starter 應該不會陌生。Hippo4J 提供以 Starter Jar 包的形式嵌套在應用內，負責與 Server 端完成交互

Starter Jar 包推送到 Maven 公共倉庫，目前公共倉庫已存在 0.0.2 版本的 Jar

5. SpringBoot 快速開始

5.1 Server 端啟動

導入 Hippo4J 初始化 SQL 語句[4]

Hippo4J[5] 代碼拉至本地，啟動 Server[6] 模塊下 ServerApplication 應用類

5.2 SpringBoot 引入 Hippo4j Starter

SpringBoot 應用引入 Hippo4j Starter Jar。備注：0.0.2 版本僅是過渡期版本，正式請等待發布 1.0.0

<dependency> 
    <groupId>io.github.acmenlt</groupId> 
    <artifactId>hippo4j-spring-boot-starter</artifactId> 
    <version>0.0.2</version> 
</dependency>

SpringBoot 應用添加 Hippo4J 相關配置文件：

spring: 
  profiles: 
    active: dev 
  application: 
    name: dynamic-threadpool-example 
  dynamic: 
    thread-pool: 
      notifys: 
        - type: DING 
          url: https://oapi.dingtalk.com/robot/send?access_token= 
          # 此處可以選擇自己的釘釘群 
          token: 4a582a588a161d6e3a1bd1de7eea9ee9f562cdfcbe56b6e72029e7fd512b2eae 
          # 通知時 @ 人員 
          receives: '15601166691' 
      # 報警發送間隔 
      alarm-interval: 30 
      # 服務端地址 
      server-addr: http://localhost:6691 
      # 租戶 id, 對應 tenant 表 
      namespace: prescription 
      # 項目 id, 對應 item 表 
      item-id: ${spring.application.name}

添加線程池配置類，動態線程池支持兩種創建方式

DynamicThreadPoolWrapper 包裝器創建，指定線程池標識
@DynamicThreadPool 注解修飾 Spring Bean

Spring 后置處理器會掃描這兩種方式創建的 Bean，拿到線程池 ID 調用 Server 端獲取配置

如果獲取 Server 端配置失敗，根據默認線程池創建實例

@Configuration 
public class ThreadPoolConfig { 
    public static final String MESSAGE_PRODUCE = "message-produce"; 
    public static final String MESSAGE_CONSUME = "message-consume"; 
 
    @Bean 
    // {@link DynamicThreadPoolWrapper} 完成 Server 端訂閱配置功能. 
    public DynamicThreadPoolWrapper messageCenterDynamicThreadPool() { 
        return new DynamicThreadPoolWrapper(MESSAGE_CONSUME); 
    } 
 
    @Bean 
    @DynamicThreadPool 
    // 通過 {@link DynamicThreadPool} 修飾 {@link DynamicThreadPoolExecutor} 完成 Server 端訂閱配置功能. 
    // 由動態線程池注解修飾后, IOC 容器中保存的是 {@link DynamicThreadPoolExecutor} 
    public ThreadPoolExecutor dynamicThreadPoolExecutor() { 
        return ThreadPoolBuilder.builder().threadFactory(MESSAGE_PRODUCE).dynamicPool().build(); 
    } 
}

啟動 SpringBoot 應用后，動態線程池的準備工作就算完成了

5.3 測試線程池動態變更

通過接口修改線程池中的配置。HTTP POST 路徑：http://localhost:6691/v1/cs/configs ，Body 請求體如下：

{ 
    "ignore": "tenantId、itemId、tpId 代表唯一線程池，請不要修改", 
    "tenantId": "prescription", 
    "itemId": "dynamic-threadpool-example", 
    "tpId": "message-produce", 
    "coreSize": 10, 
    "maxSize": 15, 
    "queueType": 9, 
    "capacity": 100, 
    "keepAliveTime": 10, 
    "rejectedType": 3, 
    "isAlarm": 0, 
    "capacityAlarm": 81, 
    "livenessAlarm": 82 
}

接口調用成功后，觀察 IDEA Client 控制臺日志輸出，日志輸出包括不限于此信息即為成功

[🔥 MESSAGE-PRODUCE] Changed thread pool. coreSize :: [11=>10], maxSize :: [15=>15], queueType :: [9=>9], capacity :: [100=>100], keepAliveTime :: [10000=>10000], rejectedType :: [7=>7]

另外，當 Client 集群部署時，可以選擇修改所有實例或某一實例。修改請求路徑：http://localhost:6691/v1/cs/configs?identify=xxx ，Body 體同上

identify 參數如何獲取?每一臺 Client 端都會分配到獨一無二的值，并在啟動時進行打印