# 使用 Feign 替代 RestTemplate

# 1、引入依赖

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

# 2、在调用端的启动类添加注解开启 Feign 的功能

@EnableCaching
@EnableTransactionManagement
@SpringBootApplication
@EnableApolloConfig
@EnableDiscoveryClient
@EnableFeignClients
public class AnimationApplication {
    
    public static void main(String[] args) {
        SpringApplication.run(AnimationApplication.class, args);
    }
}

# 3、编写 Feign 的客户端

新建一个接口,内容如下:

package com.dreamland.client;
import com.dreamland.entity.Users;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
@FeignClient("userservice")
public interface UserClient {
    @GetMapping("/user/{id}")
    Users findById(@PathVariable("id") Long id);
}

解释:注解后面代表你所要访问的注册到 nacos 的服务

这个客户端主要是基于 SpringMVC 的注解来声明远程调用的信息,比如:

服务名称:userservice
请求方式:GET
请求路径:/user/{id}
请求参数:Long id
返回值类型:User
这样,Feign 就可以帮助我们发送 http 请求,无需自己使用 RestTemplate 来发送了。

# 4、测试

我们随便找个 sevice 调用这个客户端尝试一下。(注意,保证你的服务已经注册到 nacos,且路径所描述的接口存在)

@Autowired
    UserClient userClient;
    public Users getUsers() {
        return userClient.findById(123L);
    }

是不是看起来优雅多了。

# 5、总结

使用 Feign 的步骤:

① 引入依赖

② 添加 @EnableFeignClients 注解

③ 编写 FeignClient 接口

④ 使用 FeignClient 中定义的方法代替 RestTemplate

# 6、扩展

# 1、自定义配置

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、配置文件方式

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

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

也可以针对所有服务:

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

而日志的级别分为四种:

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

# 3、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)

# 4、Feign 使用优化

Feign 底层发起 http 请求,依赖于其它的框架。其底层客户端实现包括:

・URLConnection:默认实现,不支持连接池

・Apache HttpClient :支持连接池

・OKHttp:支持连接池

因此提高 Feign 的性能主要手段就是使用连接池代替默认的 URLConnection。

这里我们用 Apache 的 HttpClient 来演示。

# 1、引入 Apache 的 HttpClient 依赖:

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

# 2、配置连接池

yml 中添加配置:

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

# 3、总结,Feign 的优化:

1. 日志级别尽量用 basic

2. 使用 HttpClient 或 OKHttp 代替 URLConnection

① 引入 feign-httpClient 依赖

② 配置文件开启 httpClient 功能,设置连接池参数

# 5、抽取 feign 为公共 api

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

# 1、抽取

首先创建一个 module,命名为 feign-api:

在 feign-api 中然后引入 feign 的 starter 依赖

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

然后,之前编写的 UserClient、User、DefaultFeignConfiguration 都复制到 feign-api 项目中

# 2、在原模块中使用 feign-api

首先,删除之前的 UserClient、User、DefaultFeignConfiguration 等类或接口。

在之前模块的 pom 文件中中引入 feign-api 的依赖:

<dependency>
    <groupId>你的模块包路径</groupId>
    <artifactId>feign-api</artifactId>
    <version>1.0</version>
</dependency>

# 3、启动项目

不出意外会出现找不到包的错误,那是因为注解的位置和 api 包的位置不在同一个包下,所以需要在注解上指定包的位置。

# 4、解决扫描包问题

方式一:

指定 Feign 应该扫描的包:

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

方式二:

指定需要加载的 Client 接口:

@EnableFeignClients(clients = {UserClient.class})

方式二是直接指定需要加载类,而方式一是直接加载一个包下所有的类。可以根据不同需求选择对应的方式解决。