基於SqlSugar的資料庫訪問處理的封裝，支援.net FrameWork和.net core的專案呼叫

語言: CN / TW / HK

時間 2022-04-29 11:24:00 部落格園-wuhuacong專欄

由於我們有時候需要在基於.net framework的專案上使用（如Winform端應用），有時候有需要在.net core的專案上使用(如.net core的WebAPI），那麼我們把基於SQLSugar的基礎模組封裝，編譯為.net standard就很有必要，而且由於.net framework和.net core在配置檔案上的差異，我們需要對基礎配置資訊進行不同環境的相容處理，以便實現基礎模組支援.net FrameWork和.net core的專案呼叫。

1、基於.netStandard的類庫模組

在上篇隨筆《基於SqlSugar的資料庫訪問處理的封裝，支援多資料庫並使之適應於實際業務開發中（1）》中介紹了對SqlSugar 基礎模組的封裝處理，為了相容不同型別的框架，我們可以把它們封裝為.net Standard類庫。

但是為了基礎模組能夠順利載入不同.net框架下的配置檔案資訊來初始化資料庫連線，我們需要配置不同的載入處理方式來讀取處理。

如.net Framework的使用App.config中讀取配置資訊，而.net core專案中使用讀取 appSettings.json裡面的配置資訊。

因此需要讓它們相容，我們需要修改專案檔案中的TargetFrameworks，讓它根據不同的框架生成不同的DLL類庫，從而達到支援不同環境下配置檔案的讀取處理。

這樣我們檢視專案屬性，就可以看到類庫是支援多種目標框架的了。

接下來我們對DbContext輔助類進行改動，讓它根據不同的目標框架條件來讀取配置資訊。

統一入口就是呼叫ConfigHelper輔助類來隔離處理操作。

        public DbContext()
        {
            this.DbSetting = ConfigHelper.GetDbSettings();
            Init(this.DbSetting.DbConfigName);
        }

        public DbContext(string dbConfigName)
        {
            if (this.DbSetting == null)
            {
                this.DbSetting = ConfigHelper.GetDbSettings();
            }
            Init(dbConfigName);
        }

以替代原先的處理程式碼。原先的只能從.net framework的App.config中讀取，現在我們需要根據框架來判斷處理。

        public DbContext()
        {
            //預設採用配置項名
            //appSettings/DefaultDb 配置項為指定連線字串的name
            var dbConfigName = ConfigurationManager.AppSettings["DefaultDb"];
            Init(dbConfigName);
        }

我們先來定義一個承載資料庫資訊的實體類物件。

    /// <summary>
    /// 資料庫配置資訊
    /// </summary>
    public class DbSetting
    {
        /// <summary>
        /// 預設指定的連線字串集合的配置項名稱
        /// </summary>
        public string DbConfigName { get; set; }

        /// <summary>
        /// 資料庫型別，預設為SQLServer
        /// </summary>
        public string DbType { get; set; } = "sqlserver";

        /// <summary>
        /// 連線字串
        /// </summary>
        public string ConnectionString { get; set; }

    }

在目標框架為.net framwork的時候，我們的App.Config配置資訊是下面的。

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <connectionStrings>
    <!--Sqlserver資料庫的連線字串-->
    <add name="sqlserver" providerName="System.Data.SqlClient" connectionString="Persist Security Info=False;Data Source=(local);Initial Catalog=WinFramework;Integrated Security=SSPI" />
    <!--MySQL資料庫的連線字串-->
    <add name="mysql" providerName="MySql.Data.MySqlClient" connectionString="Server=localhost;Database=winframework;Uid=root;Pwd=123456;SslMode=none" />
    <!--sqlite資料庫字串，路徑符號|DataDirectory|代表當前執行目錄-->
    <add name="sqlite" providerName="System.Data.SQLite" connectionString="Data Source=|DataDirectory|\WinFramework.db;Version=3;" />
    <!--PostgreSQL資料庫的連線字串-->
    <add name="npgsql" providerName="Npgsql" connectionString="Server=localhost;Port=5432;Database=winframework;User Id=postgres;Password=123456" />
    <!--不受驅動影響，32位64位均可使用-->
    <add name="oracle" providerName="OracleManaged" connectionString="Data Source=(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=localhost)(PORT=1521))(CONNECT_DATA=(SERVER=DEDICATED)(SERVICE_NAME=orcl)));User ID=win;Password=win" />
    <!--達夢資料庫的連線字串-->
    <add name="Dm" providerName="Dm" connectionString="Server=localhost;User ID=SYSDBA;PWD=SYSDBA;Database=WINFRAMEWORK;" />
  </connectionStrings>
  
  <appSettings>
    <!--指定預設的資料庫型別，如果不指定則使用第一個連線字串-->
    <add key="DefaultDb" value="sqlserver" />
    <!--字典、許可權元件的資料庫型別：mysql、npgsql、oracle、sqlite、sqlserver等，預設為sqlserver可不寫-->
    <add key="ComponentDbType" value="sqlserver" />
  </appSettings>
  <startup>
    <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.8" />
  </startup>

而如果是基於.net core的情況下，讀取的是appSettings.json裡面的配置資訊，配置檔案資訊如下所示。

{
  "ConnectionStrings": {
    "Default": "Server=.; Database=WeixinBootstrap2; Trusted_Connection=True;",
    "Oracle": "Data Source=(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=localhost)(PORT=1521))(CONNECT_DATA=(SERVER=DEDICATED)(SERVICE_NAME=orcl)));User ID=C##ABP;Password=abp",
    "MySql": "Server=localhost;Database=myprojectdb;Uid=root;Pwd=123456;",
    "PostgreSQL": "Server=localhost;Port=5432;Database=myprojectdb;User Id=postgres;Password=123456"
  },
  "DbSetting": {
    "DefaultDb": "Default",
    "ComponentDbType": "sqlserver"
  },

   ...........   

  }

其中 DefaultDb 指向的是預設的連線字串配置節點名稱，而ComponentDbType為它的資料庫型別，如sqlserver,mysql這樣的標識。

2、根據不同目標框架讀取配置資訊

有了上面不同目標框架下的配置資訊節點的格式，我們就可以根據目標框架的不同來相應讀取配置資訊，從而實現不同的初始化處理操作。

        /// <summary>
        /// 根據承載環境是netframework或者是.netcore，讀取配置資訊。
        /// 在.netframework中的app.config的appSettings中配置DefaultDb，ComponentDbType，連線字串在connectionStrings中配置
        /// 在.netcore中的appSettings.json的DbSetting節點中配置DefaultDb，ComponentDbType，連線字串在ConnectionStrings中配置
        /// </summary>
        /// <returns></returns>
        public static DbSetting GetDbSettings()
        {
            //初始化承載配置資訊物件
            var dbSetting = new DbSetting();

#if NETFRAMEWORK
            //基於.net frameowork下讀取app.config的配置
            dbSetting.DbType = ConfigurationManager.AppSettings["ComponentDbType"] ?? "sqlserver";
            dbSetting.DbConfigName = ConfigurationManager.AppSettings["DefaultDb"];

            var setting = ConfigurationManager.ConnectionStrings[1];//預設第一個連線字串
            if (!string.IsNullOrWhiteSpace(dbSetting.DbConfigName))
            {
                //如果配置節點名稱存在，則讀取它的連線字串
                setting = ConfigurationManager.ConnectionStrings[dbSetting.DbConfigName];
            }
            if (setting != null)
            {
                dbSetting.ConnectionString = setting.ConnectionString;
            }
#else
            //基於.net core下的讀取appsettings.json的配置資訊
            dbSetting.DbType = GetSectionValue("DbSetting:ComponentDbType") ?? "sqlserver";
            dbSetting.DbConfigName = GetSectionValue("DbSetting:DefaultDb");
            
            var connectionStringKey = string.Format("ConnectionStrings:{0}", dbSetting.DbConfigName);
            dbSetting.ConnectionString = GetSectionValue(connectionStringKey);
#endif
            return dbSetting;
        }

我們可以從類的頂部來選擇對應的分類，從而實現程式碼的加亮顯示，便於程式碼的編寫。

另外，我們根據配置資訊的資料庫型別，通過遍歷判斷的方式來轉換為SqlSugar對應的資料庫型別即可。

這樣DbContext初始化的時候，就能夠順利適用於不同的目標框架中了，我們在SQLSugar封裝的基類就可以不管它的具體處理，只需要初始化DbContext即可，如下程式碼所示。

基類呼叫來處理常規的物件返回操作，程式碼如下所示。

        /// <summary>
        /// 獲取所有記錄
        /// </summary>
        public virtual async Task<ListResultDto<TEntity>> GetAllAsync()
        {
            var list = await EntityDb.GetListAsync();
            return new ListResultDto<TEntity>()
            {
                Items = list
            };
        }

而如果我們需要聯合多表來實現聯合查詢，也可以使用基類的物件進行處理。

如對於字典來說，根據字典大類名稱來獲取字典專案資訊，而字典專案表裡面，只有字典大類的ID，那麼就需要聯合字典大類和字典專案兩個表進行關聯查詢了，如下程式碼所示。

        /// <summary>
        /// 根據字典型別名稱獲取所有該型別的字典列表集合(Key為名稱，Value為值）
        /// </summary>
        /// <param name="dictTypeName">字典型別名稱</param>
        /// <returns></returns>
        public async Task<Dictionary<string, string>> GetDictByDictType(string dictTypeName)
        {
            var query = this.dbContent.Client.Queryable<DictDataInfo, DictTypeInfo>(
                (d, t) => d.DictType_ID == t.Id && t.Name == dictTypeName)
                .Select(d => d); //聯合條件獲取物件

            query = query.OrderBy(d => d.DictType_ID).OrderBy(d => d.Seq);//排序
            var list = await query.ToListAsync();//獲取列表

            var dict = new Dictionary<string, string>();
            foreach (var info in list)
            {
                if (!dict.ContainsKey(info.Name))
                {
                    dict.Add(info.Name, info.Value);
                }
            }
            return dict;
        }

這樣就可以實現聯合表的查詢處理。

至此，我們就可以無差別的在不同的目標框架上，根據不同的配置檔案來初始化我們的DbContext類，從而無差別的使用基於SqlSugar的資料庫訪問處理的基類，簡化了框架的處理。

相關隨筆列表如下所示。

基於SqlSugar的資料庫訪問處理的封裝，支援.net FrameWork和.net core的專案呼叫（本篇隨筆）

基於SqlSugar的資料庫訪問處理的封裝，支援多資料庫並使之適應於實際業務開發中(2)

基於SqlSugar的資料庫訪問處理的封裝，支援多資料庫並使之適應於實際業務開發中

「其他文章」