tsai
/
abp-next-admin2
mirror of https://github.com/colinin/abp-next-admin.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
这是基于vue-vben-admin 模板适用于abp vNext的前端管理项目
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
2888 Commits
72 Branches
53 Tags
76 MiB
 
 
 
 
 
 
Tree: ac7a940a9e
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'ac7a940a9e'
${ noResults }
abp-next-admin2/docs/wiki/核心功能模块/认证授权模块/令牌管理.md

13 KiB
Raw Blame History

令牌管理

**本文档中引用的文件** - [OpenIddictTokenAppService.cs](file://aspnet-core/modules/openIddict/LINGYUN.Abp.OpenIddict.Application/LINGYUN/Abp/OpenIddict/Tokens/OpenIddictTokenAppService.cs) - [OpenIddictTokenDto.cs](file://aspnet-core/modules/openIddict/LINGYUN.Abp.OpenIddict.Application.Contracts/LINGYUN/Abp/OpenIddict/Tokens/OpenIddictTokenDto.cs) - [OpenIddictTokenController.cs](file://aspnet-core/modules/openIddict/LINGYUN.Abp.OpenIddict.HttpApi/LINGYUN/Abp/OpenIddict/Tokens/OpenIddictTokenController.cs) - [AbpOpenIddictPermissions.cs](file://aspnet-core/modules/openIddict/LINGYUN.Abp.OpenIddict.Application.Contracts/LINGYUN/Abp/OpenIddict/Permissions/AbpOpenIddictPermissions.cs) - [ClientDataSeederContributor.cs](file://aspnet-core/migrations/LY.MicroService.Applications.Single.EntityFrameworkCore/DataSeeder/ClientDataSeederContributor.cs) - [OpenIddictTokenGetListInput.cs](file://aspnet-core/modules/openIddict/LINGYUN.Abp.OpenIddict.Application.Contracts/LINGYUN/Abp/OpenIddict/Tokens/OpenIddictTokenGetListInput.cs) - [20250409030245_Initial-Single-Project-MSSQL.cs](file://aspnet-core/migrations/LY.MicroService.Applications.Single.EntityFrameworkCore.SqlServer/Migrations/20250409030245_Initial-Single-Project-MSSQL.cs)

目录

  1. 简介
  2. 项目结构
  3. 核心组件
  4. 架构概述
  5. 详细组件分析
  6. 依赖分析
  7. 性能考虑
  8. 故障排除指南
  9. 结论

简介

本项目基于ABP框架构建，采用OpenIddict实现OAuth 2.0和OpenID Connect协议，提供完整的令牌管理功能。系统支持访问令牌、ID令牌和刷新令牌的全生命周期管理，包括颁发、验证、刷新和撤销等操作。通过模块化设计，实现了令牌的存储、查询和安全管理，为开发者提供了灵活的扩展接口。

项目结构

项目采用分层架构设计，令牌管理功能主要集中在openIddict模块中。该模块包含应用层、应用契约层和HTTP API层，分别负责业务逻辑处理、数据传输和接口暴露。数据持久化通过EntityFrameworkCore实现，支持多种数据库。

graph TB
subgraph "应用层"
OpenIddictTokenAppService[OpenIddictTokenAppService]
end
subgraph "应用契约层"
OpenIddictTokenDto[OpenIddictTokenDto]
OpenIddictTokenGetListInput[OpenIddictTokenGetListInput]
IOpenIddictTokenAppService[IOpenIddictTokenAppService]
end
subgraph "HTTP API层"
OpenIddictTokenController[OpenIddictTokenController]
end
subgraph "数据访问层"
OpenIddictTokensTable[OpenIddictTokens表]
end
OpenIddictTokenAppService --> OpenIddictTokensTable
OpenIddictTokenController --> OpenIddictTokenAppService
OpenIddictTokenAppService --> OpenIddictTokenDto
OpenIddictTokenController --> OpenIddictTokenGetListInput
style OpenIddictTokenAppService fill:#f9f,stroke:#333
style OpenIddictTokenDto fill:#bbf,stroke:#333
style OpenIddictTokenController fill:#f96,stroke:#333

图示来源

  • OpenIddictTokenAppService.cs
  • OpenIddictTokenDto.cs
  • OpenIddictTokenController.cs
  • 20250409030245_Initial-Single-Project-MSSQL.cs

本节来源

  • OpenIddictTokenAppService.cs
  • OpenIddictTokenDto.cs

核心组件

令牌管理子模块的核心组件包括令牌应用服务、数据传输对象和控制器。OpenIddictTokenAppService负责处理令牌的业务逻辑，OpenIddictTokenDto定义了令牌的数据结构，OpenIddictTokenController暴露RESTful API接口。系统通过IOpenIddictTokenManager和IRepository<OpenIddictToken, Guid>与底层数据存储交互。

本节来源

  • OpenIddictTokenAppService.cs
  • OpenIddictTokenDto.cs
  • OpenIddictTokenController.cs

架构概述

系统采用典型的分层架构，从上到下分为表现层、应用层、领域层和基础设施层。OpenIddict模块作为身份认证的核心，与其他模块通过定义良好的接口进行交互。权限管理通过AbpOpenIddictPermissions类集中定义，确保了安全控制的一致性。

graph TD
A[客户端] --> B[OpenIddictTokenController]
B --> C[OpenIddictTokenAppService]
C --> D[IOpenIddictTokenManager]
C --> E[IRepository<OpenIddictToken, Guid>]
D --> F[数据库]
E --> F
C --> G[权限检查]
G --> H[AbpOpenIddictPermissions]
style A fill:#f9f,stroke:#333
style B fill:#f96,stroke:#333
style C fill:#f9f,stroke:#333
style D fill:#bbf,stroke:#333
style E fill:#bbf,stroke:#333
style F fill:#9f9,stroke:#333
style G fill:#ff9,stroke:#333
style H fill:#ff9,stroke:#333

图示来源

  • OpenIddictTokenController.cs
  • OpenIddictTokenAppService.cs
  • AbpOpenIddictPermissions.cs

详细组件分析

令牌应用服务分析

OpenIddictTokenAppService类实现了IOpenIddictTokenAppService接口，提供了对令牌的增删改查操作。服务通过依赖注入获取IOpenIddictTokenManager和IRepository<OpenIddictToken, Guid>实例，实现了与OpenIddict框架的集成。

类图

classDiagram
class OpenIddictTokenAppService {
+IOpenIddictTokenManager _tokenManager
+IRepository<OpenIddictToken, Guid> _tokenRepository
+AbpOpenIddictIdentifierConverter _identifierConverter
+DeleteAsync(Guid id) Task
+GetAsync(Guid id) Task~OpenIddictTokenDto~
+GetListAsync(OpenIddictTokenGetListInput input) Task~PagedResultDto~OpenIddictTokenDto~~
}
class IOpenIddictTokenAppService {
<<interface>>
+DeleteAsync(Guid id) Task
+GetAsync(Guid id) Task~OpenIddictTokenDto~
+GetListAsync(OpenIddictTokenGetListInput input) Task~PagedResultDto~OpenIddictTokenDto~~
}
class OpenIddictApplicationServiceBase {
<<abstract>>
}
OpenIddictTokenAppService --|> IOpenIddictTokenAppService
OpenIddictTokenAppService --|> OpenIddictApplicationServiceBase
OpenIddictTokenAppService ..> IOpenIddictTokenManager : "uses"
OpenIddictTokenAppService ..> IRepository~OpenIddictToken, Guid~ : "uses"

图示来源

  • OpenIddictTokenAppService.cs
  • IOpenIddictTokenAppService.cs

令牌查询流程

sequenceDiagram
participant Client as "客户端"
participant Controller as "OpenIddictTokenController"
participant Service as "OpenIddictTokenAppService"
participant Repository as "IRepository<OpenIddictToken, Guid>"
Client->>Controller : GET /api/openiddict/tokens
Controller->>Service : GetListAsync(input)
Service->>Repository : GetQueryableAsync()
alt 有ClientId过滤
Service->>Repository : Where(x => x.ApplicationId == input.ClientId)
end
alt 有创建时间范围
Service->>Repository : Where(x => x.CreationDate >= input.BeginCreationTime)
Service->>Repository : Where(x => x.CreationDate <= input.EndCreationTime)
end
alt 有过期时间范围
Service->>Repository : Where(x => x.ExpirationDate >= input.BeginExpirationDate)
Service->>Repository : Where(x => x.ExpirationDate <= input.EndExpirationDate)
end
Service->>Repository : CountAsync(queryable)
Service->>Repository : OrderBy(sorting)
Service->>Repository : PageBy(input.SkipCount, input.MaxResultCount)
Repository-->>Service : 返回分页结果
Service-->>Controller : 转换为Dto并返回
Controller-->>Client : 返回PagedResultDto<OpenIddictTokenDto>

图示来源

  • OpenIddictTokenController.cs
  • OpenIddictTokenAppService.cs
  • OpenIddictTokenGetListInput.cs

本节来源

  • OpenIddictTokenAppService.cs
  • OpenIddictTokenController.cs

依赖分析

令牌管理模块依赖于ABP框架的核心组件和OpenIddict库。通过AbpOpenIddictDomainModule依赖，确保了与身份认证领域的紧密集成。权限控制通过AbpOpenIddictPermissions类实现，遵循ABP的权限管理规范。

graph TD
A[OpenIddictTokenAppService] --> B[IOpenIddictTokenManager]
A --> C[IRepository<OpenIddictToken, Guid>]
A --> D[AbpOpenIddictIdentifierConverter]
B --> E[OpenIddict]
C --> F[EntityFrameworkCore]
A --> G[AbpOpenIddictPermissions]
G --> H[Authorization]
style A fill:#f9f,stroke:#333
style B fill:#bbf,stroke:#333
style C fill:#bbf,stroke:#333
style D fill:#bbf,stroke:#333
style E fill:#9f9,stroke:#333
style F fill:#9f9,stroke:#333
style G fill:#ff9,stroke:#333
style H fill:#ff9,stroke:#333

图示来源

  • OpenIddictTokenAppService.cs
  • AbpOpenIddictPermissions.cs

本节来源

  • OpenIddictTokenAppService.cs
  • AbpOpenIddictPermissions.cs

性能考虑

令牌查询操作通过分页和过滤机制优化性能。GetListAsync方法支持多种过滤条件，包括客户端ID、创建时间范围、过期时间范围等，避免了全表扫描。数据库层面通过索引优化查询性能，如在ApplicationId、Status、Subject和Type字段上创建复合索引。

故障排除指南

当令牌管理功能出现异常时，应首先检查权限配置是否正确。AbpOpenIddictPermissions.Tokens.Default权限是访问令牌API的基础权限，AbpOpenIddictPermissions.Tokens.Delete权限是删除令牌的必要权限。同时，应确保数据库连接正常，OpenIddict相关表已正确创建。

本节来源

  • AbpOpenIddictPermissions.cs
  • ClientDataSeederContributor.cs

结论

本令牌管理子模块基于ABP框架和OpenIddict库构建，提供了完整的OAuth 2.0和OpenID Connect令牌管理功能。通过清晰的分层架构和模块化设计，实现了高内聚低耦合的系统结构。系统支持灵活的查询和过滤功能，同时通过权限控制确保了安全性。未来可进一步优化性能，如引入缓存机制减少数据库访问。