Spring接口版本控制方案及RequestMappingHandlerMapping接口介绍(最新推荐)

public class ApiVersionRequestCondition implements RequestCondition<ApiVersionRequestCondition> {
    private final static Pattern VERSION_PATTERN = Pattern.compile("v(\\d+)"); // 版本号正则表达式
    private int apiVersion; // 接口版本号
    public ApiVersionRequestCondition(int apiVersion) {
        this.apiVersion = apiVersion;
    }
    // 实现getMatchingCondition方法，根据请求进行条件匹配
    @Override
    public ApiVersionRequestCondition getMatchingCondition(HttpServletRequest request) {
        Matcher matcher = VERSION_PATTERN.matcher(request.getRequestURI());
        if (matcher.find()) {
            int version = Integer.parseInt(matcher.group(1));
            if (version >= this.apiVersion) { // 当前版本大于等于请求的版本，则进行匹配
                return this;
            }
        }
        return null;
    }
    // 实现combine方法，将两个条件进行组合
    @Override
    public ApiVersionRequestCondition combine(ApiVersionRequestCondition other) {
        // 采取最新版本的约束
        return new ApiVersionRequestCondition(Math.max(this.apiVersion, other.apiVersion));
    }
    // 实现compareTo方法，用于比较条件的优先级
    @Override
    public int compareTo(ApiVersionRequestCondition other, HttpServletRequest request) {
        // 根据具体情况返回比较结果
        return other.apiVersion - this.apiVersion;
    }
}

public class CustomRequestMappingHandlerMapping extends RequestMappingHandlerMapping {
    @Override
    protected RequestCondition<?> getCustomTypeCondition(Class<?> handlerType) {
        ApiVersion apiVersion = AnnotationUtils.findAnnotation(handlerType, ApiVersion.class);
        if (apiVersion != null) {
            return new ApiVersionRequestCondition(apiVersion.value());
        }
        return null;
    }
    @Override
    protected RequestCondition<?> getCustomMethodCondition(Method method) {
        ApiVersion apiVersion = AnnotationUtils.findAnnotation(method, ApiVersion.class);
        if (apiVersion != null) {
            return new ApiVersionRequestCondition(apiVersion.value());
        }
        return null;
    }
}

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
    @Override
    public void configurePathMatch(PathMatchConfigurer configurer) {
        configurer.addPathPrefix("/api", HandlerTypePredicate.forAnnotation(RestController.class));
    }
    @Override
    public void configureHandlerMappings(List<HandlerMapping> handlerMappings) {
        // 注册自定义的RequestMappingHandlerMapping
        handlerMappings.add(customRequestMappingHandlerMapping());
    }
    @Bean
    public CustomRequestMappingHandlerMapping customRequestMappingHandlerMapping() {
        return new CustomRequestMappingHandlerMapping();
    }
}

@RestController
@RequestMapping("/api/users")
public class UserController {
    @GetMapping(produces = "application/json")
    @ApiVersion(1)
    public String getUsersV1() {
        return "User data (Version 1)";
    }
    @GetMapping(produces = "application/json")
    @ApiVersion(2)
    public String getUsersV2() {
        return "User data (Version 2)";
    }
}

版本1：GET /api/users?v1
版本2：GET /api/users?v2