前言
在之前的案例中我们使用了Ribbon的负载均衡功能,大大简化了远程调用时的代码:
String url="http://user-server/user/"+id;
User user = restTemplate.getForObject(url, User.class);
如果只做到这里,对于大项目来说就有大量重复的代码,格式基本相同,无非参数不一样。因为这里使用字符串拼接的方式来创建url路径,是以硬编码的形式生成的,这一点都不优雅。
简介
Feign的意思是伪装,Feign可以吧Rest的请求进行隐藏,伪装成类似SpringMvc的Controller一样,你也不用自己再去拼装url,伪装之后调用就像调用本地方法那样,丝毫看不出来是远程调用。这一切都交给Feign去做。
项目主页:https://github.com/OpenFeign/feign
Feign是Netflix开发的声明式、模板化的HTTP客户端,他可以帮我们更加便捷、优雅的调用HTTP API 。在SpringCloud中,使用Feign非常简单,创建一个接口,并在接口上添加一些注解,代码就完成了,在业务逻辑代码中只需通过这个接口的动态代理去掉用方法。
快速入门
添加依赖
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
<version></version>
</dependency>
开启Feign功能
因为Feign已经帮我们定义好了RestTemplate,所以启动类里面的就可以取掉了;
@SpringCloudApplication
@EnableFeignClients
public class ConsumerApplication {
public static void main(String[] args) {
SpringApplication.run(ConsumerApplication.class);
}
// @Bean
// @LoadBalanced
// public RestTemplate restTemplate(){
// return new RestTemplate();
// }
}
Feign的客户端
@FeignClient(value = "user-server",fallback = UserFeignClientFallback.class)
public interface UserFeignClient {
@GetMapping("/user/{id}")
User queryUserById(@PathVariable("id") Long id);
}
- 首先这是一个接口,Feign会通过动态代理帮我们生成实现类;
@FeignClient
声明这是一个Feign客户端类似于@Mapper
注解,我们可以通过value属性来指定要调用的服务名,还可以指定熔断器的服务降级类。- 接口中的定义方法,完全采用SpringMvc的注解,Feign会根据注解帮我们生成URL,并访问获取结果。
改造原来的逻辑,不再调用UserDao,而是将Feign接口注入进来,直接调用。
@Component
@Slf4j
//针对这个类的返回方法的指定,不再单独指定一个方法的服务降级方法指定
@DefaultProperties(defaultFallback = "queryUserByIdFallback")
public class ConsumerDao {
// @Autowired
// private RestTemplate restTemplate;
@Autowired
private UserFeignClient userFeignClient;
public User queryUserById(Long id){
return userFeignClient.queryUserById(id);
}
}
而且Feign中已经自动继承了Ribbon负载均衡,因此这里也不需要自己定义RestTemplate了。
负载均衡
Feign本身已经继承了Ribbon依赖和自动配置,因此我们不需要额外引入依赖,也不需要注册RestTemplate对象。
Hystix支持
Feign默认集成了Hystix,只不过默认是关闭的。
feign:
hystrix:
enabled: true #feign中hystrix默认是关闭的,所以需要开启
如果配置Fallback
- 我们需要创建一个类来实现UserFeignClientFallback作为fallback的处理类:
@Component
public class UserFeignClientFallback implements UserFeignClient {
@Override
public User queryUserById(Long id) {
User user = new User();
user.setName("服务器正忙");
return user;
}
}
- 然后在UserFeignClient中指定刚才编写的实现类
@FeignClient(value = "user-server",fallback = UserFeignClientFallback.class)
public interface UserFeignClient {
@GetMapping("/user/{id}")
User queryUserById(@PathVariable("id") Long id);
}
请求压缩
SpringCloud Feign支持对请求和响应进行gzip压缩,以减少通信过程中的性能损耗。
feign:
compression:
request:
enabled: true # 开启请求压缩
response:
enabled: true # 开启响应压缩
同时我们也可以对请求的数据类型,以及触发压缩的大小下限进行设置:
feign:
compression:
request:
enabled: true # 开启请求压缩
mime-types: text/html,application/xml,application/json # 设置压缩的数据类型
min-request-size: 2048 # 设置触发压缩的大小下限
日志级别
前面所说的日志级别设定对于Feign客户端而言不会产生效果,因为@FeignClient注解修改的客户端再被代理时,都会创建一个新的Feign.logger实例。我们需要额外指定这个日志的级别:
- 设置项目包下的日志级别都为debug
logging:
level:
com.example: debug
- 编写配置类,定义日志级别
@Configuration
public class FeignConfig {
@Bean
Logger.Level feignLoggerLevel(){
return Logger.Level.FULL;
}
}
Feign一共支持四种级别:
-
NONE:不记录任何日志信息,这里的默认值;
-
BASIC:仅记录请求的方法,URL以及响应状态码和执行时间;
-
HEADERS:在basic基础上,额外记录了请求和响应的头信息;
-
FULL:记录所有请求和响应的明细,包括头信息、请求体、元数据;
-
在FeignClient中指定配置类
@FeignClient(value = "user-service", fallback = UserFeignClientFallback.class, configuration = FeignConfig.class)
public interface UserFeignClient {
@GetMapping("/user/{id}")
User queryUserById(@PathVariable("id") Long id);
}