Http客户端Feign
RestTemplate存在的问题:
- 代码可读性差,编程体验不统一
- 参数复杂的URL难以维护。
Feign是一个声明式的http客户端,官方地址其作用就是帮助我们优雅的完成Http请求的发送,解决上提出的问题。
Feign的基本使用
-
引入依赖
<!-- Http客户端Feign--> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-openfeign</artifactId> </dependency>
-
在消费者的启动类上添加@EnableFeignClients注解
/** * @EnableFeignClients 开启Feign的开关注解 */ @SpringBootApplication @EnableFeignClients public class OrderApplication { public static void main(String[] args) { SpringApplication.run(OrderApplication.class, args); }
-
创建一个服务请求接口
/** * @InterfaceName UserClient * @Description 请求UserService的接口 * @Author CYT * @LastChangeDate 2023/2/7 21:32 * @Version v2.0.1 * @FeignClient("userservice") 指定要发送Http请求的接收服务名称 */ @FeignClient("userservice") public interface UserClient { @GetMapping("/user/{id}") User findById(@PathVariable("id") Long id); }
-
使用
@Autowired private UserClient userClient; public Order queryOrderById(Long orderId) { // 1.查询订单 Order order = orderMapper.findById(orderId); //2.用Feign远程调用 User user = userClient.findById(order.getUserId()); order.setUser(user); // 3.返回 return order; }
自定义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的重试 |
一般需要配置的就是日志级别
配置Feign日志的两种方式:
方式一:配置文件方式
-
全局生效:
feign: client: config: default: #default是全局配置。如果写服务名称,则是针对某个微服务的配置。 logger-level: FULL #日志级别
-
局部生效:
feign: client: config: userservice: #default是全局配置。如果写服务名称,则是针对某个微服务的配置。 logger-level: FULL #日志级别
方式二:JAVA代码方式
-
先声明一个Bean:
public class FeignConfig { @Bean public Logger.Level loggerlevel(){ return Logger.Level.BASIC; } }
-
而后如果是全局配置,则把他放到启动类的@EnableFeignClients注解上。
@EnableFeignClients(defaultConfiguration = FeignConfig.class)
-
如果是局部配置,则将它放到服务启动类的@FeignClient注解上。
@FeignClient(value = "userservice",configuration = FeignConfig.class)
Feign的性能优化:
-
Feign底层的客户端实现
- URLConnection:默认实现,不支持连接池。
- Apache HttpClient:支持连接池
- OKHttp:支持连接池
-
Feign的性能优化主要包括
- 使用连接池代替默认的URLConnection(减少链接的三次握手和断开的四次分手)
- 日志级别,最好用basic或none。
-
实现:
-
引入HttpClient依赖
<!-- httpClient--> <dependency> <groupId>io.github.openfeign</groupId> <artifactId>feign-httpclient</artifactId> </dependency>
-
在application.yml中添加httpClient的配置
feign: client: config: default: #default是全局配置。如果写服务名称,则是针对某个微服务的配置。 logger-level: none #日志级别 httpclient: enabled: true # 开启Feign对HttpClient的支持 max-connections: 200 # 链接的最大数 max-connections-per-route: 50 #每个路径的最大连接数
-
Feign的最佳实践方案:
-
首先创建一个module,命名为feign-api,然后引入feign的starter依赖。
-
将消费者中编写的UserClient、User、DefaultFeiguration都复制到feign-api项目中
-
在Order-service中引入feign-api的依赖
-
修改Order-service中的所有与上述三个组件有关的import部分,改成导入feign-api中的包
-
当UserClient移动后就不再SpringBootAppilcation的扫描包范围时,UserClient不可用。
-
解决方式一:
-
指定FeignClient所在包(适用于批量处理)
@EnableFeignClients(defaultConfiguration = FeignConfig.class,basePackages = "cn.itcast.feign.clients")
-
-
解决方式二:
-
指定FeignClient字节码(适用于处理单个)
@EnableFeignClients(defaultConfiguration = FeignConfig.class,clients = UserClient.class)
-
-
-
-
重启测试