Spring Authorization Server 中使用 JPA 实现核心服务的完整指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00816/article/details/148507976

Spring Authorization Server 中使用 JPA 实现核心服务的完整指南

spring-authorization-server Spring Authorization Server 项目地址: https://gitcode.com/gh_mirrors/spr/spring-authorization-server

前言

在现代 OAuth 2.0 和 OpenID Connect 认证授权体系中，Spring Authorization Server 作为 Spring 生态中的重要组件，提供了强大的安全认证能力。本文将深入讲解如何使用 JPA（Java Persistence API）来实现 Spring Authorization Server 的核心服务，为开发者提供一个可扩展、可定制的持久化方案。

核心概念理解

在开始实现之前，我们需要明确几个关键概念：

RegisteredClient：代表在授权服务器中注册的客户端应用
OAuth2Authorization：记录授权过程中的状态和令牌信息
OAuth2AuthorizationConsent：存储用户对客户端授权的同意记录

数据模型设计

客户端数据模型

客户端表(client)存储了所有注册的客户端信息，其核心字段包括：

CREATE TABLE client (
    id varchar(255) NOT NULL,
    clientId varchar(255) NOT NULL,
    clientSecret varchar(255) DEFAULT NULL,
    clientName varchar(255) NOT NULL,
    -- 认证方法和授权类型
    clientAuthenticationMethods varchar(1000) NOT NULL,
    authorizationGrantTypes varchar(1000) NOT NULL,
    -- 重定向URI和范围
    redirectUris varchar(1000) DEFAULT NULL,
    scopes varchar(1000) NOT NULL,
    -- 客户端和令牌设置(JSON格式)
    clientSettings varchar(2000) NOT NULL,
    tokenSettings varchar(2000) NOT NULL,
    PRIMARY KEY (id)
);

设计考虑：

多值字段(如scopes、redirectUris)使用逗号分隔的字符串存储
复杂配置使用JSON格式存储在文本字段中
注意clientSecret的存储安全

授权数据模型

授权表(authorization)是最复杂的表，记录了完整的授权流程状态：

CREATE TABLE authorization (
    id varchar(255) NOT NULL,
    registeredClientId varchar(255) NOT NULL,
    principalName varchar(255) NOT NULL,
    -- 授权相关信息
    authorizationGrantType varchar(255) NOT NULL,
    authorizedScopes varchar(1000) DEFAULT NULL,
    -- 各种令牌及其元数据
    accessTokenValue varchar(4000) DEFAULT NULL,
    accessTokenExpiresAt timestamp DEFAULT NULL,
    refreshTokenValue varchar(4000) DEFAULT NULL,
    -- ID Token相关字段
    oidcIdTokenValue varchar(4000) DEFAULT NULL,
    oidcIdTokenClaims varchar(2000) DEFAULT NULL,
    -- 设备授权相关字段
    deviceCodeValue varchar(4000) DEFAULT NULL,
    PRIMARY KEY (id)
);

关键点：

采用扁平化设计而非规范化，提高查询性能
令牌值字段长度较大(4000)，考虑实际数据库支持
各种令牌的元数据使用JSON格式存储

授权同意数据模型

授权同意表(authorizationConsent)结构相对简单：

CREATE TABLE authorizationConsent (
    registeredClientId varchar(255) NOT NULL,
    principalName varchar(255) NOT NULL,
    authorities varchar(1000) NOT NULL,
    PRIMARY KEY (registeredClientId, principalName)
);

JPA实体实现

客户端实体

@Entity
@Table(name = "client")
public class Client {
    @Id
    private String id;
    
    @Column(nullable = false, unique = true)
    private String clientId;
    
    @Column(length = 1000)
    private String clientAuthenticationMethods;
    
    @Column(length = 2000)
    private String clientSettings;
    
    // 其他字段和转换方法
}

转换要点：

多值字段使用String.join()和String.split()处理
JSON字段使用Jackson等库进行序列化/反序列化

授权实体

@Entity
@Table(name = "authorization")
public class Authorization {
    @Id
    private String id;
    
    @Column(nullable = false)
    private String registeredClientId;
    
    @Column(length = 4000)
    private String accessTokenValue;
    
    @Column(length = 2000)
    private String accessTokenMetadata;
    
    // 其他字段和转换方法
}

注意事项：

大文本字段考虑使用@Lob注解
日期字段使用@Temporal注解

Spring Data仓库实现

客户端仓库

public interface ClientRepository extends JpaRepository<Client, String> {
    Optional<Client> findByClientId(String clientId);
}

授权仓库

public interface AuthorizationRepository extends JpaRepository<Authorization, String> {
    Optional<Authorization> findByState(String state);
    Optional<Authorization> findByAccessTokenValue(String token);
    // 其他查询方法
}

核心服务实现

注册客户端服务

public class JpaRegisteredClientRepository implements RegisteredClientRepository {
    private final ClientRepository clientRepository;
    
    @Override
    public void save(RegisteredClient registeredClient) {
        Client client = convertToClient(registeredClient);
        clientRepository.save(client);
    }
    
    private Client convertToClient(RegisteredClient registeredClient) {
        // 转换逻辑
    }
}

授权服务

public class JpaOAuth2AuthorizationService implements OAuth2AuthorizationService {
    private final AuthorizationRepository authorizationRepository;
    
    @Override
    public void save(OAuth2Authorization authorization) {
        Authorization entity = convertToAuthorization(authorization);
        authorizationRepository.save(entity);
    }
    
    // 其他方法实现
}