文章目录
- 一、Feign
- 1.1 Feign介绍
- 1.2 Feign的使用步骤
- 1.3 Feign的自定义配置
- 1.3.1 配置方法
- 1.4 Feign的优化
一、Feign
1.1 Feign介绍
Feign是一个Java HTTP客户端,它使开发人员可以轻松地与RESTful API进行交互。Feign使用注释来描述REST API,它还支持负载平衡和服务发现。Feign内置了Ribbon,它是一个负载平衡器,可以将请求发送到多个实例中的一个。
使用Feign,您可以通过声明式的方式定义您的REST API客户端,而无需编写大量的样板代码。这使得开发人员可以更专注于业务逻辑,而不是编写和维护客户端代码,同时解决了使用RestTemplate调用http所存在的问题。
RestTemplate方法调用存在的问题:
- 代码可读性差,编程体验不统一;
- 参数复杂URL难以维护
1.2 Feign的使用步骤
- 添加Feign依赖项:
需要将Feign添加到项目的依赖项中。例如,在Maven项目中将依赖项添加到pom.xml文件中:
<!-- feign客户端依赖 -->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
- 添加注解:
在主启动类头部添加注解@EnableFeignClients:
@MapperScan("cn.caterpillar.order.mapper")
@SpringBootApplication
@EnableFeignClients
public class OrderApplication {
public static void main(String[] args) {
SpringApplication.run(OrderApplication.class, args);
}
}
@EnableFeignClients是一个Spring Cloud的注解,用于启用Feign客户端的功能。当您在Spring Boot应用程序中使用Feign时,需要在一个@Configuration类上添加@EnableFeignClients注解,以启用Feign客户端。@EnableFeignClients的作用如下:
- 扫描Feign客户端接口:@EnableFeignClients注解会扫描指定包下的所有Feign客户端接口,并将其注册为Spring Bean。
- 启用Feign的负载均衡功能:当使用Feign进行HTTP请求时,Feign会与Ribbon集成,以便在多个实例之间进行负载均衡。@EnableFeignClients注解会启用Feign与Ribbon的集成,以便让您的应用程序使用负载均衡功能。
- 启用Feign的错误解码功能:当远程服务发生错误时,Feign会解码错误响应并将其转换为Java异常。@EnableFeignClients注解会启用此功能,以便让您的应用程序能够处理远程服务的错误响应。
- 配置Feign的相关参数:您可以使用@EnableFeignClients注解来配置Feign的相关参数,例如连接超时时间和读取超时时间等。通过在注解中设置参数,您可以自定义Feign客户端的行为,以适应您的应用程序需求。
@EnableFeignClients注解的作用是启用Feign客户端的功能,并使其与Ribbon集成,以便使用负载均衡功能。同时还能配置Feign的相关参数,并使应用程序能够处理远程服务的错误响应。
- 创建Feign客户端接口:
以下是一个简单的Feign客户端接口:
@FeignClient("userservice")
public interface UserClient {
@GetMapping("/user/{id}")
User findById(@PathVariable("id") Long id);
}
- 注入并使用Feign客户端所定义的操作:
@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. 注入数据
order.setUser(user);
// 4.返回
return order;
}
}
1.3 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的重试 |
1.3.1 配置方法
Feign支持配置文件的方式配置,也支持java代码的方式配置
- 基于配置文件的方式
feign:
client:
config:
userservice: # 这里用default就是全局配置,如果是写服务名称,则是针对某个微服务的配置
loggerLevel: FULL # 日志级别
- 基于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)
日志的级别分为四种:
- NONE:不记录任何日志信息,这是默认值。
- BASIC:仅记录请求的方法,URL以及响应状态码和执行时间
- HEADERS:在BASIC的基础上,额外记录了请求和响应的头信息
- FULL:记录所有请求和响应的明细,包括头信息、请求体、元数据。
1.4 Feign的优化
- 日志级别尽量用basic
- 使用HttpClient或OKHttp代替URLConnection
URLConnection不能够直接修改连接数,也不能对连接进行有效的管理和维护。
演示(HttpClient为例):
- 添加依赖
<!--httpClient的依赖 -->
<dependency>
<groupId>io.github.openfeign</groupId>
<artifactId>feign-httpclient</artifactId>
</dependency>
- 设置连接池参数
feign:
httpclient:
enabled: true # 开启feign对HttpClient的支持
max-connections: 200 # 最大的连接数
max-connections-per-route: 50 # 每个路径的最大连接数
使用Apache HttpClient或OkHttp的主要好处是:
- 支持HTTP/2:HTTP/2协议可以提供更高的性能和效率,但URLConnection只支持HTTP/1.1,因此使用HttpClient或OkHttp可以充分利用HTTP/2的优势。
- 更好的连接管理:HttpClient和OkHttp都提供了更好的连接管理,包括连接池和连接复用等功能,可以减少HTTP请求的响应时间和延迟。
- 更好的流式传输支持:HttpClient和OkHttp都提供了更好的流式传输支持,可以在发送大量数据时更有效地利用内存。
- 更好的性能和可扩展性:HttpClient和OkHttp都是高性能和可扩展的HTTP客户端库,可以为您的应用程序提供更好的性能和可扩展性。