代码地址:https://github.com/AJ-Spade/cloud2020/tree/master
Feign前置
- Feign是一个声明式的Web服务的客户端,它让编写Web服务的客户端变得更容易,只需创建一个接口,并再接口上添加注解即可。
- 目的:让编写Java Http客户端(例如消费者80端口的服务)变得更容易;
- 在之前使用Ribbon+RestTemplate时,利用RestTemplate对http请求的封装处理,形成了一套模板化的调用方法。但是,在实际开发中,由于对服务依赖的调用可能不止一处,往往一个接口会被多处调用(于一个80端口的消费者,即一个Http客户端中,被多处代码块中调用),所以通常都会针对每个微服务自行封装一些客户端类来包装这些依赖服务的调用。所以,Feign在上述基础上进一步封装,由他来帮助我们定义和实现依赖服务接口的定义。
- 在Feign的实现下,我们只需要创建一个接口,并使用注解的方式配置它(类似以前在Dao接口上标注Mapper注解,现在是在一个微服务接口上面标注一个Feign注解即可),即可完成对服务提供方的接口绑定。
- 简化了使用Spring cloud Ribbon时,自动封装服务调用的客户端的开发量。
- Feign集成了Ribbon,利用Ribbon维护了Payment的服务列表信息,并通过轮询实现客户端的负载均衡。与Ribbon不同的是,通过feign,只需要以声明的方式定义服务接口(在消费者端,即Http客户端),优雅简单的实现服务调用。
版本说明
- cloud Hoxton.SR1
- boot 2.2.2RELEASE
- cloud alibaba 2.1.0 RELEASE
- java java8
- Maven 3.5以上
- Mysql 5.7以上
Feign
-
使用步骤:
-
接口+注解,微服务调用接口+@FeignClient;
-
新建cloud-consumer-feign-order80,注意:Feign是在消费端使用的;
-
POM、YML,然后在主启动类上,添加注解@EnableFeignClient,表示激活并开启Feign;
-
在业务类中:
-
业务逻辑接口+@FeignClient配置调用provider服务(与服务提供者中的业务逻辑层中暴露出来的接口对应,但是具体返回结果,需要看服务提供者中的控制层的对应方法(直接拷贝控制层中的方法也也行,不需要具体内容);@FeignClient相当于使用Feign;
-
新建PaymentFeignService接口并新增注解@FeignClient;
//服务提供者的业务层接口 public interface PaymentService { public int create(Payment payment); public Payment getPaymentById(@Param("id") Long id); }
//服务提供者的控制层对应内容 @GetMapping(value="/payment/get/{id}") public CommonResult getPaymentById(@PathVariable("id") Long id){ Payment payment = paymentService.getPaymentById(id); log.info("*********查询结果"+payment); if(payment!=null){ return new CommonResult(200,"查询成功,serverPort:"+serverPort,payment); }else{ return new CommonResult(444,"没有对应记录,查询id:"+id,null); } }
//消费者的业务逻辑接口+@FeignClient配置 @Component @FeignClient(value="CLOUD-PAYMENT-SERVICE")//找这个微服务下的如下方法 public interface PaymentFeignService { @GetMapping(value="/payment/get/{id}")微服务的具体调用地址,找的则是8001或8002服务的对应方法 public CommonResult<Payment> getPaymentById(@PathVariable("id") Long id); }
-
-
控制层Controller:在controller包下添加OrderFeignController:
@RestController @Slf4j public class OrderFeignController { @Resource private PaymentFeignService paymentFeignService; @GetMapping(value = "/consumer/payment/get/{id}") public CommonResult<Payment> getPaymentById(@PathVariable("id") Long id){ return paymentFeignService.getPaymentById(id); } }
- 测试,①启动eureka集群7001/7002;②启动微服务8001和8002;③启动OpenFeign;④http://localhost/consumer/payment/get/1; 注意:Feign自带负载均衡配置项
-
-
OpenFeign超时控制:
-
起因:因为是消费端调用服务提供者对外暴露的URL接口,所以可能服务提供者的方法处理运行了3秒钟,但是消费端只能等2秒钟,就会发生报错;默认Feign客户端只等待1秒钟。
-
步骤:
- 服务提供方8001故意写暂停程序;
- 服务消费方80的业务层添加超时接口PaymentFeignService;
- 服务消费方80的控制层添加超时方PaymentFeignService;
- 测试,错误页面;
-
设置Feign客户端的超时时间,在yml开启配置:
-
server: port: 80 eureka: client: register-with-eureka: true service-url: defaultZone: http://eureka7001.com:7001/eureka/,http://eureka7002.com:7002/eureka/ #设置feign客户端超时时间(OpenFeign默认支持ribbon) ribbon: #表示建立连接所用的时间 ReadTimeout: 5000 #表示建立连接后从服务器读取到可用资源的时间,5s ConnectTimeout: 5000
-
-
-
OpenFeign的日志打印功能:
-
目的:对Feign接口的调用情况进行监控和输出;
-
Feign提供日志打印功能,可用通过配置来调整日志级别,从而了解Feign中Http请求的细节。
-
日志级别:
- NONE:默认的,不显示任何日志;
- BASIC:记录请求方法、URL】响应状态码以及执行时间;
- HEADER:在BASIC基础上,还有请求和响应的头信息;
- FULL:在上面基础上,还有请求和响应的正文和元数据;
-
步骤:
-
配置日志bean;
//创建一个config包,其中方法如下: @Configuration public class FeignConfig { @Bean Logger.Level feignLoggerLevel() { return Logger.Level.FULL; } }
-
YML文件中,开启日志的Feign客户端;
logging: level: # feign日志以什么级别监控哪个接口,这里是以debug形式 com.atguigu.springcloud.service.PaymentFeignService: debug
-
后台查看日志;
-
-
需熟练掌握
知识点
- Feign和OpenFeign的异同点?
- Feign是Spring Cloud组件中一个轻量级RESTful的HTTP服务客户端。Feign内置了Ribbon,用来做客户端负载均衡,去调用服务注册中心的服务。Feign的使用方式是,使用Feign的注解定义接口,调用这个接口,就可以调用服务注册中心的服务。
- OpenFeign是Spring Cloud在Feign的基础上支持了SpringMVC的注解,如@RequestMapping等等。OpenFeign的@FeignClient可以解析SpringMVC的@RequestMapping注解下的接口,并通过动态代理的方式产生实现类,实现类中负载均衡,并调用其他服务。
tips
-
接口也是可以被注入的,因此在需要被注入的接口上,也要添加@Component,如该module下的OrderFeignController类就注入了PaymentFeignService接口。
-
//消费者的业务逻辑接口+@FeignClient配置 @Component @FeignClient(value="CLOUD-PAYMENT-SERVICE")//找这个微服务下的如下方法 public interface PaymentFeignService { @GetMapping(value="/payment/get/{id}")微服务的具体调用地址,找的则是8001或8002服务的对应方法 public CommonResult<Payment> getPaymentById(@PathVariable("id") Long id); }
上面代码,有点类似在消费者端编写接口,然后用@FeignClient(value=…)指示程序去服务提供者(如CLOUD-PAYMENT-SERVICE)中找具体的实现类,只是有的返回结果不太一样,一般遵循服务提供者中控制层对应的方法。
-
Feign的方法,让消费端继续沿用了控制层(controller)调用业务层(Service)的规则。