java控制api接口版本_SpringBoot实现API接口多版本支持的示例代码

在Spring Boot中实现API接口多版本支持，可以通过自定义一个版本号注解，来实现对不同版本接口的区分。具体实现步骤如下：

1. 定义版本号注解

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ApiVersion {
    int value();
}

2. 定义版本号拦截器

@Component
public class ApiVersionInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
            throws Exception {
        if (handler instanceof HandlerMethod) {
            HandlerMethod handlerMethod = (HandlerMethod) handler;
            ApiVersion apiVersion = handlerMethod.getMethodAnnotation(ApiVersion.class);
            if (apiVersion == null) {
                apiVersion = handlerMethod.getBeanType().getAnnotation(ApiVersion.class);
            }
            if (apiVersion != null) {
                int version = apiVersion.value();
                String uri = request.getRequestURI();
                String[] uriArray = StringUtils.split(uri, "/");
                if (uriArray.length > 1) {
                    String uriVersion = uriArray[1];
                    if (StringUtils.isNumeric(uriVersion)) {
                        int requestVersion = Integer.parseInt(uriVersion);
                        if (requestVersion >= version) {
                            return true;
                        }
                    }
                }
                response.setStatus(HttpServletResponse.SC_BAD_REQUEST);
                response.getWriter().write("API version " + version + " is not supported");
                return false;
            }
        }
        return true;
    }
}

3. 在Spring Boot配置类中添加版本号拦截器

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {

    @Autowired
    private ApiVersionInterceptor apiVersionInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(apiVersionInterceptor);
    }
}

4. 在Controller中使用版本号注解

@RestController
@ApiVersion(1)
@RequestMapping("/{version}/user")
public class UserController {

    @GetMapping("/{id}")
    public User getUser(@PathVariable Long id) {
        //...
    }
}

这样，当请求的URI中的版本号小于Controller中定义的版本号时，就会返回错误信息。如果请求的URI中的版本号大于或等于Controller中定义的版本号时，就会正常访问对应的接口。