【ASP .NET CORE 】SqlSugar DbFirst生成实体框架

已于 2024-06-07 11:35:23 修改
阅读量5.9k 收藏 12
点赞数 3
分类专栏： 语言-CSharp 文章标签： .netcore 数据库 Mysql SqlSugar DbFirst Template
于 2020-12-24 15:27:58 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/chenlu5201314/article/details/111614747
版权
本文详细介绍了如何在.NetCore3.1环境中，利用SqlSugarCore5.0.1.5库生成数据库实体框架。通过设置自定义模板，包括类模板、引用模板、类描述模板、构造参数赋值模板、属性描述模板和属性模板，实现了注释美化、构造函数注释以及避免警告的功能。示例中展示了如何在控制器中调用生成API，以及生成后的实体模型代码示例，展示了模板应用的实际效果。
摘要由CSDN通过智能技术生成

一、基本信息

项目版本描述
.Net Core3.1框架
SqlSugarCore5.0.1.5数据库实体框架
Microscoft Visual Studio 2019 Community16.2.0开发环境

二、默认模板

2.1、类模板 SettingClassTemplate

子属性描述示例
{using}引用见 2.2
{Namespace}命名空间,CreateClassFile函数的第二参数Model.Entity
{ClassDescription}类描述见 2.3
{SugarTable}类的Sugar属性[SugarTable("CHECK_PARAM")]
{ClassName}类名 = 表/视图名称Student
{Constructor}构造函数中的参数赋值见 2.4
{PropertyName}

属性描述&名称

见 2.5 & 2.6
{using}
namespace {Namespace}
{
{ClassDescription}{SugarTable}
    public partial class {ClassName}
    {
           public {ClassName}(){

{Constructor}
           }
{PropertyName}
    }
}

2.2、引用模板 SettingNamespaceTemplate

SettingClassTemplate 中的 {using} 参数

using System;
using System.Linq;
using System.Text;

2.3、类描述模板 SettingClassDescriptionTemplate

SettingClassTemplate 中的 {ClassDescription} 参数

子属性描述示例
{ClassDescription}类描述学生信息
    ///<summary>
    ///{ClassDescription}
    ///</summary>

2.4、构造参数赋值模板 SettingConstructorTemplate

SettingClassTemplate 中的 {Constructor} 参数，构造函数没有入参时，此模板无效

            this.{PropertyName} ={DefaultValue};

2.5、属性描述模板 SettingPropertyDescriptionTemplate

SettingClassTemplate 中的 {PropertyName} 参数

子属性描述示例
{PropertyDescription}属性描述名称
{Default}默认值NULL::CHARACTER VARYING
{IsNullable}是否为空值True
           /// <summary>
           /// Desc:{PropertyDescription}
           /// Default:{DefaultValue}
           /// Nullable:{IsNullable}
           /// </summary>

示例 

           /// <summary>
           /// Desc:名称
           /// Default:NULL::CHARACTER VARYING
           /// Nullable:True
           /// </summary>

2.6、属性模板 SettingPropertyTemplate

SettingClassTemplate 中的 {PropertyName} 参数

子属性描述示例
{SugarColumn}属性的附加Sugar属性

[SugarColumn(IsPrimaryKey=true,IsIdentity=true)]

{PropertyType}属性类型int
{PropertyName}属性名称ID
           {SugarColumn}
           public {PropertyType} {PropertyName} {get;set;}

示例

           [SugarColumn(IsPrimaryKey=true,IsIdentity=true)]
           public int ID {get;set;}

三、示例

3.1、创建API,使用默认模板生成实体

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using IBLL;
using log4net;
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Model.DBEntity;
using Model.MyModel.Config;
using SqlSugar;
using Helper;

namespace web_api_core_1.Controllers
{
    [ApiController]
    [ApiVersion("1")]
    [ApiVersion("2")]
    public abstract class ModelDBEntityController :BaseController
    {
        public ModelDBEntityController(ILog log) : base (log) { }
        /// <summary>
        /// 刷新实体模型
        /// </summary>
        /// <param name="directoryPath">实体类型文件生成路径</param>
        /// <param name="nameSpace">命令空间</param>
        [HttpGet]
        public string RefreshEntity(string directoryPath = @"C:\Entity", string nameSpace = "Model.DBEntity")
        {
            try
            {
                SqlSugarClient db = new SqlSugarClient(new ConnectionConfig()
                {
                    ConnectionString = RSSConfig.SqlConnect.ToString(),//连接符字串
                    DbType = RSSConfig.DbType,
                    IsAutoCloseConnection = true,
                    InitKeyType = InitKeyType.Attribute//从特性读取主键自增信息
                });
                foreach (var item in db.DbMaintenance.GetTableInfoList())
                {
                    string entityName = item.Name.ToUpper();/*实体名大写*/
                    db.MappingTables.Add(entityName, item.Name);
                    foreach (var col in db.DbMaintenance.GetColumnInfosByTableName(item.Name))
                    {
                        db.MappingColumns.Add(col.DbColumnName.ToUpper() /*类的属性大写*/, col.DbColumnName, entityName);
                    }
                }
                db.DbFirst.CreateClassFile(directoryPath, nameSpace);
            }
            catch(Exception exp)
            {
                log.Err(exp);
                return exp.ToMulString(Helper.StrHelper.HTML.WARP);
            }
            return "Success";
            
        }
    }
}

3.1.2、生成效果

using System;
using System.Linq;
using System.Text;
using SqlSugar;

namespace Model.DBEntity
{
    ///<summary>
    ///
    ///</summary>
    [SugarTable("machine")]
    public partial class MACHINE
    {
           public MACHINE(){


           }
           /// <summary>
           /// Desc:机器ID  暂定1:盒剂发药机  2:存取系统
           /// Default:'0'::BIGINT
           /// Nullable:False
           /// </summary>           
           [SugarColumn(IsPrimaryKey=true)]
           public long MACHINEID {get;set;}

           /// <summary>
           /// Desc:机器地址名称
           /// Default:NULL::CHARACTER VARYING
           /// Nullable:True
           /// </summary>           
           public string LOCATIONNAME {get;set;}

           /// <summary>
           /// Desc:机器IP
           /// Default:NULL::CHARACTER VARYING
           /// Nullable:True
           /// </summary>           
           public string MACHINEIP {get;set;}

           /// <summary>
           /// Desc:机器状态  1:有效  0:无效
           /// Default:1
           /// Nullable:True
           /// </summary>           
           public int? MACHINE_STATE {get;set;}

           /// <summary>
           /// Desc:
           /// Default:0
           /// Nullable:True
           /// </summary>           
           public int? RUNNING_STATE {get;set;}

           /// <summary>
           /// Desc:机器类型  1001:片剂 1002:盒剂  1003:针剂 1004:智能药柜 1005:智能药架 1006:拆零分包机 1009:其它
           /// Default:
           /// Nullable:True
           /// </summary>           
           public int? MACHINETYPE {get;set;}

    }
}

 3.2、给构造函数添加注释，并屏蔽警告 CS1591

3.2.1、由数据库生成实体模型

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using IBLL;
using log4net;
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Model.DBEntity;
using Model.MyModel.Config;
using SqlSugar;
using Helper;

namespace web_api_core_1.Controllers
{
    [ApiController]
    [ApiVersion("1")]
    [ApiVersion("2")]
    public abstract class ModelDBEntityController :BaseController
    {
        public ModelDBEntityController(ILog log) : base (log) { }
        /// <summary>
        /// 刷新实体模型
        /// </summary>
        /// <param name="directoryPath">实体类型文件生成路径</param>
        /// <param name="nameSpace">命令空间</param>
        [HttpGet]
        public string RefreshEntity(string directoryPath = @"C:\Entity", string nameSpace = "Model.DBEntity")
        {
            try
            {
                SqlSugarClient db = new SqlSugarClient(new ConnectionConfig()
                {
                    ConnectionString = RSSConfig.SqlConnect.ToString(),//连接符字串
                    DbType = RSSConfig.DbType,
                    IsAutoCloseConnection = true,
                    InitKeyType = InitKeyType.Attribute//从特性读取主键自增信息
                });
                foreach (var item in db.DbMaintenance.GetTableInfoList())
                {
                    string entityName = item.Name.ToUpper();/*实体名大写*/
                    db.MappingTables.Add(entityName, item.Name);
                    foreach (var col in db.DbMaintenance.GetColumnInfosByTableName(item.Name))
                    {
                        db.MappingColumns.Add(col.DbColumnName.ToUpper() /*类的属性大写*/, col.DbColumnName, entityName);
                    }
                }
                db.DbFirst.SettingClassTemplate(o=> { return StrHelper.SugarCustom.ClassTemplate;})
                    .SettingNamespaceTemplate(o => { return StrHelper.SugarCustom.NamespaceTemplate; })
                    .SettingClassDescriptionTemplate(o => { return StrHelper.SugarCustom.ClassDescriptionTemplate; })
                    .SettingConstructorTemplate(o => { return StrHelper.SugarCustom.ConstructorTemplate; })
                    .SettingPropertyDescriptionTemplate(o => { return StrHelper.SugarCustom.PropertyDescriptionTemplate; })
                    .SettingPropertyTemplate(o => { return StrHelper.SugarCustom.PropertyTemplate; })
                    .IsCreateAttribute(true)
                    .CreateClassFile(directoryPath, nameSpace);
            }
            catch(Exception exp)
            {
                log.Err(exp);
                return exp.ToMulString(Helper.StrHelper.HTML.WARP);
            }
            return "Success";
            
        }
    }
}

3.2.2、StrHelper.cs > StrHelper.SugarCustom

using log4net;
using Microsoft.Extensions.Configuration;
using Model.MyModel;
using SqlSugar;
using System;
using System.Collections.Generic;
using System.IO;
using System.Text;

namespace Helper
{
    public class StrHelper
    {
        /// <summary>
        /// 自定义模板
        /// <para>屏蔽CS1591警告：#pragma warning disable 1591</para>
        /// <para>构造函数添加描述</para>
        /// <para>调整部分模板的空格数量</para>
        /// </summary>
        public class SugarCustom
        {
            /// <summary>
            /// 类模板
            /// </summary>
            public const string ClassTemplate = @"{using}
#pragma warning disable 1591

namespace {Namespace}
{
 {ClassDescription}{SugarTable}
    public partial class {ClassName}
    {
        /// <summary>
        /// {ClassName}
        /// </summary>
        public {ClassName}()
        {
{Constructor}
        }
{PropertyName}
    }
}
";
            /// <summary>
            /// 构造函数参数赋值模板
            /// </summary>
            public const string ConstructorTemplate = @"            this.{PropertyName} = {DefaultValue};
";
            /// <summary>
            /// 引用模板
            /// </summary>
            public const string NamespaceTemplate = @"using System;
using System.Linq;
using System.Text;
";
            /// <summary>
            /// 类描述模板
            /// </summary>
            public const string ClassDescriptionTemplate = @"   /// <summary>
    /// {ClassDescription}    /// </summary>";
            /// <summary>
            /// 属性描述模板
            /// </summary>
            public const string PropertyDescriptionTemplate = @"        /// <summary>
        /// 描    述:{PropertyDescription}
        /// 默 认 值:{DefaultValue}
        /// 是否空值:{IsNullable}
        /// </summary>";

            /// <summary>
            /// 属性模板
            /// </summary>
            public const string PropertyTemplate = @"{SugarColumn}
        public {PropertyType} {PropertyName} { get; set; }
";
        }
        /// <summary>
        /// 默认模板
        /// </summary>
        public class SugarDefault
        {
            /// <summary>
            /// 类模板
            /// </summary>
            public const string ClassTemplate = @"{using}
namespace {Namespace}
{
{ClassDescription}{SugarTable}
    public partial class {ClassName}
    {
           public {ClassName}(){

{Constructor}
           }
{PropertyName}
    }
}
";
            /// <summary>
            /// 构造函数参数赋值模板
            /// </summary>
            public const string ConstructorTemplate = @"            this.{PropertyName} ={DefaultValue};
";
            /// <summary>
            /// 引用模板
            /// </summary>
            public const string NamespaceTemplate = @"using System;
using System.Linq;
using System.Text;
";
            /// <summary>
            /// 类描述模板
            /// </summary>
            public const string ClassDescriptionTemplate = @"    ///<summary>
    ///{ClassDescription}    ///</summary>
";
            /// <summary>
            /// 属性描述模板
            /// </summary>
            public const string PropertyDescriptionTemplate = @"           /// <summary>
           /// Desc:{PropertyDescription}
           /// Default:{DefaultValue}
           /// Nullable:{IsNullable}
           /// </summary>";
            
            /// <summary>
            /// 属性模板
            /// </summary>
            public const string PropertyTemplate = @"           {SugarColumn}
           public {PropertyType} {PropertyName} {get;set;}
";
        }


    }
}

3.2.3、生成效果 

using System;
using System.Linq;
using System.Text;
using SqlSugar;

#pragma warning disable 1591

namespace Model.DBEntity
{
    /// <summary>
    /// 
    /// </summary>
    [SugarTable("machine")]
    public partial class MACHINE
    {
        /// <summary>
        /// MACHINE
        /// </summary>
        public MACHINE()
        {

        }
        /// <summary>
        /// 描    述:机器ID  暂定1:盒剂发药机  2:存取系统
        /// 默 认 值:0
        /// 是否空值:False
        /// </summary>
           [SugarColumn(IsPrimaryKey=true,ColumnName="machineID")]
        public int MACHINEID { get; set; }

        /// <summary>
        /// 描    述:机器类型  1001:片剂 1002:盒剂  1003:针剂 1004:智能药柜 1005:智能药架 1006:拆零分包机 1009:其它
        /// 默 认 值:
        /// 是否空值:True
        /// </summary>
           [SugarColumn(ColumnName="machineType")]
        public int? MACHINETYPE { get; set; }

        /// <summary>
        /// 描    述:机器地址名称
        /// 默 认 值:
        /// 是否空值:True
        /// </summary>
           [SugarColumn(ColumnName="locationName")]
        public string LOCATIONNAME { get; set; }

        /// <summary>
        /// 描    述:机器IP
        /// 默 认 值:
        /// 是否空值:True
        /// </summary>
           [SugarColumn(ColumnName="machineIP")]
        public string MACHINEIP { get; set; }

        /// <summary>
        /// 描    述:机器状态  1:有效  0:无效
        /// 默 认 值:1
        /// 是否空值:True
        /// </summary>
           [SugarColumn(ColumnName="machine_state")]
        public byte? MACHINE_STATE { get; set; }

        /// <summary>
        /// 描    述:
        /// 默 认 值:0
        /// 是否空值:True
        /// </summary>
           [SugarColumn(ColumnName="running_state")]
        public int? RUNNING_STATE { get; set; }

    }
}

少莫千华
关注
专栏目录
SqlSugar生成实体类Demo
12-04
sqlsugar怎么利用t4模板生成实体类；以及sqlsugar简单的增删改查。自己整理的，方便以后查找
Asp.Net Core 3.1 MVC+EF Core +SqlSugar ORM框架实例 多层架构示例Demo
11-05
综上所述，这个示例是一个使用Asp.Net Core 3.1 MVC构建的Web应用，通过EF Core和SqlSugar两种ORM框架与数据库进行交互。多层架构的设计使得代码结构清晰，便于开发和维护。此外，还提供了相应的解决方案文件和工作...
.net Core中sqlsugar的安装和dbfirst的基本使用
m0_65192155的博客
01-04 915
运行后会自动创建实体类。
.net core 通过Sqlsugar生成实体
最新发布
世界太浮夸
09-13 653
直接上代码。
.NET Core WebAPI中使用SqlSugar连接数据库并使用DbFirst生成实体
瘾丶病的博客
02-27 897
.NET Core WebAPI中使用SqlSugar连接数据库并使用DbFirst生成实体。
SqlSugar使用DbFirst对象根据数据库表结构创建实体类-C#
枫叶2000的博客
06-13 1672
C#，SqlSugar 根据数据库表结构创建实体类
SqlSugar Tool 生成实体类
dxm809的博客
11-07 5009
1 打开Sql Sugar工具箱，选择实体类生成 2 选择Sql Server 3 输入连接名称，主机地址,数据库用户名，密码，点测试连接 4 上面会显示测试连接成功 5 此时就可以通过下拉框选择数据库，点确定 6 选择生成模板设置 7 这里可以修改生成的模板，如果不需要修改，直接点击保存 8 回到主界面，点击如图的生成实体按钮 9 选择生成到的文件夹 ，如果正常则会提示导出所有表成功，此时可以拷贝生成的实体类到项目中使用 ...
采用SqlSugar的DBFirst相关功能创建数据库表对应的实体类
gc_2299的博客
06-24 2949
采用SqlSugar的DBFirst相关功能创建数据库表对应的实体类
.net6 下 SqlSugar迁移创建表以及生成实体类 sqlserver数据库
weixin_44442366的博客
04-20 8061
.net6 下 SqlSugar迁移创建表库到sqlserver数据库 以及根据 sqlserver数据库生成实体类到指定文件夹
1_SqlSugar-表到实体、实体到表及库表操作
Justinyh的博客
12-15 4481
SqlSugar-表映射到实体、实体映射到表及通过代码进行库表操作。
实体类生成工具(很实用的工具)
05-28
实体类生成工具 实体类生成工具 实体类生成工具 实体类生成工具 实体类生成工具 实体类生成工具 实体类生成工具 实体类生成工具
ASP.net Core .net6 SqlSugar 博客接口
08-03
ASP.NET Core .NET 6 和 SqlSugar 是两个关键的技术组件，用于构建高效、可扩展的Web应用程序。在本文中，我们将深入探讨这两个技术以及如何在实际项目中使用它们来实现博客接口。 首先，ASP.NET Core是微软推出的...
Dome-ASP.NET CORE 6 webapi 使用 EF DBFirst 配合 sql server
05-26
ASP.NET Core 6 WebAPI与Entity Framework (EF) DBFirst结合使用是开发高效、数据库驱动的Web服务的常见方法。这个技术栈允许开发者利用SQL Server的强大功能，同时借助EF简化数据访问层的实现。以下是对这个主题的...
.Net Core2.1 使用SqlSugar对SqlServer数据库操作
07-04
在.NET Core 2.1开发环境中，SqlSugar是一个流行的ORM（对象关系映射）框架，它简化了与SQL Server数据库的交互。SqlSugar提供了一种高效、轻量级且易于使用的解决方案，使得开发者无需编写大量的SQL语句，就能实现...
ASP.NET Core MVC从入门到精通系列文章PDF版
06-30
ASP.NET Core MVC 是微软开发的一款用于构建Web应用程序的框架，它是基于ASP.NET Core的一个关键组件，支持跨平台开发。这个框架采用MVC（Model-View-Controller）设计模式，为开发者提供了一种清晰的架构来组织和...
SqlSugar根据数据库生成实体
何鹏飞的博客
05-05 2223
using CHMS.App; using SqlSugar; using System; using System.Diagnostics; using System.Linq; namespace CHMS.Store { /// <summary> /// 程序数据库操作类 /// </summary> public class AppDb { /// <summary> /// 获取程序数.
Asp.net Core如何采用sqlsguar注入连接数据库并分层
linqinong520的博客
02-14 923
appsettings.json连接数据库配置 "ConnectionConfigs": [ { "ConnectionString": "Data Source=(local);Initial Catalog=IoT;Persist Security Info=True;User ID=sa;Password=*****;Enlist=true;Pooling=true;Max Pool Size=2000;Min Pool Size=300;Connection Lifetime=
Asp.NetCore 利用SqlSugar连接数据库
fei0700的博客
11-17 4705
1、安装SqlSugarCore包 2、配置appsettings.json连接字符串(.NetCore没有Web.config了) "ConnectionStrings": { "BaseDb": "Server=127.0.0.1;Initial Catalog=Test;User ID=sa;Password=sa;MultipleActiveResultSets=true" } 3、新建类，读取Json配置文件 public class SqlsugarBase {
零基础入门：Asp.Net Core 2.0 CodeFirst网站搭建教程
本文将详细介绍如何使用CodeFirst方法从零开始搭建Asp.Net Core 2.0网站，适合那些希望深入了解并实践.NET Core框架的新手或开发者。首先，确保已经安装了.NET Core 2.0开发环境，并熟悉基本的项目创建流程。 在...
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值