Spring Boot 集成 Forest 框架

Spring Boot 集成 Forest 框架主要是为了方便地在 Spring Boot 应用中使用 Forest 进行 HTTP 请求调用。Forest 是一个高级的、基于 Java 的 HTTP 客户端框架，它简化了发送 HTTP 请求和处理响应的过程。下面是如何在 Spring Boot 项目中集成 Forest 的步骤：

1. 添加 Forest 依赖

首先，需要在 pom.xml 文件中添加 Forest 的依赖。以下是一个示例依赖配置：

<dependency>
            <groupId>com.dtflys.forest</groupId>
            <artifactId>forest-spring-boot-starter</artifactId>
            <version>1.5.32</version>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.73</version>
        </dependency>

2. 配置 Forest

接下来，可以在 application.properties 或 application.yml 文件中配置 Forest。例如，可以配置日志级别、连接池大小等：

forest:
  backend: httpclient          # 后端HTTP框架（默认为 okhttp3）
  max-connections: 1000        # 连接池最大连接数（默认为 500）
  max-route-connections: 500   # 每个路由的最大连接数（默认为 500）
  max-request-queue-size: 100  # [自v1.5.22版本起可用] 最大请求等待队列大小
  max-async-thread-size: 300   # [自v1.5.21版本起可用] 最大异步线程数
  max-async-queue-size: 16     # [自v1.5.22版本起可用] 最大异步线程池队列大小
  timeout: 3000                # [已不推荐使用] 请求超时时间，单位为毫秒（默认为 3000）
  connect-timeout: 3000        # 连接超时时间，单位为毫秒（默认为 timeout）
  read-timeout: 3000           # 数据读取超时时间，单位为毫秒（默认为 timeout）
  max-retry-count: 0           # 请求失败后重试次数（默认为 0 次不重试）
  ssl-protocol: TLS            # 单向验证的HTTPS的默认TLS协议（默认为 TLS）
  log-enabled: true            # 打开或关闭日志（默认为 true）
  log-request: true            # 打开/关闭Forest请求日志（默认为 true）
  log-response-status: true    # 打开/关闭Forest响应状态日志（默认为 true）
  log-response-content: true   # 打开/关闭Forest响应内容日志（默认为 false）
  async-mode: platform         # [自v1.5.27版本起可用] 异步模式（默认为 platform）
  variables:
    baseUrl: https://xxxx.com     # 声明全局变量

3. 创建接口类

使用 Forest，可以通过定义一个接口并使用注解来描述 HTTP 请求。例如，创建一个用于调用某个 REST API 的接口：

@BaseRequest(baseURL = "${baseUrl}",
        interceptor = ForestInterceptor.class)
public interface MyApiClient {

    @Get("/hello")
    String simpleRequest();
}

4. 创建拦截器

@Component
@Slf4j
public class ForestInterceptor implements Interceptor<String> {

   
    /**
     * 该方法在被调用时，并在beforeExecute前被调用
     * @Param request Forest请求对象
     * @Param args 方法被调用时传入的参数数组
     */
    @Override
    public void onInvokeMethod(ForestRequest req, ForestMethod method, Object[] args) {
        log.info("on invoke method:{}",method.getMethodName());
    }

    /**
     * 在请求体数据序列化后，发送请求数据前调用该方法
     * 默认为什么都不做
     * 注: multlipart/data类型的文件上传格式的 Body 数据不会调用该回调函数
     *
     * @param request Forest请求对象
     * @param encoder Forest转换器
     * @param encodedData 序列化后的请求体数据
     */
    @Override
    public byte[] onBodyEncode(ForestRequest request, ForestEncoder encoder, byte[] encodedData) {
        return encodedData;
    }


    /**
     * 该方法在请求发送之前被调用, 若返回false则不会继续发送请求
     * @Param request Forest请求对象
     */
    @Override
    public boolean beforeExecute(ForestRequest req) {
        log.info("invoke beforeExecute");
	// TODO: 设置token 判断规则，不符合就返回false       
        // 继续执行请求返回true
        return true;
    }

    /**
     * 该方法在请求成功响应时被调用
     */
    @Override
    public void onSuccess(String data, ForestRequest req, ForestResponse res) {
        log.info("invoke onSuccess");
    }

    /**
     * 该方法在请求发送失败时被调用
     */
    @Override
    public void onError(ForestRuntimeException ex, ForestRequest req, ForestResponse res) {
        log.info("invoke onError code={} msg={}",res.getStatusCode(),res.getContent());
    }

    /**
     * 该方法在请求发送之后被调用
     */
    @Override
    public void afterExecute(ForestRequest req, ForestResponse res) {
        log.info("invoke afterExecute");
    }
}

5. 使用接口

最后，在你的 Spring Boot 应用中，你可以直接注入这个接口并使用它来发送 HTTP 请求：

import org.springframework.beans.factory.annotation.Autowired;  
import org.springframework.stereotype.Service;  
  
@Service  
public class MyService {  
  
    @Autowired  
    private MyApiClient myApiClient;  
  
    public void performRequests() {  
        String response = myApiClient.simpleRequest();  
        System.out.println(response );    
    }  
}