目录
一、简介
Feign是一个声明式 WebService 客户端,使用Feign能够让编写Web Service 客户端更加简单,它的使用方法是定义一个接口,然后在上面添加注解,同时也支持JAX-RS标准的注解。Feign也支持可插拔式的编码器和解码器。
Spring Cloud 对 Fiegn 进行了封装,使其支持了Spring MVC 标准注解和、HttpMessageConverts。Feign可以与Eureka和Ribbon组合使用以支持负载均衡。
开源项目地址:
https://github.com/OpenFeign/feign
二、Feign简单应用
1)pom.xml引入Feign的依赖
<!--feign客户端依赖-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
2)代码改造
1、启动类添加注解 @EnableFeignClients
2、 添加调用Feign接口
package com.cloud.order.clients;
import com.cloud.order.pojo.User;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
/**
* @author :jizhibing
* @date :Created in 2022/4/20
* @description:
*/
@FeignClient("userservice")
public interface UserClient {
@GetMapping("/user/{id}")
User queryById(@PathVariable("id") Long id) ;
}
3、 调用Service修改
package com.cloud.order.service;
import com.cloud.order.clients.UserClient;
import com.cloud.order.mapper.OrderMapper;
import com.cloud.order.pojo.Order;
import com.cloud.order.pojo.User;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.cloud.client.loadbalancer.LoadBalanced;
import org.springframework.stereotype.Service;
import org.springframework.web.client.RestTemplate;
@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.queryById(order.getId());
//3.封装User到Order
order.setUser(user);
// 4.返回
return order;
// } public Order queryOrderById(Long orderId) {
// // 1.查询订单
// Order order = orderMapper.findById(orderId);
// //2.利用restTemplate 发起http请求,查询用户
String url = "http://localhost:8881/user/"+order.getId();
// String url = "http://userserver/user/"+order.getId();
// User user = restTemplate.getForObject(url,User.class);
// //3.设置用户信息
// order.setUser(user);
// // 4.返回
// return order;
}
}
三、Feign的自定义配置
Feign运行自定义配置来覆盖默认配置,可以修改的配置如下:
类型 |
作用 |
说明 |
feign.Logger.Level |
修改日志级别 |
包含四种不同的级别:NONE,BASIC,HEADERS,FULL |
feign.code.Decoder |
响应结果的解析器 |
http远程调用的结果做解析,例如解析json字符串为java对象 |
Feign.code.Encoder |
请求参数编码 |
将请求参数编码,便于通过http请求发送 |
Feign.Contract |
支持的注解格式 |
默认是SpringMVC的注解 |
Feign.Retryer |
失败重试机制 |
请求失败的重试机制,默认是没有,不过会使用Ribbon的重试 |
一般我们需要配置的就是日志级别。
Feign日志配置有2种方式:
1)方式一:基于配置
1、全局生效:
feign:
client:
config:
default: #这里的default就是全局配置,如果是写服务名称,则是针对某个微服务的配置
loggerLevel: FULL #日志级别
2、局部生效:
feign:
client:
config:
userservice: #这里的default就是全局配置,如果是写服务名称,则是针对某个微服务的配置
loggerLevel: FULL #日志级别
日志:
2)方式二:java代码方式
- 1、先声明一个Bean
public class FeignClientConfiguration {
@Bean
public Logger.Level feignLogLevel(){
return Logger.Level.BASIC ;
}
}
- 2、如果是全局配置,则把它放到 @EnableFeignClients 这个注解里
@EnableFeignClients(defaultConfiguration = FeignClientConfiguration.class)
- 3、如果是局部变量,则把它放到 @FeignClient 这个注解里
@FeignClient(value = "userservice",configuration = FeignClientConfiguration.class)
四、Feign 的性能优化
Feign底层的客户端实现:
- URLConnection: 默认实现,不支持连接池
- Apache HttpClient :支持连接池
- OkHttp:支持连接池
因此优化Feign的性能包括:
- 1、使用连接池替代默认的URLConnection
- 2、日志级别,最好用BASIC或者NONE
1)连接池配置
1、依赖引入:
<!--httpClient的依赖-->
<dependency>
<groupId>io.github.openfeign</groupId>
<artifactId>feign-httpclient</artifactId>
</dependency>
2、配置连接池:
feign:
client:
config:
default: #这里的default就是全局配置,如果是写服务名称,则是针对某个微服务的配置
loggerLevel: FULL #日志级别
httpclient:
enabled: true #开启feign对httpClient对支持
max-connections: 200 #最大对连接数
max-connections-per-route: 50 #每个路径对最大连接数
2)日志级别
日志级别尽量BASIC
feign:
client:
config:
default: #这里的default就是全局配置,如果是写服务名称,则是针对某个微服务的配置
loggerLevel: BASIC #日志级别
五、Feign的最佳实践
方式一(继承):
给消费者的FeignClient和提供者的Controller定义统一的父接口作为标准。
方式二(抽取):
将FeignClient抽取为独立模块,并且把接口有关的POJO,默认的Feign配置都放到这个模块中,提供给所有的消费者使用