Spring Cloud OpenFeign 优雅实现远程调用

2. 开启功能

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

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

3. 编写 Feign 客户端

基于 Spring MVC 注解声明远程调用信息。注意 @FeignClient 的 value 指定服务名，用于服务发现；path 定义统一前缀。

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

4. 执行远程调用

注入客户端接口，直接调用方法即可，无需手动拼接 URL。

@Autowired
private ProductApi productApi;

public OrderInfo selectOrderById(Integer orderId) {
    OrderInfo orderInfo = orderMapper.selectOrderById(orderId);
    // 这里看起来像本地方法调用，底层自动处理 HTTP 请求
    ProductInfo productInfo = productApi.getProductById(orderInfo.getProductId());
    orderInfo.setProductInfo(productInfo);
    return orderInfo;
}

对比 RestTemplate 方式，代码量显著减少，逻辑更加清晰。

参数传递方式

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

单个参数

服务提供方：

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

Feign 客户端：

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

多个参数

使用多个 @RequestParam 绑定：

// 服务端
@RequestMapping("/p2")
public String p2(Integer id, String name) { ... }

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

对象传递

当需要传递复杂对象时，可以使用 @SpringQueryMap（或 @QueryMap）注解将对象属性映射为查询参数。

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

JSON 传递

若需传递完整 JSON 体，使用 @RequestBody 注解。

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

最佳实践

在实际项目中，为了降低耦合度，通常建议将 Feign 接口抽取出来复用。

方案一：接口继承

定义一个公共接口，服务提供方实现该接口，消费方 Feign 接口继承它。

1. 创建公共模块：新建一个 Jar 包模块存放通用接口。
2. 编写接口：

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

3. 服务提供方实现：

@RestController
public class ProductController implements ProductInterface {
    // 实现具体逻辑
}

4. 服务消费方继承：

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

这种方式简单直接，适合小型项目。

方案二：独立 API 模块（推荐）

企业级开发中，更推荐将 Feign 接口及实体类打包成独立的 API 模块。

1. 创建 Module：新建 product-api 模块。
2. 引入依赖：包含 spring-cloud-starter-openfeign。
3. 编写 API：将接口和 DTO 放入该模块，Maven 打包。
4. 消费方使用：
   • 删除本地 ProductApi 和 ProductInfo。
   • 引入 product-api 依赖。
   • 修改扫描路径，确保 @EnableFeignClients 能扫描到外部 jar 中的接口。

@EnableFeignClients(basePackages = {"com.bite.api"})
@SpringBootApplication
public class OrderServiceApplication { ... }

这种方式实现了真正的解耦，服务提供方负责接口定义，消费方仅依赖契约，便于版本管理和团队协作。

总结

OpenFeign 通过声明式接口极大简化了微服务间的 HTTP 调用。相比 RestTemplate，它在代码可读性和维护性上优势明显。掌握参数传递的各种注解以及接口抽取的最佳实践，能让你的微服务架构更加健壮和灵活。