文章目录
- Feign
- 引入依赖
- 添加注解
- 编写Feign的客户端
- 测试
- 自定义配置
- 配置文件方式
- Java代码方式
- Feign使用优化
- 引入依赖
- 配置连接池
- 总结
Feign
Feign是一个基于Java的声明式Web服务客户端,由Netflix开发。它简化了使用RESTful API进行远程服务调用的过程,并提供了一种更简洁、更优雅的方式来定义和执行HTTP请求。
Feign的主要特点如下:
-
声明式:通过使用Feign,开发人员可以使用简单的接口注解来描述对远程服务的调用。Feign会根据接口的定义自动构建和发送HTTP请求,从而隐藏了底层HTTP通信的复杂性。
-
集成了负载均衡:Feign集成了Ribbon负载均衡器,可以与服务注册中心(如Eureka、Consul等)结合使用,实现对远程服务的负载均衡调用。
-
支持多种HTTP客户端:Feign支持多种HTTP客户端实现,包括Apache HttpClient、OkHttp等。开发人员可以根据需求选择适合的HTTP客户端。
-
整合了Hystrix:Feign可以与Hystrix断路器进行整合,为远程服务调用添加容错和熔断的功能。当远程服务不可用或响应时间过长时,Feign可以通过降级或快速失败等策略来保护调用端的稳定性。
-
支持自定义拦截器和编码器:Feign提供了扩展机制,允许开发人员自定义拦截器和编码器,以实现对请求和响应的定制处理。
使用Feign可以简化远程服务调用的代码编写和维护,使得开发人员可以更专注于业务逻辑的实现。通过使用Feign,可以轻松地定义和执行RESTful API的调用,而无需手动处理HTTP请求和响应,大大提高了开发效率和代码可读性。
引入依赖
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
添加注解
在服务消费者的启动类添加注解开启Feign的功能:
编写Feign的客户端
在服务消费者中新建一个接口,内容如下:
import cn.itcast.order.pojo.User;
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}")
User findById(@PathVariable("id") Long id);
}
这个客户端主要是基于SpringMVC的注解来声明远程调用的信息,比如:
- 服务名称:userservice
- 请求方式:GET
- 请求路径:/user/{id}
- 请求参数:Long id
- 返回值类型:User
这样,Feign就可以帮助我们发送http请求,无需自己使用RestTemplate来发送了。
测试
修改服务消费者中的OrderService类中的queryOrderById方法,使用Feign客户端代替RestTemplate:
自定义配置
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即可。
配置文件方式
基于配置文件修改feign的日志级别可以针对单个服务:
feign:
client:
config:
userservice: # 针对某个微服务的配置
loggerLevel: FULL # 日志级别
也可以针对所有服务:
feign:
client:
config:
default: # 这里用default就是全局配置,如果是写服务名称,则是针对某个微服务的配置
loggerLevel: FULL # 日志级别
而日志的级别分为四种:
- NONE:不记录任何日志信息,这是默认值。
- BASIC:仅记录请求的方法,URL以及响应状态码和执行时间
- HEADERS:在BASIC的基础上,额外记录了请求和响应的头信息
- FULL:记录所有请求和响应的明细,包括头信息、请求体、元数据。
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)
Feign使用优化
Feign底层发起http请求,依赖于其它的框架。其底层客户端实现包括:
- URLConnection:默认实现,不支持连接池
- Apache HttpClient :支持连接池
- OKHttp:支持连接池
因此提高Feign的性能主要手段就是使用连接池代替默认的URLConnection。
这里我们用Apache的HttpClient来演示。
引入依赖
<!--httpClient的依赖 -->
<dependency>
<groupId>io.github.openfeign</groupId>
<artifactId>feign-httpclient</artifactId>
</dependency>
配置连接池
feign:
client:
config:
default: # default全局的配置
loggerLevel: BASIC # 日志级别,BASIC就是基本的请求和响应信息
httpclient:
enabled: true # 开启feign对HttpClient的支持
max-connections: 200 # 最大的连接数
max-connections-per-route: 50 # 每个路径的最大连接数
总结
使用Feign的步骤:
- 引入依赖
- 添加@EnableFeignClients注解
- 编写FeignClient接口
- 使用FeignClient中定义的方法代替RestTemplate
Feign的优化:
- 日志级别尽量用basic
- 使用HttpClient或OKHttp代替URLConnection
- 引入feign-httpClient依赖
- 配置文件开启httpClient功能,设置连接池参数