服务注册与分布式协调 / 系统课时

用 OpenFeign 简化服务调用

用 OpenFeign 简化服务调用

这一课把手写 HTTP URL 的调用改成 OpenFeign 声明式接口:你只描述下游服务名、路径和参数,Feign 生成代理并完成请求。重点不是“少写几行代码”,而是看清服务名如何继续交给 Nacos 与 Spring Cloud LoadBalancer 解析。

学习目标

  • 定义 @FeignClient 接口并从业务代码中发起调用
  • 说明 Feign 代理、LoadBalancer 与 Nacos Discovery 的调用边界
  • 识别会绕过服务发现的配置方式

准备 Feign 与服务发现依赖

调用方需要 OpenFeign、Nacos Discovery 和 Spring Cloud LoadBalancer。下面是现有 Maven 项目的依赖片段,具体版本交给 Spring Cloud 与 Spring Cloud Alibaba BOM 管理。

xml
<!-- 片段示例:放入现有 Spring Boot 项目的 dependencies。 -->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-loadbalancer</artifactId>
</dependency>

在启动类启用 Feign 客户端扫描。下面是片段示例,依赖现有 Spring Boot 应用的包结构与导入:

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

调用方还要连接保存 inventory-service 实例信息的 Nacos:

yaml
spring:
  application:
    name: order-service
  cloud:
    nacos:
      discovery:
        server-addr: <HOST>:8848

用接口描述下游调用

假设下游已经注册为 inventory-service,并提供 GET /inventory/{id}。Feign 客户端只需要声明服务名、HTTP 方法、路径与参数,不需要拼接固定地址。下面的接口与控制器都是片段示例,放在已启用 Feign 扫描的调用方应用中。

java
@FeignClient(name = "inventory-service")
public interface InventoryClient {
    @GetMapping("/inventory/{id}")
    Map<String, Object> inventory(@PathVariable("id") long id);
}

业务控制器直接调用 Java 接口:

java
@RestController
public class OrderController {
    private final InventoryClient inventoryClient;

    public OrderController(InventoryClient inventoryClient) {
        this.inventoryClient = inventoryClient;
    }

    @GetMapping("/orders/{id}/stock")
    public Map<String, Object> stock(@PathVariable long id) {
        // 这里调用的是 Feign 生成的代理,实际网络请求随后才发生。
        return inventoryClient.inventory(id);
    }
}

相比直接使用 RestTemplate,业务代码不再负责构造 URL、选择 HTTP 方法或处理路径参数拼接;这些信息都集中在接口声明上。

服务名解析发生在哪里

@FeignClient(name = "inventory-service") 中的 name 首先是 Feign 的客户端标识。当没有配置固定 url,且 Spring Cloud LoadBalancer 在类路径中时,请求会进入负载均衡客户端;它再通过服务发现获取 inventory-service 的实例列表,并选择一个真实地址执行 HTTP 请求。

OpenFeign 从代理接口到 Nacos 实例解析的调用链

这条链路里,Feign 负责“如何调用”,LoadBalancer 负责“调用哪个实例”,Nacos Discovery 负责“当前有哪些实例”。三者职责不同,但最终共同把一个逻辑服务名变成可访问的网络地址。

发起请求并核对结果

启动一个或多个 inventory-service 实例,再启动 order-service。下面假设订单服务监听 8080。

bash
curl -s -o /tmp/order-stock.json -w '%{http_code}\n' http://localhost:8080/orders/1/stock
cat /tmp/order-stock.json

预期输出

text
200
{"itemId":1,"available":true,"servedBy":<PORT>}

<PORT> 是实际被选中的下游实例端口;如果注册了多个实例,多次请求可能出现不同端口。它表明调用并不是固定打到某一个写死的地址。

避免无意中绕过发现机制

下面这种写法会把调用固定到明确地址:

java
@FeignClient(name = "inventory-service", url = "http://127.0.0.1:8081")
public interface InventoryClient {
    @GetMapping("/inventory/{id}")
    Map<String, Object> inventory(@PathVariable("id") long id);
}

这是片段示例,常见于本地测试或对接不受服务注册中心管理的外部服务。对 Nacos 内部微服务来说,一旦配置固定 url,该 Feign 客户端就不再需要把服务名解析成实例地址,也就失去了基于注册中心进行实例切换的能力。

因此,内部服务调用要把 name 当成稳定契约,把实例地址交给 Nacos 与 LoadBalancer;OpenFeign 的价值是把这条治理链路隐藏在类型安全的 Java 接口之后,而不是把固定地址换一种方式写进注解。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

用 OpenFeign 简化服务调用

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通