Feign代替RestTemplate
传统利用RestTemplate发起远程调用的代码:
String url = " http://userservice/user/ "
User user= restTemplate.getForObject (url, User.class);
【存在的问题】
● 代码可读性差,编程体验不统一 ● 参数复杂URL难以维护
Feign的介绍
Feign是一个声明式的http客户端,官方地址:https://github.com/OpenFeign/feign 其作用就是帮助我们优雅的实现http请求的发送,解决上述存在的问题。
定义和使用Feign客户端
使用Feign的步骤 1、引入依赖:
<!--feign客户端依赖-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
2、在order-service的启动类添加注解(@EnableFeignClients)开启Feign的功能:
@EnableFeignClients
@MapperScan("cn.itcast.order.mapper")
@SpringBootApplication
public class OrderApplication {
public static void main(String[] args) {
SpringApplication.run(OrderApplication.class, args);
}
}
3、编写Feign客户端(接口):(接口内封装了所有对userservice发起的远程调用)
@FeignClient("userservice")
public interface UserClient {
@GetMapping("/user/{id}")
User findById(@PathVariable("id") Long id);
}
修改orderservice使用Feign客户端远程调用
package cn.itcast.order.service;
import cn.itcast.order.clients.UserClient;
import cn.itcast.order.mapper.OrderMapper;
import cn.itcast.order.pojo.Order;
import cn.itcast.order.pojo.User;
import org.springframework.beans.factory.annotation.Autowired;
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) {
Order order = orderMapper.findById(orderId);
User user=userClient.findById(order.getUserId());
order.setUser(user);
return order;
}
}
主要是基于SpringMVC的注解来声明远程调用的信息,比如:
● 服务名称:userservice ● 请求方式:GET ● 请求路径:/user/{id} ● 请求参数:Long id ● 返回值类型:User
自定义配置
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:
loggerLevel:Full
② 局部生效:
feign:
client:
config:
userservice:
loggerLevel:Full
方式二:java代码方式,需要先申明一个Bean:
public class FeignClientConfiguration{
@Bean
public Logger.Level feignLogLevel(){
return Logger.Level.BASIC;
}
}
① 如果是全局配置,则把它放到@EnableFeignClients这个注解中
@EnableFeignClients(defaultConfiguration = FeignClientConfiguration.class)
② 如果是局部配置,则把它放到@FeignClient这个注解中
@FeignClient(value= "userservice", configuration = FeignClientConfiguration.class)
Feign性能优化
Feign底层的客户端实现:
● URLConnection:默认实现,不支持连接池 ● Apache HttpClient:支持连接池 ● OkHttp:支持连接池
因此优化Feign的性能主要包括: ① 使用连接池代替默认的URLConnection ② 日志级别,最好用basic或none
Feign的性能优化-连接池配置
Feign添加HttpClient的支持 引入依赖:
<dependency>
<groupId>io.github.openfeign</groupId>
<artifactId>feign-httppclient</artifactId>
</dependency>
配置连接池:
feign:
client:
config:
default:
loggerLevel: BASIC
httpclient:
enabled:true
max-connection:200
max-connections-per-route:50
Feign的最佳实践
方式一(继承):给消费者的FeignClient和提供者的Controller定义统一的父接口作为标准
public interface UserAPI{
@GetMapping(“/user/{id})
User findById(@PathVariable("id") Long id);
}
@FeignClient(Value="userservice")
public interface UserClient extends UserAPI{
}
@RestController
public class UserController implements UserAPI{
}
方式二(抽取):将FeignClient抽取为独立模块,并且把接口有关的POJO、默认的Feign配置都放到这个模块中,提供给所有消费者使用
实现最佳实践方式二的步骤如下: 1、创建一个module,命名为feign-api,然后引入feign的starter依赖
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
2、将order-service中编写的UserClient、User、DefaultFeignConfiguration都复制到feign-api项目中 3、在order-service中引入feign-api的依赖 4、修改order-service中的所有与上诉三个组件有关的import部分,改成导入feign-api中的包
package cn.itcast.feign.service;
import cn.itcast.feign.client.UserClient;
import cn.itcast.feign.mapper.OrderMapper;
import cn.itcast.feign.pojo.Order;
import cn.itcast.feign.pojo.User;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
@Service
public class OrderService {
@Autowired
private OrderMapper orderMapper;
@Autowired
private UserClient userClient;
public Order queryOrderById(Long orderId) {
Order order = orderMapper.findById(orderId);
User user=userClient.findById(order.getUserId());
order.setUser(user);
return order;
}
}
5、重启测试
当定义的FeignClient不在SpringBootApplication的扫描包范围时,这些FeignClient无法使用。有两种方式解决 方式一:指定FeignClient所在包
@EnableFeignClients(basePackages= "cn.itcast.feign.clients")
方式二:指定FeignClient字节码
@EnableFeignClients(clients= {UserClient.class")
|