什么是feign

简单的说就是让你发起Http请求更加便利和简洁。而springcloud中服务调用的OpenFeign模块就是通过feign开发的。

如何使用

feign中包括很多模块，它的核心模块是feign-core。同时它还有很多其他模块，为他提供了例如：编码解码、日志、自定义Http客户端等等一系列功能。

1.基本使用

1.添加maven依赖

<dependency>
    <groupId>io.github.openfeign</groupId>
    <artifactId>feign-core</artifactId>
    <version>11.0</version>
</dependency>

下面介绍如何使用feign发起一个简单的GET请求。

2.创建接口

public interface Service1 {
    /**
     * 通过ID获取书本信息
     * @param id
     * @return
     */
    @RequestLine("GET /book?id={id}")
    String getBook(@Param("id")Integer id);
    /**
     * 添加书本信息
     * @param id 书本ID
     * @param bookName 书本名称
     * @param price 书本价格
     * @return
     */
    @RequestLine("POST /book/json")
    //Body中的"{"和"}"需要转义
    @Body("%7B\"id\": \"{id}\", \"bookName\": \"{bookName}\", \"price\": \"{price}\" %7D")
    @Headers({"Content-Type:application/json"})
    String addBook(@Param("id")Integer id, @Param("bookName")String bookName, @Param("price")BigDecimal price);

3.通过feign创建实例

public class App1 {
    private static Service1 service1;
    @BeforeAll
    public static void init(){
        service1 = Feign.builder()
                .target(Service1.class, "http://127.0.0.1:8080");
    }
    /**
     * 发送get请求
     */
    @Test
    public void test1(){
        String book = service1.getBook(1);
        System.out.println(book);
    }
    /**
     * 发送Post请求
     */
    @Test
    public void test2(){
        String book = service1.addBook(4, "时间就是生命", BigDecimal.TEN);
        System.out.println(book);
    }
}

上面就是feign最简单的使用。它可以让我们摆脱那些繁琐的模板化代码，同时代码也变的更加清晰明了。

2.编码和解码

上面的简单使用中，虽然比直接调用HttpClient客户端简便了一些，但是我们可以方法的返回值是String，而我们POST方法发送JSON数据时很不方便。而feign提供的编码器和解码器模块就是用来处理此类问题的。feign提供了很多常见的编码器和解码器，例如Gson、Jackson、sax、Jaxb等。下面演示如何使用Jackson集成的编码和解码器。

feign-Jackson

1.添加maven依赖

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

2.创建接口

public interface Service2 {
    /**
     * 通过ID获取书本信息
     * @param id
     * @return
     */
    @RequestLine("GET /book?id={id}")
    Book getBook(@Param("id")Integer id);
    /**
     * 添加书本信息
     * @param book
     * @return
     */
    @RequestLine("POST /book/json")
    @Headers({"Content-Type:application/json"})
    Book addBook(Book book);
}

3.使用

public class App2 {
    private static Service2 service2;
    @BeforeAll
    public static void init(){
        service2 = Feign.builder()
                //添加解码器
                .decoder(new JacksonDecoder())
                //添加编码器
                .encoder(new JacksonEncoder())
                .target(Service2.class, "http://127.0.0.1:8080");
    }
    /**
     * 发送get请求
     */
    @Test
    public void test1(){
        Book book = service2.getBook(1);
        System.out.println(book);
    }
    /**
     * 发送Post请求
     */
    @Test
    public void test2(){
        Book bookSave = new Book(5, "海燕", BigDecimal.TEN);
        Book book = service2.addBook(bookSave);
        System.out.println(book);
    }
}

对比之前的使用方式，在增加了编码和解码器之后，使用起来更加简单和简介。

feign-form

上面是使用POST提交JSON的方式，但是实际开发中我们还使用POST提交form表单的形式提交数据，上面这种方式很明显无法满足我们的需求。而feign-form可以使我们的需求。

1.添加maven依赖

<dependency>
    <groupId>io.github.openfeign.form</groupId>
    <artifactId>feign-form</artifactId>
    <version>3.8.0</version>
</dependency>

2.创建接口

public interface Service3 {
    /**
     * 创建书本信息-form形式
     * @param book
     * @return
     */
    @RequestLine("POST /book")
    @Headers({"Content-Type:application/x-www-form-urlencoded"})
    Book createBook(Book book);
    /**
     * 创建书本信息
     * @param book
     * @return
     */
    @RequestLine("POST /book/json")
    @Headers({"Content-Type:application/json"})
    Book createBookJson(Book book);
}

3.使用

public class App3 {
    private static Service3 service3;
    @BeforeAll
    public static void init(){
        service3 = Feign.builder()
                //添加解码器
                .decoder(new JacksonDecoder())
                //添加编码器
                .encoder(new FormEncoder(new JacksonEncoder()))
                .target(Service3.class, "http://127.0.0.1:8080");
    }

    /**
     * POST发送form表单数据
     */
    @Test
    public void test1(){
        Book book = new Book(6, "钢铁是怎样炼成的", BigDecimal.TEN);
        Book b = service3.createBook(book);
        System.out.println(b);
    }
    /**
     * POST发送Json数据
     */
    @Test
    public void test2(){
        Book book = new Book(7, "三国演义", BigDecimal.TEN);
        Book b = service3.createBookJson(book);
        System.out.println(b);
    }
}

3.日志

在开始使用feign时可能会出现很多错误，如果能清楚的知道feign在发送http请求的详细信息时，有利于我们学习和修改错误。而feign也提供了Slf4j日志的集成，我们只需要添加feign-slf4j即可。

<dependency>
    <groupId>io.github.openfeign</groupId>
    <artifactId>feign-slf4j</artifactId>
    <version>11.0</version>
</dependency>

而在使用时，只需要在创建实例时简单添加即可。如下所示：

service3 = Feign.builder()
        //添加解码器
        .decoder(new JacksonDecoder())
        //添加编码器
        .encoder(new FormEncoder(new JacksonEncoder()))
        //添加Slf4j日志
        .logger(new Slf4jLogger())
        //设置日志等级
        .logLevel(Logger.Level.FULL)
        .target(Service3.class, "http://127.0.0.1:8080");

这样你在控制台就能打印出发送http请求的详细信息。如下所示：

15:07:47.640 [main] DEBUG feign.Logger - [Service3#createBook] ---> POST http://127.0.0.1:8080/book HTTP/1.1
15:07:47.645 [main] DEBUG feign.Logger - [Service3#createBook] Content-Length: 95
15:07:47.645 [main] DEBUG feign.Logger - [Service3#createBook] Content-Type: application/x-www-form-urlencoded; charset=UTF-8
15:07:47.645 [main] DEBUG feign.Logger - [Service3#createBook] 
15:07:47.645 [main] DEBUG feign.Logger - [Service3#createBook] price=10&id=6&bookName=%E9%92%A2%E9%93%81%E6%98%AF%E6%80%8E%E6%A0%B7%E7%82%BC%E6%88%90%E7%9A%84
15:07:47.645 [main] DEBUG feign.Logger - [Service3#createBook] ---> END HTTP (95-byte body)
15:07:47.695 [main] DEBUG feign.Logger - [Service3#createBook] <--- HTTP/1.1 200 (24ms)
15:07:47.695 [main] DEBUG feign.Logger - [Service3#createBook] connection: keep-alive
15:07:47.698 [main] DEBUG feign.Logger - [Service3#createBook] content-type: application/json
15:07:47.698 [main] DEBUG feign.Logger - [Service3#createBook] date: Tue, 29 Dec 2020 07:07:47 GMT
15:07:47.698 [main] DEBUG feign.Logger - [Service3#createBook] keep-alive: timeout=60
15:07:47.698 [main] DEBUG feign.Logger - [Service3#createBook] transfer-encoding: chunked
15:07:47.698 [main] DEBUG feign.Logger - [Service3#createBook] 
15:07:47.699 [main] DEBUG feign.Logger - [Service3#createBook] {"id":6,"bookName":"钢铁是怎样炼成的","price":10}
15:07:47.699 [main] DEBUG feign.Logger - [Service3#createBook] <--- END HTTP (57-byte body)

4.请求拦截器

在请求还没发出之前，我们想对请求做统一处理时该怎么办呢？feign提供了请求拦截器，即在请求前我们可以对请求对象做处理。如果我们想使用请求拦截器只需要简单的两步即可完成。

1.实现RequestInterceptor接口

@Slf4j
public class DemoInterceptor implements RequestInterceptor {
    @Override
    public void apply(RequestTemplate template) {
        String url = template.url();
        log.info("自定义拦截器:[请求地址为:{}]",url);
    }
}

这个拦截器就是一个简单的打印请求URL的功能。

2.将自定义的请求拦截器注册到实例

public class App4 {
    private static Service1 service1;
    @BeforeAll
    public static void init(){
        service1 = Feign.builder()
                .requestInterceptor(new DemoInterceptor())
                .target(Service1.class, "http://127.0.0.1:8080");
    }
    /**
     * 发送get请求
     */
    @Test
    public void test1(){
        String book = service1.getBook(1);
        System.out.println(book);
    }
}

5.常见的使用场景

1.自定义@Param扩展

默认情况下@Param将参数转成String是通过调用对象的toString()实现的。例如现在我们的http接口需要我们提交时间参数，并且规定格式为yyyy-MM-dd HH:mm:ss这种格式。这个时候默认的方式就无法实现上面的功能了，我们只能手动的将其转化成字符串的时间才能实现。而实际上，@Param为我们提供了扩展。下面我用代码来展示如何实现上述的需求。

接口定义如下：

public interface Service4 {
    @RequestLine("GET /time/range?start={start}&end={end}")
    Map<String, Object> queryTimeRange(@Param(value = "start", expander = DateToString.class) Date start,
                                       @Param(value = "end", expander = DateToString.class) Date end);
}

Expander扩展类实现

public class DateToString implements Param.Expander {
    @Override
    public String expand(Object value) {
        if (value == null){
            return "";
        }
        if (value instanceof Date){
            Date date = (Date) value;
            SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
            return sdf.format(date);
        }
        throw new RuntimeException("不支持的类型");
    }
}

仅仅需要实现Expander接口，然后在@Param指定expander即可。

2.动态查询参数

当我们查询参数过多时，我们需要在接口的方法中写过多的参数。而且当我们需要动态的修改参数时，需要修改接口非常不方便。feign中提供的@QueryMap可以很好的解决上面所遇到的问题。例如下面的代码中，我们需要通过价格区间来查询书本列表。我们可以通过@QueryMap封装我们的查询参数。

@Data
public class PriceQuery {
    private BigDecimal min;
    private BigDecimal max;
}

定义PriceQuery用来封装查询参数，同时我们也可以用Map来封装。

public interface Service5 {
    @RequestLine("GET /book/list")
    List<Book> queryBooks(@QueryMap Map<String,Object> query);
    @RequestLine("GET /book/list")
    List<Book> queryBooks2(@QueryMap PriceQuery query);
}

使用如下：

public class App6 {
    private static Service5 service5;
    @BeforeAll
    public static void init(){
        service5 = Feign.builder()
                //添加解码器
                .decoder(new JacksonDecoder())
                //添加编码器
                .encoder(new JacksonEncoder())
                //添加Slf4j日志
                .logger(new Slf4jLogger())
                //设置日志等级
                .logLevel(Logger.Level.FULL)
                .target(Service5.class, "http://127.0.0.1:8080");
    }
    @Test
    public void test1(){
        Map<String,Object> query = new HashMap<>();
        query.put("min", BigDecimal.ZERO);
        query.put("max", BigDecimal.TEN);
        List<Book> books = service5.queryBooks(query);
        for (Book book : books) {
            System.out.println(book);
        }
    }
    @Test
    public void test2(){
        PriceQuery query = new PriceQuery();
        query.setMin(BigDecimal.ZERO);
        query.setMax(BigDecimal.TEN);
        List<Book> books = service5.queryBooks2(query);
        for (Book book : books) {
            System.out.println(book);
        }
    }
}

通过上面的示例代码，我们能比较简单的实现需求。

总结

上面只是feign的基本使用，如果我们不使用springcloud同样也能使用它来简化我们的http请求。而且它的httpClient客户端可以替换，默认的为java原生提供的。

文档地址

feign官方github地址：https://github.com/OpenFeign/feign

单独使用feign

单独使用feign

什么是feign

如何使用

1.基本使用

1.添加maven依赖

2.创建接口

3.通过feign创建实例

2.编码和解码

feign-Jackson

1.添加maven依赖

2.创建接口

3.使用

feign-form

1.添加maven依赖

2.创建接口

3.使用

3.日志

4.请求拦截器

1.实现RequestInterceptor接口

2.将自定义的请求拦截器注册到实例

5.常见的使用场景

1.自定义@Param扩展

接口定义如下：

Expander扩展类实现

2.动态查询参数

总结

文档地址