SpringCloud学习（六）——Feign的简单使用

在此之前，我们服务之间需要进行调用的时候使用的restTemplate，代码示例如下：

String url = "http://userservice/user/"+userId;
User user = restTemplate.getForObject(url , User.class);

这种方法需要先定义一个url，再使用restTemplate的api向这个路径去发送请求

这种方式不可避免的有一个巨大的缺陷：在实际开发中，一个url会有很复杂的情况出现，参数可能多达几十个，此时要维护一个url将是一件很恐怖的事情。其次，代码的可读性也比较差。

因此，有一种新的方式去发起远程调用，也就是Feign，feign是一种声明式的http客户端，其作用就是帮助开发者轻松的实现远程调用。

1. Feign 的使用

接下来我们以改写在 orderservice 中引用 userservice 中的信息为例，将其 RestTemplate 的方式改写为 Feign 的调用方式。

1.1 引入依赖

首先我们需要引入Feign的依赖，依赖引入如下：

<dependency>
    <groupId>org.springframework.cloudgroupId>
    <artifactId>spring-cloud-starter-openfeignartifactId>
dependency>

1.2 添加注解

随后需要在启动类的前面添加Feign的注解 @EnableFeignClients ，添加如下第一行所示，

@EnableFeignClients
@MapperScan("cn.itcast.order.mapper")
@SpringBootApplication
public class OrderApplication {

    public static void main(String[] args) {
        SpringApplication.run(OrderApplication.class, args);
    }

}

可以看到，上述启动类中将原来注入的 RestTemplate 删掉了。

1.3 编写Feign客户端

新建一个 client 的文件夹，在文件夹里创建一个接口 UserClient ，接口下的内容如下：

// 声明服务，即在userservice中访问
@FeignClient("userservice")
public interface UserClient {

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

在如上代码中，只需要指定服务就能够对服务的功能进行访问，这代表了Fiegn中实现了负载均衡，可以根据服务名指定不同的服务来进行负载。

1.4 测试

使用定义的接口进行测试，测试的代码如下：

@RestController
@RequestMapping("order")
public class OrderController {

    @Autowired
    private OrderService orderService;

    @Autowired
    private UserClient userClient;

    @GetMapping("{orderId}")
    public Order queryOrderByUserId(@PathVariable("orderId") Long orderId) {
        // 1. 根据id查询订单并返回
        Order order = orderService.queryOrderById(orderId);
        // 2. 利用Feign发起http请求
        User user = userClient.findById(order.getUserId());
        // 3. 封装User到order
        order.setUser(user);
        return order;
    }
}

2. Feign中的自定义配置

Feign可以支持很多的自定义配置，如下表所示：

类型	作用	说明
feign.Logger.Level	修改日志级别	包含四种不同的级别：NONE、BASIC、HEADERS、FULL
feign.codec.Decoder	响应结果的解析器	http远程调用的结果做解析，例如解析json字符串为java对象
feign.codec.Encoder	请求参数编码	将请求参数编码，便于通过http请求发送
feign. Contract	支持的注解格式	默认是SpringMVC的注解
feign. Retryer	失败重试机制	请求失败的重试机制，默认是没有，不过会使用Ribbon的重试

一般情况下，默认值就能满足我们使用，如果要自定义时，只需要创建自定义的@Bean覆盖默认Bean即可。

下面以日志为例来演示如何自定义配置。

2.1.配置文件方式

基于配置文件修改feign的日志级别可以针对单个服务：

feign:  
  client:
    config: 
      userservice: # 针对某个微服务的配置
        loggerLevel: FULL #  日志级别 

也可以针对所有服务：

feign:  
  client:
    config: 
      default: # 这里用default就是全局配置，如果是写服务名称，则是针对某个微服务的配置
        loggerLevel: FULL #  日志级别 

而日志的级别分为四种：

• NONE：不记录任何日志信息，这是默认值。
• BASIC：仅记录请求的方法，URL以及响应状态码和执行时间
• HEADERS：在BASIC的基础上，额外记录了请求和响应的头信息
• FULL：记录所有请求和响应的明细，包括头信息、请求体、元数据。

2.2.Java代码方式

也可以基于Java代码来修改日志级别，先声明一个类，然后声明返回一个Logger.Level的对象来覆盖默认的配置：

public class DefaultFeignConfiguration  {
    @Bean
    public Logger.Level feignLogLevel(){
        return Logger.Level.BASIC; // 日志级别为BASIC
    }
}

如果要全局生效，将其放到启动类的@EnableFeignClients这个注解中：

@EnableFeignClients(defaultConfiguration = DefaultFeignConfiguration .class) 

如果是局部生效，则把它放到对应的@FeignClient这个注解中：

@FeignClient(value = "userservice", configuration = DefaultFeignConfiguration .class) 

3. Feign 性能优化

Feign的优化我们可以从以下两个方面进行考虑：

• 改写客户端实现，Feign默认使用的是 URLConnection ，不支持连接池，可以将其改为支持连接池的 Apache HttpClient 或者 OKHttp
• 改变日志级别。最好使用 basic 或者 none 级别的日志，使效率更大

为了实现上面两个方面的优化，我们需要先引入Feign的HttpClient依赖，

<dependency>
    <groupId>io.github.openfeigngroupId>
    <artifactId>feign-httpclientartifactId>
dependency>

之后在 application.yml 中对其进行配置，配置如下：

feign:
  client:
    config:
      default: # default全局的配置
        loggerLevel: BASIC # 日志级别，BASIC就是基本的请求和响应信息
  httpclient:
    enabled: true # 开启feign对HttpClient的支持
    max-connections: 200 # 最大的连接数
    max-connections-per-route: 50 # 每个路径的最大连接数

4. Feign的抽取式使用

Fiegn的使用方式有很多，但是，在实际生产过程中，最实用的实现方式还是抽取与继承的使用方式，接下来我们介绍一下抽取的方式。

试想一下，如果我们有很多的服务，都需要调用userservice中的数据，那岂不是说我们在每个服务中都需要写一个用Feign访问userservice的结构，即创建一个client，再使用client的接口来访问。基于此，我们可以使用抽取的方式，将使用的东西抽取成一个模块，当要使用的时候，直接将其当做一个依赖进行使用即可，这样，能够大大的方便我们的访问。

4.1 抽取配置

新建一个空的Maven Module feign-api ，将需要用到的配置全部都从 orderservice 中抽取到 feign-api ，抽取后的目录结构为 ：

至此，除了启动类中的一行注解 ，orderservice 中再没有与Feign相关的配置。

4.2 引入依赖

在 feign-api 的Module中引入 feign 相关的依赖，如下：

<dependencies>
    <dependency>
        <groupId>org.springframework.cloudgroupId>
        <artifactId>spring-cloud-starter-openfeignartifactId>
    dependency>
dependencies>

在 orderservice 中引入 feign-api 的依赖如下，

<dependency>
    <groupId>cn.itcast.demogroupId>
    <artifactId>feign-apiartifactId>
    <version>1.0version>
dependency>

4.3 指明Client

按照上面的方式进行操作后，运行时会报错说找不到 UserClient ，这个错误就是在启动类中添加的注解 @EnableFeignClients 找不到 UserClient ，这种时候有两种方式可以解决。

第一种是添加扫描的包，即

@EnableFeignClients(basePackages= "cn.itcast.feign.clients")

第二种是指定 UserClient 的字节码，

@EnableFeignClients(client = {UserClient.class})

这里推荐使用第二种方式，缺少哪一个 FeignClient 就对其进行注册，之后就可以进行正常运行。