Spring Cloud OpenFeign 远程调用实战与最佳实践

3.2 开启功能

在启动类上添加 @EnableFeignClients 注解：

@EnableFeignClients
@SpringBootApplication
public class OrderServiceApplication {
    public static void main(String[] args) {
        SpringApplication.run(OrderServiceApplication.class, args);
    }
}

3.3 编写 Feign 客户端

基于 Spring MVC 注解声明远程调用信息：

@FeignClient(value = "product-service", path = "/product")
public interface ProductApi {
    @RequestMapping("/{productId}")
    ProductInfo getProductById(@PathVariable("productId") Integer productId);
}

注解说明：

• value/name：指定微服务名称，用于服务发现，底层集成 Spring Cloud LoadBalancer 进行负载均衡。也可通过 url 属性指定具体地址。
• path：定义当前 Feign Client 的统一前缀。

3.4 远程调用

修改业务逻辑，注入 Feign 客户端：

@Autowired
private ProductApi productApi;

public OrderInfo selectOrderById(Integer orderId) {
    OrderInfo orderInfo = orderMapper.selectOrderById(orderId);
    ProductInfo productInfo = productApi.getProductById(orderInfo.getProductId());
    orderInfo.setProductInfo(productInfo);
    return orderInfo;
}

对比可见，代码量大幅减少，结构更清晰。

四、OpenFeign 参数传递

Feign 客户端与服务提供者的接口声明非常相似，支持多种参数传递方式。

4.1 传递单个参数

服务提供方：

@RequestMapping("/product")
@RestController
public class ProductController {
    @RequestMapping("/p1")
    public String p1(Integer id) {
        return "p1 接收到参数:" + id;
    }
}

Feign 客户端：

@FeignClient(value = "product-service", path = "/product")
public interface ProductApi {
    @RequestMapping("/p1")
    String p1(@RequestParam("id") Integer id);
}

测试调用：

@RequestMapping("/feign")
@RestController
public class TestFeignController {
    @Autowired
    private ProductApi productApi;

    @RequestMapping("/o1")
    public String o1(Integer id) {
        return productApi.p1(id);
    }
}

访问 http://127.0.0.1:8080/feign/o1?id=5 即可验证。

4.2 传递多个参数

使用多个 @RequestParam 进行绑定：

服务提供方：

@RequestMapping("/p2")
public String p2(Integer id, String name) {
    return "p2 接收到参数，id:" + id + ",name:" + name;
}

Feign 客户端：

@RequestMapping("/p2")
String p2(@RequestParam("id") Integer id, @RequestParam("name") String name);

调用方：

@RequestMapping("/o2")
public String o2(@RequestParam("id") Integer id, @RequestParam("name") String name) {
    return productApi.p2(id, name);
}

4.3 传递对象

服务提供方：

@RequestMapping("/p3")
public String p3(ProductInfo productInfo) {
    return "接收到对象，productInfo:" + productInfo;
}

Feign 客户端：

@RequestMapping("/p3")
String p3(@SpringQueryMap ProductInfo productInfo);

4.4 传递 JSON

服务提供方：

@RequestMapping("/p4")
public String p4(@RequestBody ProductInfo productInfo) {
    return "接收到对象，productInfo:" + productInfo;
}

Feign 客户端：

@RequestMapping("/p4")
String p4(@RequestBody ProductInfo productInfo);

调用方：

@RequestMapping("/o4")
public String o4(@RequestBody ProductInfo productInfo) {
    System.out.println(productInfo.toString());
    return productApi.p4(productInfo);
}

五、最佳实践

在实际开发中，Feign 客户端与服务提供者的 Controller 代码往往高度相似。为了简化维护，有两种推荐模式。

5.1 Feign 继承方式

将常用操作封装到公共接口中，服务提供方实现该接口，消费方直接继承。

5.1.1 创建公共 Module

新建一个 Jar 包模块（如 product-api），供双方共享。

5.1.2 引入依赖

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

5.1.3 编写接口

将 API 定义放入公共模块：

public interface ProductInterface {
    @RequestMapping("/{productId}")
    ProductInfo getProductById(@PathVariable("productId") Integer productId);
    
    @RequestMapping("/p1")
    String p1(@RequestParam("id") Integer id);
    // ... 其他方法
}

5.1.4 服务提供方实现

@RequestMapping("/product")
@RestController
public class ProductController implements ProductInterface {
    // 实现具体逻辑
}

5.1.5 服务消费方继承

@FeignClient(value = "product-service", path = "/product")
public interface ProductApi extends ProductInterface {}

5.2 Feign 抽取方式（独立模块）

企业级开发更推荐将 Feign 接口抽取为独立模块，打成 Jar 包发布。

5.2.1 创建新 Module

建立独立的 product-api 模块。

5.2.2 引入依赖

仅引入 OpenFeign 相关依赖。

5.2.3 编写 API

复制 ProductApi 和实体类到该模块，打包发布。

5.2.4 服务消费方使用

1. 删除本地的 ProductApi 和 ProductInfo。
2. 引入依赖：

<dependency>
    <groupId>org.example</groupId>
    <artifactId>product-api</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

3. 指定扫描路径：

@EnableFeignClients(basePackages = {"com.bite.api"})
@SpringBootApplication
public class OrderServiceApplication {
    public static void main(String[] args) {
        SpringApplication.run(OrderServiceApplication.class, args);
    }
}

也可以指定具体加载的客户端类：@EnableFeignClients(clients = {ProductApi.class})

六、总结

本文对比了 RestTemplate 与 OpenFeign 的差异，详细介绍了 OpenFeign 的配置、参数传递及两种最佳实践模式。合理使用 OpenFeign 能显著提升微服务调用的可维护性与开发效率。