目录
1.问题
2.使用
2.1导入依赖
2.2添加注解
2.3编写Feign客户端
2.4修改OrderService
2.3访问
java.lang.AbstractMethodError: Receiver class org.springframework.cloud.netflix.ribbon.RibbonLoadBal
3.自定义Feign的配置
3.1修改日志级别
3.1.1基于配置文件
3.2.2.基于 Java 代码
4.Feign的性能优化
连接池配置
1.引入依赖
2.配置
5.Feign的最佳实践
5.1继承
5.2抽取
实现
1.问题
以前利用 RestTemplate 发起远程调用的代码:
String url = "http://user-server/user/"+order.getUserId();
User user = restTemplate.getForObject(url, User.class);
- 代码可读性差,编程体验不统一
- 参数复杂URL难以维护
Feign 是一个声明式的 http 客户端,其作用就是帮助我们优雅的实现 http 请求的发送,解决上面提到的问题。
官方地址:GitHub - OpenFeign/feign: Feign makes writing java http clients easier
2.使用
参考代码:https://gitee.com/zhanzhaoxiang/cloud-demo-nacos-feign
2.1导入依赖
<!--Feign依赖--> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-openfeign</artifactId> </dependency>
2.2添加注解
在 order-server 启动类添加注解开启 Feign
@MapperScan("cn.itcast.order.mapper")
@SpringBootApplication
@EnableFeignClients
public class OrderApplication {
public static void main(String[] args) {
SpringApplication.run(OrderApplication.class, args);
}
}
2.3编写Feign客户端
@FeignClient("user-server")
public interface UserClient {
@GetMapping("/user/{id}")
User findById(@PathVariable("id") Long id);
}
主要是基于SpringMVC的注解来声明远程调用的信息,比如:
- 服务名称:user-server
- 请求方式:GET
- 请求路径:/user/{id}
- 请求参数:Long id
- 返回值类型:User
2.4修改OrderService
将原来的RestTemplate改为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.封装user到order
order.setUser(user);
// 4.返回
return order;
}
// @Autowired
// private RestTemplate restTemplate;
//
// public Order queryOrderById(Long orderId) {
// // 1.查询订单
// Order order = orderMapper.findById(orderId);
// //2.利用restTemplate发送http请求,查询用户,get请求使用getForObject(),post请求使用postForObject()
// String url = "http://user-server/user/"+order.getUserId();
// User user = restTemplate.getForObject(url, User.class);
// //3.封装user到order
// order.setUser(user);
// // 4.返回
// return order;
// }
}
2.3访问
启动user-server,order-server,nacos
访问http://localhost:8080/order/102
报错!!!
java.lang.AbstractMethodError: Receiver class org.springframework.cloud.netflix.ribbon.RibbonLoadBal
java.lang.AbstractMethodError: Receiver class org.springframework.cloud.netflix.ribbon.RibbonLoadBalancerClient does not define or inherit an implementation of the resolved method 'abstract org.springframework.cloud.client.ServiceInstance choose(java.lang.String, org.springframework.cloud.client.loadbalancer.Request)' of interface org.springframework.cloud.client.loadbalancer.ServiceInstanceChooser.
解决:在common的pom.xml文件中加入以下代码,排除nacos中的ribbon就可以解决了
<!--nacos客户端依赖包--> <dependency> <groupId>com.alibaba.cloud</groupId> <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId> <exclusions> <exclusion> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-netflix-ribbon</artifactId> </exclusion> </exclusions> </dependency> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-loadbalancer</artifactId> </dependency>
3.自定义Feign的配置
Feign运行自定义配置来覆盖默认配置,可以修改的配置如下:
日志的级别分为四种:
- NONE:不记录任何日志信息,默认值。
- BASIC:仅记录请求的方法,URL以及响应状态码和执行时间
- HEADERS:在BASIC的基础上,额外记录了请求和响应的头信息
- FULL:记录所有请求和响应的明细,包括头信息、请求体、元数据
3.1修改日志级别
Feign得到日志级别默认是NONE,即没有日志,配置有两种方式:
3.1.1基于配置文件
1.全局生效:
feign: client: config: default: # 这里用default就是全局配置,如果是写服务名称,则是针对某个微服务的配置 loggerLevel: FULL # 日志级别四种NONE、BASIC、HEADERS、FULL
2.局部生效:
feign: client: config: user-server: # 这里用default就是全局配置,如果是写服务名称,则是针对某个微服务的配置 loggerLevel: FULL # 日志级别四种NONE、BASIC、HEADERS、FULL
3.2.2.基于 Java 代码
声明一个类,然后声明一个 Logger.Level 的对象
public class DefaultFeignConfiguration {
@Bean
public Logger.Level feignLogLevel(){
return Logger.Level.BASIC; // 日志级别为BASIC
}
}
如果是全局配置,则在启动类的@EnableFeignClients注解中添加:
@MapperScan("cn.itcast.order.mapper")
@SpringBootApplication
@EnableFeignClients(defaultConfiguration = DefaultFeignConfiguration.class)
public class OrderApplication {
public static void main(String[] args) {
SpringApplication.run(OrderApplication.class, args);
}
}
如果是局部某个服务配置,则在feign客户端的@FeignClient注解中添加:
@FeignClient(value = "user-server", configuration = DefaultFeignConfiguration.class)
public interface UserClient {
@GetMapping("/user/{id}")
User findById(@PathVariable("id") Long id);
}
4.Feign的性能优化
Feign底层的客户端实现:
- URLConnection:默认实现,不支持连接池(问题)
- Apache HttpClient :支持连接池
- OKHttp:支持连接池
因此优化Feign的性能主要包括:
- 使用连接池代替默认的URLConnection
- 日志级别,最好用basic或none(第三部分已经说了)
连接池配置
以HttpClient为例
1.引入依赖
<!--httpClient连接池的依赖 --> <dependency> <groupId>io.github.openfeign</groupId> <artifactId>feign-httpclient</artifactId> </dependency>
2.配置
feign:
client:
config:
default: # 这里用default就是全局配置,如果是写服务名称,则是针对某个微服务的配置
loggerLevel: BASIC # 日志级别四种NONE、BASIC、HEADERS、FULL
httpclient:
enabled: true # 开启feign对HttpClient的支持
max-connections: 200 # 最大的连接数
max-connections-per-route: 50 # 每个路径的最大连接数
5.Feign的最佳实践
最佳实践就是最好的使用方式。
5.1继承
给消费者的FeignClient和提供者的controller定义统一的父接口作为标准。
定义一个 API 接口,利用定义方法,Feign 客户端、Controller 都继承该接口
优点
- 简洁
- 实现了代码共享
缺点
- 服务紧耦合
- 父接口参数列表中的映射不会被继承
5.2抽取
将FeignClient抽取为独立模块,并且把接口有关的POJO、默认的Feign配置都放到这个模块中,提供给所有消费者使用
实现
1.首先创建一个maven的module,命名为feign-api,然后引入feign的starter依赖
<dependencies> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-openfeign</artifactId> </dependency> </dependencies>
2.将order-service中编写的UserClient、User、DefaultFeignConfiguration都复制到feign-api项目中
3.在order-service中引入feign-api的依赖
<!--引入feign的统一api--> <dependency> <groupId>cn.itcast.demo</groupId> <artifactId>feign-api</artifactId> <version>1.0</version> </dependency>
4.修改order-service中的所有与上述三个组件有关的import部分,改成导入feign-api中的包
5.测试
注意!!!
当定义的FeignClient不在SpringBootApplication的扫描包范围时,这些FeignClient无法使用。有两种方式解决:
一:指定FeignClient所在包
二:指定FeignClient字节码