声明式HTTP客户端 - Spring Cloud OpenFeign

Feign

什么是Feign：

• Feign是Netflix开源的声明式Http客户端
• 关于Feign的基本使用方式在微服务之间的通讯的方式一文中介绍过，这里再也不赘述

Feign的组成：

• Feign.Builder：全部的FeignClient都是由Feign.Builder构建
• Client：feign.Client.Default内部实际用的是HttpURLConnection，而LoadBalanceFeignClient默认状况下传入的就是feign.Client.Default，只是加了个负载均衡的功能。相比于feign.Client.Default，LoadBalanceFeignClient支持传入指定的Client
• Contract：原生的Feign是不支持@GetMapping、@PostMapping...等SpringMVC注解的，Spring Cloud对其扩展后才支持

---

指定Feign的日志级别

Feign默认是不打印任何日志的，但在实际项目中接口调用出现问题须要调试代码或须要查看某个接口调用所执行的耗时，那么第一时间就会想到查看Feign的日志，此时要如何去开启Feign的日志呢？主要有两种方式，经过代码配置或经过配置文件配置。另外，配置生效范围还分为局部配置和全局配置，咱们先来介绍细粒度的局部配置。

须要注意的是，Feign的日志级别与Spring Boot不同，因此不能直接配置Spring Boot的日志级别去开启。Feign的日志级别以下表：

一、局部配置 - 代码配置；经过代码配置有两个主要的步骤，先在代码定义相应的配置类，而后再到配置文件中配置FeignClient接口的日志级别。首先，定义Feign日志级别的配置类。代码以下：

package com.zj.node.contentcenter.configuration;

import feign.Logger;
import org.springframework.context.annotation.Bean;

/**
 * @author 01
 * @date 2019-07-29
 **/
public class UserCenterFeignConfig {

    @Bean
    public Logger.Level level(){
        // 设置Feign的日志级别为FULL
        return Logger.Level.FULL;
    }
}

注：该类不要加上@Configuration注解，不然将会由于父子上下文扫描重叠而成为全局配置

因为不是作的全局配置，因此除此以外还须要在FeignClient接口中指定该配置类：

package com.zj.node.contentcenter.feignclient;

import com.zj.node.contentcenter.configuration.UserCenterFeignConfig;
import com.zj.node.contentcenter.domain.dto.user.UserDTO;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;

@FeignClient(value = "user-center", configuration = UserCenterFeignConfig.class)
public interface UserCenterFeignClient {

    @GetMapping("/users/{id}")
    UserDTO findById(@PathVariable Integer id);
}

而后在配置文件中添加以下配置：

# 设置日志级别
logging:
  level:
    # 这里须要配置为debug，不然feign的日志级别配置不会生效
    com.zj.node.contentcenter.feignclient.UserCenterFeignClient: debug

配置完成后，启动项目执行相应的调用代码，控制台输出的日志以下：

---

二、局部配置 - 配置文件配置；这种配置方式就比较简单，也是比较经常使用的方式，只需在配置文件中添加以下配置便可：

# 定义feign相关配置
feign:
  client:
    config:
      # 微服务名称
      user-center:
        # 设置feign日志级别
        loggerLevel: full

# 设置日志级别
logging:
  level:
    # 这里须要配置为debug，不然feign的日志级别配置不会生效
    com.zj.node.contentcenter.feignclient.UserCenterFeignClient: debug

---

一、全局配置 - 代码配置；一样定义一个配置类：

public class GlobalFeignLoggerConfig {

    @Bean
    public Logger.Level level(){
        // 设置Feign的日志级别为FULL
        return Logger.Level.FULL;
    }
}

而后配置启动类上的@EnableFeignClients注解的defaultConfiguration属性，以下：

@EnableFeignClients(
        basePackages = "com.zj.node.contentcenter.feignclient",
        defaultConfiguration = GlobalFeignLoggerConfig.class
)

接着将配置文件中的日志配置从特定的类修改成包名，以下：

# 设置日志级别
logging:
  level:
    # 这里须要配置为debug，不然feign的日志级别配置不会生效
    com.zj.node.contentcenter.feignclient: debug

---

二、全局配置 - 配置文件配置；

# 定义feign相关配置
feign:
  client:
    config:
      # default表示为全局配置
      default:
        # 设置feign日志级别
        loggerLevel: full

# 设置日志级别
logging:
  level:
    # 这里须要配置为debug，不然feign的日志级别配置不会生效
    com.zj.node.contentcenter.feignclient: debug

---

Feign支持的配置项

因为使用代码方式配置和使用配置文件配置所支持的配置项不一样，因此分为两类。

一、代码方式所支持的配置项：

配置项	做用
Feign.Builder	Feign的入口
Client	Feign底层用什么http客户端去请求
Contract	契约，注解支持
Encoder	编码器，用于将对象转换成Http请求消息体
Decoder	×××，将响应消息体转换成对象
Logger	日志管理器
Logger.Level	指定日志级别
Retryer	指定重试策略
ErrorDecoder	指定异常×××
Request.Options	超时时间
Collection<RequestInterceptor>	请求拦截器
SetterFactory	用于设置Hystrix的配置属性，Feign整合Hystrix才会用

二、配置文件所支持的配置项：

代码配置 vs 配置文件配置：

• 关于优先级：细粒度配置文件配置 > 细粒度代码配置 > 全局配置文件配置 > 全局代码配置

配置最佳实践总结：

• 尽可能使用配置文件配置，配置文件知足不了需求的状况下再考虑使用代码配置
• 在同一个微服务内尽可能保持单一性，例如统一使用配置文件配置，尽可能不要两种方式混用，以避免增长定位问题的复杂度

---

Feign的继承

所谓Feign的继承实际是为了服务之间可以复用代码，例如如今用户中心服务有一个按id查询用户信息的接口以下：

@Slf4j
@RestController
@RequestMapping("/users")
@RequiredArgsConstructor
public class UserController {

    private final UserService userService;

    @GetMapping("/{id}")
    public User findById(@PathVariable Integer id) {
        log.info("get request. id is {}", id);
        return userService.findById(id);
    }
}

若我想在内容中心服务经过Feign调用该接口，就须要新建一个interface，并编写以下代码：

@FeignClient(name = "user-center")
public interface UserCenterFeignClient {

    @GetMapping("/users/{id}")
    UserDTO findById(@PathVariable Integer id);
}

能够看到，方法的定义其实是同样的，因此这时候就能够利用Feign的继承特性复用这种代码。首先须要建立一个单独的项目或maven模块，由于这样才能经过添加maven依赖的方式引入到不一样的项目中。这里暂且称为api模块吧，在api模块中定义一个这样的接口，代码以下：

@RequestMapping("/users")
public interface UserApi {

    @GetMapping("/{id}")
    User findById(@PathVariable Integer id);
}

而后在用户中心服务中添加api模块的依赖，接着实现UserApi接口，改写以前的UserController以下：

@Slf4j
@RestController
@RequiredArgsConstructor
public class UserController implements UserApi {

    private final UserService userService;

    @Override
    public User findById(@PathVariable Integer id) {
        log.info("get request. id is {}", id);
        return userService.findById(id);
    }
}

在内容中心服务中也添加api模块的依赖，改写以前的UserCenterFeignClient代码，让其继承UserApi，代码以下：

@FeignClient(name = "user-center")
public interface UserCenterFeignClient extends UserApi {
}

能够看到，继承了UserApi后，此时不须要再定义与目标接口相同的方法了，复用了上级接口的代码，这就是所谓Feign的继承。

其实关于这种使用方式存在许多争议，咱们来看看官方怎么说：

It is generally not advisable to share an interface between a server and a client. It introduces tight coupling, and also actually doesn’t work with Spring MVC in its current form (method parameter mapping is not inherited).

大体翻译以下：

一般不建议在服务提供者（server）和服务消费者（client）之间共享接口，由于这种方式引入了紧耦合，而且实际上在当前形式下也不适用于Spring MVC（方法参数映射不会被继承）

• 关于方法参数映射不会被继承：在上面的代码示例中能够看到，实现UserApi的UserController方法参数上，依旧须要写MVC相关的注解，由于这些注解是不会被继承的。简单来讲就是这类注解得写在实现类的方法参数上才会生效，而对于团队中对此不甚熟悉的开发人员来讲也会形成必定的”迷惑“

官网文档地址以下：

https://cloud.spring.io/spring-cloud-static/Greenwich.SR2/single/spring-cloud.html#spring-cloud-feign-inheritance

关于继承特性的争议：

• 官方观点：不建议使用
  • 理由上面已说明
• 业界观点：不少公司使用
  • 理由1：代码可复用；面向契约
  • 理由2：在业务需求变动比较频繁的状况，无需修改太多的代码

如何抉择：

根据项目状况权衡利弊便可，若须要这种特性带来的好处又能够承受紧耦合带来的负面影响，那么就选择使用该特性，不然就不要使用

---

Feign发送多参数GET请求的坑

使用过Spring MVC的都知道，当一个GET接口有多个请求参数时可使用对象来接收。例如用户服务中，有这样一个接口以下：

@RestController
@RequestMapping("/users")
public class UserController {

    @GetMapping("/query")
    public User query(User user) {
        return user;
    }
}

使用postman发送以下请求是能够正常接收并响应的：

因此在另外一个服务中使用Feign调用这种类型的接口时，咱们很天然而然的就会写成以下形式：

@FeignClient(name = "user-center")
public interface UserCenterFeignClient {

    @GetMapping("/users/query")
    UserDTO query(UserDTO userDTO);
}

实际上这种使用Feign发送多参数GET请求的方式是会有坑的，由于将多参数包装成对象时，Feign在底层会将其转换为POST请求，并把对象序列化塞到http body中，因此就会因为不支持该请求方法而报405错误。

关于这个坑咱们作个实验来验证一下，在内容中心服务中，定义一个接口以下：

@RestController
@RequestMapping("/shares")
@RequiredArgsConstructor
public class ShareController {

    private final UserCenterFeignClient userCenterFeignClient;

    @GetMapping("/queryUser")
    public UserDTO queryUser(UserDTO userDTO){
        return userCenterFeignClient.query(userDTO);
    }
}

而后经过postman进行请求，能够看到直接报405错误了：

此时用户服务的控制台中，输出了以下日志信息：

Resolved [org.springframework.web.HttpRequestMethodNotSupportedException: Request method 'POST' not supported]

那么咱们要如何去解决这个坑呢？最显而易见的方式就是不将参数包装成对象，而是拆解开来使用@RequestParam一个个写上去。然而这种方式有个很明显的弊端，若是有不少参数的时候，一个个写就比较累，并且代码也很差看。在这种“走投无路”的状况下，就会想着要不就不用GET了，换成POST吧。虽然这种方法也可行，可是却违背了RESTful的规范。

那有没有一个完美的解决方案呢？答案是有的，那就是使用@SpringQueryMap注解，该注解至关于feign.QueryMap，目的是将对象转换为GET参数。那么咱们就来试试看吧，修改UserCenterFeignClient代码以下：

@FeignClient(name = "user-center")
public interface UserCenterFeignClient {

    @GetMapping("/users/query")
    UserDTO query(@SpringQueryMap UserDTO userDTO);
}

注：该注解在spring-cloud-starter-openfeign: 2.1.0及以后的版本才开始支持的，以前的版本只能使用其余方式解决该问题。之因此会有这个坑，也是由于原生Feign的体系让Spring Cloud没法封装得与Spring MVC彻底一致的编程体验

修改完代码后重启项目，再次使用postman请求就没有报错了：

---

Feign脱离Ribbon使用

咱们都知道Feign内部整合了Ribbon，因此才能有负载均衡功能及从服务发现组件获取服务实例的调用地址功能。那么若是须要调用一个没有注册到服务发现组件上的服务或地址，即脱离Ribbon去使用Feign的话，要如何作呢？很是简单，只须要配置一下@FeignClient注解的url属性便可。以下示例：

// name是必须配置的，不然项目都没法启动，url属性一般是配置basic地址
@FeignClient(name = "baidu", url = "https://www.baidu.com")
public interface TestFeignClient {

    @GetMapping
    String index();
}

而后定义一个接口测试一下：

@RestController
@RequiredArgsConstructor
public class TestController {

    private final TestFeignClient feignClient;

    @GetMapping("/baidu")
    public String baiduIndex() {
        return feignClient.index();
    }
}

启动项目，浏览器访问以下：

---

Feign性能优化

RestTemplate VS Feign：

从上图中能够看到，Feign只在性能和灵活性上输给了RestTemplate，至于灵活性官方也说了不管如何优化也不可能像RestTemplate同样，而性能则是能够进一步提升的。

默认状况下Feign的性能在RestTemplate的50%左右，虽然项目的瓶颈通常不会出如今Feign上，但若是能让Feign的性能更好一些，也只是有利无害，因此本小节简单谈谈Feign的性能优化。

默认状况下Feign底层是使用HttpURLConnection发送请求的，众所周知HttpURLConnection是没有使用链接池的，因此能够针对这点进行优化。例如，将底层的http请求客户端为更换为Apache的HttpClient或者OkHttp等使用了链接池的http客户端，据测试使用了链接池后能够提高15%左右的性能。

另外一个优化的点就是设置合理的日志级别，以前已经介绍过日志级别的配置方式了，因此这里仅演示如何为Feign更换其余的http请求客户端及配置链接池。

这里先以HttpClient为例，第一步加依赖：

<dependency>
    <groupId>io.github.openfeign</groupId>
    <artifactId>feign-httpclient</artifactId>
</dependency>

第二步，添加配置：

feign:
  httpclient:
    # 让feign启用httpclient做为发送http请求的客户端
    enabled: true
    # 最大链接数
    max-connections: 200
    # 单个路径的最大链接数
    max-connections-per-route: 50

---

使用okhttp也是同样的，第一步加依赖：

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

第二步，添加配置：

feign:
  okhttp:
    # 让feign启用okhttp做为发送http请求的客户端
    enabled: true
    # 最大链接数
    max-connections: 200
    # 单个路径的最大链接数
    max-connections-per-route: 50