IdentityServer4中如何使用EntityFramework Core进行持久化配置

IdentityServer4 是一个用于 ASP.NET Core 的 OpenID Connect 和 OAuth 2.0 框架，它允许你为应用程序添加身份验证和授权功能。在实际应用中，我们通常需要将 IdentityServer4 的配置数据（如客户端、资源、用户等）持久化到数据库中，以便于管理和维护。EntityFramework Core 是一个流行的 ORM 框架，它可以帮助我们轻松地将数据存储到关系型数据库中。

本文将详细介绍如何在 IdentityServer4 中使用 EntityFramework Core 进行持久化配置。

1. 准备工作

在开始之前，确保你已经安装了以下工具和库：

• .NET Core SDK
• Visual Studio 或 Visual Studio Code
• EntityFramework Core
• IdentityServer4
• IdentityServer4.EntityFramework

你可以通过以下命令安装所需的 NuGet 包：

dotnet add package IdentityServer4
dotnet add package IdentityServer4.EntityFramework
dotnet add package Microsoft.EntityFrameworkCore.SqlServer

2. 创建数据库上下文

首先，我们需要创建一个数据库上下文（DbContext），用于管理 IdentityServer4 的配置数据。IdentityServer4.EntityFramework 提供了一些预定义的实体类和上下文类，我们可以直接使用它们。

using IdentityServer4.EntityFramework.DbContexts;
using IdentityServer4.EntityFramework.Options;
using Microsoft.EntityFrameworkCore;

public class IdentityServerDbContext : ConfigurationDbContext<IdentityServerDbContext>
{
    public IdentityServerDbContext(DbContextOptions<IdentityServerDbContext> options, ConfigurationStoreOptions storeOptions)
        : base(options, storeOptions)
    {
    }

    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        base.OnModelCreating(modelBuilder);
    }
}

在这个例子中，我们创建了一个名为 IdentityServerDbContext 的上下文类，它继承自 ConfigurationDbContext。ConfigurationDbContext 是 IdentityServer4.EntityFramework 提供的一个上下文类，用于管理配置数据。

3. 配置数据库连接

接下来，我们需要在 Startup.cs 文件中配置数据库连接。我们可以使用 AddConfigurationStore 和 AddOperationalStore 方法来配置 IdentityServer4 的配置数据和操作数据。

public void ConfigureServices(IServiceCollection services)
{
    var connectionString = "Server=(localdb)\\mssqllocaldb;Database=IdentityServer4;Trusted_Connection=True;";

    services.AddIdentityServer()
        .AddConfigurationStore(options =>
        {
            options.ConfigureDbContext = builder =>
                builder.UseSqlServer(connectionString,
                    sql => sql.MigrationsAssembly(typeof(Startup).Assembly.FullName));
        })
        .AddOperationalStore(options =>
        {
            options.ConfigureDbContext = builder =>
                builder.UseSqlServer(connectionString,
                    sql => sql.MigrationsAssembly(typeof(Startup).Assembly.FullName));
        })
        .AddDeveloperSigningCredential();

    services.AddDbContext<IdentityServerDbContext>(options =>
        options.UseSqlServer(connectionString));
}

在这个例子中，我们使用 SQL Server 作为数据库，并配置了连接字符串。AddConfigurationStore 方法用于配置 IdentityServer4 的配置数据存储，AddOperationalStore 方法用于配置操作数据存储。我们还使用了 AddDeveloperSigningCredential 方法，它会在开发环境中生成一个临时的签名证书。

4. 迁移数据库

在配置好数据库连接后，我们需要使用 EntityFramework Core 的迁移功能来创建数据库表。首先，我们需要创建一个迁移：

dotnet ef migrations add InitialIdentityServerMigration --context IdentityServerDbContext

然后，我们可以使用以下命令将迁移应用到数据库中：

dotnet ef database update --context IdentityServerDbContext

这将创建 IdentityServer4 所需的数据库表。

5. 添加初始数据

在数据库创建完成后，我们可以添加一些初始数据，如客户端、资源和用户。我们可以通过编写一个初始化脚本来完成这个任务。

public class SeedData
{
    public static void EnsureSeedData(IServiceProvider serviceProvider)
    {
        using (var scope = serviceProvider.GetRequiredService<IServiceScopeFactory>().CreateScope())
        {
            var context = scope.ServiceProvider.GetService<IdentityServerDbContext>();

            if (!context.Clients.Any())
            {
                foreach (var client in Config.GetClients())
                {
                    context.Clients.Add(client.ToEntity());
                }
                context.SaveChanges();
            }

            if (!context.IdentityResources.Any())
            {
                foreach (var resource in Config.GetIdentityResources())
                {
                    context.IdentityResources.Add(resource.ToEntity());
                }
                context.SaveChanges();
            }

            if (!context.ApiResources.Any())
            {
                foreach (var resource in Config.GetApiResources())
                {
                    context.ApiResources.Add(resource.ToEntity());
                }
                context.SaveChanges();
            }
        }
    }
}

在这个例子中，我们创建了一个 SeedData 类，并在其中定义了一个 EnsureSeedData 方法。这个方法会检查数据库中是否已经存在客户端、资源和用户数据，如果不存在，则添加初始数据。

6. 运行应用程序

最后，我们可以运行应用程序并验证配置是否生效。在应用程序启动时，IdentityServer4 会自动加载配置数据，并使用 EntityFramework Core 进行持久化。

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }

    app.UseIdentityServer();

    SeedData.EnsureSeedData(app.ApplicationServices);
}

在 Configure 方法中，我们调用了 SeedData.EnsureSeedData 方法来确保初始数据被添加到数据库中。

7. 总结

通过以上步骤，我们成功地在 IdentityServer4 中使用 EntityFramework Core 进行了持久化配置。我们创建了一个数据库上下文，配置了数据库连接，并使用了 EntityFramework Core 的迁移功能来创建数据库表。最后，我们添加了初始数据，并验证了配置是否生效。

使用 EntityFramework Core 进行持久化配置可以大大简化 IdentityServer4 的管理和维护工作，特别是在需要频繁更新配置数据的情况下。希望本文对你有所帮助，祝你在使用 IdentityServer4 和 EntityFramework Core 的过程中取得成功！