当前位置：首页 > news >正文

spring-cloud-starter-openfeign现实中的运行逻辑

news 2026/5/12 13:18:49

spring-cloud-starter-openfeign现实中的运行逻辑

spring-cloud-starter-openfeign 是 Spring Cloud 生态中声明式的 HTTP 客户端，核心作用是让你像调用本地方法一样调用远程 HTTP 接口，不用手写复杂的 RestTemplate/OkHttp 代码，大幅简化微服务间的通信。

· 声明式：你只需要定义一个接口，加几个注解，Spring 会自动帮你实现接口的 HTTP 调用逻辑，不用写一行请求代码。
· 底层依赖：基于 Netflix Feign 封装，默认用 Spring MVC 注解（@GetMapping/@PostMapping 等），也兼容 Feign 原生注解。
· 核心优势：集成负载均衡（默认 Ribbon）、熔断器（Hystrix/Sentinel）、请求 / 响应拦截、参数解析等，开箱即用。

安装依赖

<!--SpringCloudOpenFeign核心依赖--><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-openfeign</artifactId><!--版本建议和SpringCloud版本匹配，比如2023.0.0--><version>2023.0.0</version></dependency><!--若需要负载均衡（微服务必加）--><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-loadbalancer</artifactId></dependency>

定义 Feign 客户端接口

假设你要调用远程服务 SC-USER的 /user/{id} 接口：

importorg.springframework.cloud.openfeign.FeignClient;importorg.springframework.web.bind.annotation.GetMapping;importorg.springframework.web.bind.annotation.PathVariable;// name：远程服务名（注册中心中的服务名），url：本地测试可直接指定地址（非微服务场景）@FeignClient(name=" sc-user")publicinterfaceUserFeignClient{// 完全复用 Spring MVC 注解，和本地 Controller 写法一致@GetMapping("/user/{id}")UserDTOgetUserById(@PathVariable("id")Longid);// 复杂请求示例：POST + 请求体@PostMapping("/user")UserDTOcreateUser(@RequestBodyUserDTOuserDTO);}// 配套的实体类（和远程服务返回结构一致）classUserDTO{privateLongid;privateStringname;privateIntegerage;}

配置路由网关

spring:application:name:sc-gateway cloud:nacos:discovery:server-addr:192.168.0.54:****metadata:region:default# 路由网关配置 gateway:# 设置与服务注册发现组件结合，这样可以采用服务名的路由策略 discovery:locator:enabled:true# 配置路由规则 routes:# 采用自定义路由ID（有固定用法，不同的 id 有不同的功能，详见：https://cloud.spring.io/spring-cloud-gateway/2.0.x/single/spring-cloud-gateway.html#gateway-route-filters）-id:SC-USER# 采用LoadBalanceClient方式请求，以 lb://开头，后面的是注册在Nacos上的服务名 uri:lb://sc-user #Predicate翻译过来是“谓词”的意思，必须，主要作用是匹配用户的请求，有很多种用法 predicates:#Method方法谓词，这里是匹配GET和POST等请求-Path=/user/** filters: - StripPrefix=1 profiles: active: local main: allow-bean-definition-overriding: true banner-mode: "off" #开启sentinel适配feign feign: sentinel: enabled: true ribbon: ReadTimeout: 60000 ConnectTimeout: 60000 management: endpoints: web: exposure: #include: ["beans","metrics","info","health","loggers"] include: "*" security: enabled: false

添加负载均衡

依赖支持

<!--OpenFeign核心依赖--><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-openfeign</artifactId><version>2023.0.0</version></dependency><!--负载均衡核心依赖（必须加，否则无法根据服务名寻址）--><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-loadbalancer</artifactId></dependency><!--注册中心依赖（以Nacos为例，根据你的注册中心替换）--><dependency><groupId>com.alibaba.cloud</groupId><artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId><version>2023.0.1.0</version></dependency>

开启服务发现和 Feign

importorg.springframework.boot.SpringApplication;importorg.springframework.boot.autoconfigure.SpringBootApplication;importorg.springframework.cloud.client.discovery.EnableDiscoveryClient;importorg.springframework.cloud.openfeign.EnableFeignClients;// 开启服务发现（从注册中心获取实例）@EnableDiscoveryClient// 开启 Feign 客户端扫描@EnableFeignClients@SpringBootApplicationpublicclassFeignConsumerApplication{publicstaticvoidmain(String[]args){SpringApplication.run(FeignConsumerApplication.class,args);}}

调用 Feign 接口（负载均衡自动生效）

importorg.springframework.web.bind.annotation.GetMapping;importorg.springframework.web.bind.annotation.PathVariable;importorg.springframework.web.bind.annotation.RestController;importjavax.annotation.Resource;@RestControllerpublicclassUserController{@ResourceprivateUserFeignClientuserFeignClient;@GetMapping("/user/{id}")publicStringgetUser(@PathVariableLongid){// 多次调用会自动分发到不同实例（默认轮询）returnuserFeignClient.getUserById(id);}}