Spring Boot 3中后缀式内容协商如何实现？旧接口兼容方案咨询

现状说明 #

Spring Boot 3 中，原有的spring.mvc.pathmatch.use-registered-suffix-pattern、spring.mvc.pathmatch.use-suffix-pattern配置属性已被移除，ContentNegotiationConfigurer.favorPathExtension()方法也被废弃且无替代，默认禁用了路径后缀的内容协商机制。

可行替代方案 #

方案1：显式定义多路径映射 #

直接为不同后缀的请求定义独立的@GetMapping映射，同时保留无后缀的基础接口，确保向下兼容，这也是你提到的方式：

import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class ProductController {

    private final ProductService productService;

    public ProductController(ProductService productService) {
        this.productService = productService;
    }

    @GetMapping(value = "/products/{id}.json", produces = MediaType.APPLICATION_JSON_VALUE)
    public Product getProductJson(@PathVariable String id) {
        return productService.getProduct(id);
    }

    @GetMapping(value = "/products/{id}.xml", produces = MediaType.APPLICATION_XML_VALUE)
    public Product getProductXml(@PathVariable String id) {
        return productService.getProduct(id);
    }

    @GetMapping(value = "/products/{id}", produces = {MediaType.APPLICATION_JSON_VALUE, MediaType.APPLICATION_XML_VALUE})
    public Product getProduct(@PathVariable String id) {
        return productService.getProduct(id);
    }
}

这种方式直观、易维护，完全符合Spring Boot 3规范，不依赖任何废弃特性。

方案2：自定义路径匹配与内容协商处理器 #

如果接口数量较多，不想重复定义方法，可以通过自定义策略来解析路径后缀：

1. 创建自定义ContentNegotiationStrategy，从请求路径提取后缀并映射为对应媒体类型
2. 配置ContentNegotiationManager，加入自定义策略
3. 调整路径匹配策略，确保后缀能被解析

自定义内容协商策略示例

import org.springframework.http.MediaType;
import org.springframework.web.accept.ContentNegotiationStrategy;
import org.springframework.web.context.request.NativeWebRequest;

import java.util.Collections;
import java.util.List;
import java.util.Map;

public class PathSuffixContentNegotiationStrategy implements ContentNegotiationStrategy {

    private static final Map<String, MediaType> SUFFIX_MEDIA_TYPE_MAP = Map.of(
            "json", MediaType.APPLICATION_JSON,
            "xml", MediaType.APPLICATION_XML
    );

    @Override
    public List<MediaType> resolveMediaTypes(NativeWebRequest webRequest) {
        String requestPath = webRequest.getNativeRequest(javax.servlet.http.HttpServletRequest.class).getRequestURI();
        int lastDotIndex = requestPath.lastIndexOf('.');
        if (lastDotIndex != -1 && lastDotIndex < requestPath.length() - 1) {
            String suffix = requestPath.substring(lastDotIndex + 1);
            MediaType mediaType = SUFFIX_MEDIA_TYPE_MAP.get(suffix.toLowerCase());
            if (mediaType != null) {
                return Collections.singletonList(mediaType);
            }
        }
        return Collections.emptyList();
    }
}

配置类注册策略

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.accept.ContentNegotiationManager;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {

    @Bean
    public ContentNegotiationManager contentNegotiationManager() {
        ContentNegotiationManager manager = new ContentNegotiationManager();
        manager.addStrategy(new PathSuffixContentNegotiationStrategy());
        // 保留原有基于Accept头的协商策略
        manager.addStrategy(new org.springframework.web.accept.HeaderContentNegotiationStrategy());
        return manager;
    }
}

路径匹配配置

在application.yml中设置：

spring:
  mvc:
    pathmatch:
      matching-strategy: path-pattern-matcher

这种方式适合大量接口兼容后缀的场景，避免重复代码，但需要自行维护后缀与媒体类型的映射关系。

方案选择建议 #

• 少量接口需要兼容时，优先选方案1，实现简单不易出错
• 接口数量多或需统一管理后缀规则时，再考虑方案2，但要做好兼容性测试

内容的提问来源于stack exchange，提问作者daniu