forest 发行版 - 木兰确实

```java
@Component
public class MySSEInterceptor implements SSEInterceptor {
    
    @Override
    public void onSuccess(InputStream data, ForestRequest request, ForestResponse response) {
        // 和普通拦截器 onSuccess 相同，data 是 SSE 的消息流，不建议在这里动它
    }

@Override
    public void afterExecute(ForestRequest request, ForestResponse response) {
        // 和普通拦截器 afterExecute 相同
    }

@Override
    public void onSSEOpen(EventSource eventSource) {
        // SSE 开始监听时调用
    }

@Override
    public void onSSEClose(ForestRequest request, ForestResponse response) {
        // SSE 结束监听时调用
    }

// 监听名称为 data 的消息
    @SSEDataMessage
    public void onData(ForestRequest request, @SSEName String name, @SSEValue String value) {
        // 参数列表中的参数个数不做限制，可随意排列组合 ForestRequest、ForestResponse、EventSource 这几个类型参数
        // name: @SSEName 注解修饰的参数可传递 SSE 消息的名称
        // value: @SSEValue 注解修饰的参数可传递 SSE 消息的值
    }

// 监听名称为 event 的消息
    @SSEEventMessage
    public void onEvent(EventSource eventSource, @SSEValue String value) {
        // 参数列表中的参数个数不做限制，可随意排列组合 ForestRequest、ForestResponse、EventSource 这几个类型参数
    }

// 通过 @SSEMessage 注解可以指定要监听何种名称的消息
    @SSEMessage("id")
    public void onData(EventSource eventSource) {
        // 参数列表中的参数个数不做限制，可随意排列组合 ForestRequest、ForestResponse、EventSource 这几个类型参数
    }

}

```

绑定方式和普通拦截器一样

```java
@Get(url = "/sse", interceptor = MySSEInterceptor.class)
ForestSSE testSSE_withInterceptor();
```

#### 新增特性

- feat: SSE 拦截器

#### 修复问题

- fix: @SSEName 注解参数取值错误
- fix: SSE 请求长连接超时
- fix: SSE 请求返回的控制器为单例的问题

#### 代码改动

- update: SSE 适配 spring-boot 和 solon

最后提交信息为： update: SSE 适配 spring-boot 和 solon

v1.6.0

e0f8ec3

2024-12-18 18:43

v1.6.0

Forest v1.6.0 版本发布了！此次版本更新功能较多，新增了包括 SSE、Jsonpath、链式条件函数等新特性。

#### 支持 SSE

此次最大的更新，主要是支持了 SSE，并且支持<b>声名式</b>和<b>编程式</b>两种 SSE 接口

##### 声明式 SSE 接口：

接口定义：

```java
public interface SSEClient {
    // Forest SSE 控制器类作为 SSE 接口返回类型
    @Get("/sse")
    ForestSSE testSSE();
    
    // 自定义 SSE 控制器类作为 SSE 接口返回类型
    @Get("/sse")
    MySSEHandler testSSE2();

}
```

自定义 SSE 控制器类：

```java
public class MySSEHandler extends ForestSSE {

@Override
    protected void onOpen(EventSource eventSource) {
        // SSE 开始监听时执行
    }

@Override
    protected void onClose(ForestRequest request, ForestResponse response) {
        // SSE 结束监听时执行
    }

@SSEDataMessage
    public void onHello(@SSEValue String value) {
        // 监听名称为 data 的消息事件
        // @SSEValue 注解修饰的 value 参数为消息的值
    }

@SSEEventMessage(valueRegex = "\\{.*name.*\\}")
    public void onEvent(@SSEValue Contact contact) {
        // 监听名称为 event 的消息事件
        // 并且消息要满足匹配正则表达式 "\\{.*name.*\\}" 的要求
    }
}

```

接口调用:

```java
// ForestSSE 作为返回值的接口调用
sseClient.testSSE().listen();
// 自定义 SSE 控制器作为返回值的接口调用
sseClient.testSSE().listen();
```

##### 编程式 SSE 接口:

```java
Forest.get("http://localhost:{}/", server.getPort())
        .sse() // 指定请求为 SSE 请求 
        .setOnOpen(eventSource -> {
            // SSE 开始监听时执行
        })
        .setOnClose((req, res) -> {
            // SSE 结束监听时执行
        })
        .addOnData((eventSource, name, value) -> {
            // 监听到名称为 data 的消息事件时执行
        })
        .addOnEventMatchesPrefix("close", (eventSource, name, value) -> {
            // 监听到名称为 event 的消息事件，并且消息的值满足"close"前缀匹配要求时执行
            eventSource.close(); // 手动关闭 SSE 监听
        })
        .listen(); // 开始监听
```

#### 支持链式条件函数

```java
Forest.get("http://localhost:{}", server.getPort())
        .addHeader("A", 0)
        .cond(b > 100, q -> q.addHeader("B", 100))       // [单分支] 如果 b > 100，则添加 Header B:100
        .cond(c > 200, q -> q.addHeader("C", 200))       // [单分支] 如果 c > 200，则添加 Header C:100
        .ifThen(a > 0, q -> q.addHeader("A", a + 1))     // [多分支] 如果 a > 0，则添加 Header A:a+1
        .elseIfThen(a == 0, q -> q.addHeader("A", 0))    // [多分支] 但如果 a = 0，则添加 Header A:0
        .elseIfThen(a == -1, q -> q.addHeader("A", -1))  // [多分支] 但如果 a = -1，则添加 Header A:-1
        .elseIfThen(a == -2, q -> q.addHeader("A", -2))  // [多分支] 但如果 a = -2，则添加 Header A:-2
        .elseThen(q -> q.addHeader("A", 10))             // [多分支] 否则添加 Header A:10
        .execute();
```

#### 支持 JsonPath

声名式 JsonPath 注解

```java
public interface TestJSONPathClient {

@Get("/test/user")
    @JSONPathResult("$.data")
    TestUser getSingleUser();

@Get("/test/user")
    @JSONPathResult("$.data")
    List<TestUser> getListOfUsers();

@Get("/test/user")
    @JSONPathResult("$.data[*].age")
    List<Integer> getListOfUserAges();

@Get("/test/user")
    @JSONPathResult("$.data[?(@.age>{minAge})].age")
    List<Integer> getListOfUserAges(@Var("minAge") int minAge);
}

```

编程式 JsonPath 接口

```java
TestUser user = Forest.get("http://localhost:{}/test/user", server.getPort())
        .executeAsResponse()
        .getByPath("$.data", TestUser.class);
```

#### 安全流处理接口

```java
Forest.get("http://localhost:{}/download/test-img.jpg", server.getPort())
        .executeAsStream((in, req, res) -> {
            // in 为已经打开的 InpuStream 流对象
            // 在这里不需要手动打开和关闭流
        });
```

大JSON数据的流式处理

```java
List<MyUser> list = Forest.get("http://localhost:{}/user.json", server.getPort())
        .executeAsStream((in, req, res) -> {
            // 在回调函数返回的数据会作为请求的最终返回值
            return new Gson()
                .fromJson(new JsonReader(new InputStreamReader(in)), MyUser.class)
        });

```

#### 新增特性

- feat: 支持SSE
- feat: 链式条件接口
- feat: 支持Jsonpath
- feat: 字符串模板可以用 {} 替代 {数字} 作为参数占位符
- feat: 类级别`@BindingVar`注解
- feat: 适配Android环境的Log
- feat: 新增 onResponse 生命周期回调函数
- feat: 支持 Optional 作为接口返回结果类型
- feat: 支持 CompletableFuture 作为接口返回结果类型
- feat: 自定义 LogHandler 支持 Spring Bean 方式注入
- feat: 美化字符串表达式报错信息
- feat: 新增安全响应流处理接口

#### 修复问题

- fix: 百分号无法被 URLEncode 的问题
- fix: @Address 注解的属性无法重写的问题
- fix: 过滤器函数无法调用
- fix: 可能出现的 connection pool shut down 问题
- fix: 在后端为okhttp3情况下，打印content-type为multiparty/form-data，body为其他类型时报错的问题
- fix: 在拦截器的onMethodInitialized方法中调用setReturnType函数无效(#I8PJ9R)
- fix: 修复未恢复parentScope导致的栈溢出(#I9TP9Z)

#### 代码改动

- update: 缓存框架换成Hutool的LRU缓存
- update: forest-solon-plugin 升级 solon 为：3.0.1（兼容 2.5.9+）
- update: 更新依赖最新稳定版本
- refactor: 在发生 Response: [Network Error] 错误时，可以打印 status 信息
- opt: query支持线程安全
- reflector: 重构 ForestAuthenticator 接口
- refactor: 重构响应的流处理逻辑
- add: ResultGetter.openStream 方法
- refactor: 修改表达式异常报错信息格式

#### 贡献者

- @wittplus (witt)
- @Kiroe (Kiro)
- @noear_admin (西东)

最后提交信息为： test: 安全响应流处理接口

v1.5.36

8712765

2024-02-27 10:59

v1.5.36

最后提交信息为： test: jackson兼容问题

v1.5.35

d211512

2023-11-29 11:08

v1.5.35

最后提交信息为： update: new version 1.5.35

v1.5.34

12e280b

2023-11-28 11:49

v1.5.34

最后提交信息为： update: new version 1.5.34

v1.5.33

57377b3

2023-08-29 13:38

v1.5.33

最后提交信息为： test: 1.5.33

v1.5.32

09eea86

2023-06-19 19:06

v1.5.32

最后提交信息为： update: version 1.5.32

v1.5.31

10661bc

2023-04-26 01:36

v1.5.31

最后提交信息为： feat: 所有 Forest 请求默认带上 User-Agent: forest/version 的请求头

v1.5.30

dbff4be

2023-03-08 16:21

v1.5.30

`v1.5.30`版本发布了，这次版本更新有了较大的改动，支持和适配了 SpringBoot3 和 Solon 框架，将XML模块拆分出了主模块，以及新增了延迟参数特性

#### 适配 SpringBoot3

项目中新增了`forest-spring-boot3-starter`模块，集成时需引入如下的依赖

```xml

<dependency>
    <groupId>com.dtflys.forest</groupId>
    <artifactId>forest-spring-boot3-starter</artifactId>
    <version>1.5.30</version>
</dependency>

<dependency>
    <groupId>com.dtflys.forest</groupId>
    <artifactId>forest-jakarta-xml</artifactId>
    <version>1.5.30</version>
</dependency>
```

如果是老版本 SpringBoot，依赖方式基本不变，但XML的模块需额外引入

```

<dependency>
    <groupId>com.dtflys.forest</groupId>
    <artifactId>forest-spring-boot-starter</artifactId>
    <version>1.5.30</version>
</dependency>

<dependency>
    <groupId>com.dtflys.forest</groupId>
    <artifactId>forest-jaxb</artifactId>
    <version>1.5.30</version>
</dependency>
```

具体做法参考示例项目 https://gitee.com/dromara/forest/tree/master/forest-examples

#### 适配 Solon

项目中新增了`forest-solon-plugin`模块，集成时需引入如下的依赖

```xml

<dependency>
    <groupId>com.dtflys.forest</groupId>
    <artifactId>forest-solon-plugin</artifactId>
    <version>1.5.30</version>
</dependency>

<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>fastjson</artifactId>
    <version>1.2.83</version>
</dependency>

<dependency>
    <groupId>com.dtflys.forest</groupId>
    <artifactId>forest-jaxb</artifactId>
    <version>1.5.30</version>
</dependency>
```

具体做法参考示例项目 https://gitee.com/dromara/forest/tree/master/forest-examples

#### 关于XML模块的说明

本次更新将XML序列化和反序列化相关功能移出了`forest-core`主模块，需根据不同的项目情况选择相应的 Forest XML 模块依赖。

如果项目，即普通非 SpringBoot3 项目（Spring、SpringBoot1或2）JDK版本也在17以下的项目，则用`forest-jaxb`依赖

```xml

<dependency>
    <groupId>com.dtflys.forest</groupId>
    <artifactId>forest-jaxb</artifactId>
    <version>1.5.30</version>
</dependency>
```

如果您的项目是 SpringBoot3，或是 JDK 17及以上版本的项目，这选择`forest-jakarta-xml`依赖

```xml

<dependency>
    <groupId>com.dtflys.forest</groupId>
    <artifactId>forest-jakarta-xml</artifactId>
    <version>1.5.30</version>
</dependency>
```

#### 延迟参数 (Lambda参数)

有很多情况，Header、Query、Body的参数值不能马上得出，而是在请求发送前的那一刻（所有请求参数都到位时）才能得出，典型的例子就是加签验证的场景（在Header中添加一个参数token，而token的值是对整个body做加密的结果）

- 请求头的延迟参数

```java
Forest.post("/test")
        .addHeader("Content-Type", "application/json; charset=UTF-8")
        // 这里传入的是一个 Lambda 表达式，它会在请求发送的前一刻才执行
        // 将会通过对整个请求的Body做序列化后再进行Base64运算得出一个值，并给到Authorization请求头
        .addHeader("Authorization", req -> Base64.encode("Token=" + req.body().encodeToString()))
        .addBody("id", "1972664191")
        .addBody("name", "XieYu20011008")
        .execute();
```

- 请求体的延迟参数

```java
Forest.post("/test")
        .addHeader("Content-Type", "application/json; charset=UTF-8")
        .addHeader("_id", "20011008")
        .addBody("id", "1972664191")
        // 这里传入的是一个 Lambda 表达式，它会在请求发送的前一刻才执行
        // 执行过程和原理同上
        .addBody("name", req -> "Foo" + req.headerValue("_id"))
        .addBody("token", req -> Base64.encode(req.body().encode()))
        .execute();
```

这里在延迟参数Lambda表达式中调用的`req.body().encode()`执行的body序列化过程，会`自动排除`调用它的延迟参数本身，所以不必担心会发生死循环的情况

#### 新增特性

- feat: 适配 springboot3
- feat: 适配 solon
- feat: 延迟参数 (Lambda参数)，支持 Query, Header，Body 三种参数的延迟求值
- feat: 可自定义异步请求池拒绝策略
- feat: 请求体序列化接口，ForestRequest.body().encode() 和 ForestRequest.body().encodeToString()

#### 修复问题

- fix: #I63WWN ForestProxy添加header没有效果
- fix: onBodyEncode 生命周期顺序问题
- fix: 不同 ForestConfiguration 对象共用同一个异步线程池的问题
- fix: 无法解析 `localhost:8080` 这类省略 http:// 的 url

#### 其他改动

- reflector: 将xml解析模块拆分成了 forest-jaxb 和 forest-jakarta-xml 两个子模块，需要的情况要分别自行引入
- reflector: request body encoder
- refactor: Forest Body clone
- refactor: 构建 Query String 部分
- add: HTTPRoxy 注解的 headers 属性
- add: forest 示例工程

#### 特别鸣谢

特别感谢 Solon 作者 (@noear_admin) 对 Forest 项目在 Solon 适配上的支持

最后提交信息为： fix: 无法解析 localhost 这类省略 http:// 的 url

v1.5.28

3ed96a2

2022-11-22 11:50

v1.5.28

最后提交信息为： update: new version -> 1.5.28

v1.5.27

8b29dc5

2022-11-10 15:47

v1.5.27

最后提交信息为： comment: 修改注释以符合Javadoc规范

v1.5.26

0816ec6

2022-08-08 10:38

v1.5.26

最后提交信息为： update: new version 1.5.26

v1.5.25

45e7057

2022-07-18 13:30

v1.5.25

最后提交信息为： update: 更新jackson版本到2.13.3

v1.5.24

e15ccc9

2022-06-27 12:20

v1.5.24

最后提交信息为： update: new version 1.5.24

v1.5.23

25cfd0c

2022-06-21 00:54

v1.5.23

Forest v1.5.23 版本发布了！此次版本更新对请求执行的性能进行了彻底的优化！

将 OkHttp3 后端的请求 QPS 提升了 3 倍多！

将 Httpclient 后端的请求 QPS 提升了 1 倍多！

#### 优化内容

1. 引入了 ForestRoute 路由的概念，每个 Host + Port 的不同组合对应不同的路由
2. 将 OkHttpClient 以及 HttpClient 后端 Client 对象归类到不同的路由，并进行缓存
3. 可以从外部注入自定义的后端 Client 对象
4. 接口的后端 Client 对象是否缓存是可选项，可通过`@BackendClient`注解进行配置

#### 新增特性

- feat: 快速接口支持快速下载文件
- feat: 可配置注入OkHttpClient和HttpClient对象 (#I5CWAL)
- feat: 可配置接口的后端Client对象是否缓存 (#I5D818)

#### BUG修复

- fix: springboot配置binary转换器初始化失败 (#I5D07S)
- fix: ForestResponse.statusIs(xxx)会出现空指针 (#I5CWQL)
- fix: 在@Address注解的basePath中写的端口号会失效 (#I5CR15)
- fix: 使用@HTTPProxy注解对https请求设置http代理后出现java.lang.IllegalArgumentException:Socket may not be null
- fix: 在不设置ContentType和BodyType的情况下无法正常发送请求 (#I5CML4)
- fix: ForestRequest.addBody(List) 循环中只执行一次

#### 代码改动

- refactor: 重构Cookie (#I5C26U)
- refactor: 重构OkHttpClient
- add: 添加拦截器到请求中方法ForestRequest#addInterceptor(Class<? extends Interceptor>)
- add: HttpClientFactory
- add: OkHttpClientFactory

#### 特别鸣谢

- @CHMing 
- @tanglinyan

最后提交信息为： update: 去掉不用的import

v1.5.22

bf3bd5f

2022-06-08 11:38

v1.5.22

`1.5.22`版本发布了！本次更新主要解决了统一连接池问题，并开始支持Kotlin，兼容4.x等较低的spring版本

#### 主要更新内容

##### 统一连接池

以前版本的 `max-connections` 和 `max-route-connections` 配置属性是针对 OkHttp3 和 HttpClient 后端框架连接池的设置，这样使得不同后端的请求在不同的连接池中，而后端的连接池相互隔离，无法形成统一的最大连接数的限制

而且 OkHttp3 的请求数限制是放在 Dispatcher 中的，而不是在连接池中，而 Dispatcher 直接绑定在了 OkHttpClient 对象上，所以很难对其进行设置和管理，基本上 `max-connections` 和 `max-route-connections` 属性对 OkHttp3 是无效的，等于是设置了个寂寞。

而本次更新的统一连接池，可以通过`max-connections` 和 `max-route-connections`属性统一管理 OkHttp 和 HttpClient 所有后端的所有请求的最大请求数和最大每路由请求数，同时也包括异步请求在内可以一同进行限制

##### 参数定义返回类型

新增@Return参数注解，来标识某个参数为返回类型

```java
    /**
     * 通过 Class 类型参数来标识返回类型
     * 
     * @param clazz 返回类型
     * @return clazz 参数所标识的返回类型的实例
     * @param <T> 未知泛型参数，通过传入 clazz 参数来明确泛型的实际类型
     */
    @Get("/")
    <T> T getGenericClass(@Return Class<T> clazz);

/**
     * 通过 Type 类型参数来标识返回类型
     * 
     * @param type 返回类型
     * @return type 参数所标识的返回类型的实例
     * @param <T> 未知泛型参数，通过传入 type 参数来明确泛型的实际类型
     */
    @Get("/")
    <T> T getGenericType(@Return Type type);

/**
     * 通过 TypeReference 类型参数来标识返回类型
     * 
     * @param typeReference 返回类型
     * @return typeReference 参数所标识的返回类型的实例
     * @param <T> 未知泛型参数，通过传入 typeReference 参数来明确泛型的实际类型
     */
    @Get("/")
    <T> T getGenericTypeReference(@Return TypeReference<T> typeReference);

```

#### 新增特性

- feat: 统一连接池 (#I5APJA)
- feat: 可配置异步请求线程池队列大小 (#I5B78X)
- feat: 支持通过参数定义返回类型 (#I5ANZL)

#### 修复问题

- fix: spring 5.1 以下的低版本启动失败
- fix: 请求地址中包含#字符会被转义导致资源找不到 (#I59O7M)
- fix: 配置BaseRequest的baseURL属性后,完整请求路径中的默认端口号会被覆盖,导致请求失败 (#I4YBDV)
- fix: 解决当@body注解在对象上标识以后，char&Character类型的属性无法从客户端传输至服务端问题
- fix: kotlin项目启动异常 (#I50PDZ)
- fix: RetryWhen重试条件接口在最后一次重试后会执行两次 (#I599BT)

#### 其它改动

- update: #I5ANZR 删除单元测试代码中的Log4j2依赖

#### 特别鸣谢

本次更新参与贡献的小伙伴

- @fangzhengjin
- @xiao4852

最后提交信息为： feat: #I5APJA 统一连接池