SpringMVC注解与Feign客户端注解对比

1. 背景知识

梳理SpringMVC和Feign客户端常用注解后，本文对两类注解做个对比。

• Spring MVC中常用注解
• Feign客户端常用注解

理解两者定位（服务端 vs 客户端）是掌握注解使用的关键：

• Spring MVC注解用于服务端，描述如何解析一个HTTP请求；
• Feign客户端注解用于客户端，描述如何构造一个HTTP请求（包括URL、参数、头、体等）

2.功能定位对比

3.核心注解对比

3.1 请求映射

3.2 参数处理

3.3 特殊功能

4. 关键差异演示

4.1. URL路径差异

//Spring MVC:
@RestController
@RequestMapping("/users")
public class UserController {
    @GetMapping("/{id}")
    public User getUser(@PathVariable Long id) { ... }
}

//Feign接口中必须指定完整路径（包括类上的路径），因为Feign不支持类级别的路径继承
@FeignClient(name = "user-service")
public interface UserClient {
    @GetMapping("/users/{id}")   // 这里必须写完整路径，包括类上没有公共前缀
    User getUser(@PathVariable("id") Long id); 
}

4.2. 参数处理差异 

//Spring MVC 注解用于获取参数(如使用@RequestHeader获取请求头)
@PostMapping("/users")
public User createUser(@RequestBody User user,@RequestHeader("X-Token") String token)
{...}


// Feign注解用于设置参数(如使用@RequestHeader设置请求头)
@FeignClient(name="user-service")
public interface UserClient {
@PostMapping("/users")
User createUser(@RequestBody User user,@RequestHeader("X-Token") String token);
}

4.3. 路径变量处理差异

// Spring MVC（支持隐式绑定）
@GetMapping("/orders/{orderId}/items/{itemId}")
public Item getItem(@PathVariable Long orderId, 
                    @PathVariable String itemId) {...}

// OpenFeign（@PathVariable 必须显式命名）
@FeignClient(name="order-service")
public interface OrderClient {
    @GetMapping("/orders/{orderId}/items/{itemId}")
    Item getItem(@PathVariable("orderId") Long orderId, 
                 @PathVariable("itemId") String itemId);
}

4.4. 查询参数处理差异

// Spring MVC（自动绑定POJO）
@GetMapping("/search")
public List<User> searchUsers(UserQuery query) {
    // 自动处理 ?name=xxx&age=xxx 到query的映射
}

// OpenFeign（需要@SpringQueryMap注解）
@FeignClient(name="user-service")
public interface UserClient {
    @GetMapping("/search")
    List<User> searchUsers(@SpringQueryMap UserQuery query);
    //需要使用@SpringQueryMap注解构建query到 ?name=xxx&age=xxx 的映射
}

5. 二者协作演示

服务A：使用Spring MVC暴露API，服务端

// 服务A（使用Spring MVC暴露API，服务端）
@RestController
@RequestMapping("/products")
public class ProductController {
    
    @GetMapping("/{id}")
    public Product getProduct(@PathVariable Long id) {
        // 返回产品信息
    }

    @GetMapping("/search")
    public List<Product> searchProducts(ProductQuery query) {
        // 返回产品列表信息
    }
}

服务B：使用OpenFeign调用服务A， 客户端

// 服务B（使用OpenFeign调用服务A， 客户端）
@FeignClient(name = "product-service", configuration = FeignConfig.class)
public interface ProductClient {
    
    @GetMapping("/products/{id}")
    Product getProduct(@PathVariable("id") Long id);
    
    @PostMapping("/products/search")
    List<Product> searchProducts(@SpringQueryMap ProductQuery query);
}

// 配置类
@Configuration
public class FeignConfig {
    // OpenFeign使用的拦截器为 RequestInterceptor
    @Bean
    public RequestInterceptor authInterceptor() {
        return template -> template.header("X-Auth", "token123");
    }
}

// 调用示例
@Service
public class OrderService {
    private final ProductClient productClient;
    
    public Product getProductForOrder(Long productId) {
        return productClient.getProduct(productId);
    }
}

6.相关阅读

• Spring MVC中常用注解_笔记
• Spring Cloud OpenFeign 常用注解_笔记
• Spring MVC拦截器：HandlerInterceptor介绍-笔记
• OpenFeign拦截器：feign.RequestInterceptor 简介-笔记