Spring Boot中RESTful API版本控制

在Spring Boot中，对RESTful API进行版本控制是一个很好的实践，可以帮助你在不破坏现有客户端的情况下，逐步引入新的功能或修改现有功能。以下是几种常见的API版本控制方法：

1. URL版本控制

这是最常见的方法，通过在URL中包含版本号来实现版本控制。

示例：

http://example.com/api/v1/users
http://example.com/api/v2/users

实现方式： 在Controller类或方法上使用@RequestMapping注解来指定版本号。

@RestController
@RequestMapping("/api/v1")
public class UserControllerV1 {

    @GetMapping("/users")
    public List<User> getUsersV1() {
        // 实现代码
    }
}

@RestController
@RequestMapping("/api/v2")
public class UserControllerV2 {

    @GetMapping("/users")
    public List<User> getUsersV2() {
        // 实现代码
    }
}

2. 请求头版本控制

通过自定义请求头来指定API版本。

示例：

GET /users HTTP/1.1
Host: example.com
Accept: application/vnd.example.v1+json

实现方式： 在Controller类或方法上使用@RequestMapping注解来指定请求头。

@RestController
public class UserController {

    @GetMapping(value = "/users", headers = @RequestHeader(name = "Accept", pattern = "application/vnd.example.v1+json"))
    public List<User> getUsersV1() {
        // 实现代码
    }

    @GetMapping(value = "/users", headers = @RequestHeader(name = "Accept", pattern = "application/vnd.example.v2+json"))
    public List<User> getUsersV2() {
        // 实现代码
    }
}

3. 内容协商版本控制

通过Accept头中的媒体类型来指定API版本。

示例：

GET /users HTTP/1.1
Host: example.com
Accept: application/vnd.example.users.v1+json

实现方式： 在Controller类或方法上使用@RequestMapping注解来指定媒体类型。

@RestController
public class UserController {

    @GetMapping(value = "/users", produces = MediaType.APPLICATION_JSON_VALUE + "; version=1")
    public List<User> getUsersV1() {
        // 实现代码
    }

    @GetMapping(value = "/users", produces = MediaType.APPLICATION_JSON_VALUE + "; version=2")
    public List<User> getUsersV2() {
        // 实现代码
    }
}

4. 过滤器版本控制

通过自定义过滤器来处理API版本控制。

示例：

public class VersionFilter implements Filter {

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        HttpServletRequest httpRequest = (HttpServletRequest) request;
        String version = httpRequest.getHeader("Accept");

        if (version != null && version.contains("v1")) {
            httpRequest.getRequestURI = httpRequest.getRequestURI().replace("/api/v2", "/api/v1");
        }

        chain.doFilter(request, response);
    }
}

配置过滤器： 在Spring Boot配置类中配置过滤器。

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void addFilters(FilterRegistration registration) {
        registration.addFilter(new VersionFilter());
    }
}

总结

以上是几种常见的API版本控制方法，你可以根据项目需求和团队习惯选择合适的方法。URL版本控制是最直观和常用的方法，而请求头和内容协商版本控制则提供了更多的灵活性。过滤器版本控制则适用于更复杂的场景，可以在请求到达Controller之前进行预处理。