Spring Cloud 远程调用：OpenFeign 优雅实践

3. 编写 Feign 客户端

定义一个接口来描述远程调用的信息，使用 @FeignClient 注解指定服务名：

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

这里有两个关键点：

• value/name：指定微服务名称，底层会结合 Spring Cloud LoadBalancer 进行负载均衡。
• path：定义当前 Feign Client 的统一前缀，避免重复书写。

4. 调用服务

在业务逻辑中直接注入这个接口，就像调用本地 Bean 一样：

@Autowired
private ProductApi productApi;

public OrderInfo selectOrderById(Integer orderId) {
    OrderInfo orderInfo = orderMapper.selectOrderById(orderId);
    // 直接调用接口方法，无需关心 URL 拼接
    ProductInfo productInfo = productApi.getProductById(orderInfo.getProductId());
    orderInfo.setProductInfo(productInfo);
    return orderInfo;
}

对比 RestTemplate 方式，代码量显著减少，且结构清晰。

参数传递详解

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

1. 单个参数 (Query Param)

服务提供方：

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

Feign 客户端：

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

2. 多个参数

使用多个 @RequestParam 即可绑定：

// 服务端
@RequestMapping("/p2")
public String p2(@RequestParam("id") Integer id, @RequestParam("name") String name) {
    return "id:" + id + ",name:" + name;
}

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

测试请求示例：http://127.0.0.1:8080/feign/o2?id=5&name=zhangsan

3. 对象参数

如果传递的是复杂对象，通常建议使用 @RequestBody 以 JSON 格式传输，这样能保持数据结构完整。

服务提供方：

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

Feign 客户端：

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

提示：确保消费方和服务端都引入了 Jackson 依赖，以便自动处理 JSON 序列化。

最佳实践

在实际项目中，Feign 接口往往与服务提供者的 Controller 高度重合。为了避免重复定义，业界有两种主流做法。

1. 接口继承方式

将公共接口提取出来，服务提供方实现该接口，消费方 Feign 接口继承该接口。

定义公共接口：

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

服务提供方实现：

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

服务消费方继承：

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

这种方式简单直接，适合小型项目或模块内部复用。

2. 独立模块抽取（推荐）

企业级开发中，更推荐将 Feign 接口和 DTO 抽取为独立的 Jar 包（如 product-api）。

步骤：

1. 创建新 Module，打包成 Jar。
2. 消费方引入该依赖。
3. 在启动类指定扫描路径：

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

或者指定具体的 Client 类：

@EnableFeignClients(clients = {ProductApi.class})

这种方式解耦更彻底，便于多服务共享契约，是微服务治理中的常见模式。

总结

OpenFeign 通过声明式接口极大地简化了微服务间的 HTTP 调用。相比 RestTemplate，它在代码可读性、类型安全和维护成本上都具有明显优势。掌握参数传递细节以及接口抽取的最佳实践，能让你的微服务架构更加健壮和易于扩展。