一、Feign的介绍
Feign是一个声明式的http客户端,官方地址:
https://github.com/OpenFeign/feign
其作用就是帮助我们优雅的实现http请求的发送,解决如浏览器访问的时候后面一大堆参数的问题。
使用Feign的步骤如下:
- 引入依赖:
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
- 在order-service的启动类添加注解开启Feign功能:
@MapperScan("cn.itcast.order.mapper")
@SpringBootApplication
@EnableFeignClients(clients = UserClient.class,defaultConfiguration = DefaultFeignConfiguration.class)
public class OrderApplication {
public static void main(String[] args) {
SpringApplication.run(OrderApplication.class, args);
}
}
- 编写Feign客户端:
/**
* feign实现远程调用声明的bean
*/
@FeignClient("user-service")
public interface UserClient {
@GetMapping("/user/{id}")
User findById(@PathVariable("id") Long id);
}
主要是基于SpringMVC的注解来声明远程调用信息,比如:
- 服务名称:user-service
- 请求方式:GET
- 请求路径:/user/{id}
- 请求参数:Long id
- 返回值类型:User
- 则OrderService或OrderServiceImpl中方法改写为:
@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;
}
}
此时通过order-service调用user-service就实现了远程调用,因为Feifn内部自带Ribbon,因此也同时实现了负载均衡。
二、Feign的自定义配置
可以通过自定义配置,来覆盖Feign的默认配置,可以修改的配置如下:
配置Feign日志有两种方式:
- 方式一:配置文件方式
feign:
client:
config:
default: #此处为default表示全局配置,如果想要局部配置,可以当配某一个服务名
loggerLevel: FULL
- 方式二:java代码方式,需要先声明一个Bean:
/**
* 配饰feign日志的bean
*/
public class FeignClientConfiguration {
@Bean
public Logger.Level feignLogLevel(){
return Logger.Level.BASIC;
}
}
如果想要全局生效,则在osder服务启动类上加上注解:@EnableFeignClients(defaultConfiguration = FeignClientConfiguration.class)
@MapperScan("cn.itcast.order.mapper")
@SpringBootApplication
@EnableFeignClients(defaultConfiguration = FeignClientConfiguration.class)
public class OrderApplication {
public static void main(String[] args) {
SpringApplication.run(OrderApplication.class, args);
}
}
如果只想对局部服务生效,则注解加在调用这个服务的类中:@FeignClient(value = “user-service”,configuration = FeignClientConfiguration.class)
/**
* feign实现远程调用声明的bean
*/
@FeignClient(value = "user-service",configuration = FeignClientConfiguration.class)
public interface UserClient {
@GetMapping("/user/{id}")
User findById(@PathVariable("id") Long id);
}
三、Feign性能优化
Feign底层客户端实现:
- URLConnection:默认实现,不持支连接池;
- Apache HttpClient:支持连接池;
- OKHttp:支持连接池;
因此优化Feign的性能主要包括:
- 使用连接池代替默认的URLConnection;
- 日志级别,最好用basic或none
在order服务中,对Feign添加HttpClient的支持:
- 引入依赖:
<!-- 引入HttpClient依赖 -->
<dependency>
<groupId>io.github.openfeign</groupId>
<artifactId>feign-httpclient</artifactId>
</dependency>
- 配置连接池:
feign:
httpclient:
enabled: true #支持HttpClient的开关
max-connections: 200 #最大连接数
四、Feign的最佳实践
方式一:继承,给消费者的FeignClient和提供者的controller定义统一的父接口作为标准。
//统一父接口作为规范
public interface UserAPI{
@GetMapping("/user/(id)")
User findById(@PathVariable("id") Long id);
}
//order服务直接继承父接口
@FeignClient(value = "user-service")
public interface UserClient extends UserAPI{}
//user服务的controller类
@RestController
public class UserController implements UserAPI{}
效果图:
注:一般情况下不推荐使用这种方式,因为order为服务客户端,user为服务服务端,不推荐在客户端与服务端中公用一个接口
方式二:将FeignClient抽取作为独立的模块,并且把有关的实体类、默认的Feign配置都放到这个模块中,提供给所有消费者使用。
实现方式二步骤:
- 创建模块feign-api,并引入feign的starter的依赖:
<!-- 引入feign的starter依赖 -->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
- 将order-service中编写的UserClient、User、DefaultFeignConfiguration都复制到feign-api项目中。
-
在order-service中引入feign-api的依赖。
<!-- 引入feign的统一api --> <dependency> <groupId>cn.itcast.demo</groupId> <artifactId>feign-api</artifactId> <version>1.0</version> </dependency>
-
修改之前的导包,因为已经变更到feign-api中去了。
当引入了feign-api包,还是引入不了UserClient时,如下图:
针对这种问题一有有两种解决方案:
方式一:指定FeignClient所在包
@EnableFeignClients(basePackages = "UserClient所在的包")
方式二:指定FeignClients字节码
@EnableFeignClients(clients = UserClient.class, defaultConfiguration = FeignClientConfiguration.class)
此处推荐第二种写法!
- 重启测试。