FreeSql.Generator命令列代碼生成器是如何實作的

目錄

• FreeSql介紹
• FreeSql.Generator
• RazorEngine.NetCore
• 原始碼決議
• FreeSql.Tools

FreeSql

FreeSql 是功能強大的物件關系映射技術(O/RM)，支持 .NETCore 2.1+ 或 .NETFramework 4.0+ 或 Xamarin，

有一個強大的ORM，也方便我們開發一個代碼生成器，

一般情況下，我們開發資料庫相關的應用，主要分為三種code first、db first、model first

我只用過前二種，

• code first，代碼優先，資料庫都是根據物體類生成，所有的關系，可以是邏輯關聯，也可以是物理關聯，
• DB First: 資料庫優先，直接設計表結構，用設計工具生成表，設計主鍵，外鍵、索引，關聯關系等，

當我們使用DB First時，設計好的資料庫，我們怎么生成一些物體類、通用的代碼、控制器、服務層、Dto呢，今天我來給大家介紹一下FreeSql專案中的一些工具，當然，不使用此ORM的小伙伴也能使用此工具，因為他是通用，

FreeSql.Generator 命令列方式

通過幾行命令，就可實作生成專案中通用的代碼結構，不需要復制一段代碼后修改，加快開發速度，減少重復勞動，少用一根頭發，

由于每個人的專案結構，代碼位置各不相同，對于ORM來說，不同的業務邏輯各不相同，所以該專案沒有相應的模板，相信使用過Razor的同學一定能實作自己的模板，

1-2年前，我和一個學長也寫過代碼生成器，這里分享一下當時做專案時的一些模板，https://github.com/i542873057/SJNScaffolding/tree/master/SJNScaffolding.RazorPage/Templates,該專案是基于 . NET Core+Razor Page,由于已離職，所以沒有繼續維護，這些模板都和ABP相關，當時提取了一些通用的功能，單表操作，可以直接生成前后端功能，只需要在word中按統一的格式寫好資料字典的檔案，直接復制到系統，即可根據空格，定義型別等方式決議欄位，

回到FreeSql.Generator 命令列

• 對于此工具的使用可參考 https://github.com/dotnetcore/FreeSql/wiki/DbFirst
• 原始碼位置 https://github.com/dotnetcore/FreeSql/tree/master/Extensions/FreeSql.Generator
• 前提是本地安裝了.net core 3.1 的sdk.

怎么使用呢，

1. 安裝 dotnet-tool 生成物體類

dotnet tool install -g FreeSql.Generator

2. 新建目錄，在地址欄輸入 cmd 快速打開命令視窗，輸入命令：

FreeSql.Generator --help

我們可以看到

C:\Users\igeekfan\Desktop\code>FreeSql.Generator --help
        ____                   ____         __
       / __/  ____ ___  ___   / __/ ___ _  / /
      / _/   / __// -_)/ -_) _\ \  / _ `/ / /
     /_/    /_/   \__/ \__/ /___/  \_, / /_/
                                    /_/


  # Github # https://github.com/2881099/FreeSql v1.5.0

    使用 FreeSql 快速生成資料庫的物體類

    更新工具：dotnet tool update -g FreeSql.Generator


  # 快速開始 #

  > FreeSql.Generator -Razor 1 -NameOptions 0,0,0,0 -NameSpace MyProject -DB "MySql,Data Source=127.0.0.1;..."

     -Razor 1                  * 選擇模板：物體類+特性

     -Razor 2                  * 選擇模板：物體類+特性+導航屬性

     -Razor "d:\diy.cshtml"    * 自定義模板檔案

     -NameOptions              * 總共4個布林值，分別對應：
                               # 首字母大寫
                               # 首字母大寫,其他小寫
                               # 全部小寫
                               # 下劃線轉駝峰

     -NameSpace                * 命名空間

     -DB "MySql,Data Source=127.0.0.1;Port=3306;User ID=root;Password=root;Initial Catalog=資料庫;Charset=utf8;SslMode=none;Max pool size=2"

     -DB "SqlServer,Data Source=.;Integrated Security=True;Initial Catalog=資料庫;Pooling=true;Max Pool Size=2"

     -DB "PostgreSQL,Host=192.168.164.10;Port=5432;Username=postgres;Password=123456;Database=資料庫;Pooling=true;Maximum Pool Size=2"

     -DB "Oracle,user id=user1;password=123456;data source=//127.0.0.1:1521/XE;Pooling=true;Max Pool Size=2"

     -DB "Sqlite,Data Source=document.db"

     -DB "Dameng,server=127.0.0.1;port=5236;user id=2user;password=123456789;database=2user;poolsize=2"
                               Dameng 是國產達夢資料庫

     -Filter                   Table+View+StoreProcedure
                               默認生成：表+視圖+存盤程序
                               如果不想生成視圖和存盤程序 -Filter View+StoreProcedure

     -Match                    正則運算式，只生成匹配的表，如：dbo\.TB_.+

     -FileName                 檔案名，默認：{name}.cs

     -Output                   保存路徑，默認為當前 shell 所在目錄
                               推薦在物體類目錄創建 gen.bat，雙擊它重新所有物體類

• 更新命令列

dotnet tool update -g FreeSql.Generator

3. 這里lin-cms-dotnetcore這個專案來測驗，

• 資料庫表名是下劃線，欄位也是下劃線方式，
• -Razor 指定 第一個模板
• -NameOptions 0,0,0,1 最后一個1，代表 下劃線轉駝峰，滿足C#命名規則
• -NameSpace 指定了命名空間 LinCms.Core.Entities
• -DB 就是資料庫的相關配置
• mysql 本地地址 127.0.0.1 3306埠 用戶名 root 密碼123456 資料庫 lin-cms
• -Match book 這樣就能只生成book，支持正則運算式，如 -Math lin_user 就會生成以lin_user開頭的表，如dbo.TB_.+，會生成以TB開頭的表，即只生成匹配的表

4. 執行此命令，

FreeSql.Generator -Razor 1  -NameOptions 0,0,0,1 -NameSpace LinCms.Core.Entities -DB "MySql,Data Source=127.0.0.1;Port=3306;User ID=root;Password=123456;Initial Catalog=lincms;Charset=utf8;SslMode=none;Max pool size=2"

這時候代碼已經生成了

其中一個代碼 生成如下，這些類是partial ，熟悉C#的同學，應該知道，類的定義使用此關鍵字，我們能在不同的地方為該類擴展，以防止重新同步資料庫的結構時，丟失改動的欄位，

namespace LinCms.Core.Entities {

	[JsonObject(MemberSerialization.OptIn), Table(Name = "book")]
	public partial class Book {

		/// <summary>
		/// 主鍵Id
		/// </summary>
		[JsonProperty, Column(Name = "id", IsPrimary = true, IsIdentity = true)]
		public long Id { get; set; }

		[JsonProperty, Column(Name = "author", DbType = "varchar(20)")]
		public string Author { get; set; } = string.Empty;

		[JsonProperty, Column(Name = "image", DbType = "varchar(50)")]
		public string Image { get; set; } = string.Empty;

        //更多xxx
	}

}

• 最終效果圖如下

此時會生成二個檔案 __重新生成.bat,下次重新點擊他就能重新生成物體類了，

FreeSql.Generator -Razor "__razor.cshtml.txt" -NameOptions 1,1,0,1 -NameSpace MyProject -DB "MySql,Data Source=127.0.0.1;Port=3306;User ID=root;Password=123456;Initial Catalog=lincms;Charset=utf8;SslMode=none;Max pool size=2" -FileName "{name}.cs"

上面的命令-Razor 指定了這個txt檔案 __razor.cshtml.txt

我們可以定義自己的模板，以生成符合自已業務的的代碼，從而實作快速開發，

我們可以看下模板中的檔案內容,他就是asp.net下的mvc 結構下的razor后端模板渲染,把這個.txt后綴去掉，就很明了了，對于asp.net mvc的razor，我們可以將控制器下方法的值替換掉cshtml中的值，這個程序是有一個類別庫在幫我們實作的,叫RazorEngine，不過那個是.net framework下的實踐，.NET Framework 下的RazorEngine代碼生成介紹

@using FreeSql.DatabaseModel;@{
var gen = Model as RazorModel;

Func<string, string> GetAttributeString = attr => {
	if (string.IsNullOrEmpty(attr)) return null;
	return string.Concat(", ", attr.Trim('[', ']'));
};
Func<DbColumnInfo, string> GetDefaultValue = https://www.cnblogs.com/igeekfan/p/col => {
    if (col.CsType == typeof(string)) return " = string.Empty;";
    return "";
};
}
//xxx
namespace @gen.NameSpace {

@if (string.IsNullOrEmpty(gen.table.Comment) == false) {
	@:/// 

	@:/// @gen.table.Comment.Replace("/r/n", "/n").Replace("/n", "/r/n		/// ")
	@:/// 
}
	[JsonObject(MemberSerialization.OptIn)@GetAttributeString(gen.GetTableAttribute())]
	public partial class @gen.GetCsName(gen.FullTableName) {

	@foreach (var col in gen.columns) {

		if (string.IsNullOrEmpty(col.Coment) == false) {
		@:/// 

		@:/// @col.Coment.Replace("/r/n", "/n").Replace("/n", "/r/n		/// ")
		@:/// 
		}
		@:@("[JsonProperty" + GetAttributeString(gen.GetColumnAttribute(col)) + "]")
		@:public @gen.GetCsType(col) @gen.GetCsName(col.Name) { get; set; }@GetDefaultValue(col)
@:
	}
	}
@gen.GetMySqlEnumSetDefine()
}

RazorEngine.NetCore

到了.NET Core時代，我看了下FreeSql.Generator用的這個類別庫RazorEngine.NetCore，實作動態操作cshtml，生成需要的文本，

Razor Engine是基于微軟Razor決議的模板引擎，它允許你使用Razor語法構建動態模板，你只需要使用Engine的靜態方法，Engine.Razor.RunCompile等，

創建一個控制臺應用，然后安裝包，

Install-Package RazorEngine.NetCore

using RazorEngine;
using RazorEngine.Templating; // For extension methods.


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

Console.WriteLine(result);

• 輸出如下內容

Hello World, welcome to RazorEngine!

此處使用的RunCompile方法是擴展方法，您需要參考RazorEngine.Templating命名空間，

The "templateKey" 保持唯一值，比如使用guid值，字串，并且你可以根據此字串key重新運行快取的模板，

如果再次根據此key，可使用原本的模板，

var result = Engine.Razor.Run("templateKey", null, new { Name = "Max" });

• 會輸出如下內容

Hello Max, welcome to RazorEngine!

上面中的RunCompile第三個引數，傳null,因為我們第四個引數使用的是匿名類，

根目錄創建一個HelloWord.cshtml，要選擇屬性，->如果較新則復制 內容，

Hello @Model.Name, welcome to RazorEngine!

控制臺如下代碼，

string templateFilePath = "HelloWorld.cshtml";
var templateFile = File.ReadAllText(templateFilePath);
string templateFileResult = Engine.Razor.RunCompile(templateFile, Guid.NewGuid().ToString(), null, new
{
    Name = "World"
});

Console.WriteLine(templateFileResult);

• 控制臺輸出

Hello World, welcome to RazorEngine!

• 使用強型別 CopyRightUserInfo.cs生成一個著作權所有

using System;
namespace OvOv.Razor
{
    public class CopyRightUserInfo
    {
        public string UserName { get; set; }
        public string EmailAddress { get; set; }
        public DateTime CreateTime { get; set; }
        public string FileRemark { get; set; }
    }

}

根目錄創建一個CopyRightTemplate.cshtml，要選擇屬性，->如果較新則復制 內容，

@{
    var gen = Model as OvOv.Razor.CopyRightUserInfo;
}
//=============================================================
// 創建人:            @gen.UserName
// 創建時間:          @gen.CreateTime
// 郵箱：             @gen.EmailAddress
//==============================================================

控制臺如下代碼，

string copyRightTemplatePath = "CopyRightTemplate.cshtml";
var copyRightTemplate = File.ReadAllText(copyRightTemplatePath);
string copyRightResult = Engine.Razor.RunCompile(copyRightTemplate, Guid.NewGuid().ToString(), typeof(CopyRightUserInfo), new CopyRightUserInfo
{
    CreateTime = DateTime.Now,
    EmailAddress = "[email protected]",
    UserName = "IGeekFan"
});
Console.WriteLine(copyRightResult);

Console.ReadKey();

• 控制臺輸出

//=============================================================
// 創建人:            IGeekFan
// 創建時間:          2020/6/23 18:14:08
// 郵箱：             [email protected]
//==============================================================

全放到控制臺下，輸出如下結果，代碼生成器最重要的一點解決了，我們就能實作自己的代碼生成器，先構建自己的模板，實作輸入（命令列，WPF，WEB端及更多），輸出（生成檔案），

• 以上原始碼已放到示例代碼中 https://github.com/luoyunchong/dotnetcore-examples/blob/master/aspnetcore-freesql/OvOv.Razor/Program.cs

原始碼決議

首先這是一個控制臺應用，Main(string[] args)可接收多個引數，

1. 處理無引數，--help
2. 處理args陣列，決議出所有的引數，如果沒有設定，則為默認值，（處理一些引數例外問題）最重要的是根據-Razor，選定對應的模板，

ArgsRazor=""//根據-Razor  1 不是2 還是模板的路徑，取出的模板文本值，
var razorId = Guid.NewGuid().ToString("N");
RazorEngine.Engine.Razor.Compile(ArgsRazor, razorId);

3. 根據資料庫連接串，取出引數過濾后的表，視圖，存盤程序
4. 回圈資料庫的表等，

• model為模板中需要的資料
• razorId與上文的razorId相同，
• sw為生成后的文本保存的值，

var sw = new StringWriter();
var model = new RazorModel(fsql, ArgsNameSpace, ArgsNameOptions, tables, table);
RazorEngine.Engine.Razor.Run(razorId, sw, null, model);

5. 將sw字串保存生成類.cs檔案（根據引數配置生成檔案名）
6. 另外生成一個__重新生成.bat,__razor.cshtml.txt，方便后續用戶重新生成物體類，

FreeSql.Tools

這是 FreeSql 衍生出來的輔助工具包，內含生成器等功能；作者：mypeng1985 因為這個不兼容mac,linux,所以作者建議使用dotnet-tool 命令列工具生成物體類，從而支持MAC/Linux系統，對于不是使用FreeSql的開發者，也能使用此工具，你只需要修改對應的模板即可，

使用方式：不多介紹，

• https://github.com/2881099/Freesql.tools
• 分為WPF ，WinForm + DSkin 版本（套網頁）
• 看了下代碼，底層生成代碼邏輯也是用的RazorEngine .NET Framework 下的RazorEngine代碼生成介紹

FreeSql官方群 4336577

預覽圖

標籤：.NET Core

上一篇：Magicodes.IE在.NET Core中通過請求頭匯出多種格式檔案

下一篇：C# 人臉識別庫 0.1