SpringCloud之OpenFeign

xvanzai2024-11-132025-03-24

在使用Nacos（注册中心）实现服务治理和利用RestTempalte实现服务远程调用时，发现远程调用的代码过于复杂：

具体参考发现并调用服务部分

该调用方式不仅复杂，并且和本地方法调用的形式差异太大。

为了统一编程体验，需要改变远程调用的开发方式，让远程调用像本地方法调用一样简单。

OpenFeign

其实远程调用的关键点就在于四个：

请求方式
请求路径
请求参数
返回值类型

OpenFeign可以利用SpringMVC的相关注解来声明上述4个参数，然后基于动态代理帮我们生成远程调用的代码，而无需我们手动再编写。

快速入门

引入依赖

在消费者服务的pom.xml中引入OpenFeign的依赖和loadBalancer依赖：

<!--openFeign-->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
<!--负载均衡器-->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-loadbalancer</artifactId>
</dependency>

启用OpenFeign

接下来，我们在消费者服务启动类上添加注解@EnableFeiginClients，启动OpenFeign功能。

**@EnableFeignClients**
@MapperScan("com.xx.xx.mapper")
@SpringBootApplication
public class Application{
	public static void main(String[] args){
			SpringApplication.run(CApplication.class,args);
		}
}

编写OpenFeign客户端

定义一个新的接口，编写Feign客户端：

实例代码如下：

package com.xx.xx.client;

import com.hmall.cart.domain.dto.ItemDTO;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;

import java.util.List;

@FeignClient("item-service")
public interface ItemClient {

    @GetMapping("/items")
    List<ItemDTO> queryItemByIds(@RequestParam("ids") Collection<Long> ids);
}

这里只需要声明接口，无需实现方法。接口中的几个关键信息：

@FeignClient("item-service") ：声明服务名称
@GetMapping ：声明请求方式
@GetMapping("/items") ：声明请求路径
@RequestParam("ids") Collection<Long> ids ：声明请求参数
List<ItemDTO> ：返回值类型

有了上述信息，OpenFeign就可以利用动态代理帮我们实现这个方法，并且向http://item-service/items发送一个GET请求，携带ids为请求参数，并自动将返回值处理为List<ItemDTO>。

我们只需要直接调用这个方法，即可实现远程调用了。

使用FeignClient

最后，我们直接调用ItemClient的方法：

// 注册
private final ItemClient itemClient;

// 使用
List<ItemDTO> items = itemClient.queryItemByIds(itemIds);

feign替我们完成了服务拉取、负载均衡、发送http请求的所有工作，是不是看起来优雅多了。

而且，这里我们不再需要RestTemplate了，还省去了RestTemplate的注册。

连接池

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

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

因此我们通常会使用带有连接池的客户端来代替默认的HttpURLConnection。比如，我们使用OK Http.

引入依赖

在pom.xml中引入依赖：

<!--OK http 的依赖 -->
<dependency>
  <groupId>io.github.openfeign</groupId>
  <artifactId>feign-okhttp</artifactId>
</dependency>

开启连接池

在application.yml配置文件中开启Feign的连接池功能：

1
2
3

feign:
  okhttp:
    enabled: true # 开启OKHttp功能

重启服务，连接池就生效了。

日志配置

OpenFeign只会在FeignClient所在包的日志级别为DEBUG时，才会输出日志。而且其日志级别有4级：

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

Feign默认的日志级别就是NONE，所以默认我们看不到请求日志。

定义日志级别

新建一个配置类，定义Feign的日志级别：

代码如下：

import feign.Logger;
import org.springframework.context.annotation.Bean;

public class DefaultFeignConfig {
    @Bean
    public Logger.Level feignLogLevel(){
        return Logger.Level.FULL;
    }
}