淺入 ABP 系列(6)：資料庫配置
淺入 ABP 系列(6)：資料庫配置
版權護體©作者：痴者工良，微信公眾號轉載文章需要 《NCC開源社群》同意。
目錄
本系列的第五篇：https://www.cnblogs.com/whuanle/p/13061059.html
因為這一部分屬於 ASP.NET Core 的基礎部分，ABP 沒有封裝，因此沒啥要說的。
這一篇我們將來學習如何在 ABP 中新增資料庫配置以及劃分一個簡單資料庫模組的結構，我們將使用 EFCore + Freesql 來搭建資料庫模組。
強烈推薦 Freesql！Freesql 是葉老師出品的 ORM 框架，現在屬於 NCC 成員專案，Freesql 解決了我很多在日常開發中的痛點，並且其對業務開發的考慮和眾多有些的拓展功能，實在令我愛不釋手！
在 AbpBase.Database 中，通過 Nuget 新增以下幾個庫：
版本都是 1.9.0-preview0917，你可以使用最新版本的。
Freesql
FreeSql.Provider.Sqlite
FreeSql.Provider.SqlServer
FreeSql.Provider.MySql
建立標準的 EFCore 資料庫上下文
在 ABP 中，EFCore 上下文類需要繼承 AbpDbContext<T>，整體編寫方法跟繼承 DbContext<T> 一致 ，接下來我們將一步步來講解在 AbpBase 中如何新增 EFCore 功能。
連線字串
ABP 中，可以在上下文類加上一個 ConnectionStringName 特性，然後在配置服務時，ABP 會自動為其配置連線字串。
[ConnectionStringName("Default")]
public partial class DatabaseContext : AbpDbContext<DatabaseContext>
Default 是一個標識，你也可以填寫其他字串標識。
定義隔離的上下文
首先，我們在 AbpBase.Database 模組中，建立兩個資料夾：
BaseData
ExtensionData
BaseData
ExtensionData 用來存放可能會拓展或者經常變動的表結構。
在 BaseData 中建立一個 AbpBaseDataContext 類，其內容如下：
using Microsoft.EntityFrameworkCore;
using Volo.Abp.Data;
using Volo.Abp.EntityFrameworkCore;
namespace AbpBase.Database
{
/// <summary>
/// 上下文
/// <para>這部分用於定義和配置基礎表的對映</para>
/// </summary>
[ConnectionStringName("Default")]
public partial class AbpBaseDataContext : AbpDbContext<AbpBaseDataContext>
{
#region 定義 DbSet<T>
#endregion
public AbpBaseDataContext(DbContextOptions<AbpBaseDataContext> options)
: base(options)
{
}
/// <summary>
/// 定義對映
/// </summary>
/// <param name="modelBuilder"></param>
protected override void OnModelCreating(ModelBuilder modelBuilder)
{
#region 定義 對映
#endregion
OnModelCreatingPartial(modelBuilder);
}
partial void OnModelCreatingPartial(ModelBuilder modelBuilder);
}
}
在 ExtensionData 中也建立一個相同的 AbpBaseDataContext 類，其內容如下：
using Microsoft.EntityFrameworkCore;
namespace AbpBase.Database
{
public partial class AbpBaseDataContext
{
#region 定義 DbSet<T>
#endregion
/// <summary>
/// 定義對映
/// </summary>
/// <param name="modelBuilder"></param>
partial void OnModelCreatingPartial(ModelBuilder modelBuilder)
{
}
}
}
分部類，前者用於定義那些非常基礎的，程式核心的實體(表)以及對映。而後者定義後續可能多次修改的，設計時感覺有設計餘地的。
多資料庫支援和配置
這裡我們將對上下文進行配置和注入，使得程式能夠支援多資料庫。
在 AbpBase.Domain.Shared 專案中，建立一個列舉，其內容如下：
namespace AbpBase.Domain.Shared
{
public enum AbpBaseDataType
{
Sqlite = 0,
Mysql = 1,
Sqlserver = 2
// 其他資料庫
}
}
再建立一個 WholeShared 類，其內容如下：
namespace AbpBase.Domain.Shared
{
/// <summary>
/// 全域性共享內容
/// </summary>
public static class WholeShared
{
// 資料庫連線屬性可以自行在配置檔案中定義，這裡寫固定的，只是為了演示
/// <summary>
/// 資料庫連線字串
/// </summary>
public static readonly string SqlConnectString = "";
/// <summary>
/// 要使用的資料庫型別
/// </summary>
public static readonly AbpBaseDataType DataType = AbpBaseDataType.Sqlite;
}
}
然後我們在 AbpBaseDatabaseModule 模組中的 ConfigureServices 函式裡面新增依賴注入：
context.Services.AddAbpDbContext<AbpBaseDataContext>();
這裡不需要配置資料庫連線字串，後面可以通過 ABP 的一些方法來配置。
配置上下文連線字串
string connectString = default;
Configure<AbpDbConnectionOptions>(options =>
{
connectString = WholeShared.SqlConnectString;
options.ConnectionStrings.Default = connectString;
});
配置多資料庫支援：
FreeSql.DataType dataType = default;
Configure<AbpDbContextOptions>(options =>
{
switch (WholeShared.DataType)
{
case AbpBaseDataType.Sqlite:
options.UseSqlite<AbpBaseDataContext>(); dataType = FreeSql.DataType.Sqlite; break;
case AbpBaseDataType.Mysql:
options.UseMySQL<AbpBaseDataContext>(); dataType = FreeSql.DataType.MySql; break;
case AbpBaseDataType.Sqlserver:
options.UseSqlServer<AbpBaseDataContext>(); dataType = FreeSql.DataType.SqlServer; break;
}
});
這樣就完成了對 EFCore 的多資料庫配置了。
下面我們來使用類似的方法配置 Freesql。
Freesql 配置服務
首先，Freesql 裡面有多種配置方式，例如 DbContext，讀者可以到 Wiki 去學習 Freesql：https://github.com/dotnetcore/FreeSql/wiki/%E5%85%A5%E9%97%A8
筆者這裡使用的是 “非正規” 的設計方式，哈哈哈哈。
在 BaseData 目錄中，建立一個 FreesqlContext 類，其內容如下：
using FreeSql.Internal;
using System;
using System.Collections.Generic;
using System.Text;
namespace AbpBase.Database
{
/// <summary>
/// Freesql 上下文
/// </summary>
public partial class FreesqlContext
{
public static IFreeSql FreeselInstance => Freesql_Instance;
private static IFreeSql Freesql_Instance;
public static void Init(string connectStr, FreeSql.DataType dataType = FreeSql.DataType.Sqlite)
{
Freesql_Instance = new FreeSql.FreeSqlBuilder()
.UseNameConvert(NameConvertType.PascalCaseToUnderscore)
.UseConnectionString(dataType, connectStr)
//.UseAutoSyncStructure(true) // 自動同步實體結構到資料庫，生產環境禁止使用！
.Build();
OnModelCreating(Freesql_Instance);
}
private static void OnModelCreating(IFreeSql freeSql)
{
OnModelCreatingPartial(freeSql);
}
}
}
ExtensionData 目錄中，建立 FreesqlContext 類 如下：
using FreeSql;
using System;
using System.Collections.Generic;
using System.Text;
namespace AbpBase.Database
{
public partial class FreesqlContext
{
private static void OnModelCreatingPartial(IFreeSql freeSql)
{
var modelBuilder = freeSql.CodeFirst;
SyncStruct(modelBuilder);
}
/// <summary>
/// 同步結構到資料中
/// </summary>
/// <param name="codeFirst"></param>
private static void SyncStruct(ICodeFirst codeFirst)
{
// codeFirst.SyncStructure(typeof(user));
}
}
}
然後在 AbpBaseDatabaseModule 的 ConfigureServices 函式中添加註入服務：
FreesqlContext.Init(connectString, dataType);
context.Services.AddSingleton(typeof(IFreeSql), FreesqlContext.FreeselInstance);
context.Services.AddTransient(typeof(FreesqlContext), typeof(FreesqlContext));
通過以上步驟，我們的 ABP 就可以支援多資料庫了，EFCore + Freesql，並且將將表分級隔離維護。