早睡蛋

Fegin

8/1/2022 Fegin技术远程调用

# 基于Feign远程调用

在没用Feign之前，我们可以使用Spring Web中的RestTemplate模板，使用方法如下：

@Autowired
    private RestTemplate restTemplate;

public static final String USER_SERVICE_URL = "http://userservice/user/";
    
String url = USER_SERVICE_URL + order.getUserId();
        User user = restTemplate.getForObject(url, User.class);
1
2
3
4
5
6
7

基于RestTemplate，存在以下问题：

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

# Feign介绍

Feign是声明式事务，帮助我们优雅发送http请求

Feign 是一个声明式的 Web Service 客户端。它的出现使开发 Web Service 客户端变得很简单。使用 Feign 只需要创建一个接口加上对应的注解，比如：@FeignClient 注解。 Feign 有可插拔的注解，包括 Feign 注解和 AX-RS 注解。Feign 也支持编码器和解码器，Spring Cloud Open Feign 对 Feign 进行增强支持 Spring Mvc 注解，可以像 Spring Web 一样使用 HttpMessageConverters 等。

Feign 是一种声明式、模板化的 HTTP 客户端。在 Spring Cloud 中使用 Feign，可以做到使用 HTTP 请求访问远程服务，就像调用本地方法一样的，开发者完全感知不到这是在调用远程方法，更感知不到在访问 HTTP 请求。接下来介绍一下 Feign 的特性，具体如下：

  • 可插拔的注解支持，包括 Feign 注解和AX-RS注解。
  • 支持可插拔的 HTTP 编码器和解码器。
  • 支持 Hystrix 和它的 Fallback。
  • 支持 Ribbon 的负载均衡。
  • 支持 HTTP 请求和响应的压缩。Feign 是一个声明式的 WebService 客户端，它的目的就是让 Web Service 调用更加简单。它整合了 Ribbon 和 Hystrix，从而不需要开发者针对 Feign 对其进行整合。Feign 还提供了 HTTP 请求的模板，通过编写简单的接口和注解，就可以定义好 HTTP 请求的参数、格式、地址等信息。Feign 会完全代理 HTTP 的请求，在使用过程中我们只需要依赖注入 Bean，然后调用对应的方法传递参数即可。

# Feign依赖以及使用

依赖：

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
1
2
3
4

启动类加入注解：

/** 开启 Feign 扫描支持 */
@EnableFeignClients
1
2

设计接口，这个接口标上@FeignClient注解，定义了远程调用的所有方法：

@FeignClient("userservice")
public interface UserClient {
		@GetMapping("/user/{id}")
    User findById(@PathVariable("id") Long id);
}
1
2
3
4
5
  • 服务名称：userservice
  • 请求方式：GET
  • 请求路径：/user/{id}
  • 参数：Long id
  • 返回值：User

在对应业务上注入，然后使用：

@Autowired
    private UserClient userClient;
    ........
    {
      User user = userClient.findById(orderId);
    }
1
2
3
4
5
6

测试后发现，其采用的策略为负载均衡，这是因为Feign已经集成了ribbon，实现了负载均衡。

image-20220801160626323

# Feign自定义配置

Feign可以自定义的配置如下：

image-20220801161026828

一般我们只需要配置日志级别

# 修改日志级别

有两种方式：

  • 基于配置文件方式

全局配置：

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

局部配置：

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

效果如下：

image-20220801161926310

  • 基于Java代码方式配置日志

先声明一个@Bean

public class FeignClientConfiguration {    
	@Bean  
	public Logger.Level feignLogLevel(){      
	return Logger.Level.BASIC;  
	}
}
1
2
3
4
5
6
7

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

@EnableFeignClients(defaultConfiguration = FeignClientConfiguration.class)
1

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

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

# Feign性能优化

Feign底层的客户端实现：

  • URLConnection：默认实现，不支持连接池
  • Apache HttpClient：支持连接池（Spring底层实现方案）
  • OKHttp：支持连接池

优化主要包括：

  • 使用连接池代替URLConnection
  • 日志级别，最好用basic与none

引入http依赖

<!--httpClient的依赖 -->
<dependency> 
	<groupId>io.github.openfeign</groupId>   		
	<artifactId>feign-httpclient</artifactId>
</dependency>
1
2
3
4
5

配置连接池：

feign:
	client:   
		config:     
			default: # 这里用default就是全局配置，如果是写服务名称，则是针对某个微服务的配置        
				loggerLevel: Basic #  日志级别
	httpclient:
		enabled: true # 开启feign对HttpClient的支持
		max-connections: 200 # 最大的连接数
		max-connections-per-route: 50 # 每个路径的最大连接数
1
2
3
4
5
6
7
8
9

# Feign的最佳实践分析

方式一（继承）：

image-20220801164136319

以上方法不推荐使用，因为会造成紧耦合。并且对Spring MVC不起作用，因为父类参数列表中的映射不会被继承。

方式二（抽取）：

image-20220801164548024

user-service帮需要调用他的服务提供所需要的接口、实体类以及默认配置，并且将其包装成依赖，其他服务需要调用时，直接引用依赖即可。

方式二的不足：依赖引入是全部引入，这样会有多余的部分。所以根据需求进行方式的选择。

# Feign最佳实践（方式二）

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

  • 首先创建一个module，命名为feign-api，然后引入feign的starter依赖
  • 将order-service中编写的UserClient、User、DefaultFeignConfiguration都复制到feign-api项目中
  • 在order-service中引入feign-api的依赖
  • 修改order-service中的所有与上述三个组件有关的import部分，改成导入feign-api中的包重启测试

注意：在调用时，没有提示错误，但是显示xxxClient没有注入，这是因为在启动类上定义的开关扫描的是当前包，而此时api调用的包已经到了另一个包中了。

解决方案：

  1. 指定FeignClient所在包

    @EnableFeignClients(basePackages = "xx.xx.feign.clients")
    1

  2. 指定FeignClient字节码

@EnableFeignClients(clients = {UserClient.class})
1