微服务远程调用openFeign整合

程序员Leo

发布于 2023-08-07 21:43:35

7590

在上一节 Ribbon 和 Nacos 服务注册中心，我们学习了使用 nacos 进行服务注册和服务发现以及 Ribbon 负载均衡以及他的简单原理剖析。这一节我们来继续认识 SpringCloud 的一些核心组件 openFeign 。

# 1. 问题分析

先来看我们以前利用 RestTemplate 发起远程调用的代码：

存在的问题：

在服务消费者中，我们把 url 地址硬编码到代码中，不方便后期维护。
在服务消费者中，不清楚服务提供者的状态。
服务消费者调用服务提供者时候，如果出现故障能否及时发现不向用户抛出异常页面？
RestTemplate 这种请求调用方式是否还有优化空间？能不能类似于 Dubbo 那样玩？

# 2. 了解 Feign

Feign 是一个声明式的 http 客户端，官方地址：https://github.com/OpenFeign/feign

其作用就是帮助我们优雅的实现 http 请求的发送，解决上面提到的问题。

# 3. 项目整合 Feign

Fegin 的使用步骤如下：

# 3.1 引入依赖

我们在 order-service 服务的 pom 文件中引入 feign 的依赖：

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

# 3.2 添加注解

在 order-service 的启动类添加注解开启 Feign 的功能：

# 3.3 编写 Feign 客户端

package com.cisyam.order.client;

import com.cisyam.pojo.User;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;

/**
 * @author gaoziman
 */
@FeignClient("userservice")
public interface UserClient {

    /**
     * 通过用户后编号去获取用户对象
     * @param id
     * @return
     */
    @GetMapping("/user/{id}")
    User findById(@PathVariable("id") Long id);
}

这个客户端主要是基于 SpringMVC 的注解来声明远程调用的信息，比如：

服务名称： userservice
请求方式： GET
请求路径： /user/{id}
请求参数： Long id
返回值类型： User

这样， Feign 就可以帮助我们发送 http 请求，无需自己使用 RestTemplate 来发送了。

# 3.4 测试

修改 order-service 中的 OrderService 类中的 queryOrderById 方法，使用 Feign 客户端代替 RestTemplate：

# 3.5 总结

使用 Feign 的步骤：

① 引入依赖

② 添加 @EnableFeignClients 注解

③ 编写 FeignClient 接口

④ 使用 FeignClient 中定义的方法代替 RestTemplate

# 4. 自定义配置

Feign 可以支持很多的自定义配置，如下表所示：

类型	作用	说明
feign.Logger.Level	修改日志级别	包含四种不同的级别：NONE、BASIC、HEADERS、FULL
feign.codec.Decoder	响应结果的解析器	http 远程调用的结果做解析，例如解析 json 字符串为 java 对象
feign.codec.Encoder	请求参数编码	将请求参数编码，便于通过 http 请求发送
feign. Contract	支持的注解格式	默认是 SpringMVC 的注解
feign. Retryer	失败重试机制	请求失败的重试机制，默认是没有，不过会使用 Ribbon 的重试

一般情况下，默认值就能满足我们使用，如果要自定义时，只需要创建自定义的 @Bean 覆盖默认 Bean 即可。

下面以日志为例来演示如何自定义配置。

# 4.1 配置文件方式

基于配置文件修改 feign 的日志级别可以针对单个服务：

feign:  
  client:
    config: 
      userservice: # 针对某个微服务的配置
        loggerLevel: FULL #  日志级别

也可以针对所有服务：

feign:  
  client:
    config: 
      default: # 这里用default就是全局配置，如果是写服务名称，则是针对某个微服务的配置
        loggerLevel: FULL #  日志级别

而日志的级别分为四种：

NONE：不记录任何日志信息，这是默认值。
BASIC：仅记录请求的方法，URL 以及响应状态码和执行时间
HEADERS：在 BASIC 的基础上，额外记录了请求和响应的头信息
FULL：记录所有请求和响应的明细，包括头信息、请求体、元数据。

# 4.2 Java 代码方式

也可以基于 Java 代码来修改日志级别，先声明一个类，然后声明一个 Logger.Level 的对象：

public class DefaultFeignConfiguration  {
    @Bean
    public Logger.Level feignLogLevel(){
        return Logger.Level.BASIC; // 日志级别为BASIC
    }
}

如果要全局生效，将其放到启动类的 @EnableFeignClients 这个注解中：

@EnableFeignClients(defaultConfiguration = DefaultFeignConfiguration .class)

如果是局部生效，则把它放到对应的 @FeignClient 这个注解中：

@FeignClient(value = "userservice", configuration = DefaultFeignConfiguration .class)

# 5. Feign 使用优化

Feign 底层发起 http 请求，依赖于其它的框架。其底层客户端实现包括：

URLConnection：默认实现，不支持连接池
Apache HttpClient ：支持连接池
OKHttp：支持连接池

因此提高 Feign 的性能主要手段就是使用连接池代替默认的 URLConnection。

这里我们用 Apache 的 HttpClient 来演示。

# 5.1 引入依赖

在 order-service 的 pom 文件中引入 Apache 的 HttpClient 依赖：

<!--httpClient的依赖 -->
<dependency>
    <groupId>io.github.openfeign</groupId>
    <artifactId>feign-httpclient</artifactId>
</dependency>

# 5.2 配置连接池

在 order-service 的 application.yml 中添加配置：

feign:
  client:
    config:
      default: # default全局的配置
        loggerLevel: BASIC # 日志级别，BASIC就是基本的请求和响应信息
  httpclient:
    enabled: true # 开启feign对HttpClient的支持
    max-connections: 200 # 最大的连接数
    max-connections-per-route: 50 # 每个路径的最大连接数

接下来，在 FeignClientFactoryBean 中的 loadBalance 方法中打断点：