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
54 Tags
77 MiB
 
 
 
 
 
 
Tree: ac7a940a9e
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'ac7a940a9e'
${ noResults }
abp-next-admin2/docs/wiki/扩展开发/自定义模块开发/数据库迁移与数据管理/数据种子管理.md

14 KiB
Raw Blame History

数据种子管理

**本文档引用的文件** - [IdentityDataSeedContributor.cs](file://aspnet-core/migrations/LY.MicroService.Applications.Single.EntityFrameworkCore/DataSeeder/IdentityDataSeedContributor.cs) - [ClientDataSeederContributor.cs](file://aspnet-core/templates/aio/content/migrations/PackageName.CompanyName.ProjectName.AIO.EntityFrameworkCore/DataSeeder/ClientDataSeederContributor.cs) - [IdentityServerDataSeedContributor.cs](file://aspnet-core/migrations/LY.MicroService.IdentityServer.EntityFrameworkCore/DataSeeder/IdentityServerDataSeedContributor.cs) - [IdentityServerDataSeederWorker.cs](file://aspnet-core/services/LY.MicroService.IdentityServer/DataSeeder/IdentityServerDataSeederWorker.cs) - [IdentityServerModule.Seeder.cs](file://aspnet-core/services/LY.MicroService.IdentityServer/IdentityServerModule.Seeder.cs)

目录

  1. 简介
  2. 数据种子机制概述
  3. 核心组件分析
  4. 多租户环境下的数据初始化
  5. 条件性数据填充实现
  6. 执行流程与顺序控制
  7. 调试方法与最佳实践
  8. 版本升级时的数据迁移策略

简介

ABP框架提供了一套完整的数据种子（Data Seed）机制，用于在模块初始化时自动填充基础数据。该机制通过IDataSeedContributor接口和相关实现类，实现了灵活、可扩展的数据初始化功能。本文档将详细介绍ABP框架中的数据种子管理机制，包括如何定义种子数据提供程序、处理多租户环境下的默认数据初始化、实现条件性数据填充等关键概念。

数据种子机制概述

ABP框架的数据种子机制基于IDataSeedContributor接口实现，该接口定义了SeedAsync方法，用于在系统启动时执行数据初始化逻辑。数据种子贡献者（Data Seed Contributor）通常在模块的预配置阶段注册，并在应用程序启动时由IDataSeeder服务调用。

classDiagram
class IDataSeedContributor {
<<interface>>
+Task SeedAsync(DataSeedContext context)
}
class IdentityDataSeedContributor {
+ILogger<IdentityDataSeedContributor> Logger
+ICurrentTenant CurrentTenant
+IGuidGenerator GuidGenerator
+IdentityRoleManager IdentityRoleManager
+Task SeedAsync(DataSeedContext context)
}
class ClientDataSeederContributor {
+IOpenIddictApplicationManager _applicationManager
+IOpenIddictScopeManager _scopeManager
+IClientRepository _clientRepository
+IApiResourceRepository _apiResourceRepository
+IApiScopeRepository _apiScopeRepository
+ICustomIdentityResourceDataSeeder _customIdentityResourceDataSeeder
+IIdentityResourceDataSeeder _identityResourceDataSeeder
+IGuidGenerator _guidGenerator
+IPermissionDataSeeder _permissionDataSeeder
+IConfiguration _configuration
+ICurrentTenant _currentTenant
+Task SeedAsync(DataSeedContext context)
}
class IdentityServerDataSeedContributor {
+IApiResourceRepository _apiResourceRepository
+IApiScopeRepository _apiScopeRepository
+IClientRepository _clientRepository
+ICustomIdentityResourceDataSeeder _customIdentityResourceDataSeeder
+IIdentityResourceDataSeeder _identityResourceDataSeeder
+IWeChatResourceDataSeeder _weChatResourceDataSeeder
+IGuidGenerator _guidGenerator
+IPermissionDataSeeder _permissionDataSeeder
+IConfiguration _configuration
+ICurrentTenant _currentTenant
+Task SeedAsync(DataSeedContext context)
}
IDataSeedContributor <|-- IdentityDataSeedContributor
IDataSeedContributor <|-- ClientDataSeederContributor
IDataSeedContributor <|-- IdentityServerDataSeedContributor

图表来源

  • IdentityDataSeedContributor.cs
  • ClientDataSeederContributor.cs
  • IdentityServerDataSeedContributor.cs

本节来源

  • IdentityDataSeedContributor.cs
  • ClientDataSeederContributor.cs

核心组件分析

IdentityDataSeedContributor分析

IdentityDataSeedContributor是身份模块的数据种子贡献者，负责在系统初始化时创建默认的角色。该类实现了IDataSeedContributor接口，并通过依赖注入获取必要的服务实例。

sequenceDiagram
participant Worker as DataSeederWorker
participant Seeder as IDataSeeder
participant Contributor as IdentityDataSeedContributor
participant RoleManager as IdentityRoleManager
Worker->>Seeder : SeedAsync()
Seeder->>Contributor : SeedAsync(context)
Contributor->>RoleManager : FindByNameAsync("Users")
alt 角色不存在
RoleManager-->>Contributor : null
Contributor->>RoleManager : CreateAsync(new IdentityRole(...))
RoleManager-->>Contributor : 创建成功
else 角色已存在
RoleManager-->>Contributor : 返回角色对象
end
Contributor-->>Seeder : 完成
Seeder-->>Worker : 完成

图表来源

  • IdentityDataSeedContributor.cs

本节来源

  • IdentityDataSeedContributor.cs

ClientDataSeederContributor分析

ClientDataSeederContributor负责初始化客户端相关的数据，包括OpenIddict应用、API资源、API作用域等。该类根据配置决定使用OpenIddict还是IdentityServer进行数据初始化。

flowchart TD
Start([开始]) --> CheckConfig["检查配置 AuthServer:UseOpenIddict"]
CheckConfig --> |True| SeedOpenIddict["执行 OpenIddict 数据初始化"]
CheckConfig --> |False| SeedIdentityServer["执行 IdentityServer 数据初始化"]
SeedOpenIddict --> CreateScope["创建作用域 lingyun-abp-application"]
CreateScope --> CreateApp["创建应用 lingyun-abp-application"]
CreateApp --> End([结束])
SeedIdentityServer --> CreateApiResources["创建 API 资源"]
CreateApiResources --> CreateApiScopes["创建 API 作用域"]
CreateApiScopes --> CreateClients["创建客户端"]
CreateClients --> End

图表来源

  • ClientDataSeederContributor.cs

本节来源

  • ClientDataSeederContributor.cs

IdentityServerDataSeedContributor分析

IdentityServerDataSeedContributor是身份服务器模块的核心数据种子贡献者，负责初始化所有与身份验证和授权相关的数据。

classDiagram
class IdentityServerDataSeedContributor {
-IApiResourceRepository _apiResourceRepository
-IApiScopeRepository _apiScopeRepository
-IClientRepository _clientRepository
-ICustomIdentityResourceDataSeeder _customIdentityResourceDataSeeder
-IIdentityResourceDataSeeder _identityResourceDataSeeder
-IWeChatResourceDataSeeder _weChatResourceDataSeeder
-IGuidGenerator _guidGenerator
-IPermissionDataSeeder _permissionDataSeeder
-IConfiguration _configuration
-ICurrentTenant _currentTenant
+Task SeedAsync(DataSeedContext context)
-CreateWeChatClaimTypeAsync()
-CreateApiScopesAsync()
-CreateApiResourcesAsync()
-CreateClientsAsync()
}
class ICustomIdentityResourceDataSeeder {
<<interface>>
+Task CreateCustomResourcesAsync()
}
class IIdentityResourceDataSeeder {
<<interface>>
+Task CreateStandardResourcesAsync()
}
class IWeChatResourceDataSeeder {
<<interface>>
+Task CreateStandardResourcesAsync()
}
IdentityServerDataSeedContributor --> ICustomIdentityResourceDataSeeder : "使用"
IdentityServerDataSeedContributor --> IIdentityResourceDataSeeder : "使用"
IdentityServerDataSeedContributor --> IWeChatResourceDataSeeder : "使用"

图表来源

  • IdentityServerDataSeedContributor.cs

本节来源

  • IdentityServerDataSeedContributor.cs

多租户环境下的数据初始化

在多租户环境中，数据种子需要考虑租户上下文的切换。ABP框架通过ICurrentTenant服务提供了租户上下文管理功能，数据种子贡献者可以在SeedAsync方法中使用using语句来临时改变当前租户。

sequenceDiagram
participant Context as DataSeedContext
participant Tenant as ICurrentTenant
participant Contributor as DataSeedContributor
Context->>Contributor : SeedAsync(context)
Contributor->>Tenant : Change(context.TenantId)
activate Tenant
Contributor->>Database : 执行数据初始化操作
Database-->>Contributor : 返回结果
deactivate Tenant
Contributor-->>Context : 完成

图表来源

  • IdentityDataSeedContributor.cs

本节来源

  • IdentityDataSeedContributor.cs

条件性数据填充实现

数据种子贡献者通常需要实现条件性数据填充，即仅在数据库为空或特定条件满足时才插入数据。这可以通过查询现有数据来判断是否需要执行初始化操作。

flowchart TD
A[开始] --> B{检查数据是否存在}
B --> |不存在| C[执行数据插入]
C --> D[保存更改]
D --> E[结束]
B --> |已存在| F[跳过插入]
F --> E

图表来源

  • IdentityDataSeedContributor.cs

本节来源

  • IdentityDataSeedContributor.cs

执行流程与顺序控制

数据种子的执行流程由后台工作服务（Background Service）驱动，通过IDataSeeder服务协调多个IDataSeedContributor的执行顺序。

sequenceDiagram
participant Host as HostedService
participant Worker as DataSeederWorker
participant Seeder as IDataSeeder
participant Contributors as List<IDataSeedContributor>
Host->>Worker : StartAsync()
Worker->>Seeder : SeedAsync()
Seeder->>Contributors : 遍历所有贡献者
loop 每个贡献者
Contributors->>Contributor : SeedAsync(context)
Contributor-->>Contributors : 完成
end
Contributors-->>Seeder : 全部完成
Seeder-->>Worker : 完成
Worker-->>Host : 完成

图表来源

  • IdentityServerDataSeederWorker.cs
  • IdentityServerModule.Seeder.cs

本节来源

  • IdentityServerDataSeederWorker.cs
  • IdentityServerModule.Seeder.cs

调试方法与最佳实践

调试方法

  1. 在SeedAsync方法中添加日志记录，跟踪执行流程
  2. 使用断点调试，观察数据查询和插入的过程
  3. 检查数据库状态，确认数据是否正确插入

最佳实践

  1. 始终检查数据是否存在，避免重复插入
  2. 使用事务确保数据一致性
  3. 合理组织数据种子贡献者的职责，保持单一职责原则
  4. 在开发环境中启用数据种子，在生产环境中谨慎使用

本节来源

  • IdentityDataSeedContributor.cs
  • ClientDataSeederContributor.cs

版本升级时的数据迁移策略

在系统版本升级时，数据种子机制可以用于执行数据迁移任务。通过在新的数据种子贡献者中添加版本检查逻辑，可以确保只在特定版本升级时执行相应的数据迁移操作。

flowchart TD
A[开始] --> B{检查当前版本}
B --> |需要迁移| C[执行数据迁移]
C --> D[更新版本标记]
D --> E[结束]
B --> |无需迁移| E

图表来源

  • IdentityServerDataSeedContributor.cs

本节来源

  • IdentityServerDataSeedContributor.cs