Feign 远程调用

Feign是一个声明式的 Http 客户端，Github：https://github.com/OpenFeign/feign

简单使用

引入依赖

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>

在启动类添加注解开启 Feign 的功能

@EnableFeignClients
@SpringBootApplication

编写 Feign 客户端

@FeignClient("userService")
public interface UserClient {
    @GetMapping("/user/{id}")
    User findById(@PathVariable("id") Long id);
}

替换 RestTemplate

@Service
public class OrderService {

    @Autowired
    private OrderMapper orderMapper;
    // @Autowired
    // private RestTemplate restTemplate;
    @Autowired
    private UserClient userClient;

    public Order queryOrderById(Long orderId) {
        // 1.查询订单
        Order order = orderMapper.findById(orderId);
        // 2.查询用户
        // String url = "http://localhost:8081/user/" + order.getUserId();
//        String url = "http://userService/user/" + order.getUserId();
//        User user = restTemplate.getForObject(url, User.class);
        // Feign
        User user = userClient.findById(order.getUserId());
        // 3.封装用户信息
        order.setUser(user);
        // 4.返回
        return order;
    }
}

自定义配置

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

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

一般只需要配置日志级别，日志的级别：

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

配置方式有两种，一为配置文件，或者创建 bean

配置文件

配置文件针对单个服务

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

针对所有服务

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

bean

先声明一个类，然后声明一个 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)

Feign 使用优化

Feign 底层客户端实现：

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

• Apache HttpClient ：支持连接池

• OKHttp：支持连接池

使用连接池可以提高 Feign 的性能

下例为替换为 HttpClient

1. 引入依赖

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

1. 配置连接池

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

最佳实践

所谓最近实践，就是使用过程中总结的经验，最好的一种使用方式

Feign 的客户端与服务提供者的 controller 代码非常相似

// Feign 客户端
@FeignClient("userService")
public interface UserClient {
    @GetMapping("/user/{id}")
    User findById(@PathVariable("id") Long id);
}

// Controller
@GetMapping("/user/{id}")
public User queryById(@PathVariable("id") Long id) {
    return userService.queryById(id);
}

对于重复的代码，有两种简化方法

方式一：继承

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

定义一个接口

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

Feign 客户端实现

@FeignClient(value="userService")
public interface UserClient extends UserAPI{}

Controller 类

@RestController
public class UserController implements UserAPI{
    public User findById(@PathVariable("id") Long id){
        // code
    }
}

优点：简单，实现了代码共享

缺点：

• 服务提供方、消费方紧耦合
• 参数列表中的注解映射并不会继承，因此Controller中必须再次声明方法、参数列表、注解

方式二：抽取方式

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

创建一个新项目，引入 Feign 起步依赖

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>

在消费者处引入 feign-api 的依赖

当定义的 FeignClient 不在 SpringBootApplication 的扫描包范围时，这些 FeignClient 无法使用，有两种方式解决

1. 指定 Feign 应该扫描的包

@EnableFeignClients(basePackages = "net.yexca.feign.clients")

1. 指定要加载的 Client 接口

@EnableFeignClients(clients = {UserClient.class})