服务消费者调用服务提供者的时候使用RestTemplate
技术
存在不便之处
url
restTmplate.getForObJect
这两处代码都比较模板化,能不能不让我我们来写这种模板化的东⻄ 。
另外来说,拼接url
非常的low
,拼接字符串,拼接参数,很low
还容易出错。
那我们就来介绍下面的Feign
组件,可以很优雅的解决上面的问题。
Feign
是Netflix开发的一个轻量级RESTful的HTTP服务客户端(用它来发起请求,远程调用的)
,是以 Java
接口注解的方式调用Http
请求,而不用像Java
中通过封装HTTP
请求报文的方式直接调用,Feign
被广泛应用在Spring Cloud
的解决方案中。
类似于Dubbo
,服务消费者拿到服务提供者的接口,然后像调用本地接口方法一样去调用,实际发出的 是远程的请求。
Feign
可帮助我们更加便捷,优雅的调用HTTP API
:不需要我们去拼接url
然后呢调用 restTemplate
的api
,在SpringCloud
中,使用Feign
非常简单,创建一个接口(在消费者–服务调 用方这一端),并在接口上添加一些注解,代码就完成了SpringCloud
对Feign
进行了增强,使Feign
支持了SpringMVC
注解(OpenFeign
)本质:封装了Http调用流程,更符合面向接口化的编程习惯,类似于Dubbo的服务调用。
Dubbo
的调用方式其实就是很好的面向接口编程
在服务调用者工程(消费)创建接口(添加注解)
(效果) Feign = RestTemplate+Ribbon+Hystrix
1、服务消费者工程(自动投递微服务)中引入Feign依赖(或者父类工程)
<dependency>
<groupId>org.springframework.cloudgroupId>
<artifactId>spring-cloud-starter-openfeignartifactId>
dependency>
2、服务消费者工程(自动投递微服务)启动类使用注解@EnableFeignClients添加Feign支持
@SpringBootApplication
@EnableDiscoveryClient
@EnableFeignClients // 开启Feign 客户端功能
public class AutodeliverApplication8096 {
public static void main(String[] args) {
SpringApplication.run(AutodeliverApplication8096.class,args);
}
}
注意:此时去掉Hystrix熔断的支持注解@EnableCircuitBreaker即可,包括引入的依赖,因为Feign 会自动引入。
3、创建Feign接口
// 原来:http://riemann-service-resume/resume/openstate/ + userId;
// @FeignClient表明当前类是一个Feign客户端,value指定该客户端要请求的服务名称(登记到注册中心上的服务提供者的服务名称)
@FeignClient(value = "riemann-service-resume", fallback = ResumeFallback.class, path = "/resume")
// @RequestMapping("/resume")
public interface ResumeServiceFeignClient {
// Feign要做的事情就是,拼装url发起请求
// 我们调用该方法就是调用本地接口方法,那么实际上做的是远程请求
@GetMapping("/openstate/{userId}")
public Integer findDefaultResumeState(@PathVariable("userId") Long userId);
}
注意:
1)@FeignClient
注解的name
属性用于指定要调用的服务提供者名称,和服务提供者yml
文件中 spring.application.name
保持一致。
2)接口中的接口方法,就好比是远程服务提供者Controller
中的Hander
方法(只不过如同本地调用了),那么在进行参数绑定的时,可以使用@PathVariable、@RequestParam、 @RequestHeader
等,这也是OpenFeign
对SpringMVC
注解的支持,但是需要注意value
必须设置,否则会抛出异常
4、使用接口中方法完成远程调用(注入接口即可,实际注入的是接口的实现)
@RestController
@RequestMapping("/autodeliver")
public class AutodeliverController {
@Autowired
private ResumeServiceFeignClient resumeServiceFeignClient;
@GetMapping("/checkState/{userId}")
public Integer findResumeOpenState(@PathVariable Long userId) {
Integer defaultResumeState = resumeServiceFeignClient.findDefaultResumeState(userId);
return defaultResumeState;
}
}
Feign
本身已经集成了Ribbon
依赖和自动配置,因此我们不需要额外引入依赖,可以通过 ribbon.xx
来
进 行全局配置,也可以通过服务名.ribbon.xx
来对指定服务进行细节配置配置(参考之前,此处略)
Feign
默认的请求处理超时时⻓1s
,有时候我们的业务确实执行的需要一定时间,那么这个时候,我们
就需要调整请求处理超时时⻓,Feign
自己有超时设置,如果配置Ribbon
的超时,则会以Ribbon
的为准。
Ribbon设置
# 针对的被调用方微服务名称,不加就是全局生效
riemann-service-resume:
ribbon:
# 请求连接超时时间
ConnectTimeout: 2000
# 请求处理超时时间
# Feign超时时长设置
ReadTimeout: 3000
# 对所有操作都进行重试
OkToRetryOnAllOperations: true
# 根据如上配置,当访问到故障请求的时候,它会再尝试访问一次当前实例(次数由MaxAutoRetries配置),
# 如果不行,就换一个实例进行访问,如果还不行,再换一次实例访问(更换次数由MaxAutoRetriesNextServer配置),
# 如果依然不行,返回失败信息。
MaxAutoRetries: 0 # 对当前选中实例重试次数,不包括第一次调用
MaxAutoRetriesNextServer: 0 # 切换实例的重试次数
NFLoadBalancerRuleClassName: com.netflix.loadbalancer.RoundRobinRule # 负载策略调整
1、在Feign客户端工程配置文件(application.yml)中开启Feign对熔断器的支持
# 开启Feign的熔断功能
feign:
hystrix:
enabled: false
Feign
的超时时⻓设置那其实就上面Ribbon
的超时时⻓设置
Hystrix
超时设置(就按照之前Hystrix设置的方式就OK了)
注意:
1)开启Hystrix
之后,Feign
中的方法都会被进行一个管理了,一旦出现问题就进入对应的回退逻辑处理
2)针对超时这一点,当前有两个超时时间设置(Feign/hystrix
),熔断的时候是根据这两个时间的最小值来进行的
,即处理时⻓超过最短的那个超时时间了就熔断进入回退降级逻辑
。
hystrix:
command:
default:
execution:
isolation:
thread:
# Hystrix的超时时长设置
timeoutInMilliseconds: 15000
2、自定义FallBack处理类(需要实现FeignClient接口)
/**
* 降级回退逻辑需要定义一个类,实现FeignClient接口,实现接口中的方法
*/
@Component // 别忘了这个注解,还应该被扫描到
public class ResumeFallback implements ResumeServiceFeignClient {
@Override
public Integer findDefaultResumeState(Long userId) {
return -6;
}
}
3、在@FeignClient注解中关联2)中自定义的处理类
Feign
支持对请求和响应进行GZIP
压缩,以减少通信过程中的性能损耗。通过下面的参数 即可开启请求与响应的压缩功能:
feign:
# Feign对请求压缩和响应压缩的支持
compression:
request:
enabled: true # 开启请求压缩
mime-types: text/html,application/xml,application/json # 设置压缩的数据类型,此处也是默认值
min-request-size: 2048 # 设置触发压缩的大小下限,此处也是默认值
response:
enabled: true # 开启响应压缩
Feign是http请求客户端,类似于咱们的浏览器,它在请求和接收响应的时候,可以打印出比较详细的
一些日志信息(响应头,状态码等等)。
如果我们想看到Feign请求时的日志,我们可以进行配置,默认情况下Feign的日志没有开启。
1、开启Feign日志功能及级别
/**
* Feign的日志级别(Feign请求过程信息)
* NONE:默认的,不显示任何日志----性能最好
* BASIC:仅记录请求方法、URL、响应状态码以及执行时间----生产问题追踪
* HEADERS:在BASIC级别的基础上,记录请求和响应的header
* FULL:记录请求和响应的header、body和元数据----适用于开发及测试环境定位问题
*/
@Configuration
public class FeignLog {
@Bean
Logger.Level feignLevel() {
return Logger.Level.FULL;
}
}
2、配置log日志级别为debug
logging:
level:
# Feign日志只会对日志级别为debug的做出响应
com.riemann.controller.service.ResumeServiceFeignClient: debug