FreeSql.Generator命令行代码生成器是如何实现的

最新推荐文章于 2024-09-25 08:52:44 发布
最新推荐文章于 2024-09-25 08:52:44 发布
阅读量647 收藏 2
点赞数
分类专栏： 技术
原文链接：https://www.colorgg.com
版权

目录

  • 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 命令行

怎么使用呢。

  1. 安装 dotnet-tool 生成实体类
dotnet tool install -g FreeSql.Generator
  1. 新建目录，在地址栏输入 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
  1. 这里lin-cms-dotnetcore这个项目来测试。

https://i-blog.csdnimg.cn/blog_migrate/073414308b1397f1c82f794cc5ae24f7.jpeg

  • 数据库表名是下划线，字段也是下划线方式。
  • -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开头的表。即只生成匹配的表
  1. 执行此命令。
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 = col => {
    if (col.CsType == typeof(string)) return " = string.Empty;";
    return "";
};
}
//xxx
namespace @gen.NameSpace {

@if (string.IsNullOrEmpty(gen.table.Comment) == false) {
	@:/// <summary>
	@:/// @gen.table.Comment.Replace("\r\n", "\n").Replace("\n", "\r\n		/// ")
	@:/// </summary>
}
	[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) {
		@:/// <summary>
		@:/// @col.Coment.Replace("\r\n", "\n").Replace("\n", "\r\n		/// ")
		@:/// </summary>
		}
		@:@("[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 = "710277267@qq.com",
    UserName = "IGeekFan"
});
Console.WriteLine(copyRightResult);

Console.ReadKey();
  • 控制台输出
//=============================================================
// 创建人:            IGeekFan
// 创建时间:          2020/6/23 18:14:08
// 邮箱：             710277267@qq.com
//==============================================================

全放到控制台下，输出如下结果。代码生成器最重要的一点解决了，我们就能实现自己的代码生成器，先构建自己的模板，实现输入（命令行，WPF，WEB端及更多），输出（生成文件）。

源码解析

首先这是一个控制台应用，Main(string[] args)可接收多个参数。

  1. 处理无参数，--help
  2. 处理args数组，解析出所有的参数，如果没有设置，则为默认值。（处理一些参数异常问题）最重要的是根据-Razor，选定对应的模板。
ArgsRazor=""//根据-Razor  1 不是2 还是模板的路径，取出的模板文本值。
var razorId = Guid.NewGuid().ToString("N");
RazorEngine.Engine.Razor.Compile(ArgsRazor, razorId);
  1. 根据数据库连接串，取出参数过滤后的表，视图，存储过程
  2. 循环数据库的表等，
  • 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);
  1. 将sw字符串保存生成类.cs文件（根据参数配置生成文件名）
  2. 另外生成一个__重新生成.bat,__razor.cshtml.txt，方便后续用户重新生成实体类。

FreeSql.Tools

这是 FreeSql 衍生出来的辅助工具包，内含生成器等功能；作者：mypeng1985
因为这个不兼容mac,linux,所以作者建议使用dotnet-tool 命令行工具生成实体类，从而支持MAC/Linux系统。对于不是使用FreeSql的开发者，也能使用此工具，你只需要修改对应的模板即可。

使用方式：不多介绍。

FreeSql官方群 4336577

预览图

FreeSql代码生成器.zip
07-10
基于FreeSql的代码生成器，可通过修改模板生成代码，使用Razor模板技术。
FreeSql.Tools:FreeSql 工具包，包括生成器等
05-14
dotnet tool install -g FreeSql.Generator 新建目录，在地址栏输入 cmd 快速打开命令窗口，输入命令： FreeSql.Generator --help 命令行工具生成实体类，后续的重新生成操作（一键完成）、并且支持 Mac/Linux 系统...
已跳过全部重新生成_FreeSql.Generator命令行代码生成器是如何实现的
weixin_39849479的博客
11-28 613
目录FreeSql介绍FreeSql.GeneratorRazorEngine.NetCore源码解析FreeSql.ToolsFreeSqlFreeSql 是功能强大的对象关系映射技术(O/RM)，支持 .NETCore 2.1+ 或 .NETFramework 4.0+ 或 Xamarin。有一个强大的ORM，也方便我们开发一个代码生成器。一般情况下，我们开发数据库相关的应用，主要分...
FreeSql 开源项目教程
最新发布
gitblog_00975的博客
09-25 848
FreeSql 开源项目教程 FreeSql dotnetcore/FreeSql: 这是一个用于SQL Server、MySQL、PostgreSQL等多种数据库的ORM框架。适合用于需要使用ASP.NET Core访问多种数据库的场景。特点：易于使用，支持多种数据库，具有高性能和可扩展性。 ...
已跳过全部重新生成_【朝夕的ACM笔记】图论-最小生成树
weixin_39606003的博客
12-03 290
【朝夕的ACM笔记】目录与索引最小生成树一、基本概念连通图：图中的任意两个节点都是相通的。生成树：连通图的一个连通子图，其含有全部 个节点，但仅有 条边。最小生成树：边权和最小的生成树。通俗地说，给定 个点， 条边，从其中选取若干条边，使得产生的图为连通图，且边权和最小，这张图就是最小生成树。下面介绍两种最小生成树的求法。二、Kruskal算法2.1 算法思想Kruskal（克鲁斯卡尔）算...
编译时选择”重新生成解决方案“，会出现，"已跳过生成: 项目", 不编译, 也不报错，
cdn_founder的专栏
07-12 1万+
编译时选择”重新生成解决方案“，会出现，"已跳过生成: 项目", 不编译, 也不报错 解决方法：查看“生成”-> “配置管理器”-> 设置要生成的项目，勾选生成项目即可
FreeSql.Cloud:提供跨数据库访问，分布式事务TCC、SAGA解决方案
05-28
:unicorn: FreeSql.Cloud 为 FreeSql 提供跨数据库访问，分布式事务TCC、SAGA解决方案，支持 .NET Core 2.1+, .NET Framework 4.0+. 快速开始 dotnet add package FreeSql.Cloud or Install-Package FreeSql.Cloud ...
Webapi.FreeSql.zip
04-08
通过NuGet包管理器或命令行工具安装`FreeSql`和`FreeSql.Provider.xxx`（这里的`xxx`代表你所使用的数据库类型）。例如，如果你使用的是MySQL，可以运行以下命令： ```sh dotnet add package FreeSql dotnet add ...
.net core3.1项目代码实例+freesql+mysql数据库
11-24
.net core3.1项目代码实例，vs2019打开，freesql可切换国产数据库，默认mysql数据库，模仿苹果系统桌面菜单布局。注：该代码只作为学习参考，不上传数据库，需要运行的可根据Model类库自行新建mysql数据库
已跳过全部重新生成_这些让人相见恨晚的高效代码小技巧你听过吗？
weixin_39920403的博客
12-03 512
全文共2358字，预计学习时长10分钟图源：unsplashPython出圈了，似乎现在人人都在学Python，朋友圈的课程广告遍地跑，小学生都看起了编程入门。的确，Python是目前公认的最通用的编程语言，以其易理解易操作的优势攻占了每一个职场人大学生必备技能榜单。学会Python确实能协助你高效工作。但学了是一回事儿，会了是另一回事儿，不是每个人学过Python的人都能玩得转它。以下几个小技巧...
Oracle与Mysql的代码生成器
我认不到你的博客
11-18 1145
代码生成器顾名思义就是一个生成代码的软件。为了节省成本，在日常的企业开发中，代码生成器使用比较普遍。
Visual Studio生成Dll（已跳过全部重新生成）问题
LM514104的博客
09-06 2853
问题如下： 解决方案： 生成成功
修改之后全部重新生成
fengkuangfj的专栏
05-25 629
修改之后全部重新生成
VS项目解决方案中的某个项目总是在编译时“已跳过生成”
热门推荐
大厨也爱搞研究的博客
07-23 2万+
编译时选择”重新生成解决方案“，会出现，”已跳过生成: 项目”, 不编译, 也不报错解决方法：查看“生成”-> “配置管理器”-> 设置要生成的项目，勾选生成项目即可
已跳过全部重新生成_可变数据生成之跳号的流水号如何批量打印？
weixin_39546747的博客
12-04 211
流水号条码或者数据打印的时候，总会遇到要跳过某个或者某几个数据的情况。比如有些抽奖卷上，会比较忌讳号4使用，希望打印流水号的时候跳过去。Label mx条码软件中的流水号数据的“自定义进制”的功能，可以实现跳号的需求。举例如下： 一、打开软件，左侧工具栏中选择文字工具按钮，在页面中画出一个文字，点击该文本，在右侧属性栏中修改字体、字号、颜色、起始文字内容。二、属性栏下方数据选项里选择“流水号”属性...
VS2005 生成解决方案时已跳过生成，打开项目属性显示“未能完成操作 未指定的错误”
丶hLLLLL的博客
05-17 963
网上找了一圈都是要修改平台为win32，我的项目使用平台是POS_SDK,不能解决问题 直到看到一个说删除 .vcproj文件，具体流程如下： 1，先把.vcproj 文件剪切到其他地方 2，打开.sln,报错-》点“确定”-》再点“确定” 3， 把 .vcproj 文件 放回来，在vs2005右边的“解决方案”处右键 重新加载，就可以了 参考原文 https://blog.csdn.net/weihongcsu/article/details/5711572 ...
使用 FreeSql 快速生成数据库的实体类
极客神殿
05-02 1723
一.首先在cmd安装 FreeSql.Generator dotnet tool install -g FreeSql.Generator 二. 了解 FreeSql.Generator --help的用法 目前只支持.netcore 3.1 更新工具：dotnet tool update -g FreeSql.Generator # 快速开始 # > FreeSql.Generator -Razor 1 -NameOptions 0,0,0,0 -NameSpace MyProj
FreeSql实体映射成数据库，数据库映射成实体类，指定表生成实体
weixin_49092494的博客
12-14 3255
文章目录codeListDbContext codeList 首先codeList就是一个将实体类映射成数据库表的东西 使用方法： 1.先引入包 补充一下上图：这四个包都要安装 写实体类 namespace FreeSqlDemo1 { public partial class Blog { //根据实体创建数据库 public static IFreeSql fsql = new FreeSql.FreeSqlBuilder() .UseConnectionString(Fre
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值