Feign远程调用

简介

Feign是一个声明式的http客户端，官方地址：https://github.com/OpenFeign/feign

其作用就是帮助我们优雅的实现http请求的发送。Feign集成了Ribbon

1、Feign替代RestTemplate

1.1 RestTemplate方式调用存在的问题

先来看下使用RestTemplate发起远程调用的代码：

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

存在一下几个问题：

• 代码可读性差，编程体验不统一
• 参数复杂URL难以维护

1.2 定义和使用Feign客户端

1.2.1 引入依赖

<!--Feign客户端依赖-->
<dependency>
	<groupId>org.springframework.cloud</groupId>
	<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>

1.2.2 添加@EnableFeignClients注解开启Feign

在orderservice的启动类添加注解开启Feign

1.2.3 编写Feign客户端

package com.lyq.order.clients;
//...
@FeignClient("userservice")
public interface UserClient {

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

1.2.3 用Feign客户端代替RestTemplate

@Service
public class OrderService {
    @Autowired
    private OrderMapper orderMapper;
    @Autowired
    private UserClient userClient;
    public Order queryOrderById(Long orderId) {
        // 1.查询订单
        Order order = orderMapper.findById(orderId);
        // 2.查询用户,利用Feign远程调用
        User user = userClient.findById(order.getUserId());
        // 3.封装user信息
        order.setUser(user);
        // 4.返回
        return order;
    }
}

2、自定义配置

Feign运行自定义配置来覆盖默认配置，可以修改的配置如下：

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

一般我们需要配置的就是日志级别。

2.1 配置Feign日志

2.1.1 配置文件方式

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

2.1.2 java代码方式

2.1.2.1 申明一个bean

public class FeignClientConfiguration {
    @Bean
    public Logger.Level feignLogLevel(){
        return Logger.Level.BASIC; 
    }
}

2.1.2.2 配置

全局配置

如果是全局配置，则把它放到@EnableFeignClients这个注解中:

@EnableFeignClients(defaultConfiguration = FeignClientConfiguration.class) 

局部配置

如果是局部配置，则把它放到@FeignClient这个注解中：

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

3、Feign使用优化

3.1 分析

Feign底层的客户端实现：

• URLConnection：默认实现，不支持连接池

• Apache HttpClient：支持连接池

• OKHttp：支持连接池

因此，优化Feign的性能主要包括：

1、使用连接池代替默认的URLConnection【使用HttpClient或OKHttp代替URLConnection】

2、日志级别，最好使用Basic或者None

3.2 Feign的性能优化-连接池配置

Feign添加HttpClient的支持：

3.2.1 引入依赖

<!--httpClient的依赖 -->
<dependency>
    <groupId>io.github.openfeign</groupId>
    <artifactId>feign-httpclient</artifactId>
</dependency>

3.2.2 配置连接池

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

3.3 总结

Feign的优化：

1. 日志级别尽量用basic

2. 使用HttpClient或OKHttp代替URLConnection

3. 1. 引入feign-httpClient依赖
   2. 配置文件开启httpClient功能，设置连接池参数

4、Feign的最佳实践

4.1 方式一（继承）

给消费者的FeignClient和提供者的controller定义统一的父接口作为标准。

遵循了面向契约编程的思想，企业中使用较多

存在问题：

• 服务紧耦合
• 父接口参数列表中的映射关系不会被继承

4.2 方式二（抽取）

将FeignClient抽取为独立模块，并且把接口有关的POJO、默认的Feign配置都放到这个模块中，提供给所有消费者使用

抽取前：

抽取后：

4.3 总结

Feign的最佳实践：

1. 让controller和FeignClient继承同一接口
2. 将FeignClient、POJO、Feign的默认配置都定义到一个项目中，供所有消费者使用

5、抽取FeignClient

5.1 实现

实现最佳实践方式二的步骤如下：

1. 首先创建一个module，命名为feign-api，然后引入feign的starter依赖

2. 将order-service中编写的UserClient、User、DefaultFeignConfiguration都复制到feign-api项目中

3. 在order-service中引入feign-api的依赖

4. 修改order-service中的所有与上述三个组件有关的import部分，改成导入feign-api中的包

5. 重启测试

5.2 扫描FeignClient问题

不同包的FeignClient的导入，由于定义的FeignClient不在SpringBootApplication的扫描包范围时，这些FeignClient无法使用。有两种方式解决：

5.2.1 指定FeignClient所在包

@EnableFeignClients(basePackages = "com.lyq.feign.clients")

5.2.2 指定FeignClient字节码

@EnableFeignClients(clients = {UserClient.class})

点击这里查看实例代码