SpringCloud Open feign 使用okhttp 优化详解

下面我将为你详细讲解“SpringCloud Open feign 使用okhttp 优化详解”的完整攻略。

什么是Spring Cloud Open Feign

Spring Cloud Open Feign 是一个让编写 Java HTTP 客户端变得更加容易的工具。简单来说，Feign 可以帮助我们减少样板式的代码，例如参数验证、请求构建、错误处理等等，让我们能够更容易地去实现 API 调用。

为什么要使用okhttp优化

默认情况下，Feign 使用 HttpURLConnection 来发起 HTTP 请求。虽然这个 API 能够满足大部分常规的请求，但是在性能表现、特性、可靠性等等方面较为匮乏。而 OkHttpClient 则是目前最性能最佳的 HTTP 客户端之一，我们可以通过在 Feign 配置中指定 OkHttp 客户端来获得更好的性能。

如何使用OkHttp优化Feign

在 Spring Cloud Open Feign 中使用 OkHttp，需要以下的步骤：

1. 添加依赖

<dependency>
    <groupId>io.github.openfeign</groupId>
    <artifactId>feign-okhttp</artifactId>
</dependency>
<dependency>
    <groupId>com.squareup.okhttp3</groupId>
    <artifactId>okhttp</artifactId>
</dependency>

2. 配置Feign

在配置 FeignClient 接口时，我们可以通过添加 @Configuration 注解，在配置类中增加配置。

@Configuration
public class FeignClientConfig {

    @Bean
    public OkHttpClient client() {
        return new OkHttpClient.Builder()
                .connectTimeout(10, TimeUnit.SECONDS)
                .readTimeout(10, TimeUnit.SECONDS)
                .writeTimeout(10, TimeUnit.SECONDS)
                .build();
    }

    @Bean
    public Contract feignContract() {
        return new SpringMvcContract();
    }

    @Bean
    public Retryer feignRetryer() {
        return new Retryer.Default();
    }

    @Bean
    public Decoder feignDecoder() {
        return new ResponseEntityDecoder(new SpringDecoder());
    }

    @Bean
    public Encoder feignEncoder() {
        return new SpringEncoder();
    }
}

在配置方法中，首先定义了一个 OkHttp 的 OkHttpClient，设置了连接、读取、写入超时的时间。接着定义了 SpringMVC 规范下的 Contract 实现，以及重试机制和消息解析编码器。

3. 配置FeignClient接口

在需要使用 FeignClient 接口的地方，我们添加 @FeignClient 注解，并将其 clients 属性指定为 okhttp 类型即可完成 Feign 对 OkHttp 的配置。

@FeignClient(value = "xxx",
        url = "http://localhost:8080",
        configuration = {FeignClientConfig.class},
        client = OkHttpClient.class)
public interface HelloFeign {
    @GetMapping("/hello")
    String hello(@RequestParam("name") String name);
}

4. 测试代码

最后增加一个测试代码来尝试调用 FeignClient 接口。

@RunWith(SpringRunner.class)
@SpringBootTest(classes = FeignApplication.class)
public class HelloFeignTest {

    @Autowired
    private HelloFeign helloFeign;

    @Test
    public void testHello() {
        String result = helloFeign.hello("Feign");
        System.out.println(result);
    }
}

示例说明

示例1：自定义OkHttp的配置信息

通过自定义 OkHttp 的配置信息，在配置方法中实现了 OkHttp 的构建。例如我们设置了连接、读取、写入超时三个时间都为 10 秒，以及开启压缩功能。

@Bean
public OkHttpClient client() {
    return new OkHttpClient.Builder()
            .connectTimeout(10, TimeUnit.SECONDS)
            .readTimeout(10, TimeUnit.SECONDS)
            .writeTimeout(10, TimeUnit.SECONDS)
            .addInterceptor(new GzipRequestInterceptor())
            .build();
}

示例2：FeignClient接口的自定义参数

我们在 FeignClient 接口中，自己定义了一个 header 参数 和一个 path 参数。其中 header 参数是通过使用 @RequestHeader 注解来指定的，而 path 参数是通过在方法参数中使用 @PathVariable 注解来指定的。

@FeignClient(value = "users",
        url = "${microservice.users.url}",
        configuration = {FeignClientConfig.class},
        client = OkHttpClient.class)
public interface UsersFeign {

    @RequestMapping(value = "/users/{id}", method = RequestMethod.GET)
    User findUserById(@PathVariable("id") long id, @RequestHeader("token") String token);
}

以上两个示例分别展示了如何自定义OkHttp的配置信息和FeignClient接口的自定义参数。通过以上步骤，我们就可以使用 OkHttpClient 来优化 Feign 了。