[2025-06-25] 更新文档
Some checks failed
Publish to Confluence / confluence (push) Failing after 53s

This commit is contained in:
liuxiaohua 2025-06-25 17:59:43 +08:00
parent 624ba298c1
commit d79ccc20fa
9 changed files with 365 additions and 19 deletions

View File

@ -22,7 +22,10 @@
<!-- :toc: --> <!-- :toc: -->
# engine-starter-feign 使用教程 # engine-starter-feign 使用教程Deprecated
- <font color="red">该版本存在BUG请使用 2.0.2 版本</font>
- 在存在 RequestInterceptor 的情况下token 无法向下游透传的BUG
> 基于 Feign 的通用封装 > 基于 Feign 的通用封装
> 具体使用可参考 [engine-sample > engine-sample-starter-web](../engine-sample/engine-sample-starter-web) > 具体使用可参考 [engine-sample > engine-sample-starter-web](../engine-sample/engine-sample-starter-web)

View File

@ -22,7 +22,10 @@
<!-- :toc: --> <!-- :toc: -->
# engine-starter-feign 使用教程 # engine-starter-feign 使用教程Deprecated
- <font color="red">该版本存在BUG请使用 2.0.2 版本</font>
- 在存在 RequestInterceptor 的情况下token 无法向下游透传的BUG
> 基于 Feign 的通用封装 > 基于 Feign 的通用封装
> 具体使用可参考 [engine-sample > engine-sample-starter-web](../engine-sample/engine-sample-starter-web) > 具体使用可参考 [engine-sample > engine-sample-starter-web](../engine-sample/engine-sample-starter-web)

View File

@ -0,0 +1,108 @@
<!-- Space: qifu -->
<!-- Parent: 后端技术&知识&规范 -->
<!-- Parent: 技术方案 -->
<!-- Parent: 基建 -->
<!-- Parent: 00-基础组件 -->
<!-- Parent: 00-EngineStarterFeign使用指南 -->
<!-- Title: 20250605-engine-starter-feign-2.0.2 -->
<!-- Macro: :anchor\((.*)\):
Template: ac:anchor
Anchor: ${1} -->
<!-- Macro: \!\[.*\]\((.+)\)\<\!\-\- width=(.*) \-\-\>
Template: ac:image
Url: ${1}
Width: ${2} -->
<!-- Macro: \<\!\-\- :toc: \-\-\>
Template: ac:toc
Printable: 'false'
MinLevel: 2
MaxLevel: 4 -->
<!-- Include: 杂项/声明文件.md -->
<!-- :toc: -->
# 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
<dependency>
<groupId>com.yuanmeng.engine</groupId>
<artifactId>engine-starter-feign</artifactId>
</dependency>
```
### 添加兼容包(可选)
- 项目中存在 `web-core` 时需要添加兼容包
```xml
<dependency>
<groupId>com.yuanmeng.engine</groupId>
<artifactId>engine-starter-compatible-feign</artifactId>
</dependency>
```
------
## 完整默认配置文件
```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
```

View File

@ -22,7 +22,10 @@
<!-- :toc: --> <!-- :toc: -->
# 旧项目引入新包教程 # 旧项目引入新包教程Deprecated
- <font color="red">该版本存在BUG请使用 2.0.2 版本</font>
- 在存在 RequestInterceptor 的情况下token 无法向下游透传的BUG
- **注意:** `qifu-saas-parent >= 2.0.0-SNAPSHOT` - **注意:** `qifu-saas-parent >= 2.0.0-SNAPSHOT`

View File

@ -0,0 +1,59 @@
<!-- Space: qifu -->
<!-- Parent: 后端技术&知识&规范 -->
<!-- Parent: 技术方案 -->
<!-- Parent: 基建 -->
<!-- Parent: 00-基础组件 -->
<!-- Parent: 00-EngineStarter引入指南 -->
<!-- Title: 20250617-EngineStarter引入指南-2.0.2 -->
<!-- Macro: :anchor\((.*)\):
Template: ac:anchor
Anchor: ${1} -->
<!-- Macro: \!\[.*\]\((.+)\)\<\!\-\- width=(.*) \-\-\>
Template: ac:image
Url: ${1}
Width: ${2} -->
<!-- Macro: \<\!\-\- :toc: \-\-\>
Template: ac:toc
Printable: 'false'
MinLevel: 2
MaxLevel: 4 -->
<!-- Include: 杂项/声明文件.md -->
<!-- :toc: -->
# 旧项目引入新包教程
- **注意:** `qifu-saas-parent >= 2.0.2-SNAPSHOT`
## 快速使用
### 添加需要引入的模块
```xml
<dependency>
<groupId>com.yuanmeng.engine</groupId>
<artifactId>engine-starter-web</artifactId>
</dependency>
```
### 添加兼容包(可选)
#### 兼容包兼容列表
| 旧包 | 新包 | 兼容包 | 说明 |
|-----------------------------|-----------------------------|----------------------------------------|----|
| 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)

View File

@ -22,7 +22,10 @@
<!-- :toc: --> <!-- :toc: -->
# engine-starter-web 使用教程 # engine-starter-web 使用教程Deprecated
- <font color="red">该版本存在BUG请使用 2.0.2 版本</font>
- 在存在 RequestInterceptor 的情况下token 无法向下游透传的BUG
> 基于 web 的各种工具封装 > 基于 web 的各种工具封装
> 具体使用可参考 [engine-sample > engine-sample-starter-web](../engine-sample/engine-sample-starter-web) > 具体使用可参考 [engine-sample > engine-sample-starter-web](../engine-sample/engine-sample-starter-web)

View File

@ -22,7 +22,9 @@
<!-- :toc: --> <!-- :toc: -->
# engine-starter-web 使用教程 # engine-starter-web 使用教程Deprecated
- <font color="red">该版本存在BUG请使用 2.0.2 版本</font>
- 在存在 RequestInterceptor 的情况下token 无法向下游透传的BUG
> 基于 web 的各种工具封装 > 基于 web 的各种工具封装
> 具体使用可参考 [engine-sample > engine-sample-starter-web](../engine-sample/engine-sample-starter-web) > 具体使用可参考 [engine-sample > engine-sample-starter-web](../engine-sample/engine-sample-starter-web)

View File

@ -4,7 +4,7 @@
<!-- Parent: 基建 --> <!-- Parent: 基建 -->
<!-- Parent: 00-基础组件 --> <!-- Parent: 00-基础组件 -->
<!-- Parent: 00-EngineStarterWeb使用指南 --> <!-- Parent: 00-EngineStarterWeb使用指南 -->
<!-- Title: 20250605-engine-starter-web-2.0.1 --> <!-- Title: 20250605-engine-starter-web-2.0.2 -->
<!-- Macro: :anchor\((.*)\): <!-- Macro: :anchor\((.*)\):
Template: ac:anchor Template: ac:anchor
@ -27,6 +27,11 @@
> 基于 web 的各种工具封装 > 基于 web 的各种工具封装
> 具体使用可参考 [engine-sample > engine-sample-starter-web](../engine-sample/engine-sample-starter-web) > 具体使用可参考 [engine-sample > engine-sample-starter-web](../engine-sample/engine-sample-starter-web)
## 变更记录
- 添加无限层级填充
- 修复脚手架扫描包问题
- 修复Nacos配置无法自动刷新问题
## 功能特性 ## 功能特性
- [X] `YmAutofillResponseAdvice`: 全局返回结果填充处理 - [X] `YmAutofillResponseAdvice`: 全局返回结果填充处理
@ -49,7 +54,7 @@
## 快速使用 ## 快速使用
- **注意:** `qifu-saas-parent >= 2.0.1-SNAPSHOT` - **注意:** `qifu-saas-parent >= 2.0.2-SNAPSHOT`
- **注意:** 启动类 `@ComponentScan` 需要变更为如下形式 - **注意:** 启动类 `@ComponentScan` 需要变更为如下形式
- ```java - ```java
@ComponentScan(value = "com.yuanmeng.*", @ComponentScan(value = "com.yuanmeng.*",

File diff suppressed because one or more lines are too long