devbox
我家自动化
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

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

作者：我家自动化 | 2024-02-23 08:39:19

赞

踩

sqlsugar dbfirst

一、基本信息

项目版本描述
.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
  1. {using}
  2. namespace {Namespace}
  3. {
  4. {ClassDescription}{SugarTable}
  5.     public partial class {ClassName}
  6.     {
  7.            public {ClassName}(){
  8.  
  9. {Constructor}
  10.            }
  11. {PropertyName}
  12.     }
  13. }
  14.

 

2.2、引用模板 SettingNamespaceTemplate

SettingClassTemplate 中的 {using} 参数

  1. using System;
  2. using System.Linq;
  3. using System.Text;
  4.

2.3、类描述模板 SettingClassDescriptionTemplate

SettingClassTemplate 中的 {ClassDescription} 参数

子属性描述示例
{ClassDescription}类描述学生信息
  1.     ///<summary>
  2.     ///{ClassDescription}
  3.     ///</summary>
  4.

2.4、构造参数赋值模板 SettingConstructorTemplate

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

  1.             this.{PropertyName} ={DefaultValue};
  2.

2.5、属性描述模板 SettingPropertyDescriptionTemplate

SettingClassTemplate 中的 {PropertyName} 参数

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

示例 

  1.            /// <summary>
  2.            /// Desc:名称
  3.            /// Default:NULL::CHARACTER VARYING
  4.            /// Nullable:True
  5.            /// </summary>

 

2.6、属性模板 SettingPropertyTemplate

SettingClassTemplate 中的 {PropertyName} 参数

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

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

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

示例

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

三、示例

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

  1. using System;
  2. using System.Collections.Generic;
  3. using System.Linq;
  4. using System.Threading.Tasks;
  5. using IBLL;
  6. using log4net;
  7. using Microsoft.AspNetCore.Authorization;
  8. using Microsoft.AspNetCore.Http;
  9. using Microsoft.AspNetCore.Mvc;
  10. using Model.DBEntity;
  11. using Model.MyModel.Config;
  12. using SqlSugar;
  13. using Helper;
  14.  
  15. namespace web_api_core_1.Controllers
  16. {
  17.     [ApiController]
  18.     [ApiVersion("1")]
  19.     [ApiVersion("2")]
  20.     public abstract class ModelDBEntityController :BaseController
  21.     {
  22.         public ModelDBEntityController(ILog log) : base (log) { }
  23.         /// <summary>
  24.         /// 刷新实体模型
  25.         /// </summary>
  26.         /// <param name="directoryPath">实体类型文件生成路径</param>
  27.         /// <param name="nameSpace">命令空间</param>
  28.         [HttpGet]
  29.         public string RefreshEntity(string directoryPath = @"C:\Entity", string nameSpace = "Model.DBEntity")
  30.         {
  31.             try
  32.             {
  33.                 SqlSugarClient db = new SqlSugarClient(new ConnectionConfig()
  34.                 {
  35.                     ConnectionString = RSSConfig.SqlConnect.ToString(),//连接符字串
  36.                     DbType = RSSConfig.DbType,
  37.                     IsAutoCloseConnection = true,
  38.                     InitKeyType = InitKeyType.Attribute//从特性读取主键自增信息
  39.                 });
  40.                 foreach (var item in db.DbMaintenance.GetTableInfoList())
  41.                 {
  42.                     string entityName = item.Name.ToUpper();/*实体名大写*/
  43.                     db.MappingTables.Add(entityName, item.Name);
  44.                     foreach (var col in db.DbMaintenance.GetColumnInfosByTableName(item.Name))
  45.                     {
  46.                         db.MappingColumns.Add(col.DbColumnName.ToUpper() /*类的属性大写*/, col.DbColumnName, entityName);
  47.                     }
  48.                 }
  49.                 db.DbFirst.CreateClassFile(directoryPath, nameSpace);
  50.             }
  51.             catch(Exception exp)
  52.             {
  53.                 log.Err(exp);
  54.                 return exp.ToMulString(Helper.StrHelper.HTML.WARP);
  55.             }
  56.             return "Success";
  57.             
  58.         }
  59.     }
  60. }

3.1.2、生成效果

  1. using System;
  2. using System.Linq;
  3. using System.Text;
  4. using SqlSugar;
  5.  
  6. namespace Model.DBEntity
  7. {
  8.     ///<summary>
  9.     ///
  10.     ///</summary>
  11.     [SugarTable("machine")]
  12.     public partial class MACHINE
  13.     {
  14.            public MACHINE(){
  15.  
  16.  
  17.            }
  18.            /// <summary>
  19.            /// Desc:机器ID  暂定1:盒剂发药机  2:存取系统
  20.            /// Default:'0'::BIGINT
  21.            /// Nullable:False
  22.            /// </summary>           
  23.            [SugarColumn(IsPrimaryKey=true)]
  24.            public long MACHINEID {get;set;}
  25.  
  26.            /// <summary>
  27.            /// Desc:机器地址名称
  28.            /// Default:NULL::CHARACTER VARYING
  29.            /// Nullable:True
  30.            /// </summary>           
  31.            public string LOCATIONNAME {get;set;}
  32.  
  33.            /// <summary>
  34.            /// Desc:机器IP
  35.            /// Default:NULL::CHARACTER VARYING
  36.            /// Nullable:True
  37.            /// </summary>           
  38.            public string MACHINEIP {get;set;}
  39.  
  40.            /// <summary>
  41.            /// Desc:机器状态  1:有效  0:无效
  42.            /// Default:1
  43.            /// Nullable:True
  44.            /// </summary>           
  45.            public int? MACHINE_STATE {get;set;}
  46.  
  47.            /// <summary>
  48.            /// Desc:
  49.            /// Default:0
  50.            /// Nullable:True
  51.            /// </summary>           
  52.            public int? RUNNING_STATE {get;set;}
  53.  
  54.            /// <summary>
  55.            /// Desc:机器类型  1001:片剂 1002:盒剂  1003:针剂 1004:智能药柜 1005:智能药架 1006:拆零分包机 1009:其它
  56.            /// Default:
  57.            /// Nullable:True
  58.            /// </summary>           
  59.            public int? MACHINETYPE {get;set;}
  60.  
  61.     }
  62. }

 

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

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

  1. using System;
  2. using System.Collections.Generic;
  3. using System.Linq;
  4. using System.Threading.Tasks;
  5. using IBLL;
  6. using log4net;
  7. using Microsoft.AspNetCore.Authorization;
  8. using Microsoft.AspNetCore.Http;
  9. using Microsoft.AspNetCore.Mvc;
  10. using Model.DBEntity;
  11. using Model.MyModel.Config;
  12. using SqlSugar;
  13. using Helper;
  14.  
  15. namespace web_api_core_1.Controllers
  16. {
  17.     [ApiController]
  18.     [ApiVersion("1")]
  19.     [ApiVersion("2")]
  20.     public abstract class ModelDBEntityController :BaseController
  21.     {
  22.         public ModelDBEntityController(ILog log) : base (log) { }
  23.         /// <summary>
  24.         /// 刷新实体模型
  25.         /// </summary>
  26.         /// <param name="directoryPath">实体类型文件生成路径</param>
  27.         /// <param name="nameSpace">命令空间</param>
  28.         [HttpGet]
  29.         public string RefreshEntity(string directoryPath = @"C:\Entity", string nameSpace = "Model.DBEntity")
  30.         {
  31.             try
  32.             {
  33.                 SqlSugarClient db = new SqlSugarClient(new ConnectionConfig()
  34.                 {
  35.                     ConnectionString = RSSConfig.SqlConnect.ToString(),//连接符字串
  36.                     DbType = RSSConfig.DbType,
  37.                     IsAutoCloseConnection = true,
  38.                     InitKeyType = InitKeyType.Attribute//从特性读取主键自增信息
  39.                 });
  40.                 foreach (var item in db.DbMaintenance.GetTableInfoList())
  41.                 {
  42.                     string entityName = item.Name.ToUpper();/*实体名大写*/
  43.                     db.MappingTables.Add(entityName, item.Name);
  44.                     foreach (var col in db.DbMaintenance.GetColumnInfosByTableName(item.Name))
  45.                     {
  46.                         db.MappingColumns.Add(col.DbColumnName.ToUpper() /*类的属性大写*/, col.DbColumnName, entityName);
  47.                     }
  48.                 }
  49.                 db.DbFirst.SettingClassTemplate(o=> { return StrHelper.SugarCustom.ClassTemplate;})
  50.                     .SettingNamespaceTemplate(o => { return StrHelper.SugarCustom.NamespaceTemplate; })
  51.                     .SettingClassDescriptionTemplate(o => { return StrHelper.SugarCustom.ClassDescriptionTemplate; })
  52.                     .SettingConstructorTemplate(o => { return StrHelper.SugarCustom.ConstructorTemplate; })
  53.                     .SettingPropertyDescriptionTemplate(o => { return StrHelper.SugarCustom.PropertyDescriptionTemplate; })
  54.                     .SettingPropertyTemplate(o => { return StrHelper.SugarCustom.PropertyTemplate; })
  55.                     .IsCreateAttribute(true)
  56.                     .CreateClassFile(directoryPath, nameSpace);
  57.             }
  58.             catch(Exception exp)
  59.             {
  60.                 log.Err(exp);
  61.                 return exp.ToMulString(Helper.StrHelper.HTML.WARP);
  62.             }
  63.             return "Success";
  64.             
  65.         }
  66.     }
  67. }

3.2.2、StrHelper.cs > StrHelper.SugarCustom

  1. using log4net;
  2. using Microsoft.Extensions.Configuration;
  3. using Model.MyModel;
  4. using SqlSugar;
  5. using System;
  6. using System.Collections.Generic;
  7. using System.IO;
  8. using System.Text;
  9.  
  10. namespace Helper
  11. {
  12.     public class StrHelper
  13.     {
  14.         /// <summary>
  15.         /// 自定义模板
  16.         /// <para>屏蔽CS1591警告：#pragma warning disable 1591</para>
  17.         /// <para>构造函数添加描述</para>
  18.         /// <para>调整部分模板的空格数量</para>
  19.         /// </summary>
  20.         public class SugarCustom
  21.         {
  22.             /// <summary>
  23.             /// 类模板
  24.             /// </summary>
  25.             public const string ClassTemplate = @"{using}
  26. #pragma warning disable 1591
  28. namespace {Namespace}
  29. {
  30.  {ClassDescription}{SugarTable}
  31.     public partial class {ClassName}
  32.     {
  33.         /// <summary>
  34.         /// {ClassName}
  35.         /// </summary>
  36.         public {ClassName}()
  37.         {
  38. {Constructor}
  39.         }
  40. {PropertyName}
  41.     }
  42. }
  43. ";
  44.             /// <summary>
  45.             /// 构造函数参数赋值模板
  46.             /// </summary>
  47.             public const string ConstructorTemplate = @"            this.{PropertyName} = {DefaultValue};
  48. ";
  49.             /// <summary>
  50.             /// 引用模板
  51.             /// </summary>
  52.             public const string NamespaceTemplate = @"using System;
  53. using System.Linq;
  54. using System.Text;
  55. ";
  56.             /// <summary>
  57.             /// 类描述模板
  58.             /// </summary>
  59.             public const string ClassDescriptionTemplate = @"   /// <summary>
  60.     /// {ClassDescription}    /// </summary>";
  61.             /// <summary>
  62.             /// 属性描述模板
  63.             /// </summary>
  64.             public const string PropertyDescriptionTemplate = @"        /// <summary>
  65.         /// 描    述:{PropertyDescription}
  66.         /// 默 认 值:{DefaultValue}
  67.         /// 是否空值:{IsNullable}
  68.         /// </summary>";
  69.  
  70.             /// <summary>
  71.             /// 属性模板
  72.             /// </summary>
  73.             public const string PropertyTemplate = @"{SugarColumn}
  74.         public {PropertyType} {PropertyName} { get; set; }
  75. ";
  76.         }
  77.         /// <summary>
  78.         /// 默认模板
  79.         /// </summary>
  80.         public class SugarDefault
  81.         {
  82.             /// <summary>
  83.             /// 类模板
  84.             /// </summary>
  85.             public const string ClassTemplate = @"{using}
  86. namespace {Namespace}
  87. {
  88. {ClassDescription}{SugarTable}
  89.     public partial class {ClassName}
  90.     {
  91.            public {ClassName}(){
  93. {Constructor}
  94.            }
  95. {PropertyName}
  96.     }
  97. }
  98. ";
  99.             /// <summary>
  100.             /// 构造函数参数赋值模板
  101.             /// </summary>
  102.             public const string ConstructorTemplate = @"            this.{PropertyName} ={DefaultValue};
  103. ";
  104.             /// <summary>
  105.             /// 引用模板
  106.             /// </summary>
  107.             public const string NamespaceTemplate = @"using System;
  108. using System.Linq;
  109. using System.Text;
  110. ";
  111.             /// <summary>
  112.             /// 类描述模板
  113.             /// </summary>
  114.             public const string ClassDescriptionTemplate = @"    ///<summary>
  115.     ///{ClassDescription}    ///</summary>
  116. ";
  117.             /// <summary>
  118.             /// 属性描述模板
  119.             /// </summary>
  120.             public const string PropertyDescriptionTemplate = @"           /// <summary>
  121.            /// Desc:{PropertyDescription}
  122.            /// Default:{DefaultValue}
  123.            /// Nullable:{IsNullable}
  124.            /// </summary>";
  125.             
  126.             /// <summary>
  127.             /// 属性模板
  128.             /// </summary>
  129.             public const string PropertyTemplate = @"           {SugarColumn}
  130.            public {PropertyType} {PropertyName} {get;set;}
  131. ";
  132.         }
  133.  
  134.  
  135.     }
  136. }

3.2.3、生成效果 

  1. using System;
  2. using System.Linq;
  3. using System.Text;
  4. using SqlSugar;
  5.  
  6. #pragma warning disable 1591
  7.  
  8. namespace Model.DBEntity
  9. {
  10.     /// <summary>
  11.     /// 
  12.     /// </summary>
  13.     [SugarTable("machine")]
  14.     public partial class MACHINE
  15.     {
  16.         /// <summary>
  17.         /// MACHINE
  18.         /// </summary>
  19.         public MACHINE()
  20.         {
  21.  
  22.         }
  23.         /// <summary>
  24.         /// 描    述:机器ID  暂定1:盒剂发药机  2:存取系统
  25.         /// 默 认 值:0
  26.         /// 是否空值:False
  27.         /// </summary>
  28.            [SugarColumn(IsPrimaryKey=true,ColumnName="machineID")]
  29.         public int MACHINEID { get; set; }
  30.  
  31.         /// <summary>
  32.         /// 描    述:机器类型  1001:片剂 1002:盒剂  1003:针剂 1004:智能药柜 1005:智能药架 1006:拆零分包机 1009:其它
  33.         /// 默 认 值:
  34.         /// 是否空值:True
  35.         /// </summary>
  36.            [SugarColumn(ColumnName="machineType")]
  37.         public int? MACHINETYPE { get; set; }
  38.  
  39.         /// <summary>
  40.         /// 描    述:机器地址名称
  41.         /// 默 认 值:
  42.         /// 是否空值:True
  43.         /// </summary>
  44.            [SugarColumn(ColumnName="locationName")]
  45.         public string LOCATIONNAME { get; set; }
  46.  
  47.         /// <summary>
  48.         /// 描    述:机器IP
  49.         /// 默 认 值:
  50.         /// 是否空值:True
  51.         /// </summary>
  52.            [SugarColumn(ColumnName="machineIP")]
  53.         public string MACHINEIP { get; set; }
  54.  
  55.         /// <summary>
  56.         /// 描    述:机器状态  1:有效  0:无效
  57.         /// 默 认 值:1
  58.         /// 是否空值:True
  59.         /// </summary>
  60.            [SugarColumn(ColumnName="machine_state")]
  61.         public byte? MACHINE_STATE { get; set; }
  62.  
  63.         /// <summary>
  64.         /// 描    述:
  65.         /// 默 认 值:0
  66.         /// 是否空值:True
  67.         /// </summary>
  68.            [SugarColumn(ColumnName="running_state")]
  69.         public int? RUNNING_STATE { get; set; }
  70.  
  71.     }
  72. }

 

声明：本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：【wpsshop博客】
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号