X-Admin&ABP框架開發-代碼生成器

　　在平常開發中，有時會遇到一些類似的代碼，甚至是隻要CV一次，改幾個名稱，就能夠實現功能了，並且總歸起來，均可以由一些公用的頁面更改而來，所以，結合我平常開發中使用到的頁面，封裝一個適合本身的代碼生成器，僅處於入門階段，包括生成的代碼結構都僅是把框架展現出來，內部詳細暫時沒得，針對於應用服務中的接口和實現，相關Dto，MVC中的控制器、視圖及視圖模型進行了模板製做及生成相關的文件。

 

1、設計思路

　　方案一：開始想到的是，搞個控制檯，而後給一個.cs文件，而後控制檯去解析其中的命名空間，類名，屬性，再用配置好的razor模板去替換，再生成相關的一些文件出來，可是發現，萬事開頭難，第一步去解析cs文件就很差搞，找了網上的資料，不太好弄，乾脆想了下，放棄這種方案，由於想到了另外一種經常使用的方案。

 

　　方案二：直接在控制檯中，配置控制檯去訪問數據庫，而後給定指定表名，去讀取數據庫中的表和字段，再反過來去生成相關文件，可是這裏會遇到一個這樣的問題，好比我使用的是mysql，mysql自己有個配置表名大小寫忽視的，這樣一來，獲取到的表名都將是小寫打頭，儘管可能配置了是區分大小寫，可是，我設計表時，採用Pre_table，形式區分業務表，好比是CRM模塊須要用到的CRM_Client，那將用CRM打頭，後面這部分Client纔是實際代碼中的類名，種種問題都有可能，可是做爲沒有那麼多可能性下，好比沒得前綴，不區分大小寫，形式簡單，那麼能夠考慮使用。此時，想到了abp中的Migrator控制檯並想到了方案三。

 

　　方案三：若是說直接搞一個控制檯在代碼中，模仿Abp自帶的Migrator同樣，啓動後，給定類名，經過反射去取得該類的屬性名，豈不是美滋滋，須要哪一個類的相關文件，只需啓動，而後輸入類名，便可獲得相關的文件。這幾種方案的前提都是在Dto文件中會展現全部實體字段，若是須要選擇性的使用字段，則還需藉助人工智能，以人力去完成更改生成的文件。

 

2、Razor引擎的使用

　　我選擇了方案二做爲入手去實現，而且採用Razor引擎做爲模板解析的工具。Nuget引入RazorEngine.NetCore包，開始實現依靠模板生成代碼。 

一、先嚐試下Razor引擎，控制檯中CV下Razor引擎提供的Demo，引入相關命名空間，學習下如何去使用。

string template = "Hello @Model.Name, welcome to RazorEngine!";
var result = Engine.Razor.RunCompile(template, "templateKey", null, new { Name = "World" });
Console.WriteLine(result);

 運行完畢，能夠獲取到運行結果，須要注意的是，若是是在linux或是mac跑會獲得錯誤，該問題是Razor引擎自己的問題，暫時只能在window下跑。

 

二、熟悉了下Razor的使用方式後，開始使用簡單文件形式填充一些數據模擬生成過程。

 

首先，一個文件做爲填充模板，一個文件內存儲Json數據做爲數據源，程序啓動時加載兩個文件。

var templatePage = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "SimpleCOders\\Templates", "templatePage.txt");
TemplatePage = File.ReadAllText(templatePage);

var templatePageJson = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "SimpleCOders\\Templates", "templatePageJson.json");
TemplatePageJson = File.ReadAllText(templatePageJson);

其次，數據源整理成相應類結構，獲得批量待解析數據。

var templatePageJsonList = JsonConvert.DeserializeObject<List<PageDataModel>>(TemplatePageJson);

foreach (var templatePageJson in templatePageJsonList)
{
    RazorParse(
        templatePageJson.Index ?? 1,
        templatePageJson.Date,
        templatePageJson.Index - 1,
        templatePageJson.Index + 1,
        templatePageJson.Content
    );
}

最後，設計一下解析器，將讀取到的數據源，進行解析成相關的類，而後依次按照模板生成文件

var entityResult = Engine.Razor.RunCompile(TemplatePage, "templatePageKey", null, new
{
    PostData = (date ?? DateTime.Now).ToString("yyyy-MM-dd"),
    PrevIndex = prev.Value,
    NextIndex = next.Value,
    ContentHtml = content
});

按照一條數據即是一個模板文件去生成能夠獲得批量生成文件。

 

3、適合本身的簡單代碼生成器

　　開始着手適合本身的簡單代碼生成器，思路一致，只是增長了須要讀取數據庫這一環節。

一、模板製做，以應用服務接口爲例，經常使用的增刪改查進行封裝，利用Razor語法進行填充處理，此處對於主鍵類型，沒有進行處理，只能支持諸如int、long之類的，後期在繼續優化。

using Abp.Application.Services;
using Abp.Application.Services.Dto;
using System.Collections.Generic;
using System.Threading.Tasks;
using @Model.ProjectNameSpace.@Model.ProjectModule.@(Model.EntityName)s.Dto;

namespace @Model.ProjectNameSpace.@Model.ProjectModule.@(Model.EntityName)s
{
    /// <summary>
    /// @(Model.EntityDescription)應用服務接口
    /// </summary>
    public interface I@(Model.EntityName)AppService : IApplicationService
    {
        /// <summary>
        /// 獲取@(Model.EntityDescription)數據集合
        /// </summary>
        /// <param name="input"></param>
        /// <returns></returns>
        Task<PagedResultDto<@(Model.EntityName)ListDto>> GetPaged@(Model.EntityName)(GetPaged@(Model.EntityName)Input input);

        /// <summary>
        /// 獲取@(Model.EntityDescription)編輯信息
        /// </summary>
        /// <param name="input"></param>
        /// <returns></returns>
        Task<Get@(Model.EntityName)ForEditOutput> Get@(Model.EntityName)ForEdit(NullableIdDto<@Model.EntityKeyType> input);

        /// <summary>
        /// 建立或修改@(Model.EntityDescription)信息
        /// </summary>
        /// <param name="input"></param>
        /// <returns></returns>
        Task CreateOrUpdate@(Model.EntityName)(CreateOrUpdate@(Model.EntityName)Input input);

        /// <summary>
        /// 刪除@(Model.EntityDescription)
        /// </summary>
        /// <param name="input"></param>
        /// <returns></returns>
        Task Delete@(Model.EntityName)(List<EntityDto<@Model.EntityKeyType>> inputs);
    }
}

 二、設置相應的解析器，與以前的嘗試不一樣，此次使用了具體的類型，這是Razor中的另外一種方式，解析完畢後將文件按照指定路徑保存，儘可能符合項目的路徑存儲。

var iRazorAppService = Engine.Razor.RunCompile(IRazorAppService, nameof(IRazorAppService), typeof(TemplateParseModel), templateParseModel);
UtilHelper.Save(Path.Combine(AppDomain.CurrentDomain.BaseDirectory, applicationPath, $"I{templateParseModel.EntityName}AppService.cs"), iRazorAppService);
builder.Append(iRazorAppService);

 三、數據庫鏈接讀取表結構，控制檯下，採用直接讀取的形式，不走DbContext方式，Nuget中引入MySql.Data包(我本地用的Mysql)，增長Appsettings.json文件並配置好鏈接字符串,用sql語句形式直接讀取數據庫中的信息，此處封裝了一個DbHelper類及將讀取到的信息封裝到指定類中。

using (var SqlConnection = new MySqlConnection(connectionStr))
{
    SqlConnection.Open();
    var columsInfo = string.Format(@"select table_name,column_name,ordinal_position,is_nullable,data_type,character_maximum_length,column_key,column_comment
        from information_schema.COLUMNS
        where table_schema = '{0}' and table_name = '{1}'", dbschema, tablename);

    MySqlCommand mySqlCommand = new MySqlCommand(columsInfo, SqlConnection);
    MySqlDataReader dataReader = mySqlCommand.ExecuteReader();

    List<ColumnInfo> sqlDatasList = new List<ColumnInfo>();
    while (dataReader.Read())
    {
        var columnInfo = new ColumnInfo()
        {
            TableName = dataReader[dataReader.GetName(0)].ToString(),
            Name = dataReader[dataReader.GetName(1)].ToString(),
            OrdinalPosition = StringExtension.GetValueOrNull<int>(dataReader[dataReader.GetName(2)].ToString()),
            IsNullable = dataReader[dataReader.GetName(3)].ToString(),
            DataType = dataReader[dataReader.GetName(4)].ToString(),
            CharacterMaximumLength = StringExtension.GetValueOrNull<int>(dataReader[dataReader.GetName(2)].ToString()),
            ColumnKey = dataReader[dataReader.GetName(6)].ToString(),
            ColumnComment = dataReader[dataReader.GetName(7)].ToString(),
        };
        sqlDatasList.Add(columnInfo);
    }

    dataReader.Close();
    SqlConnection.Close();
    return sqlDatasList;

四、啓動後輸入表名、實體名、實體描述(並未保存到數據庫中)，再經過手動將其加入到項目中，諸如命名空間及模塊名稱都加入到了配置文件中，方便配置，至少相對手動去一個個添加來說，減小了部分工做量，也達到了輔助的效果，可是要達到全面輔助，還得在進行繼續優化，針對其中的類等等，暫時沒有加入屬性，只放置了Id、Name等等，以後得考慮把數據庫中字段也循環輸出到模板文件中。

　至此，依靠Razor引擎製做一個簡單的(算是減小了工做量)代碼生成器初步完成了，年後繼續完善，加入豐富的功能，並移入到框架中做爲提升生產力的手段。新年快樂~

 

　倉庫地址：https://gitee.com/530521314/Partner.TreasureChest.git

2020-01-01,望技術有成後能回來看見本身的腳步