使用 SpringBoot 对 RESTfulAPI 进行版本控制

前言

一个项目复杂了之后难免同一套代码，需要兼容不同版本的api。根据请求中的版本信息区分。通过实施API版本控制，您可以在不破坏现有功能的情况下引入新功能。本文也简单实现两个Demo，利用两个不同版本的接口来，允许您扩展功能，同时最大限度地减少对现有逻辑的影响。

基于 SpringBoot 实现

使用如下两个不同版本的接口访问后端

http://localhost:8088/user/v1/add
http://localhost:8088/user/v2/add

不同版本Service的实现

假定 V2 是 V1 版 service 的升级，定义两个接口：UserService 、PersonService

public interface UserService {

    List<String> getPage();
    String getById(String id);
    void addUser();
    void updateUser();
    void deleteUser(String id);
}

public interface PersonService {
    void test();
}

其实现类UserV1ServiceImpl、UserV2ServiceImpl

@Service
@Qualifier("v1")
public class UserV1ServiceImpl implements UserService{
    @Override
    public List<String> getPage() {
        return null;
    }
    @Override
    public String getById(String id) {
        return null;
    }
    @Override
    public void addUser() {
        System.out.println("v1的输出");
    }
    @Override
    public void updateUser() {
    }
    @Override
    public void deleteUser(String id) {
    }
}

@Service
@Qualifier("v2")
public class UserV2ServiceImpl extends UserV1ServiceImpl{
    @Override
    public void addUser() {
        super.addUser();
        // TODO v2的操作信息
        System.out.println("v2的输出");
    }
}

PersonV1ServiceImpl、PersonV2ServiceImpl

@Service
@Qualifier("v1")
public class PersonV1ServiceImpl implements PersonService{
    @Override
    public void test() {
        System.out.println("personv1");
    }
}
@Service
@Qualifier("v2")
public class PersonV2ServiceImpl extends PersonV1ServiceImpl{
    @Override
    public void test() {
        System.out.println("personv2");
    }
}

Controller的调用

本处只是为了演示都写到一个controller里面

@RestController
@RequestMapping("/user")
public class UserController {
    @Autowired
    @Qualifier("v1")
    private UserService userV1Service;
    @Autowired
    @Qualifier("v2")
    private UserService userV2Service;
    @Autowired
    @Qualifier("v1")
    private PersonService personV1Service;
    @Autowired
    @Qualifier("v2")
    private PersonService personV2Service;

    @GetMapping("/v1/add")
    public void addV1() {
        userV1Service.addUser();
        personV1Service.test();
    }
    @GetMapping("/v2/add")
    public void addV2() {
        userV2Service.addUser();
        personV2Service.test();
    }
}

输出

http://localhost:8088/user/v2/add
输出：
v1的输出
personv1
http://localhost:8088/user/v2/add
输出：
v1的输出
v2的输出
personv2

总结：

API版本控制对于软件开发和维护具有许多好处。以下是其中一些主要好处：

1. 向后兼容性：通过版本控制，可以确保对现有客户端和系统的连续支持，即使在引入新功能或更改时也是如此。这有助于降低对以前版本的用户产生干扰的风险。
2. 更平滑的过渡：版本控制允许在版本之间逐步且受控地进行过渡，这让开发人员能够灵活地按照自己的节奏更新系统，从而降低突然和潜在破坏性变化的风险。
3. 清晰的文档：API版本控制提供了一种清晰的方式来记录和传达更改。客户可以参考特定版本的API文档，以了解支持的内容以及可能发生的更改。
   改进的测试：通过为每个API版本单独进行测试，可以更容易地对特定版本的特定更改进行集中测试，从而降低回归风险。
4. 面向未来：版本控制使您能够规划未来并设计API以适应不断变化的需求和用户反馈。这有助于确保软件的可维护性和可靠性，并最大限度地减少对现有系统的干扰。

尽管存在与API版本控制相关的挑战，如数据库架构更改、数据迁移、数据一致性、复杂性增加、兼容性测试和性能开销等，但通过仔细的规划和最佳实践的使用，可以最大程度地减少潜在陷阱并确保API版本之间的平稳过渡。
最后，祝大家玩的开心~~