From d79ccc20fad9e9acf420e8740ad44c119a8a2514 Mon Sep 17 00:00:00 2001 From: liuxiaohua Date: Wed, 25 Jun 2025 17:59:43 +0800 Subject: [PATCH] =?UTF-8?q?=E2=9C=A8=20[2025-06-25]=20=E6=9B=B4=E6=96=B0?= =?UTF-8?q?=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../feign/20250527-engine-starter-feign-2.0.0.md | 5 +- .../feign/20250605-engine-starter-feign-2.0.1.md | 5 +- .../feign/20250617-engine-starter-feign-2.0.2.md | 108 ++++++++++ .../starter/20250527-EngineStarter引入指南-2.0.0.md | 5 +- .../starter/20250617-EngineStarter引入指南-2.0.2.md | 59 ++++++ .../web/20250527-engine-starter-web-2.0.0.md | 5 +- .../web/20250605-engine-starter-web-2.0.1.md | 4 +- .../web/20250617-engine-starter-web-2.0.2.md | 9 +- 杂项/test.json | 184 ++++++++++++++++-- 9 files changed, 365 insertions(+), 19 deletions(-) create mode 100644 文档/基础组件/feign/20250617-engine-starter-feign-2.0.2.md create mode 100644 文档/基础组件/starter/20250617-EngineStarter引入指南-2.0.2.md diff --git a/文档/基础组件/feign/20250527-engine-starter-feign-2.0.0.md b/文档/基础组件/feign/20250527-engine-starter-feign-2.0.0.md index 3da9514..ed09707 100644 --- a/文档/基础组件/feign/20250527-engine-starter-feign-2.0.0.md +++ b/文档/基础组件/feign/20250527-engine-starter-feign-2.0.0.md @@ -22,7 +22,10 @@ -# engine-starter-feign 使用教程 +# engine-starter-feign 使用教程(Deprecated) +- 该版本存在BUG,请使用 2.0.2 版本 +- 在存在 RequestInterceptor 的情况下,token 无法向下游透传的BUG + > 基于 Feign 的通用封装 > 具体使用可参考 [engine-sample > engine-sample-starter-web](../engine-sample/engine-sample-starter-web) diff --git a/文档/基础组件/feign/20250605-engine-starter-feign-2.0.1.md b/文档/基础组件/feign/20250605-engine-starter-feign-2.0.1.md index 303693f..dc9e7e9 100644 --- a/文档/基础组件/feign/20250605-engine-starter-feign-2.0.1.md +++ b/文档/基础组件/feign/20250605-engine-starter-feign-2.0.1.md @@ -22,7 +22,10 @@ -# engine-starter-feign 使用教程 +# engine-starter-feign 使用教程(Deprecated) +- 该版本存在BUG,请使用 2.0.2 版本 +- 在存在 RequestInterceptor 的情况下,token 无法向下游透传的BUG + > 基于 Feign 的通用封装 > 具体使用可参考 [engine-sample > engine-sample-starter-web](../engine-sample/engine-sample-starter-web) diff --git a/文档/基础组件/feign/20250617-engine-starter-feign-2.0.2.md b/文档/基础组件/feign/20250617-engine-starter-feign-2.0.2.md new file mode 100644 index 0000000..a6b1eda --- /dev/null +++ b/文档/基础组件/feign/20250617-engine-starter-feign-2.0.2.md @@ -0,0 +1,108 @@ + + + + + + + + + + + + + + + +# engine-starter-feign 使用教程 + + +> 基于 Feign 的通用封装 +> 具体使用可参考 [engine-sample > engine-sample-starter-web](../engine-sample/engine-sample-starter-web) + +## 变更记录 +- 修复存在 RequestInterceptor 的情况下,token 无法向下游透传的BUG + +## 功能特性 + +- [X] 请求头添加内部请求标识 `X-QiFu-From-In: true` +- [X] 请求头透传 +- [X] 请求结果解析映射(解封装 `Result`) +- [X] 添加请求头透传 + +------- + +## 快速使用 + +- **注意:** `qifu-saas-parent >= 2.0.2-SNAPSHOT` +- **注意:** 启动类 `@ComponentScan` 需要变更为如下形式 +- ```java + @ComponentScan(value = "com.yuanmeng.*", + excludeFilters = { + @ComponentScan.Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class), + @ComponentScan.Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) + }) + @SpringBootApplication + public class SampleStarterWebApplication { + + public static void main(String[] args) { + SpringApplication.run(SampleStarterWebApplication.class, args); + } + + } + ``` + +### 添加依赖 + +```xml + + + com.yuanmeng.engine + engine-starter-feign + +``` + +### 添加兼容包(可选) + +- 项目中存在 `web-core` 时需要添加兼容包 + +```xml + + + com.yuanmeng.engine + engine-starter-compatible-feign + +``` + +------ + +## 完整默认配置文件 + +```yaml +yuanmeng: + feign: + #- 开启feign自动配置 + enable: true + #- 开启请求头内部标识 + enable-contract: true + #- 开启旧包兼容 + enable-ignore: true + #- 开启结果解析 + enable-decoder: true + #- 开启请求头传递 + enable-interceptor: true + #- 链接超时时间 + connect-timeout: 10 + connect-time-unit: seconds + #- 读取超时时间 + read-timeout: 60 + read-time-unit: seconds +``` diff --git a/文档/基础组件/starter/20250527-EngineStarter引入指南-2.0.0.md b/文档/基础组件/starter/20250527-EngineStarter引入指南-2.0.0.md index 118e996..0d3df50 100644 --- a/文档/基础组件/starter/20250527-EngineStarter引入指南-2.0.0.md +++ b/文档/基础组件/starter/20250527-EngineStarter引入指南-2.0.0.md @@ -22,7 +22,10 @@ -# 旧项目引入新包教程 +# 旧项目引入新包教程(Deprecated) +- 该版本存在BUG,请使用 2.0.2 版本 +- 在存在 RequestInterceptor 的情况下,token 无法向下游透传的BUG + - **注意:** `qifu-saas-parent >= 2.0.0-SNAPSHOT` diff --git a/文档/基础组件/starter/20250617-EngineStarter引入指南-2.0.2.md b/文档/基础组件/starter/20250617-EngineStarter引入指南-2.0.2.md new file mode 100644 index 0000000..78da9f7 --- /dev/null +++ b/文档/基础组件/starter/20250617-EngineStarter引入指南-2.0.2.md @@ -0,0 +1,59 @@ + + + + + + + + + + + + + + + +# 旧项目引入新包教程 + + +- **注意:** `qifu-saas-parent >= 2.0.2-SNAPSHOT` + +## 快速使用 + +### 添加需要引入的模块 + +```xml + + + com.yuanmeng.engine + engine-starter-web + +``` + +### 添加兼容包(可选) + +#### 兼容包兼容列表 + +| 旧包 | 新包 | 兼容包 | 说明 | +|-----------------------------|-----------------------------|----------------------------------------|----| +| web-core | engine-starter-web | engine-starter-compatible-web | | +| oauth2-core | engine-starter-web | engine-starter-compatible-web | | +| data-mybatis-plus、data-core | engine-starter-mybatis-plus | engine-starter-compatible-mybatis-plus | | + + +### 重复功能禁用 +- 核心包默认集成并开启了一些通用功能 + - 可以通过对应的配置文件关闭核心包中的功能 + - 也可以移除项目中的重复配置代码 + +#### 各个模块的功能特性列表 +[功能特新列表(00-EngineStarter开头)](http://confluence.qifu.com/pages/viewpage.action?pageId=38508258) diff --git a/文档/基础组件/web/20250527-engine-starter-web-2.0.0.md b/文档/基础组件/web/20250527-engine-starter-web-2.0.0.md index d8ca4cc..f220e64 100644 --- a/文档/基础组件/web/20250527-engine-starter-web-2.0.0.md +++ b/文档/基础组件/web/20250527-engine-starter-web-2.0.0.md @@ -22,7 +22,10 @@ -# engine-starter-web 使用教程 +# engine-starter-web 使用教程(Deprecated) +- 该版本存在BUG,请使用 2.0.2 版本 +- 在存在 RequestInterceptor 的情况下,token 无法向下游透传的BUG + > 基于 web 的各种工具封装 > 具体使用可参考 [engine-sample > engine-sample-starter-web](../engine-sample/engine-sample-starter-web) diff --git a/文档/基础组件/web/20250605-engine-starter-web-2.0.1.md b/文档/基础组件/web/20250605-engine-starter-web-2.0.1.md index 177acf9..9a37dc0 100644 --- a/文档/基础组件/web/20250605-engine-starter-web-2.0.1.md +++ b/文档/基础组件/web/20250605-engine-starter-web-2.0.1.md @@ -22,7 +22,9 @@ -# engine-starter-web 使用教程 +# engine-starter-web 使用教程(Deprecated) +- 该版本存在BUG,请使用 2.0.2 版本 +- 在存在 RequestInterceptor 的情况下,token 无法向下游透传的BUG > 基于 web 的各种工具封装 > 具体使用可参考 [engine-sample > engine-sample-starter-web](../engine-sample/engine-sample-starter-web) diff --git a/文档/基础组件/web/20250617-engine-starter-web-2.0.2.md b/文档/基础组件/web/20250617-engine-starter-web-2.0.2.md index 317fd14..8c79dc2 100644 --- a/文档/基础组件/web/20250617-engine-starter-web-2.0.2.md +++ b/文档/基础组件/web/20250617-engine-starter-web-2.0.2.md @@ -4,7 +4,7 @@ - +