From b99e21c754a239bed79126cee019035772e39f46 Mon Sep 17 00:00:00 2001 From: "chen.ma" Date: Sun, 9 Oct 2022 22:27:02 +0800 Subject: [PATCH] Update official documentation --- docs/docs/user_docs/other/official-ccounts.md | 23 ++ docs/docs/user_docs/other/operation.md | 23 ++ docs/docs/user_docs/other/update-log.md | 265 ++++++++++++++++++ docs/docusaurus.config.js | 4 +- 4 files changed, 313 insertions(+), 2 deletions(-) create mode 100644 docs/docs/user_docs/other/official-ccounts.md create mode 100644 docs/docs/user_docs/other/operation.md create mode 100644 docs/docs/user_docs/other/update-log.md diff --git a/docs/docs/user_docs/other/official-ccounts.md b/docs/docs/user_docs/other/official-ccounts.md new file mode 100644 index 00000000..61a1a5c6 --- /dev/null +++ b/docs/docs/user_docs/other/official-ccounts.md @@ -0,0 +1,23 @@ +--- +sidebar_position: 5 +--- + +# 推荐公众号 + +## JavaGuide + +专注Java后端学习和大厂面试的公众号！ + +![](https://images-machen.oss-cn-beijing.aliyuncs.com/JavaGuide.png) + +## HelloGitHub + +HelloGitHub，专注于开源社区技术和知识内容分享。 + +![](https://images-machen.oss-cn-beijing.aliyuncs.com/HelloGitHub.png) + +## macrozheng + +专注Java技术分享，解析优质开源项目。涵盖SpringBoot、SpringCloud、Docker、K8S等实用技术，作者Github开源项目mall（50K+Star）。 + +![](https://images-machen.oss-cn-beijing.aliyuncs.com/macrozheng.png) diff --git a/docs/docs/user_docs/other/operation.md b/docs/docs/user_docs/other/operation.md new file mode 100644 index 00000000..ba9ed7f0 --- /dev/null +++ b/docs/docs/user_docs/other/operation.md @@ -0,0 +1,23 @@ +--- +sidebar_position: 6 +--- + +# 公众号合作 + +## 推荐须知 + +hippo4j 作为一款新兴动态线程池框架，开源出来的时间比较晚，目前迫切需要不同的途径进行推广。 + +如果您是公众号运营者或者开源爱好者，欢迎将 hippo4j 推荐给您的粉丝。 + +1. 您无需为 hippo4j 专门撰写文案，只需要直接导入 [推荐文章](https://mp.weixin.qq.com/s/JTTwcBEiK_MnFcPTZl3zGA) 即可。 +2. 在文章底部或内容中留下项目官网或者 GitHub 仓库链接。 +3. 文章需至少 1000+ 的阅读量。 + +作为推荐回报，hippo4j 可以为您： + +1. 在框架官方文档 [推荐公众号](/docs/user_docs/other/official-ccounts) 页面处留下您的公众号二维码。 +2. 在框架官方交流群里@全体成员推广您的公众号一次，附带介绍语。 +3. 您的公众号所有新推文章都可以将链接发送到 hippo4j 交流群中，增加阅读量。 + +如果您还有除公众号以外的其它途径可以与 hippo4j 相互推荐，欢迎 [加群沟通](/docs/user_docs/other/group)。 diff --git a/docs/docs/user_docs/other/update-log.md b/docs/docs/user_docs/other/update-log.md new file mode 100644 index 00000000..b88961bb --- /dev/null +++ b/docs/docs/user_docs/other/update-log.md @@ -0,0 +1,265 @@ +--- +sidebar_position: 4 +--- + +# 更新日志 + +## 1.4.1 (Sep 12, 2022) + +这是一个功能增强版本，修复了若干 BUG。建议按照当前版本升级。具体信息可查看 Release 标签地址：[1.4.1](https://github.com/opengoofy/hippo4j/milestone/11?closed=1) + +**Feature** + +- 支持 H2 数据库 @weihubeats +- 动态线程池配置变更时，支持单个、多个或全部节点变 @pizihao +- 增加线程池活跃度和容量报警可选择关闭 +- @DynamicThreadPool 线程池不存在则创建 @shanjianq +- 支持 ETCD 配置中心动态调整参数 @weihubeats +- 创建动态线程池支持 spring 线程池 @BigXin0109 +- 线程池实例变更增加执行超时时间 +- 线程池相关查询页面增加阻塞队列属性 +- 定义动态线程池时，抽象默认配置 +- 提供 ExecutorContext 封装上下文细节 @road2master +- Docker 制作服务端镜像，帮助开发者快速启动 @BigXin0109 +- RabbitMQ 适配器增加多个 MQ 数据源 @weihubeats + +**Bug** + +- 动态线程池设置关闭时启动报错 @dousp +- ExecutorTtlWrapper 类型的 Executor 不生效 @BigXin0109 +- Undertow 获取 WebServer 类型参数异常 @shining-stars-lk +- 修复线程池核心、最大线程数校验限制 +- ByteConvertUtil#getPrintSize 单位转换错误 @onesimplecoder +- 创建线程池单选框选择错误 +- ReflectUtil#getFieldsDirectly missing fields @BigXin0109 +- 本地代码中设置的 capacity 无效 @BigXin0109 +- 服务端线程池超时时间存在拆箱空指针异常 @oreoft +- 未读取服务端返回执行超时时间属性 +- ResizableCapacityLinkedBlockingQueue#put 当前元素数量大于 capacity 未阻塞 + +**Optimize** + +- 长轮询任务判断逻辑优化 @shining-stars-lk +- 线程池存在实例不允许删除线程池 @shanjianq +- 优化租户、项目列表展示排版 +- 通知报警模块项目和线程池下拉查询排序修改 +- 动态线程池拒绝策略触发，以异步的方式报警 +- 优化框架中线程池工厂产生的线程名称 @road2master + +## 1.4.0 (Aug 16, 2022) + +`hippo4j server` 兼容历史低版本，`hippo4j config` 中部分属性名进行了调整，请参考 [hippo4j config 快速开始](https://hippo4j.cn/docs/user_docs/getting-started/hippo4j-core-start)。 + +注意事项： +1. 如果是对已运行 hippo4j server 升级，执行 `/conf/sql-upgrade` 目录下对应的升级脚本。 +2. 需客户端在 1.4.0 及以上版本才可在 hippo4j server 设置线程执行超时时间属性。 + +**Feature** + +- 添加 Alibaba Dubbo 线程池监控及动态变更 +- hippo4j server 支持任务执行超时时间动态修改 +- 阿里 TTL 框架线程池适配 +- 添加动态线程池自动注册功能 +- 订阅回调线程池参数变更 +- 动态线程池监控增加 SPI 自定义功能 +- hippo4j server 支持多种线程池监控方式，例如 Prometheus +- 通知相关参数添加动态变更功能 + +**Bug** + +- 线程池变更：executeTimeOut 变更极端情况下会出现异常 +- 用户登录时候，如果输入了不存在的用户名，后台报空指针异常 +- 修复了对 spring-boot 服务中 tomcat 线程池的兼容问题 +- 排除 Tomcat Jar 使用 Undertow 启动报错 + +**Optimize** + +- hippo4j-core-spring-boot-starter 模块修改名称为 hippo4j-config-spring-boot-starter +- 拆分容器线程池子页面：Tomcat、Undertow、Jetty +- 服务端访问客户端时对 URL 转码 +- MyBatisPlus 修改全局填充方法优化 +- 控制台线程池列表下拉框默认正序 +- 控制台线程池实例菜单，对于非可修改容量队列外，不允许修改队列容量 +- 动态线程池控制台功能变更 +- 租户和项目列表分页查询按照创建时间倒序展示 +- 线程池监控页面图表 UI 优化 +- 设置 maven-gpg-plugin 插件默认不执行 +- 前端控制台相关搜索条件添加必填提示 +- hippo4j 消息通知 & 报警抽象优化 +- 配置中心未配置线程池启动报错 +- 控制台线程池报警 UI 以及功能优化 +- Web、框架线程池编辑弹框 UI 优化 +- 线程池添加、编辑页面 UI 优化 +- 线程池运行详情页前端 UI 优化 + +**Refactor** + +- 删除自定义日志组件 +- 线程池监控功能重构 +- hippo4j core 配置中心生效判断重构 +- 配置变更通知 & 报警通知重构 +- Web 容器线程池适配迁移 hippo4j-adapter + +## 1.3.1 (July 17, 2022) + +注：这是一个兼容历史版本的小范围升级。 + +**Feature** + +- 控制台新增线程池功能设置为 Admin 权限 +- 添加 Hystrix 线程池监控及动态变更 +- 添加 Netty 上传动态线程池监控数据方式 +- 添加 GitHub Actions CI 流程 +- 添加 Spring Kafka 示例项目 +- Tomcat 版本号 >= 9.0.55 线程池适配 + +**Refactor** + +- 更多线程池拆分子目录页面 + +**Optimize** + +- hippo4j core 添加 banner 打印 +- 优化可变更容量阻塞队列名称 + +**BUG** + +- Apollo 配置修改延迟了一个版本 +- Spring Boot 环境下使用 hippo4j-core 接入，配置中心使用 nacos；启动时提示 ConfigService not found + +查看 1.3.1 版本发布：https://github.com/mabaiwan/hippo4j/milestone/9 + +## 1.3.0 (June 06, 2022) + +1.3.0 发布 **适配三方框架的基础框架**。 + +目前已完成 **Dubbo、RabbitMQ、RocketMQ、RocketMQSpringCloudStream** 的线程池适配，后续还会接入 **Kafka、Hystrix** 等框架或中间件的线程池适配。 + +注：这是一个兼容历史版本的重大升级。 + +**Feature** + +- 添加 RabbitMQ 线程池监控及动态变更 +- 添加 RocketMQ 线程池监控及动态变更 +- 添加 Dubbo 线程池监控及动态变更 +- 添加 SpringCloud Stream RocketMQ 消费线程池监控及动态变更 + +**Refactor** + +- 重构容器线程池查询及修改功能 +- 优化配置中心触发监听后，所执行的数据变更逻辑 + +**Optimize** + +- 前端控制台删除无用组件 +- 服务端页面字段未显示中文 +- 控制台 UI 优化 +- 修改线程池实例后实时刷新列表参数 +- 容器线程池编辑仅限 Admin 权限 +- SpringBoot Starter 变更包路径 + +**BUG** + +- 修复 SpringBoot Nacos 动态刷新不生效 +- 报警配置 alarm=false 不配置通知报警平台和接收人报错 + +## 1.2.1 (May 07, 2022) + +**BugFix** + +- apollo 动态配置不生效 +- 修复 hippo4j-core 后置处理器创建线程池问题 +- 重构 hippo4j-core spring 后置处理器逻辑 +- 优化ThreadPoolNotifyAlarmHandler下的空指针异常 +- 修复线程池核心、最大线程数变更问题 +- startup.cmd 未正常读取 conf 配置文件 + +**Optimize** + +- 配置文件中字段歧义 +- 修改代码中历史网址 +- InstanceInfo 的 groupKey 参数重复设置 +- ConfigFileTypeEnum 枚举字段添加注释 +- 线程资源通过线程池创建，不允许自行显示创建线程 +- Guava 版本升级至 30.0-jre 及以上版本 +- SystemClock 替换 System.currentTimeMillis() +- 添加代码格式化插件 Spotless +- 修改线程池文案 + +## 1.2.0 (Mar 13, 2022) + +**Feature** + +- hippo4j-core线程池资源对接 Prometheus 监控 +- hippo4j-core 支持 Zookeeper +- hippo4j-core 支持 Apollo + +**Optimize** + +- 适配非 Web SpringBoot 项目使用 Hippo4J +- 优化报警通知 +- 修复在 JDK 小版本中的兼容性问题 + +**BugFix** + +- server 端查看容器线程池，参数为 null +- 重构线程池查看及容器线程池查看等交互 +- 修复引入 hippo4j-spring-boot-starter 后，运行单元测试报错 +- 修复可能出现的空指针异常 + +## 1.1.0 (Mar 13, 2022) + +Hippo4J 线程池框架 1.1.0 RELEASE 版本，添加了 Hippo4J-Core（依赖配置中心的动态线程池）. + +**Feature** + +- 删除 DynamicThreadPoolExecutor 内代码实现，仅通过线程池扩展点进行扩展 +- 通过动态代理实现线程池拒绝策略执行次数统计 +- 抽象通知报警消息模块 +- 抽象 hippo4j 核心组件，不依赖 server 端即可完成动态调参、监控、报警等功能 +- 前端删除线程池按钮添加 Admin 权限 +- 添加线程池任务运行超长报警 +- 容器线程池支持 Undertow +- 容器线程池支持 Jetty +- 重构服务端异常体系 + +**Optimize** + +- 前端项目 Token 失效跳转登录页 +- 优化 Server 启动脚本日志输出 +- 优化前端按钮权限控制粒度 +- 优化线程池报警推送文案 +- 前端弹框样式优化 +- 适配低版本 SpringBoot Bind +- 优化消息通知模块 + +**BugFix** + +- Duplicate entry 'xxx' for key 'uk_configinfo_datagrouptenant' + +## 1.0.0 (Feb 01, 2022) + +**Feature** + +- 线程池运行堆栈查看 +- 扩展 Web 容器线程池动态调参、监控 + +**Optimize** + +- 删除高版本 SpringBoot Api +- ListableBeanFactory#findAnnotationOnBean SpringBoot 低版本适配 +- 优化客户端关闭时调用服务端钩子函数 +- 线程池实例参数弹框添加实例 ID 和线程池状态 +- 补充线程池替换 Hippo4J 文档 +- 1.5.x springboot 引入hippo4j-spring-boot-starter配置项，bean初始化失败 +- 优化线程池参数编辑合理性校验 +- BaseInstanceRegistry 读写锁重构 + +**BugFix** + +- 本地项目线程池实例缓存无法精确清理 +- 线程池实例页面多实例不同 Active 展示错误 +- 创建动态线程池逻辑判断修复 +- 创建动态线程池增强参数未设置 +- 控制消息推送报警频率的方法有并发安全的问题 +- tomcat线程池上下文获取失败 diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 50df8518..c83cb4a2 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -60,7 +60,7 @@ const config = { announcementBar: { id: 'announcementBar-1', // Increment on change // content: `⭐️ If you like hippo4j, give it a star on Gitee, thanks.`, - content: `⭐️ 如果您喜欢 hippo4j，请在 Gitee 或 GitHub 上给它一个 star，谢谢！`, + content: `⭐️ 如果您喜欢 hippo4j，请在 Gitee 和 GitHub 上给它一个 star，谢谢！`, // content: `👉 《小马哥的代码实战课》官方知识星球来啦！！！`, }, navbar: { @@ -146,7 +146,7 @@ const config = { items: [ { label: 'Gitee', - href: 'https://gitee.com/mabaiwancn/hippo4j', + href: 'https://gitee.com/itmachen/hippo4j', }, { label: 'GitHub',