服务调用Feign
服务调用Feign入门:
在学习ribbon时,使用的RestTemplate实现REST API调用,代码大致如下:
/** * 通过订单系统,调用商品服务根据id查询商品信息 * @param id * @return */ @GetMapping("/buy/{id}") public Product findById(@PathVariable("id") Long id) { return restTemplate.getForObject("http://service-product/product/" + id, Product.class); }
由代码可知,我们是使用拼接字符串的方式构造URL的,该URL只有一个参数。但是,在现实中,URL中往往含有多个参数。这时候我们如果还用这种方式构造URL,那么就会非常痛苦。
Feign简介:
Feign是Netflix开发的声明式,模板化的HTTP客户端,其灵感来自Retrofit,JAXRS-2.0以及WebSocket
Feign可帮助我们更加便捷,优雅的调用HTTP API。
在SpringCloud中,使用Feign非常简单——创建一个接口,并在接口上添加一些注解,代码就完成了。
Feign支持多种注解,例如Feign自带的注解或者JAX-RS注解等。
SpringCloud对Feign进行了增强,使Feign支持了SpringMVC注解,并整合了Ribbon和Eureka,从而让Feign的使用更加方便。
基于Feign的服务调用:
1.引入依赖
在服务消费者 order_service 添加Fegin依赖
<!-- springCloud整合openFeign --> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-openfeign</artifactId> </dependency>
2.启动类添加Feign的支持
通过@EnableFeignClients注解开启Spring Cloud Feign的支持功能,RestTemplate也不需要使用了,可以去掉
@SpringBootApplication @EntityScan("com.fgy.common.domain") // 激活feign @EnableFeignClients public class OrderApplication { public static void main(String[] args) { SpringApplication.run(OrderApplication.class,args); } }
3.启动类激活FeignClient
创建一个 Feign接口,此接口是在Feign中调用微服务的核心接口
在服务消费者 order_service 添加一个 ProductFeginClient 接口
/** * 声明需要调用的服务名称 * @FeignClient * name:服务提供者的服务名称 */ @FeignClient(name = "service-product") public interface ProductFeignClient { /** * 配置需要调用的微服务接口 */ @GetMapping(value = "/product/{id}") public Product findById(@PathVariable("id") Long id); }
定义各参数绑定时, @PathVariable、@RequestParam、@RequestHeader等可以指定参数属性,在Feign中绑定参数必须通过value属性来指明具体的参数名,不然会抛出异常
@FeignClient :注解通过name指定需要调用的微服务的名称,用于创建Ribbon的负载均衡器。所以Ribbon会把 product-service 解析为注册中心的服务。
4.配置请求提供者的调用接口
修改 OrderController ,添加ProductFeginClient的自动注入,删除RestTemplate的注入,并在需要调用的方法中使用ProductFeginClient 完成微服务调用
/** * 订单控制层 */ @RestController @RequestMapping("/order") public class OrderController { @Autowired private ProductFeignClient productFeignClient; /** * 通过订单系统,调用商品服务根据id查询商品信息 * @param id * @return */ @GetMapping("/buy/{id}") public Product findById(@PathVariable("id") Long id) { return productFeignClient.findById(id); } }
5.测试效果
Feign 和Ribbon 的联系:
Ribbon是一个基于 HTTP 和 TCP 客户端 的负载均衡的工具。它可以在客户端配置RibbonServerList(服务端列表),使用 HttpClient 或 RestTemplate 模拟http请求,步骤相当繁琐。
Feign 是在 Ribbon的基础上进行了一次改进,是一个使用起来更加方便的 HTTP 客户端。采用接口的方式, 只需要创建一个接口,然后在上面添加注解即可 ,将需要调用的其他服务的方法定义成抽象方法即可, 不需要自己构建http请求。然后就像是调用自身工程的方法调用,而感觉不到是调用远程方法,使得编写客户端变得非常容易。
负载均衡:
Feign 中本身已经集成了Ribbon依赖和自动配置,因此我们不需要额外引入依赖,也不需要再注册RestTemplate 对象。
另外,我们可以像配置Ribbon那样,通过 ribbon.xx 来进行全局配置,也可以通过 服务名.ribbon.xx 来对指定服务配置负载均衡策略。
服务调用Feign高级:
Feign的配置
从Spring Cloud Edgware 版本开始,Feign支持使用属性自定义Feign,Feign支持如下配置项:
feign: client: config: feignName: # 定义FeginClient的名称 connectTimeout: 5000 # 建立连接的超时时长 readTimeout: 5000 # 读取超时时长 # 配置Feign的日志级别,相当于代码配置方式中的Logger loggerLevel: full # Feign的错误解码器 errorDecoder: com.example.SimpleErrorDecoder # 配置重试 retryer: com.example.SimpleRetryer # 配置请求拦截器 requestInterceptors: - com.example.FooRequestInterceptor - com.example.BarRequestInterceptor
#配置熔断不处理404异常 decode404: false
请求压缩
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 # 设置触发压缩的大小下限
注:上面的数据类型、压缩大小下限均为默认值。
日志级别
在开发或者运行阶段往往希望看到Feign请求过程的日志记录,默认情况下Feign的日志是没有开启的。
要想用属性配置方式来达到日志效果,只需在 application.yml 中添加如下内容即可:
feign: client: config: product-service: loggerLevel: FULL logging: level: com.fgy.order.fegin.ProductFeginClient: debug
logging.level.xx : debug : Feign日志只会对日志级别为debug的做出响应
feign.client.config.product-service.loggerLevel : 配置Feign的日志有四种
日志级别:
NONE 【性能最佳,适用于生产】:不记录任何日志(默认值)
BASIC 【适用于生产环境追踪问题】:仅记录请求方法、URL、响应状态代码以及执行时间
HEADERS :记录BASIC级别的基础上,记录请求和响应的header。
FULL 【比较适用于开发及测试环境定位问题】:记录请求和响应的header、body和元数据。