在前面的学习中,使用了Ribbon的负载均衡功能(注意:Feign集成了Ribbon),大大简化了远程调用时的代码,但是服务地址还是需要拼接,还需要利用RestTemplate进行访问,代码较多,重复率高。如果使用feign的话,就能更加简洁的访问。
String url = "http://user-service/user/" + id;
User user = this.restTemplate.getForObject(url, User.class)
如果就学到这里,你可能以后需要编写类似的大量重复代码,格式基本相同,无非参数不一样。有没有更优雅的方式,来对这些代码再次优化呢?这就是接下来要学的Feign的功能了。
Feign也叫伪装,Feign可以把Rest的请求进行隐藏,伪装成类似SpringMVC的Controller一样。你不用再自己拼接url,拼接参数等等操作,一切都交给Feign去做。其实Feign客户端的主要作用就是拼接地址。
快速入门
1、在服务的消费方导入依赖:spring-cloud-starter-openfeign
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
2、在服务消费方的启动类中通过@EnableFeighClients注解开启Feign功能,
Feign中已经自动集成了Ribbon负载均衡,因此不需要额外引入依赖,可以通过配置开启使用Ribbon。也不需要再注册 RestTemplate 对象并添加@LoadBalanced注解进行负载均衡,即不需要自己定义RestTemplate进行负载均衡的配置。
由于eureka-client中也集成了ribbon,所以openfeign中的ribbon被忽略
3、在 consumer-demo(服务消费方)中编写如下Feign客户端接口:
@FeignClient("user-service") public interface UserClient { @GetMapping("/user/{id}") User queryById(@PathVariable("id") Long id); }
注意:@PathVariable注解中一定要写参数,否则报Error creating bean with name 'com.zwhxpp.consumer.client.UserClient',PathVariable annotation was empty on param 0错误,导致无法启动服务。
Feign客户端的接口的作用是替我们拼接一个服务地址:http://user-service/user/{id}
1)、首先这是一个接口,Feign会通过动态代理,帮我们生成实现类。这点跟mybatis的mapper很像
2)、@FeignClient ,声明当前类是一个Feign客户端,同时通过 value 属性指定服务名称
3)、接口中的定义方法,完全采用SpringMVC的注解,Feign会根据注解帮我们生成URL,并访问获取结果
4)、@GetMapping中的/user,请不要忘记;因为Feign需要拼接可访问的地址
4、编写新的控制器类 ConsumerFeignController ,使用UserClient访问:
@RestController @RequestMapping("/cf") public class ConsumerFeignController { @Autowired private UserClient userClient; @GetMapping("/{id}") public User queryById(@PathVariable Long id){ return userClient.queryById(id); } }
5、启动测试,访问接口:http://localhost:9092/cf/7
由于Feign集成了Ribbon和Hystrix,可以通过配置开启使用Ribbon和Hystrix。
Ribbon默认情况下是开启的。默认内置请求超时时长1000ms,一旦超时则进行重试。
Fegin内置了ribbon,ribbon默认设置了请求超时时长,默认是1000,我们可以通过手动配置来修改这个超时时长:
ribbon:
ReadTimeout: 2000 # 读取超时时长 ConnectTimeout: 1000 # 建立链接的超时时长
因为ribbon内部有重试机制,一旦超时,会自动重新发起请求。如果不希望重试,可以添加配置:
ribbon: ConnectTimeout: 1000 # 连接超时时长 ReadTimeout: 2000 # 数据通信超时时长 MaxAutoRetries: 0 # 当前服务器的重试次数 MaxAutoRetriesNextServer: 0 # 重试多少次服务 OkToRetryOnAllOperations: false # 是否对所有的请求方式都重试
重新给User-Service的方法设置上线程沉睡时间2秒可以测试上述配置,
配置超时时间就是2s,而现在沉睡就要2s,另外还有请求的时间,所以一定会超过2s,如果超过2s就会报错,因为超时了,由于没有做服务降级,所以会提示一个错误信息。
Ctrl+F9可以重新编译并加载(通过使用idea自带的录制宏功能,一切在idea中键盘的操作(如Ctrl+shift+S)都被记录,再为该操作设置快捷键ctrl+S,就可以保存时自动编译),不用重新启动。也直接进行热部署即可。
Feign支持Hystrix
触发Hystrix服务降级的情况:线程池已满或请求超时
Feign默认也有对Hystrix的集成:只不过,默认情况下是关闭的。需要通过下面的参数来开启;
修改application.yml 添加如下配置:
feign: hystrix: enabled: true
但是,Feign中的Fallback配置不像Hystrix中那样简单了,原来是在controller中编写降级的方法,现在如果用了Feign客户端,需要要单独写一个服务降级的类,实现feign客户端的各个方法,哪一个方法有错就调用哪一个方法返回。
1)首先,要定义一个服务降级的类,针对Feign客户端里面的各个方法,当请求失败时调用哪一个服务降级的方法。实现刚才编写的UserClient,作为fallback的处理类,服务降级类中的方法要与请求方法名保持一致,只要我们实现UserClient就可以了。即当UserClient中的方法请求失败即调用该服务降级的方法。
@Component public class UserClientFallBack implements UserClient { @Override public User queryById(Long id) { User user = new User(); user.setId(id); user.setName("用户异常"); return user; } }
2)然后在feign客户端UserClient中,指定刚才编写的实现类,这样当服务降级时调用这个类
@FeignClient(value = "user-service",fallback = UserClientFallBack.class) public interface UserClient { @GetMapping("/user/{id}") public User queryById(@PathVariable("id") Long id); }
3) 重启测试, 重启启动 consumer-demo,由于user-service 服务会引发超时,在页面访问:http://localhost:9092/cf/8,返回的是服务降级的返回结果。
Feign支持请求压缩
Spring Cloud 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 # 设置触发压缩的大小下限
注:上面的数据类型、压缩大小下限均为默认值。
由于无法验证,配置后,重新启动后不报错就默认配置生效。
日志级别
前面讲过,通过 logging.level.xx(包名)=debug 来设置哪一些包的日志级别。然而只有这个对Fegin客户端而言不会产生效果。因为@FeignClient 注解所在的客户端在被代理时,都会创建一个新的Fegin.Logger实例。我们需要额外指定这个日志Logger的级别才可以。
1)在服务消费方 consumer-demo 的配置文件中设置com.zwhxpp包下的日志级别都为 debug, 修改application.yml 添加如下配置:
logging:
level:
com.zwhxpp: debug
开发阶段把日志级别都设置为debug,项目部署的时候(生产环境),由于debug级别比较大,应该改为info级别。
2)在 consumer-demo 编写FeignConfig配置类,注册一个Bean,返回日志级别。定义日志级别
@Configuration public class FeignConfig { @Bean public Logger.Level feignLoggerLevel(){ return Logger.Level.FULL; } }
这里指定的Level级别是FULL,Feign支持4种级别:
1、NONE:不记录任何日志信息,这是默认值。
2、BASIC:仅记录请求的方法,URL以及响应状态码和执行时间
3、HEADERS:在BASIC的基础上,额外记录了请求和响应的头信息
4、FULL:记录所有请求和响应的明细,包括头信息、请求体、元数据。
3)在 服务消费方consumer-demo 的Feign客户端 UserClient 接口类上的@FeignClient注解中指定配置类:
@FeignClient(value = "user-service",fallback = UserClientFallBack.class ,configuration = FeignConfig.class) public interface UserClient { @GetMapping("/user/{id}") public User queryById(@PathVariable("id") Long id); }
4)重启项目,访问:http://localhost:8080/cf/8 ;即可看到每次访问的日志: