IdentityServer4系列 | 支持數據持久化

一、前言

在前面的篇章介紹中，一些基礎配置如API資源、客戶端資源等數據以及使用過程中發放的令牌等操作數據，我們都是通過將操作數據和配置數據存儲在內存中進行實現的，而在實際開發生產中，我們需要考慮如何處理數據持久化呢？

這時IdentityServer4具有良好的擴展性，其中一個可擴展點是用於IdentityServer所需數據的存儲機制，進行持久化操作。

下面將如何配置IdentityServer以使用EntityFramework（EF）作為此數據的存儲機制把這些數據存儲到Sql Server數據庫， 這樣更符合我們實際生產環境的需求。

二、初識

在我們的 IdentityServer4中官方定義的兩個上下文，是有兩種類型的數據需要持久化到數據庫中：

1、配置數據（資源、客戶端、身份）；//這里是對應配置上下文 ConfigurationDbContext

2、IdentityServer在使用時產生的 操作數據（令牌，代碼和用戶的授權信息consents）；//這里是對應操作上下文 PersistedGrantDbContext

這兩個上下文以及對應的數據模型，已經被 IdentityServer4 官方給封裝好了， 我們不需要做額外的操作，直接進行遷移即可使用。

2.1 ConfigurationDb

ConfigurationDbContext (IdentityServer configuration data) —— 負責數據庫中對客戶端、資源和 CORS 設置的配置存儲；

如果需要從 EF 支持的數據庫加載客戶端、標識資源、API 資源或 CORS 數據 (而不是使用內存中配置)， 則可以使用配置存儲。此支持提供 IClientStore、IResura Store 和 ICorsPolicyService 擴展性點的實現。這些實現使用名為 ConfigurationDbContext 的 dbcontext 派生類對數據庫中的表進行建模。

2.2 PersistedGrantDb

PersistedGrantDbContext (IdentityServer operational data.) -—— 負責存儲同意、授權代碼、刷新令牌和引用令牌；

如果需要從 EF 支持的數據庫 (而不是默認的內存數據庫) 加載授權授予、同意和令牌 (刷新和引用)， 則可以使用操作存儲。此支持提供了 IPersistedGrantStore 擴展點的實現。實現使用名為 PersistedGrantDbContext 的 dbcontext 派生類對數據庫中的表進行建模。

三、實踐

3.1 新建站點

建立一個MVC的Asp.Net Core項目 ，使用MVC模板

3.2 Nuget包

IdentityServer4.EntityFramework以及EF相關包

1.IdentityServer4
2.IdentityServer4.AspNetIdentity
3.IdentityServer4.EntityFramework

因為本文中使用的是SqlServer數據庫，所以需要安裝對應的EF程序包對數據庫的支持。

Microsoft.EntityFrameworkCore.SqlServer

3.3 數據庫上下文

appsettings.json

  "ConnectionStrings": {
    "DataContext": "data source=.;initial catalog=Yuan.Idp;user id=sa;password=123456;",   
  }

配置連接數據庫

 var connectionString = Configuration.GetConnectionString("DataContext");
 if (connectionString == "")
 {
      throw new Exception("數據庫配置異常");
 }

2.配置數據庫服務

在startup.cs中ConfigureServices方法添加如下代碼：

        public void ConfigureServices(IServiceCollection services)
        {
            services.AddControllersWithViews();
            var connectionString = Configuration.GetConnectionString("DataContext");
            if (connectionString == "")
            {
                throw new Exception("數據庫配置異常");
            }
            var migrationsAssembly = typeof(Startup).GetTypeInfo().Assembly.GetName().Name;
            // in DB  config
            var builder = services.AddIdentityServer(options =>
            {
                options.Events.RaiseErrorEvents = true;
                options.Events.RaiseInformationEvents = true;
                options.Events.RaiseFailureEvents = true;
                options.Events.RaiseSuccessEvents = true;
            }).AddConfigurationStore(options => //添加配置數據（ConfigurationDbContext上下文用戶配置數據）
            {
                options.ConfigureDbContext = builder => builder.UseSqlServer(connectionString, sql => sql.MigrationsAssembly(migrationsAssembly));
            }).AddOperationalStore(options =>   //添加操作數據（PersistedGrantDbContext上下文 臨時數據（如授權和刷新令牌））
            {
                options.ConfigureDbContext = builder => builder.UseSqlServer(connectionString, sql => sql.MigrationsAssembly(migrationsAssembly));
                // 自動清理 token ，可選
                options.EnableTokenCleanup = true;
                // 自動清理 token ，可選
                options.TokenCleanupInterval = 30;
            }).AddTestUsers(TestUsers.Users);
            // not recommended for production - you need to store your key material somewhere secure
            builder.AddDeveloperSigningCredential();

            services.ConfigureNonBreakingSameSiteCookies();
        }

3.4 遷移數據

3.4.1 控制台遷移

方法一：

需要添加EF工具，安裝Microsoft.EntityFrameworkCore.Tools, 進行遷移

  1、add-migration InitialIdentityServerPersistedGrantDbMigration -c PersistedGrantDbContext -o Data/Migrations/PersistedGrantDb 
   2、add-migration InitialIdentityServerConfigurationDbMigration -c ConfigurationDbContext -o Data/Migrations/ConfigurationDb 
   3、update-database -Context PersistedGrantDbContext
   4、update-database -Context ConfigurationDbContext   

3.4.2 在命令窗口

方法二：

判斷是否支持命令行遷移，你可以在項目所在的目錄下打開一個命令 Power shell 並運行命令 dotnet ef， 它應該是這樣的：

dotnet ef 無法執行，因為找不到指定的命令或文件

從 3.0 起，EF Core 命令列工具 (dotnet ef) 不在 .NET Core SDK 里面，需另裝。命令如下：

dotnet tool install --global dotnet-ef

要創建遷移，請在IdentityServer項目目錄中打開命令提示符。 在命令提示符下運行這兩個命令：

1. dotnet ef migrations add InitialIdentityServerPersistedGrantDbMigration -c PersistedGrantDbContext -o Data/Migrations/PersistedGrantDb
2. dotnet ef migrations add InitialIdentityServerConfigurationDbMigration -c ConfigurationDbContext -o Data/Migrations/ConfigurationDb
 
#生成
1. update-database -c PersistedGrantDbContext   
2. update-database -c ConfigurationDbContext  

3.5 顯示數據庫

(圖片來自網絡)

3.6 初始化數據庫

在之前的篇章中，我們是定義的內存配置數據實現的操作，而在本篇中，我們進行數據持久化操作，可以將之前內存的數據作為種子處理遷移到創建的數據庫中進行初始化操作。

參考文章: 用戶數據遷移

3.6.1 創建文件

創建SeedData.cs文件，用於初始化基礎數據：

    public class SeedData
    {
        public static void EnsureSeedData(IServiceProvider serviceProvider)
        {
            Console.WriteLine("Seeding database...");

            using (var scope = serviceProvider.GetRequiredService<IServiceScopeFactory>().CreateScope())
            {
                scope.ServiceProvider.GetService<PersistedGrantDbContext>().Database.Migrate();

               var context = scope.ServiceProvider.GetRequiredService<ConfigurationDbContext>();
                context.Database.Migrate();
                EnsureSeedData(context);
            }

            Console.WriteLine("Done seeding database.");
            Console.WriteLine();
        }
        private static void EnsureSeedData(ConfigurationDbContext context)
        {
            if (!context.Clients.Any())
            {
                Console.WriteLine("Clients 正在初始化");
                foreach (var client in Config.GetClients)
                {
                    context.Clients.Add(client.ToEntity());
                }
                context.SaveChanges();
            }

            if (!context.IdentityResources.Any())
            {
                Console.WriteLine("IdentityResources 正在初始化");
                foreach (var resource in Config.GetIdentityResources)
                {
                    context.IdentityResources.Add(resource.ToEntity());
                }
                context.SaveChanges();
            }

            if (!context.ApiResources.Any())
            {
                Console.WriteLine("ApiResources 正在初始化");
                foreach (var resource in Config.GetApiResources)
                {
                    context.ApiResources.Add(resource.ToEntity());
                }
                context.SaveChanges();
            }

            if (!context.ApiScopes.Any())
            {
                Console.WriteLine("ApiScopes 正在初始化");
                foreach (var resource in Config.GetApiScopes)
                {
                    context.ApiScopes.Add(resource.ToEntity());
                }
                context.SaveChanges();
            }
        }
    }

配置內容可以查看之前篇章內容文件Config.cs 或者項目地址.

3.6.2 調用方法

然后我們可以從主入口Main方法調用它：

        public static void Main(string[] args)
        {
            var seed = args.Contains("/seed");
            if (seed)
            {
                args = args.Except(new[] { "/seed" }).ToArray();
            }
            var host = CreateHostBuilder(args).Build();
            if (seed)
            {
                SeedData.EnsureSeedData(host.Services);
            }
            host.Run();
        }

3.6.3 程序運行

輸入 dotnet run /seed　

3.6.4 效果

四、問題

4.1 提示找不到上下文

上面我們說到了的兩個上下文，如果我們直接通過執行遷移命令是會報錯的，比如我們直接遷移 PersistedGrantDbContext 上下文：

因為遷移的目標不匹配，需要更改遷移程序集，如

options.UseSqlServer(connection, b => b.MigrationsAssembly("Ids4.EFCore"))

所以，就需要在項目中配置對應的服務，我們在 startup.cs 啟動文件中，配置服務 ConfigureService ,配置 EF 操作數據庫.

解決方法 : 可參考上面的實踐部分中的數據庫上下文.

1. 獲取數據庫連接字符串

2. 配置數據庫服務

4.2 dotnet ef 無法執行

因為找不到指定的命令或文件

從 3.0 起，EF Core 命令列工具 (dotnet ef) 不在 .NET Core SDK 里面，需另裝。命令如下：

dotnet tool install --global dotnet-ef

五、總結

1. 簡單介紹了IdentityServer4持久化存儲機制相關配置和操作數據，實現了數據遷移,及應用程序的實踐。
2. 本篇未對用戶進行持久化操作存儲說明，因為IdentityServer4本就支持了接入其他認證方式，所以自己根據需要進行合理擴展的，比如我們可以使用 Asp.Net Core 自帶的 Identity 身份認證機制來實現擴展，當然，你也可以自己定義相應的操作，在后續篇章中會進行說明介紹。
3. 如果有不對的或不理解的地方，希望大家可以多多指正，提出問題，一起討論,不斷學習,共同進步。
4. 項目地址

六、附加

EF支持持久化配置和操作數據