為ABP框架配置數(shù)據(jù)庫(kù)

更新時(shí)間：2022年02月23日 11:30:07 作者：癡者工良

這篇文章介紹了為ABP框架配置數(shù)據(jù)庫(kù)的方法，文中通過(guò)示例代碼介紹的非常詳細(xì)。對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下

創(chuàng)建標(biāo)準(zhǔn)的 EFCore 數(shù)據(jù)庫(kù)上下文

在 ABP 中，EFCore 上下文類(lèi)需要繼承 AbpDbContext<T>，整體編寫(xiě)方法跟繼承 DbContext<T> 一致，接下來(lái)我們將一步步來(lái)講解在 AbpBase 中如何添加 EFCore 功能。

連接字符串

ABP 中，可以在上下文類(lèi)加上一個(gè) ConnectionStringName 特性，然后在配置服務(wù)時(shí)，ABP 會(huì)自動(dòng)為其配置連接字符串。

    [ConnectionStringName("Default")]
    public partial class DatabaseContext : AbpDbContext<DatabaseContext>

Default 是一個(gè)標(biāo)識(shí)，你也可以填寫(xiě)其他字符串標(biāo)識(shí)。

定義隔離的上下文

首先，我們?cè)?nbsp;AbpBase.Database 模塊中，創(chuàng)建兩個(gè)文件夾：

BaseData
ExtensionData

BaseData 目錄用來(lái)存放基礎(chǔ)表結(jié)構(gòu)的上下文，ExtensionData 用來(lái)存放可能會(huì)拓展或者經(jīng)常變動(dòng)的表結(jié)構(gòu)。

在 BaseData 中創(chuàng)建一個(gè) AbpBaseDataContext 類(lèi)，其內(nèi)容如下：

using Microsoft.EntityFrameworkCore;
using Volo.Abp.Data;
using Volo.Abp.EntityFrameworkCore;

namespace AbpBase.Database
{
    /// <summary>
    /// 上下文
    /// <para>這部分用于定義和配置基礎(chǔ)表的映射</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 中也創(chuàng)建一個(gè)相同的 AbpBaseDataContext 類(lèi)，其內(nèi)容如下：

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)
        {

        }
    }
}

分部類(lèi)，前者用于定義那些非?；A(chǔ)的，程序核心的實(shí)體(表)以及映射。而后者定義后續(xù)可能多次修改的，設(shè)計(jì)時(shí)感覺(jué)有設(shè)計(jì)余地的。

多數(shù)據(jù)庫(kù)支持和配置

這里我們將對(duì)上下文進(jìn)行配置和注入，使得程序能夠支持多數(shù)據(jù)庫(kù)。

在 AbpBase.Domain.Shared 項(xiàng)目中，創(chuàng)建一個(gè)枚舉，其內(nèi)容如下：

namespace AbpBase.Domain.Shared
{
    public enum AbpBaseDataType
    {
        Sqlite = 0,
        Mysql = 1,
        Sqlserver = 2

        // 其他數(shù)據(jù)庫(kù)
    }
}

再創(chuàng)建一個(gè) WholeShared 類(lèi)，其內(nèi)容如下：

namespace AbpBase.Domain.Shared
{
    /// <summary>
    /// 全局共享內(nèi)容
    /// </summary>
    public static class WholeShared
    {
        // 數(shù)據(jù)庫(kù)連接屬性可以自行在配置文件中定義，這里寫(xiě)固定的，只是為了演示

        /// <summary>
        /// 數(shù)據(jù)庫(kù)連接字符串
        /// </summary>
        public static readonly string SqlConnectString = "";

        /// <summary>
        /// 要使用的數(shù)據(jù)庫(kù)類(lèi)型
        /// </summary>
        public static readonly AbpBaseDataType DataType = AbpBaseDataType.Sqlite;
    }
}

然后我們?cè)?nbsp;AbpBaseDatabaseModule 模塊中的 ConfigureServices 函數(shù)里面添加依賴(lài)注入：

context.Services.AddAbpDbContext<AbpBaseDataContext>();

這里不需要配置數(shù)據(jù)庫(kù)連接字符串，后面可以通過(guò) ABP 的一些方法來(lái)配置。

配置上下文連接字符串

            string connectString = default;
            Configure<AbpDbConnectionOptions>(options =>
            {
                connectString = WholeShared.SqlConnectString;
                options.ConnectionStrings.Default = connectString;
            });

配置多數(shù)據(jù)庫(kù)支持：

            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;
                }
            });

這樣就完成了對(duì) EFCore 的多數(shù)據(jù)庫(kù)配置了。

下面我們來(lái)使用類(lèi)似的方法配置 Freesql。

Freesql 配置服務(wù)

首先，F(xiàn)reesql 里面有多種配置方式，例如 DbContext，讀者可以到 Wiki 去學(xué)習(xí) Freesql：

https://github.com/dotnetcore/FreeSql/wiki/%E5%85%A5%E9%97%A8

筆者這里使用的是 “非正規(guī)” 的設(shè)計(jì)方式，哈哈哈哈。

在 BaseData 目錄中，創(chuàng)建一個(gè) FreesqlContext 類(lèi)，其內(nèi)容如下：

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) // 自動(dòng)同步實(shí)體結(jié)構(gòu)到數(shù)據(jù)庫(kù)，生產(chǎn)環(huán)境禁止使用！

                .Build();
            OnModelCreating(Freesql_Instance);
        }

        private static void OnModelCreating(IFreeSql freeSql)
        {


            OnModelCreatingPartial(freeSql);
        }
    }
}

ExtensionData 目錄中，創(chuàng)建 FreesqlContext 類(lèi) 如下：

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>
        /// 同步結(jié)構(gòu)到數(shù)據(jù)中
        /// </summary>
        /// <param name="codeFirst"></param>
        private static void SyncStruct(ICodeFirst codeFirst)
        {
            //  codeFirst.SyncStructure(typeof(user));
        }
    }
}

然后在 AbpBaseDatabaseModule 的 ConfigureServices 函數(shù)中添加注入服務(wù)：

            FreesqlContext.Init(connectString, dataType);
            context.Services.AddSingleton(typeof(IFreeSql), FreesqlContext.FreeselInstance);
            context.Services.AddTransient(typeof(FreesqlContext), typeof(FreesqlContext));

通過(guò)以上步驟，我們的 ABP 就可以支持多數(shù)據(jù)庫(kù)了，EFCore + Freesql，并且將將表分級(jí)隔離維護(hù)。

到此這篇關(guān)于為ABP框架配置數(shù)據(jù)庫(kù)的文章就介紹到這了。希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: