Spring Security团队正式宣布Spring Security OAuth终止维护

Spring Security团队正式宣布Spring Security OAuth终止维护。

spring 官宣终止维护spring security oauth

目前官网的主页已经高亮提醒大家彻底停止维护。

官网已经通知EOL

旧的Spring Security OAuth项目终止到2.5.2.RELEASE版本，该项目将不会再进行任何的迭代，包括Bug修复，之前胖哥已经提醒该项目即将停止维护，有心的同学已经进行了迁移。

2020年就已经宣布了EOL时间表

项目文档和代码仓库被移除

目前该项目的官方文档已经正式从spring.io移除，文档已经指向404，这是连文档也没有了。新增了OAuth2授权服务器Spring Authorization Server的文档。

文档已经被移除

不仅仅文档被移除，连项目的仓库也被迁移到Spring的过期项目仓库spring-attic并被标记为read-only。

代码仓库已经被转移

Spring Security OAuth的Spring Boot自动配置代码仓库也一并被迁移，也就是说Spring Boot相关的自动配置也被移除。

代码仓库已经被转移

从这种情况看来大约Spring Security OAuth的确是死了。难道就没有可用的了吗？当然不是。

迁移指南

这是胖哥总结的迁移指南。

依赖项检查

那么如何检查你的项目是否用了旧的OAuth2设施呢？当然是对依赖进行检查。以下清单中的依赖任何版本的都是过期的，都需要迁移：

<dependency> <groupId>org.springframework.security.oauth</groupId> <artifactId>spring-security-oauth-parent</artifactId> </dependency> <dependency> <groupId>org.springframework.security.oauth</groupId> <artifactId>spring-security-oauth</artifactId> </dependency> <dependency> <groupId>org.springframework.security.oauth</groupId> <artifactId>spring-security-oauth2</artifactId> </dependency> <dependency> <groupId>org.springframework.security</groupId> <artifactId>spring-security-jwt</artifactId> </dependency> <dependency> <groupId>org.springframework.security.oauth.boot</groupId> <artifactId>spring-security-oauth2-autoconfigure</artifactId> </dependency>

你可以通过mvn dependency:tree来检查依赖树是否集成了上述依赖项。

新的OAuth2替代方案

需要开发者掌握OAuth2.0、OAuth2.1、OIDC 1.0的一些知识。

Spring Security 5中集成了OAuth2 Client和Resource Server两个模块。如果有迁移的需要，建议迁移至最新的Spring Security 5.7.x，方便向Spring 6过渡。以Spring Boot为例，首先要集成Spring Security：

<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-security</artifactId> </dependency>

这里建议使用最新版本，目前是2.7。

集成OAuth2 Client依赖

OAuth2 Client依赖于Spring Security，不能单独使用：

<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-oauth2-client</artifactId> </dependency>

集成Resource Server依赖

Resource Server同样也依赖于Spring Security，不能单独使用：

<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-oauth2-resource-server</artifactId> </dependency>

集成OAuth2授权服务器依赖

目前Spring生态中的OAuth2授权服务器是Spring Authorization Server，目前已具备生产就绪能力。在最新的0.3.0版本中，官方文档正式在spring.io上线，需要你知道的是它必须在Java 11及以上版本才能使用。它也作为一个Spring Security子模块，不能单独使用：

<dependency> <groupId>org.springframework.security</groupId> <artifactId>spring-security-oauth2-authorization-server</artifactId> <version>0.3.0</version> </dependency>

透露一下，该项目的Spring Boot Starter也将在不久实装。

总结

旧的Spring Security OAuth过期，其实也不必恐慌，除非你们在这一方面的架构需要继续迭代。不过随着新的方案面世，旧方案的可维护性会大大降低，有条件的还是要迁移一下的。Spring Cloud也将会在未来某个时间点做出一些调整以适应新的架构。请持续关注，后面会及时带来相关的消息。