【Feign】 基于 Feign 远程调用、 自定义配置、性能优化、实现 Feign 最佳实践
🐌个人主页: 🐌 叶落闲庭
💨我的专栏:💨
SpringCloud
MybatisPlus
JVM
石可破也,而不可夺坚;丹可磨也,而不可夺赤。
Feign
- 一、 基于 Feign 远程调用
- 1.1 RestTemplate方式存在的问题
- 1.2 Feign 的介绍
- 1.3 定义和使用Feign客户端
- 二、 自定义配置
- 2.1 配置Feign日志(配置文件方式)
- 2.2 配置Feign日志(Java代码方式)
- 三、 性能优化
- 3.1 Feign 底层客户端实现
- 3.2 Feign的性能优化(连接池配置)
- 四、 实现 Feign 最佳实践
- 4.1 新建module,命名feign-api,然后引入feign的starter依赖
- 4.2 将order-service中编写的UserClient、User、DefaultFeignConfiguration都复制到feign-api项目中
- 4.3 在order-service中引l入feign-api的依赖
- 4.4 修改order-service中的所有与上述三个组件有关的import部分,改成导入feign-api中的包
一、 基于 Feign 远程调用
1.1 RestTemplate方式存在的问题
之前利用RestTemplate发起远程调用需要拼接字符串的形式传递url地址,通过这个url地址指明服务名称和请求路径以及请求参数信息,然后传递请求方式和返回值类型,由RestTemplate向这个指定地址发起请求,再把这个结果转成对应类型。
String url = "http://userservice/user/" + order.getUserId();
User user = restTemplate.getForObject(url, User.class);
通过RestTemplate发送http请求的方式代码可读性差,编程体验不统一,若是参数非常多就会导致URL参数复杂,难以维护。
1.2 Feign 的介绍
Feign 是一个声明式的http客户端,声明式就相当于MySQL中的事务一样,在Spring中要开启事务,不需要手动打开或关闭,只需要在配置文件中声明事务,Spring就会自动实现事务,同样声明式http客户端也是如此,Feign可以帮助我们优雅的实现http请求的发送。
1.3 定义和使用Feign客户端
- 1.引入依赖
<!--feign客户端依赖-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
- 2.在启动类添加注解@EnableFeignClients开启Feign功能
@SpringBootApplication
@EnableFeignClients(defaultConfiguration = FeignClientConfiguration.class)
public class OrderApplication {
public static void main(String[] args) {
SpringApplication.run(OrderApplication.class, args);
}
}
- 3.编写Feign客户端
@FeignClient("userservice")
public interface UserClient {
@GetMapping("/user/{id}")
User findById(@PathVariable("id") Long id);
}
- 服务名称:userservice
- 请求方式:GET
- 请求路径:/user/{id}
- 请求参数:Long id
- 返回值类型:User
- 4.发送http请求
@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());
//封装user到order
order.setUser(user);
// 4.返回
return order;
}
}
二、 自定义配置
Feign运行自定义配置来覆盖默认配置,可以修改的配置如下:
类型 | 作用 | 说明 |
---|---|---|
feign.Logger.Level | 修改日志级别 | 包含四种不同的级别:NONE、BASIC、HEADERS、FULL |
feign.codec.Decoder | 相应结果的解析器 | http远程调用的结果做解析,例如解析json字符串为java对象 |
feign.codec.Encoder | 请求参数编码 | 将请求参数编码,便于通过http请求发送 |
feign.Contract | 支持的注解格式 | 默认是SpringMVC的注解 |
feign.Retryer | 失败重试机制 | 请求失败的重试机制,默认是没有,不过会使用Ribbont的重试 |
一般配置的只是日志级别
2.1 配置Feign日志(配置文件方式)
打开服务的配置文件,添加Feign的配置
- 全局生效:
feign:
client:
config:
default: # 默认全局配置
loggerLevel: FULL # 打开全部日志
- 局部生效:
feign:
client:
config:
userservice: # 针对 userservice 服务
loggerLevel: FULL # 打开全部日志
2.2 配置Feign日志(Java代码方式)
- 声明bean
public class FeignClientConfiguration {
@Bean
public Logger.Level logLevel() {
return Logger.Level.BASIC;
}
}
- 若是全局配置,则把它放到@EnableFeignClients这个注解中
@EnableFeignClients(defaultConfiguration = FeignClientConfiguration.class)
- 若是局部配置,则把它放到@FeignClient这个注解中
@FeignClient(value = "userservice",configuration = FeignClientConfiguration.class)
三、 性能优化
3.1 Feign 底层客户端实现
- URLConnection:默认实现,不支持连接池
- Apache HttpClient:支持连接池
- OKHttp:支持连接池
优化Feign的性能主要包括: -
- 使用连接池代替潜默认的URLConnection
-
- 日志级别,最好用 basic 或 none
3.2 Feign的性能优化(连接池配置)
- Feign中添加HttpClient的支持,引入依赖:
<!--引入HttpClient依赖-->
<dependency>
<groupId>io.github.openfeign</groupId>
<artifactId>feign-httpclient</artifactId>
</dependency>
- 配置连接池:
feign:
client:
config:
default: # 默认全局配置
loggerLevel: BASIC # 日志级别,BASIC是最基本的请求和响应
httpclient:
enabled: true # 支持HttpClient的开关
max-connections: 200 # 最大连接数
max-connections-per-route: 50 # 单个路径最大连接数
四、 实现 Feign 最佳实践
4.1 新建module,命名feign-api,然后引入feign的starter依赖
- 新建模块:
- 引入feign的starter依赖:
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
<version>2.2.1.RELEASE</version>
</dependency>>
4.2 将order-service中编写的UserClient、User、DefaultFeignConfiguration都复制到feign-api项目中
4.3 在order-service中引l入feign-api的依赖
<!--引入统一feign-api-->
<dependency>
<groupId>cn.itcast.demo</groupId>
<artifactId>feign-api</artifactId>
<version>1.0</version>
</dependency>
4.4 修改order-service中的所有与上述三个组件有关的import部分,改成导入feign-api中的包
import cn.itcast.feign.pojo.User;
import cn.itcast.feign.clients.*;
- 当定义的FeignClient不在SpringBootApplication的扫描包范围时,这些FeignClient无法使用。有两种方式解决:
- 方式一:指定FeignClient)所在包
@EnableFeignClients(basePackages = "cn.feign.clients")
- 方式二:指定FeignClient字节码(推荐)
@EnableFeignClients(clients = UserClient.class)