Spring Cloud Alibaba 微服务整合 OpenFeign（五）

目录

JAVA 项目中如何实现接口调用

Httpclient

Okhttp

HttpURLConnection

RestTemplate 

什么是Feign

优势

Spring Cloud Alibaba 快速整合 OpenFeign

引入依赖

编写调用接口+@FeignClient注解

调用端在启动类上添加 @EnableFeignClients 注解

发起调用

Spring Cloud Feign 的自定义配置及使用

日志配置

契约配置

自定义拦截器实现认证逻辑

超时时间配置

---

  Spring Cloud Aibaba 学习目录

1. Spring Cloud Alibaba 微服务介绍（一）

2. Spring Cloud Alibaba 之Nacos 安装（二）

3. Spring Cloud Alibaba 微服务组件 Nacos 注册中心（三）

4. Spring Cloud Alibaba 微服务负载均衡 Ribbon（四）

5. Spring Cloud Alibaba 微服务整合 OpenFeign（五）

6. Spring Cloud Alibaba 微服务组件 Nacos 配置中心（六）

7. Spring Cloud Alibaba 微服务组件 Sentinel 服务保护（七）

8. Spring Cloud Alibaba 分布式事务概念（八）

9. Spring Cloud Alibaba 微服务组件 Seata 分布式事务（九）

10. Spring Cloud Alibaba 服务网关 Gateway（十）

11. Spring Cloud Alibaba 微服务组件 Skywalking 分布式任务链（十一）

语雀文档：Spring Cloud Aibaba 学习 · 语雀

---

JAVA 项目中如何实现接口调用

Httpclient

HttpClient 是 Apache Jakarta Common 下的子项目，用来提供高效的、最新的、功能丰富的支持 Http 协议的客户端编程工具包，并且它支持 HTTP 协议最新版本和建议。HttpClient相比传统 JDK 自带的 URLConnection，提升了易用性和灵活性，使客户端发送 HTTP 请求变得容易，提高了开发的效率。

Okhttp

一个处理网络请求的开源项目，是安卓端最火的轻量级框架，由 Square 公司贡献，用于替代HttpUrlConnection 和 Apache HttpClient。OkHttp 拥有简洁的 API、高效的性能，并支持多种协议（HTTP/2 和 SPDY）。

HttpURLConnection

HttpURLConnection 是 Java 的标准类，它继承自 URLConnection，可用于向指定网站发送GET 请求、POST 请求。HttpURLConnection 使用比较复杂，不像 HttpClient 那样容易使用。

RestTemplate 

RestTemplate 是 Spring 提供的用于访问 Rest 服务的客户端，RestTemplate 提供了多种便捷访问远程 HTTP 服务的方法，能够大大提高客户端的编写效率。上面介绍的是最常见的几种调用接口的方法，我们下面要介绍的方法比上面的更简单、方便，它就是 Feign。

---

什么是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的使用更加方便

优势

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

---

Spring Cloud Alibaba 快速整合 OpenFeign

引入依赖

<dependency>
     <groupId>org.springframework.cloud</groupId>
     <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>

编写调用接口+@FeignClient注解

@FeignClient(value="feign-stock",contextId = "FeignStockService",path = "stock")
public interface FeignStockService {


    @GetMapping("/reductStock")
    String reductStock();

}

调用端在启动类上添加 @EnableFeignClients 注解

@EnableFeignClients
@SpringBootApplication
public class FeignOrderApp {

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

发起调用

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


    private final FeignStockService feignStockService;

    @GetMapping("addOrder")
    public String addOrder(){

        String stock = feignStockService.reductStock();
        return "order remoe call feign stock=>"+stock;
    }
}

Spring Cloud Feign 的自定义配置及使用

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

日志配置

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

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

/**
 * 此处配置@Configuration注解就会全局生效，如果想指定对应微服务生效，就不能配置
 * @date: 2021/12/7 20:03
 * @return: 
 */
@Configuration
public class FeignConfig {


    /**
     * 日志级别
     * <p>
     *     1. NONE【性能最佳，适用于生产】：不记录任何日志（默认值）。
     *     2. BASIC【适用于生产环境追踪问题】：仅记录请求方法、URL、响应状态代码以及
     *        执行时间。
     *     3. HEADERS：记录BASIC级别的基础上，记录请求和响应的header。
     *     4. FULL【比较适用于开发及测试环境定位问题】：记录请求和响应的header、body
     *       和元数据。
     * </p>
     * @date: 2021/12/6 20:40
     * @return: feign.Logger.Level
     */
    @Bean
    public Logger.Level feignLoggerLevel(){

        return Logger.Level.BASIC;
    }
}

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

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

局部配置

让调用的微服务生效，在@FeignClient 注解中指定使用的配置类

/**
 * FeignStockService
 * @date: 2021/12/6 20:32
 */
@FeignClient(value="feign-stock",contextId = "FeignStockService",path = "stock",configuration = FeignConfig.class)
public interface FeignStockService {


    @GetMapping("/reductStock")
    String reductStock();

}

在 yml配置文件中执行 Client 的日志级别才能正常输出日志

# 日志
logging:
  level:
    com.zlp.feign.order.feign: debug

BASIC 级别日志

契约配置

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

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

修改契约配置，支持Feign原生的注解

/**
  * 修改契约配置，支持Feign原生的注解
  * @return
  */
 @Bean
 public Contract feignContract() {
  return new Contract.Default();
 }

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

OrderFeignService 中配置使用Feign原生的注解

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

自定义拦截器实现认证逻辑

控制拦截

/**
 * Feign 请求头拦截
 * @date: 2021/12/6 21:01
 */
@Configuration
@Slf4j(topic = "FeignRequestInterceptor")
public class FeignRequestInterceptor implements RequestInterceptor {


    @Override
    public void apply(RequestTemplate requestTemplate) {

        String accessToken = UUID.randomUUID().toString();
        log.info("accessToken={}",accessToken);
        requestTemplate.header("Authorization",accessToken);
    }
}

控制台输出

超时时间配置

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

全局配置

  /**
     *  超时配置
     * @date: 2021/12/7 20:20
     * @return: feign.Request.Options
     */
    @Bean
    public Request.Options options() {
        return new Request.Options(5000, 10000);
    }

yml 中配置

feign:
  client:
    config:
       # 连接超时时间，默认2s
      connectTimeout: 5000
       # 请求处理超时时间，默认5s
      readTimeout: 10000

测试超时情况：

---

 项目地址https://gitee.com/gaibianzlp/springcould-alibaba-example.githttps://gitee.com/gaibianzlp/springcould-alibaba-example.githttps://gitee.com/gaibianzlp/springcould-alibaba-example.git点关注不迷路，觉得对你有帮助请给一个赞或者长按一键三连，谢谢!