1. 程式人生 > >.NET Core實戰專案之CMS 第十一章 開發篇-資料庫生成及實體程式碼生成器開發

.NET Core實戰專案之CMS 第十一章 開發篇-資料庫生成及實體程式碼生成器開發

上篇給大家從零開始搭建了一個我們的ASP.NET Core CMS系統的開發框架,具體為什麼那樣設計我也已經在第十篇文章中進行了說明。不過文章釋出後很多人都說了這樣的分層不是很合理,什麼資料庫實體應該跟倉儲放在一起形成領域物件,什麼ViewModel應該放在應用層結構倉儲層與UI層。其實我想說的是,這樣都沒問題,看你自己的理解了!我上篇文章已經說了,如果你願意,完全可以把所有的層融合在一起,隨意合併分離這個依你個人喜好。我也是本著簡單原則以及合適原則的思想來進行那樣的分層結構,覺得這樣層次更分明些。還有雖然現在DDD的思想很流行,但是實現起來確很複雜,小專案就別那樣折騰了。如果你有不同的意見,歡迎加群討論。什麼?你問我群號?自己找去,我才不會告訴你!

本文已收錄至《.NET Core實戰專案之CMS 第一章 入門篇-開篇及總體規劃作者:依樂祝原文地址:https://www.cnblogs.com/yilezhu/p/10112406.html

寫在前面

今天我們就進入.NET Core實戰專案之CMS的開發篇了,在開始之前呢我們首先需要把我們前面設計的邏輯模型轉換成對應的物理模型,再根據我們物理模型生成相應的資料庫指令碼,接著我們就新建資料庫,然後執行下我們生成的指令碼即可。當然這麼多表如果一個一個的寫對應的資料庫實體模型,一個一個的寫倉儲層程式碼以及服務層程式碼,感覺就是在搬磚啊,有木有,所以當然得自己實現個程式碼生成器來自動生成這些程式碼了!下面我們一步步來先生成下資料庫然後再打造一個實體模型的程式碼生成器吧!

資料庫生成

生成物理模型

  1. 首先用pdm開啟我們設計的邏輯模型檔案,字尾名是ldm的檔案,如下圖所示:

    640?wx_fmt=png

  2. 依次點選“Tools”-》"Generate Logical Data Model",如下圖所示。或者直接使用快捷鍵Ctrl+Shift+P 開啟物理模型生成選項對話方塊。

    640?wx_fmt=png

  3. 如下圖所示選擇號對應的資料庫後,自定義物理模型的名稱程式碼後點擊確定即可生成物理模型。這裡資料庫型別有很多選擇如:mysql,sqlserver,oracle等等,我們選擇sqlserver2008,你可以隨意從下拉框選擇一個數據庫進行生成(當然要跟你的資料庫對應)!

    640?wx_fmt=png

  4. 注意這裡生成的物理模型預設是不會生成註釋的如下圖所示:

    640?wx_fmt=png

    怎麼辦呢?如何才能講Name 列的內容拷貝到Comment這個裡面呢?因為這個Commment裡面的內容才會真正的轉換到資料庫欄位的註釋。

    這時候你需要Tools->Execute Commands->Edit/Run Scripts (或者快捷鍵Ctrl+Shift+X)開啟指令碼執行的視窗,然後把下面的程式碼拷貝進行 run一下即可。

    '程式碼一:將Name中的字元COPY至Comment中


    Option   Explicit
    ValidationMode   =   True
    InteractiveMode   =   im_Batch

    Dim   mdl   '   the   current   model

    '   get   the   current   active   model
    Set   mdl   =   ActiveModel
    If   (mdl   Is   Nothing)   Then
         MsgBox   "There   is   no   current   Model "
    ElseIf   Not   mdl.IsKindOf(PdPDM.cls_Model)   Then
         MsgBox   "The   current   model   is   not   an   Physical   Data   model. "
    Else
         ProcessFolder   mdl
    End   If

    '   This   routine   copy   name   into   comment   for   each   table,   each   column   and   each   view
    '   of   the   current   folder
    Private   sub   ProcessFolder(folder)
         Dim   Tab   'running     table
         for   each   Tab   in   folder.tables
               if   not   tab.isShortcut   then
                     tab.comment   =   tab.name
                     Dim   col   '   running   column
                     for   each   col   in   tab.columns
                           col.comment=   col.name
                     next
               end   if
         next

         Dim   view   'running   view
         for   each   view   in   folder.Views
               if   not   view.isShortcut   then
                     view.comment   =   view.name
               end   if
         next

         '   go   into   the   sub-packages
         Dim   f   '   running   folder
         For   Each   f   In   folder.Packages
               if   not   f.IsShortcut   then
                     ProcessFolder   f
               end   if
         Next
    end   sub

    640?wx_fmt=png

    這裡指令碼執行的很快,你也可以把指令碼儲存起來下次再用,執行後的效果如下所示:

    640?wx_fmt=png

    我們的Comment這一行的內容已經跟Name一樣了!

資料庫指令碼生成

  1. 首先開啟我們生成的物理模型,副檔名為pdm的檔案,如下圖所示,乍一看跟物理模型差不多,實際上還是有區別的!

    640?wx_fmt=png

  2. 然後依次如下圖所示選擇“Database”->"Generate Database" 或者快捷鍵Ctrl+G開啟資料庫生成選項對話方塊

    640?wx_fmt=png

  3. 如下圖所示設定一下生成的資料庫指令碼的路徑以及指令碼名稱即可生成資料庫指令碼檔案,如下圖所示:

    640?wx_fmt=png

  4. 到我們上面設定的資料夾裡即可檢視到我們生成的資料庫指令碼,如下圖所示:

    640?wx_fmt=png

資料庫生成

  1. 開啟我們的資料庫,並新建一個名為CzarCms的新的資料庫,如下圖所示:

    640?wx_fmt=png

  2. 選擇我們新建的資料庫,然後按照如下圖所示的方式開啟我們剛才生成的資料庫指令碼

    640?wx_fmt=png

  3. 如下圖所示確認一下目前選擇的是你剛新建的資料庫,然後點選執行,執行下指令碼

    640?wx_fmt=png

  4. 不出以外的話會出現如下圖所示的“命令已成功完成”的訊息,這表示指令碼執行成功了,然後重新整理下我們剛才的資料庫,可以看到我們的表已經生成成功了!

    640?wx_fmt=png

  5. 這裡你可以檢查下,看看生成的資料庫表有沒有問題,如果有問題的話,重新走一遍流程生成指令碼然後執行下就行了,不過需要注意的是,如果你資料庫中有資料就要當心了,重新生成的指令碼會drop掉你的表重新建立,所以如果是個別字段出問題的話就邏輯模型以及物理模型修改後,手動在資料庫中修改即可!

  6. 這裡我給每個表的主鍵設計了自增,給isdelete等等設定了預設的0,以及addtime設定了getdate()等等。

實體模型生成器編寫

好了,上面我已經帶著你一步一步的演示了資料庫的建立過程,下面我就帶著你實現一個簡單的POCO實體物件的程式碼生成器吧!什麼?市面上不是有很多程式碼生成器嗎?靠,我就是要帶著你自己實現一個,咋滴?是用別人的爽,還是用自己實現的爽呢?自己琢磨吧!

思考

大家先腦補一下,如果是你想根據資料庫實現一個程式碼生成器你的思路是怎樣的呢?是不是首先得獲取下資料庫裡面的所有的表,然後獲取這些表對應的列以及列的型別,是否為空等等資訊。然後再建一個模板,迴圈這些表的資訊來根據模板建立對應的檔案呢。至於模板檔案可能你會想到T4或者CodeSmish模板等等,可這些都太複雜了,複雜的語法以及靈活性的問題我這裡選擇另一個文字檔案的形式來進行程式碼的生成。

這個程式碼生成器的靈感以及部分程式碼來自於Zxw.Framework.NetCore,這個框架的github地址是:https://github.com/VictorTzeng/Zxw.Framework.NetCore/tree/master/Zxw.Framework.NetCore 有興趣的小夥伴可以看下。

下面就讓我們簡單實現下我們自己的實體模型程式碼生成器吧.

實體程式碼生成器

  1. 首先我們建立一個Option物件來接收我們所需要的引數,比如說:資料庫型別,資料庫連線字串,作者,實體模型的名稱空間等等,如下所示:

     /// <summary>
       /// yilezhu
       /// 2018.12.12
       /// 程式碼生成選項
       /// </summary>
       public class CodeGenerateOption
       {
           /// <summary>
           /// 資料庫連線字串
           /// </summary>
           public string ConnectionString { get; set; }
           /// <summary>
           /// 資料庫型別
           /// </summary>
           public string DbType  { get; set; }
           /// <summary>
           /// 作者
           /// </summary>
           public string Author { get; set; }

           /// <summary>
           /// 程式碼生成時間
           /// </summary>
           public string GeneratorTime { get; set; } = DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss");

           /// <summary>
           /// 輸出路徑
           /// </summary>
           public string OutputPath { get; set; }

           /// <summary>
           /// 實體名稱空間
           /// </summary>
           public string ModelsNamespace { get; set; }
       }
  2. 從資料庫裡面獲取所有表的指令碼,這裡我只是簡單的實現了下SqlServer的程式碼,後續我會對這塊進行提取封裝,並支援MySql,Oracle,PSQL等等:

    //TODO 從資料庫獲取表列表以及生成實體物件
               if (_options.DbType != DatabaseType.SqlServer.ToString())
                   throw new ArgumentNullException("這是我的錯,目前只支援MSSQL資料庫的程式碼生成!後續更新MySQL");
               DatabaseType dbType = DatabaseType.SqlServer;
               string strGetAllTables = @"SELECT DISTINCT d.name as TableName, f.value as TableComment
    FROM      sys.syscolumns AS a LEFT OUTER JOIN
                   sys.systypes AS b ON a.xusertype = b.xusertype INNER JOIN
                   sys.sysobjects AS d ON a.id = d.id AND d.xtype = 'U' AND d.name <> 'dtproperties' LEFT OUTER JOIN
                   sys.syscomments AS e ON a.cdefault = e.id LEFT OUTER JOIN
                   sys.extended_properties AS g ON a.id = g.major_id AND a.colid = g.minor_id LEFT OUTER JOIN
                   sys.extended_properties AS f ON d.id = f.major_id AND f.minor_id = 0";
               List<DbTable> tables = null;
               using (var conn = new SqlConnection(_options.ConnectionString))
               {
                   tables = conn.Query<DbTable>(strGetAllTables).ToList();
  3. 遍歷每個表然後獲取每個表對應的列(也是隻實現的SqlServer的程式碼)

     tables.ForEach(item =>
                   {
                       string strGetTableColumns = @"SELECT   a.name AS ColName, CONVERT(bit, (CASE WHEN COLUMNPROPERTY(a.id, a.name, 'IsIdentity')
                   = 1 THEN 1 ELSE 0 END)) AS IsIdentity, CONVERT(bit, (CASE WHEN
                       (SELECT   COUNT(*)
                        FROM      sysobjects
                        WHERE   (name IN
                                            (SELECT   name
                                             FROM      sysindexes
                                             WHERE   (id = a.id) AND (indid IN
                                                                 (SELECT   indid
                                                                  FROM      sysindexkeys
                                                                  WHERE   (id = a.id) AND (colid IN
                                                                                      (SELECT   colid
                                                                                       FROM      syscolumns
                                                                                       WHERE   (id = a.id) AND (name = a.name))))))) AND (xtype = 'PK'))
                   > 0 THEN 1 ELSE 0 END)) AS IsPrimaryKey, b.name AS ColumnType, COLUMNPROPERTY(a.id, a.name, 'PRECISION')
                   AS ColumnLength, CONVERT(bit, (CASE WHEN a.isnullable = 1 THEN 1 ELSE 0 END)) AS IsNullable, ISNULL(e.text, '')
                   AS DefaultValue, ISNULL(g.value, ' ') AS Comment
    FROM      sys.syscolumns AS a LEFT OUTER JOIN
                   sys.systypes AS b ON a.xtype = b.xusertype INNER JOIN
                   sys.sysobjects AS d ON a.id = d.id AND d.xtype = 'U' AND d.name <> 'dtproperties' LEFT OUTER JOIN
                   sys.syscomments AS e ON a.cdefault = e.id LEFT OUTER JOIN
                   sys.extended_properties AS g ON a.id = g.major_id AND a.colid = g.minor_id LEFT OUTER JOIN
                   sys.extended_properties AS f ON d.id = f.class AND f.minor_id = 0
    WHERE   (b.name IS NOT NULL) AND (d.name = @TableName)
    ORDER BY a.id, a.colorder";
                       item.Columns = conn.Query<DbTableColumn>(strGetTableColumns, new
                       {
                           TableName = item.TableName
                       }).ToList();
  4. 接下來就是對資料庫獲取的列進行一個轉換,根據資料庫欄位型別轉換成對應的C#型別了

     item.Columns.ForEach(x =>
                       {
                           var csharpType = DbColumnTypeCollection.DbColumnDataTypes.FirstOrDefault(t =>
                               t.DatabaseType == dbType && t.ColumnTypes.Split(',').Any(p =>
                                   p.Trim().Equals(x.ColumnType, StringComparison.OrdinalIgnoreCase)))?.CSharpType;
                           if (string.IsNullOrEmpty(csharpType))
                           {
                               throw new SqlTypeException($"未從字典中找到\"{x.ColumnType}\"對應的C#資料型別,請更新DbColumnTypeCollection型別對映字典。");
                           }

                           x.CSharpType = csharpType;
                       });
  5. 既然所有的表以及表對應的列我們都拿到了,那麼我們就可以進行程式碼的生成了,當然在生成之前還得建立我們的模板檔案:

    // 本程式碼由程式碼生成器生成請勿隨意改動
    // 生成時間  {GeneratorTime}
    using System;

    namespace {ModelsNamespace}
    {
       /// <summary>
       /// {Author}
       /// {GeneratorTime}
       /// {Comment}
       /// </summary>
       public class {ModelName}
       {
           {ModelProperties}
       }
    }

    看到沒有,很簡單的POCO物件的樣子,接下來就是生成對應的模板了,具體怎麼生成呢?思考下:是不是首先讀取模板檔案到一個string裡面,然後就是簡單的replace了!很簡單吧,具體的程式碼我都上傳到了Github上,文章末尾我會給出地址。另外為了大家引用的方便我已經把這個Czar.Cms.Core專案製作成了Nuget包,大家只需要搜尋這個包引用下就可以用了!什麼?Nuget包怎麼引用啊?騷年你可以上天了~

測試實體程式碼生成器

  1. Czar.Cms.Test 這個專案新增Nuget包引用,引用後的Nuget如下所示:

    640?wx_fmt=png

  2. 接下來就是新建一個測試類,然後建立一個依賴注入容器,並把我們需要的Option傳遞進去,如下所示:

     /// <summary>
           /// 構造依賴注入容器,然後傳入引數
           /// </summary>
           /// <returns></returns>
           public IServiceProvider BuildServiceForSqlServer()
           {
               var services = new ServiceCollection();

               services.Configure<CodeGenerateOption>(options =>
               {
                   options.ConnectionString = "Data Source=.;Initial Catalog=CzarCms;User ID=sa;Password=1;Persist Security Info=True;Max Pool Size=50;Min Pool Size=0;Connection Lifetime=300;";//這個必須
                   options.DbType = DatabaseType.SqlServer.ToString();//資料庫型別是SqlServer,其他資料型別參照列舉DatabaseType//這個也必須
                   options.Author = "yilezhu";//作者名稱,隨你,不寫為空
                   options.OutputPath = @"E:\workspace\vs2017\Czar.Cms\src\Czar.Cms.Models";//實體模型輸出路徑,為空則預設為當前程式執行的路徑
                   options.ModelsNamespace = "Czar.Cms.Models";//實體名稱空間
               });
               services.AddSingleton<CodeGenerator>();//注入Model程式碼生成器
               return services.BuildServiceProvider(); //構建服務提供程式
           }
  3. 接著就是寫我們的測試方法了,程式碼如下:

     [Fact]
           public void GeneratorModelForSqlServer()
           {
               var serviceProvider= BuildServiceForSqlServer();
               var codeGenerator = serviceProvider.GetRequiredService<CodeGenerator>();
               codeGenerator.GenerateModelCodesFromDatabase();