From 1984fcfb89d9dd73ec5a2153b2a4497517749fb6 Mon Sep 17 00:00:00 2001 From: guide Date: Wed, 1 Dec 2021 17:17:15 +0800 Subject: [PATCH] =?UTF-8?q?[docs]=E3=80=8CHippo4J=20=E5=88=9D=E5=A7=8B?= =?UTF-8?q?=E5=8C=96=20SQL=20=E8=AF=AD=E5=8F=A5=E3=80=8D=E8=B7=AF=E5=BE=84?= =?UTF-8?q?=E9=94=99=E8=AF=AF&Markdown=E8=AF=AD=E6=B3=95=E8=A7=84=E8=8C=83?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 113 ++++++++++++++++-------------------------------------- 1 file changed, 33 insertions(+), 80 deletions(-) diff --git a/README.md b/README.md index 926f2866..82b0b968 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,26 @@
- +
-

- :fire:   动态线程池（Hippo4J）系统，包含 Server 端及 SpringBoot Client 端需引入的 Starter. + :fire:   动态线程池（Hippo4J）系统，包含 Server 端及 SpringBoot Client 端需引入的 Starter.

- - - - - - - - - - - - + + + + + + + + LICENSE - - - - - - - - - - + + + + +

-
- ## 为什么写这个项目？ [美团线程池文章](https://tech.meituan.com/2020/04/02/java-pooling-pratice-in-meituan.html "美团线程池文章") 介绍中，因为业务对线程池参数没有合理配置，触发过几起生产事故，进而引发了一系列思考。最终决定封装线程池动态参数调整，扩展线程池监控以及消息报警等功能 @@ -45,8 +33,6 @@ ![](https://user-images.githubusercontent.com/77398366/139702684-17595e6e-a743-4a33-a0be-0626967f32f5.png) -
- ## 它解决了什么问题？ 线程池在业务系统应该都有使用到，帮助业务流程提升效率以及管理线程，多数场景应用于大量的异步任务处理 @@ -55,57 +41,43 @@ ![](https://images-machen.oss-cn-beijing.aliyuncs.com/image-20211023160830084.png) -
- 如果线程池的配置涉及到上述问题，那么就有可能需要发布业务系统来解决；如果发布后参数仍不合理，继续发布...... Hippo4J 很好解决了这个问题，它将业务中所有线程池统一管理，遇到上述问题不需要发布系统就可以替换线程池参数 ![](https://images-machen.oss-cn-beijing.aliyuncs.com/image-20211023142726818.png) -
- -## 它有什么特性？ +## 它有什么特性？ 应用系统中线程池并不容易管理。参考美团的设计，Hippo4J 按照租户、项目、线程池的维度划分。再加上系统权限，让不同的开发、管理人员负责自己系统的线程池操作 举个例子，小编在一家公司的公共组件团队，团队中负责消息、短链接网关等项目。公共组件是租户，消息或短链接就是项目 -
- -| 模块 | 模块名称 | 注释 | -| -------------------------------------- | ------------------ | ---------------------------------------- | -| hippo4j-auth | 用户权限 | 用户、角色、权限等功能 | -| hippo4j-common | 公共模块 | - | -| hippo4j-config | 配置中心 | 提供线程池准实时更新功能 | -| hippo4j-console | 控制台 | 对接前端项目 | -| hippo4j-discovery | 注册中心 | 提供线程池项目实例注册、续约、下线等功能 | -| hippo4j-spring-boot-starter | Starter | 客户端依赖组件 | -| hippo4j-example | 示例项目 | - | -| hippo4j-server | 服务端 | Server 集成各组件 | -| hippo4j-tools | 抽象工具类 | GitHub 变更监控、操作日志等组件 | - - -
+| 模块 | 模块名称 | 注释 | +| --------------------------- | ---------- | ---------------------------------------- | +| hippo4j-auth | 用户权限 | 用户、角色、权限等功能 | +| hippo4j-common | 公共模块 | - | +| hippo4j-config | 配置中心 | 提供线程池准实时更新功能 | +| hippo4j-console | 控制台 | 对接前端项目 | +| hippo4j-discovery | 注册中心 | 提供线程池项目实例注册、续约、下线等功能 | +| hippo4j-spring-boot-starter | Starter | 客户端依赖组件 | +| hippo4j-example | 示例项目 | - | +| hippo4j-server | 服务端 | Server 集成各组件 | +| hippo4j-tools | 抽象工具类 | GitHub 变更监控、操作日志等组件 | Hippo4J 除去动态修改线程池，还包含实时查看线程池运行时指标、负载报警、配置日志管理等 - ![](https://images-machen.oss-cn-beijing.aliyuncs.com/image-20211023101844619.png) -
- ## 如何运行 Demo？ -目前动态线程池功能已经完成，可以直接把代码拉到本地运行。导入 [Hippo4J 初始化 SQL 语句](https://github.com/acmenlt/dynamic-threadpool/blob/develop/server/src/main/resources/hippo_manager.sql) +目前动态线程池功能已经完成，可以直接把代码拉到本地运行。导入 [Hippo4J 初始化 SQL 语句](./hippo4j-server/src/main/resources/hippo_manager.sql) 1. 启动 `hippo4j-server` 模块下 ServerApplication 应用类 2. 启动 `hippo4j-example` 模块下 ExampleApplication 应用类 > 🌟   Hippo4J 已集成前端项目，详情参考 [Run Console](http://hippox.cn/zh-cn/docs/run/runConsole.html) -
- 通过接口修改线程池中的配置。HTTP POST 路径：http://localhost:6691/v1/cs/configs ，Body 请求体如下： ```json @@ -126,8 +98,6 @@ Hippo4J 除去动态修改线程池，还包含实时查看线程池运行时指 } ``` -
- 接口调用成功后，观察 dynamic-threadpool-example 控制台日志输出，日志输出包括不限于此信息即为成功 ```tex @@ -135,8 +105,6 @@ Hippo4J 除去动态修改线程池，还包含实时查看线程池运行时指 capacity :: [100=>100], keepAliveTime :: [10000=>10000], rejectedType :: [7=>7] ``` -
- 现阶段已集成钉钉消息推送，后续会持续接入企业微信、邮箱、飞书、短信等通知渠道。可以通过添加钉钉群体验消息推送，群号：31764717 @@ -156,12 +124,8 @@ capacity :: [100=>100], keepAliveTime :: [10000=>10000], rejectedType :: [7=>7]
-
- 项目代码功能还在持续开发，初定发布 1.0.0 RELEASE 完成以下功能。部署了 Server 服务，只需要引入 Starter 组件到业务系统中，即可完成动态修改、监控、报警等特性 -
- ## 查看源码能收获什么？ 目前还没有发布 Release 版本，小伙伴可以阅读框架源码，查看框架中好的设计理念或者编码技巧 @@ -170,39 +134,28 @@ capacity :: [100=>100], keepAliveTime :: [10000=>10000], rejectedType :: [7=>7] ![](https://images-machen.oss-cn-beijing.aliyuncs.com/image-20211023143632685.png) -
- - ## Github Stars 趋势 如果小伙伴查看源码设计有所收获，辛苦点个 🚀 Star ，方便后续查看 -[![Stargazers over time](https://starchart.cc/acmenlt/dynamic-threadpool.svg)](https://starchart.cc/acmenlt/dynamic-threadpool) - -
- +[![Stargazers over time](https://starchart.cc/acmenlt/dynamic-threadpool.svg)](https://starchart.cc/acmenlt/dynamic-threadpool) ## 致谢 Hippo4J 项目基于或参考以下项目: 1. [Nacos](https://github.com/alibaba/nacos)：an easy-to-use dynamic service discovery, configuration and service management platform for building cloud native applications. - 2. [Eureka](https://github.com/Netflix/Eureka)：AWS Service registry for resilient mid-tier load balancing and failover. - -3. [ShardingSphere](https://github.com/apache/shardingsphere)：Build criterion and ecosystem above multi-model databases - -4. [mzt-biz-log](https://github.com/mouzt/mzt-biz-log)：支持Springboot，基于注解的可使用变量、可以自定义函数的通用操作日志组件 - -5. [equator](https://github.com/dadiyang/equator)：一个用于比较两个对象的所有属性是否全部相等，并且可以获取所有不相等的属性的比对器 - -
+3. [ShardingSphere](https://github.com/apache/shardingsphere)：Build criterion and ecosystem above multi-model databases. +4. [mzt-biz-log](https://github.com/mouzt/mzt-biz-log)：支持 Springboot，基于注解的可使用变量、可以自定义函数的通用操作日志组件. +5. [equator](https://github.com/dadiyang/equator)：一个用于比较两个对象的所有属性是否全部相等，并且可以获取所有不相等的属性的比对器. ## 最后 小编是个有代码洁癖的程序员，项目中的代码开发完全遵守阿里巴巴代码规约，也推荐大家使用，培养好的编码习惯 对于这个项目，是否有什么不一样看法，欢迎在 Issue 一起沟通交流；或者添加小编微信进交流群 +