SpringCloud Alibaba study-5-Feign (微服务调用)

1. 什么是Feign

Feign是Netflix开发的声明式、模板化的HTTP客户端，其灵感来自Retrofit、JAXRS-2.0以及
WebSocket。Feign可帮助我们更加便捷、优雅地调用HTTP API。

Feign支持多种注解，例如Feign自带的注解或者JAX-RS注解等。

Spring Cloud openfeign对Feign进行了增强，使其支持Spring MVC注解，另外还整合了
Ribbon和Nacos，从而使得Feign的使用更加方便

2. 优势

Feign可以做到使用 HTTP 请求远程服务时就像调用本地方法一样的体验，开发者完全感知不
到这是远程方法，更感知不到这是个 HTTP 请求。它像 Dubbo 一样，consumer 直接调用接
口方法调用 provider，而不需要通过常规的 Http Client 构造请求再解析返回数据。它解决了
让开发者调用远程接口就跟调用本地方法一样，无需关注与远程的交互细节，更无需关注分布
式环境开发。

3. SpringCloudAlibaba 快速整合OpenFeign

1. 新建模块order-openfeign
2. 引入依赖

<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!--nacos 服务注册发现-->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>
		
		<!--openfeign 服务调用-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>

2. 编写调用接口+@FeignClient注解
   

@FeignClient(name = "stock-service",path = "/stock")
public interface StockFeignService {

    @GetMapping("/reduce")
    public String reduce();
}

3. 在启动类上添加 @EnableFeignClients 注解

@SpringBootApplication
@EnableFeignClients
public class OrderOpenFeignApplication {

    public static void main(String[] args) {
        SpringApplication.run(OrderOpenFeignApplication.class);
    }

}

4. 发起调用，像调用本地方法一样调用远程服务

@RestController
@RequestMapping("/order")
public class OrderController {

    @Autowired
    private StockService stockService;

    @RequestMapping("/add")
    public String add() {
        String msg = stockFeignService.reduce();
        return "Hello Feign!  msg:"+msg;
    }
}

4. Spring Cloud OpenFeign的自定义配置及使用

Feign 提供了很多的扩展机制，让用户可以更加灵活的使用。

4.1 日志配置

有时候我们遇到 Bug，比如接口调用失败、参数没收到等问题，或者想看看调用性能，就需要配置 Feign 的日志了，以此让 Feign 把请求信息输出来。

1. 定义一个配置类，指定日志级别:

/**
 * 全局配置：使用@Configuration 会将配置作用于所有的服务提供方
 * 局部配置：如果之针对某一个服务进行配置，不要加@Configuration,并且在@FeignClient中设置 Configuration属性
 */
@Configuration
public class FeignConfig {

    @Bean
    public Logger.Level feignLoggerLevel() {
        return Logger.Level.FULL;
    }

}

通过源码可以看到日志等级有 4 种，分别是：

1. NONE【性能最佳，适用于生产】：不记录任何日志（默认值）。
2. BASIC【适用于生产环境追踪问题】：仅记录请求方法、URL、响应状态代码以及
   执行时间。
3. HEADERS：记录BASIC级别的基础上，记录请求和响应的header。
4. FULL【比较适用于开发及测试环境定位问题】：记录请求和响应的header、body
   和元数据。

2. 编写StockFeignService

@FeignClient(name = "stock-service",path = "/stock")
public interface StockFeignService {

    @RequestMapping("/reduce")
    String reduce();
}

3. 此时调用接口的话，发现不会右日志输出；
在yml配置文件中执行 Client 的日志级别才能正常输出日志，格式是"logging.level.feign接口包路径=debug"

logging:
  level:
    com.zhx.order.feign : debug

注意：哈可以通过yml文件进行局部配置，如：

feign:
  client:
    config:
      stock-service:
        loggerLevel: BASIC

4.2 契约配置

Spring Cloud 在 Feign 的基础上做了扩展，使用 Spring MVC 的注解来完成Feign的功能。原生的 Feign 是不支持 Spring MVC 注解的，如果你想在 Spring Cloud 中使用原生的注解方式来定义客户端也是可以的，通过配置契约来改变这个配置，Spring Cloud 中默认的是 SpringMvcContract。

Spring Cloud 1 早期版本就是用的原生Fegin. 随着netflix的停更替换成了OpenFeign

@Bean
    public Contract feignContract() {
        return new Contract.Default();
    }

注意：修改契约配置后，OrderFeignService 不再支持springmvc的注解，需要使用Feign原
生的注解

使用原生的注解：

@FeignClient(value = "mall‐order",path = "/order")
public interface OrderFeignService {
	@RequestLine("GET /findOrderByUserId/{userId}")
	public R findOrderByUserId(@Param("userId") Integer userId);
 }

也可使用yml方式：

feign:
  client:
  	config:
  	  mall‐order: #对应微服务
  		loggerLevel: FULL
  		contract: feign.Contract.Default #指定Feign原生注解契约配置

4.3 超时时间配置

通过 Options 可以配置连接超时时间和读取超时时间，Options 的第一个参数是连接的超时
时间（ms），默认值是 2s；第二个是请求处理的超时时间（ms），默认值是 5s。

全局配置：

@Configuration
public class FeignConfig {
  @Bean
   public Request.Options options() {
		 return new Request.Options(5000, 10000);
	 }
 }

yml中配置：

feign:
  client:
    config:
      mall‐order: #对应微服务
        # 连接超时时间，默认2s
        connectTimeout: 5000
  		# 请求处理超时时间，默认5s
  		readTimeout: 10000

补充说明： Feign的底层用的是Ribbon，但超时时间以Feign配置为准