SpringCloud学习总结（八）——服务调用Feign

案例准备

用例spring_cloud_feign 项目地址：传送门

 

一、服务调用Feign入门

前面我们使用的RestTemplate实现REST API调用，代码大致如下：

/**
     * 基于ribbon的形式调用远程微服务
     *  1.使用@LoadBalanced声明RestTemplate
     *  2.使用服务名称替换ip地址
     */
    @RequestMapping(value = "/buy/{id}",method = RequestMethod.GET)
    public Product findById(@PathVariable Long id) {
        //服务名称service-product替换ip地址
        Product product = restTemplate.getForObject("http://service-product/product/"+id,Product.class);
        return product;
    }

由代码可知，我们是使用拼接字符串的方式构造URL的，该URL只有一个参数。但是，在现实中，URL 中往往含有多个参数。这时候我们如果还用这种方式构造URL，那么就会非常痛苦。那应该如何解决？我们带着这样的问题进入到本章的学习。

1、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的使用更加方便。

 

2、基于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的支持功能

@SpringBootApplication
@EntityScan("cn.hzp.order.domain")
//激活Feign
@EnableFeignClients
public class OrderApplication {
    public static void main(String[] args) {
        SpringApplication.run(OrderApplication.class,args);
    }
}

（3）配置调用商品服务的接口

/**
 * 声明需要调用的微服务名称
 *  @FeignClient
 *      * name : 服务提供者的名称
 */
@FeignClient(name="service-product")
public interface ProductFeignClient {
​
    /**
     * 配置需要调用的微服务接口
     */
    @RequestMapping(value="/product/{id}",method = RequestMethod.GET)
    public Product findById(@PathVariable("id") Long id);
}

（4）订单服务通过自动的接口调用商品服务

其程序最终还是通过Feign转化成restTemplate方式调用商品服务。

@RestController
@RequestMapping("/order")
public class OrderController {
    @Autowired
    private ProductFeignClient productFeignClient;
​
    /**
     * 通过Feign方式，声明式调用接口
     */
    @RequestMapping(value = "/buy/{id}",method = RequestMethod.GET)
    public Product findById(@PathVariable Long id) {
​
        //调用接口实现调用商品服务。本质上还是调用restTemplate的方式，feign会进行转化
        Product product= productFeignClient.findById(id);
        // Product product = restTemplate.getForObject("http://service-product/product/"+id,Product.class);
        return product;
    }
}

​

（5）测试效果

3、Feign 和Ribbon的联系

Ribbon是一个基于 HTTP 和 TCP 客户端 的负载均衡的工具。它可以 在客户端 配置RibbonServerList（服务端列表），使用 HttpClient 或 RestTemplate 模拟http请求，步骤相当繁琐。

Feign 是在 Ribbon的基础上进行了一次改进，是一个使用起来更加方便的 HTTP 客户端。采用接口的方式， 只需要创建一个接口，然后在上面添加注解即可 ，将需要调用的其他服务的方法定义成抽象方法即可， 不需要自己构建http请求。然后就像是调用自身工程的方法调用，而感觉不到是调用远程方法，使得编写客户端变得非常容易

 

4、负载均衡

Feign 中本身已经集成了Ribbon依赖和自动配置，因此我们不需要额外引入依赖，也不需要再注册RestTemplate 对象。另外，我们可以像上节课中讲的那样去配置Ribbon，可以通过 ribbon.xx 来进行全局配置。也可以通过 服务名 .ribbon.xx 来对指定服务配置：

启动两个 product_service，端口为9001,9011 ，重新测试可以发现使用Ribbon的轮询策略进行负载均衡

 

二、服务调用Feign高级

1、Feign的配置

从Spring Cloud Edgware开始，Feign支持使用属性自定义Feign。对于一个指定名称的Feign Client（例如该Feign Client的名称为 feignName ），Feign支持如下配置项：

​

feign:
  client:
    config:
      feignName: ##定义FeginClient的名称
        connectTimeout: 5000  # 相当于Request.Options
        readTimeout: 5000   # 相当于Request.Options
        # 配置Feign的日志级别，相当于代码配置方式中的Logger
        loggerLevel: full
        # Feign的错误解码器，相当于代码配置方式中的ErrorDecoder
        errorDecoder: com.example.SimpleErrorDecoder
        # 配置重试，相当于代码配置方式中的Retryer
        retryer: com.example.SimpleRetryer
        # 配置拦截器，相当于代码配置方式中的RequestInterceptor
         requestInterceptors:
            - com.example.FooRequestInterceptor
            - com.example.BarRequestInterceptor
         decode404: false

• feignName ：FeginClient的名称

• connectTimeout ： 建立链接的超时时长

• readTimeout ： 读取超时时长

• loggerLevel: Fegin 的日志级别

• errorDecoder ：Feign的错误解码器

• retryer ： 配置重试

• requestInterceptors ： 添加请求拦截器

• decode404 ： 配置熔断不处理404异常

 

2、请求压缩

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 # 设置触发压缩的大小下限

注：上面的数据类型、压缩大小下限均为默认值

 

3、查看被调用的服务的日志

在开发或者运行阶段往往希望看到Feign请求过程的日志记录，默认情况下Feign的日志是没有开启的。要想用属性配置方式来达到日志效果，只需在 application.yml 中添加如下内容即可：

#配置feign日志的输出
#日志级别  NONE : 不输出日志(高)   BASIC: 适用于生产环境追踪问题    HEADERS : 在BASIC的基础上,记录请求和响应头信息   FULL : 记录所有
feign:
  client:
    config:
      service-product:  #需要调用的服务名称，这里查询商品服务的日志情况
        loggerLevel: FULL   #日志级别
logging:
  level:
    cn.hzp.order.feign.ProductFeignClient: debug #只查看商品服务接口的调用日志

• logging.level.xx : debug : Feign日志只会对日志级别为debug的做出响应

• feign.client.config.shop -service-product.loggerLevel : 配置Feign的日志Feign有四种日志级别：

  • NONE 【性能最佳，适用于生产】：不记录任何日志（默认值）

  • BASIC 【适用于生产环境追踪问题】：仅记录请求方法、URL、响应状态代码以及执行时间

  • HEADERS ：记录BASIC级别的基础上，记录请求和响应的header。

  • FULL 【比较适用于开发及测试环境定位问题】：记录请求和响应的header、body和元数据。

 

 

4、 源码分析

//TODO 待补充

 

 

 

---

感谢itheima提供的材料