【转发】 3步搞定 Springcloud Feign 组件 HTTP 请求

本文转发：https://zhuanlan.zhihu.com/p/79875428

今天要给大家介绍的主角是Feign 。

Feign是一个受到Retrofit，JAXRS-2.0和WebSocket启发的Java到HTTP客户端绑定器。 Feign的第一个目标是降低HTTP API的复杂性。

官网：https://github.com/OpenFeign/feign

1、首先导入maven坐标，我们选择feign-jackson集成jackson解析json。10.X版本需要JDK1.8以上。

<dependency>
    <groupId>io.github.openfeign</groupId>
    <artifactId>feign-jackson</artifactId>
    <version>10.2.3</version>
</dependency>

2、编写接口使用注解来操作Feign如何发送http请求。

public interface LemonAPI {
    @RequestLine("GET /user/formGet?username={username}&password={password}")
    String get(@Param("username") String username, @Param("password") String password); 
}

3、在main方法中调用Feign.bulider()指定请求uri并且调用接口中的方法，最终在控制台打印结果返回值。

public class App {
    public static void main(String[] args) {
        LemonAPI lemonAPI = Feign.builder()
                 .target(LemonAPI.class, "http://localhost:8899");
        String result = lemonAPI.get("abc", "123");
        System.out.println(result);
    }
}

在定义接口时，需要使用Feign接口注解定义Http请求类型、请求头、请求体、请求参数等等。

例子1：

//请求方式POST，请求路径/user/formPost
@RequestLine("POST /user/formPost")
//请求头表单提交方式
@Headers("Content-Type: application/x-www-form-urlencoded;charset=UTF-8")
//参数格式name1=value1&name2=value2，参数值由@Param对应提供
@Body("username={username}&password={password}")
String formPost(@Param("username") String username, @Param("password") String password);

例子2：

//请求方式GET 请求路径/user/formGet?name1=value1&name2=value2，参数值由@Param对应提供
@RequestLine("GET /user/formGet?username={username}&password={password}")
String formGet(@Param("username") String username, @Param("password") String password);

//请求方式GET 请求路径/find，参数值由@QueryMap 提供，自动添加到uri后面
@RequestLine("GET /find")
String find(@QueryMap Map<String, Object> queryMap);

1、target() 指定接口类型和URL地址返回接口Http代理对象，从而通过代理对象调用方法发送HTTP请求。
除了target方法之外，还有一些可选方法。如下：

2、client() Feign 在默认情况下使用的是 JDK 原生的 URLConnection 发送HTTP请求，通过client方法可配置其他HTTP客户端，如HttpClient、OkHttpClient、Http2Client等。

3、options() 指定连接超时时长及响应超时时长，单位毫秒。

4、retryer() 指定重试策略，参数分别是最小时间，最大时间，重连次数。

5、encoder() decoder() 指定编码/解码方式默认是String，可配置Gson、Jackson、Sax等。

6、logger() logLevel() 指定日志和日志等级，可配置SLF4J等。

注意：如果需要使用Jackson、SLF4J、Gson、Sax、OkHttpClient、Http2Client、HttpClient等需要导入对应坐标。

例子：

LemonApi lemonApi = Feign.builder()
        //使用OkHttpClient作为HTTP请求客户端
        .client(new OkHttpClient())
        //1000ms连接超时、5000ms响应超时
        .options(new Options(1000, 5000))
        //基础重连时间500ms，最大重连时间5000ms，尝试重连次数3次（每次重连时间在基础上*1.5但不能大于最大重连时间）
        .retryer(new  Retryer.Default(500,5000,3))
        //使用Jackson编码和解码
        .encoder(new JacksonEncoder())
        .decoder(new JacksonDecoder())
        //使用Feign自带日志并输出到项目路径logs/http.log下
        .logger(new Logger.JavaLogger().appendToFile("logs/http.log"))
        //日志级别FULL，记录请求和响应所有信息。
        .logLevel(Logger.Level.FULL)
        //设置请求URL，对LemonApi接口创建HTTP代理类。
        .target(LemonApi.class, "http://localhost:8899");
//使用代理类发起HTTP请求
String formGet = lemonApi.formGet("abc", "123");