OpenFeign实战：Spring Cloud微服务间优雅调用指南

前言

OpenFeign 是 Spring Cloud 官方推荐的声明式 HTTP 客户端，让微服务间调用像调用本地方法一样简单。本文带你全面掌握 OpenFeign 的核心用法。
一、引入依赖

1. <dependency>
2.     <groupId>org.springframework.cloud</groupId>
3.     spring-cloud-starter-openfeign</artifactId>
4. </dependency>
6. // 启动类开启 Feign
7. @SpringBootApplication
8. @EnableFeignClients
9. public class OrderApplication {
10.     public static void main(String[] args) {
11.         SpringApplication.run(OrderApplication.class, args);
12.     }
13. }

复制代码

二、声明 Feign 客户端

1. // 调用 user-service 的 Feign 接口
2. @FeignClient(name = "user-service", path = "/api/users")
3. public interface UserFeignClient {
5.     @GetMapping("/{id}")
6.     User getUserById(@PathVariable("id") Long id);
8.     @PostMapping
9.     User createUser(@RequestBody User user);
11.     @GetMapping
12.     List<User> listUsers(@RequestParam("page") int page,
13.                           @RequestParam("size") int size);
15.     @DeleteMapping("/{id}")
16.     void deleteUser(@PathVariable("id") Long id);
17. }
19. // 在 Service 中注入使用
20. @Service
21. public class OrderService {
23.     @Autowired
24.     private UserFeignClient userFeignClient;
26.     public Order createOrder(Long userId, Long productId) {
27.         // 像调用本地方法一样调用远程服务
28.         User user = userFeignClient.getUserById(userId);
29.         // 业务逻辑...
30.     }
31. }

复制代码

三、配置超时和重试

1. # application.yml
2. feign:
3.   client:
4.     config:
5.       default:
6.         connectTimeout: 5000
7.         readTimeout: 10000
8.         loggerLevel: FULL
9.       user-service:
10.         connectTimeout: 3000
11.         readTimeout: 5000
13. # 全局超时配置
14. ribbon:
15.   ConnectTimeout: 3000
16.   ReadTimeout: 5000
17.   MaxAutoRetries: 1
18.   MaxAutoRetriesNextServer: 2

复制代码

四、Feign 日志配置

1. @Configuration
2. public class FeignConfig {
4.     @Bean
5.     public Logger.Level feignLoggerLevel() {
6.         return Logger.Level.FULL;  // 记录完整请求响应
7.     }
8. }
10. // 在 FeignClient 中使用自定义配置
11. @FeignClient(name = "user-service",
12.              configuration = FeignConfig.class)
13. public interface UserFeignClient {
14.     // ...
15. }
17. # 日志级别说明
18. # NONE: 无日志（默认）
19. # BASIC: 仅记录请求方法、URL、响应状态码、执行时间
20. # HEADERS: 记录 BASIC + 请求/响应头
21. # FULL: 记录 HEADERS + 请求/响应体

复制代码

五、请求拦截器（传递 Token）

1. @Component
2. public class FeignAuthInterceptor implements RequestInterceptor {
4.     @Override
5.     public void apply(RequestTemplate template) {
6.         // 从请求上下文获取 Token
7.         ServletRequestAttributes attributes = (ServletRequestAttributes)
8.             RequestContextHolder.getRequestAttributes();
9.         if (attributes != null) {
10.             HttpServletRequest request = attributes.getRequest();
11.             String token = request.getHeader("Authorization");
12.             if (token != null) {
13.                 // 将 Token 传递给下游服务
14.                 template.header("Authorization", token);
15.             }
16.         }
17.     }
18. }
20. // 配置拦截器
21. @Configuration
22. public class FeignConfig {
23.     @Bean
24.     public RequestInterceptor feignAuthInterceptor() {
25.         return new FeignAuthInterceptor();
26.     }
27. }

复制代码

六、Fallback 降级

1. @FeignClient(name = "user-service",
2.              fallbackFactory = UserFeignFallbackFactory.class)
3. public interface UserFeignClient {
4.     @GetMapping("/{id}")
5.     User getUserById(@PathVariable("id") Long id);
6. }
8. // 降级工厂：可以获取到异常信息
9. @Component
10. public class UserFeignFallbackFactory
11.         implements FallbackFactory<UserFeignClient> {
13.     @Override
14.     public UserFeignClient create(Throwable cause) {
15.         return new UserFeignClient() {
16.             @Override
17.             public User getUserById(Long id) {
18.                 log.error("调用 user-service 失败", cause);
19.                 return new User(id, "默认用户", "降级数据");
20.             }
21.         };
22.     }
23. }
25. # 开启降级
26. feign.circuitbreaker.enabled: true

复制代码

总结

OpenFeign 让微服务间调用变得优雅简洁。核心要点：声明式接口定义、配置超时重试、拦截器传递上下文、Fallback 实现降级保护。配合 Nacos 实现服务发现，配合 Sentinel 实现限流熔断，构建完整的微服务通信方案。

觉得有帮助请点赞收藏！有问题欢迎评论区交流
来源：程序园用户自行投稿发布，如果侵权，请联系站长删除
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！