SimpleAdmin手摸手教學之:CodeFirst

一、前言

傳統開發中,通常採用DbFirst的方式開發,先有數據庫和表,再將對應的錶轉爲實體。隨着技術的發展,開始有了CodeFist的方式開發,先創建實體類,再通過實體類反向的創建數據庫和表結構,微軟的EF框架就是典型,本系統使用的ORM是SqlSugar,同樣也支持CodeFisrt,詳情可以查看文檔https://www.donet5.com/Doc/1/1206

二、WebFirst

WebFirst  是果糖大數據團隊開發的新一代 高性能 代碼生成器&數據庫設計工具,由.net core 3.1 + sqlsugar 開發 導入1000個表只要1-2秒,用法簡單,功能強大,支持多種數據庫 ,具體功能如下:

一、 建庫、CodeFirst方式在線建表,沒用到CodeFirst的用戶可以用工具輕鬆體驗,支持公共字段

二、導出EXCEL文檔,把每個表的數據導出來

三、模版管理 可以自個添加修改模版,使用的是Razor模版引擎對C#程序員更加友好

四、方案管理,可以創建自已的生成方案,修改方案

五、支持擴展模版屬性,支持生成更加豐富的前端代碼

六、支持生成解決方案

七、支持生成附加文件,支持文件後綴

八、支持視圖

九、支持自定義數據類型

十、支持多種數據庫 MYSQL PGSQL SQLITE SQLSERVE  ORCLE  達夢 

本系統生成實體類就是採用的是Sqlusgar的WebFirst。參考文檔https://www.donet5.com/Doc/11

三、生成實體類

採用webfirst生成實體類,具體用戶不闡述,參考webfirst文檔,在自定義模板->模板管理菜單裏新建一個模板,下面是我的模板,可以根據情況修改

using System;
using System.Collections.Generic;
using System.Linq;
using SqlSugar;
namespace @Model.name_space
{
    /// <summary>
    /// @((Model.Description+"").Replace("\r","").Replace("\n",""))
    ///</summary>
    [SugarTable("@(Model.TableName)",TableDescription ="@((Model.Description+"").Replace("\r","").Replace("\n",""))")]
    [Tenant(SqlsugarConst.DB_Default)]
    public class @(Model.ClassName): DataEntityBase
    {
@foreach (var item in Model.PropertyGens)
{
    var isPrimaryKey = item.IsPrimaryKey ? ",IsPrimaryKey = true" : "";
    var isIdentity = item.IsIdentity ? ",IsIdentity = true" : "";
    var isNull=(item.IsNullable&&item.Type!="string"&&item.IsSpecialType==false&&item.Type!="byte[]")?"?":"";
    var isIgnore=(item.IsIgnore?",IsIgnore = true":"");
    var isJson=(item.CodeType.StartsWith("json")?",IsJson= true":"");
    var Length=item.Length==null?"":$",Length= {item.Length}";
    var isnullable=item.IsNullable?"true":"false";    

    var name = item.DbColumnName.ToLower();
    var list = name .Split("_");
   //for (int i = 0; i < list.Length; i++)
   // {
    //var str = list[i].ToLower();
    //var c = str.Substring(0, 1).ToUpper() + str.Substring(1);
    //list[i] = c;
    //}
    var column = string.Join("", list);
   // var column = name.Substring(0, 1).ToUpper() + name.Substring(1);
    var newPropertyName=column; //這裏可以用C#處理 實體屬性的顯式格式
    //想和數據庫一樣就用 newPropertyName=item.DbColumnName
    if(System.Text.RegularExpressions.Regex.IsMatch(newPropertyName.Substring(0,1), "[0-9]"))
    {
        newPropertyName="_"+newPropertyName;//處理屬性名開頭爲數字情況
    }
    if(newPropertyName==Model.ClassName)
    {
        newPropertyName="_"+newPropertyName;//處理屬性名不能等於類名
    }

    var desc=(item.Description+"").Replace("\r","").Replace("\n","");//處理換行

    if(isIgnore!="")
    {
       isPrimaryKey =isIdentity =isNull="";
     }
        @:/// <summary>
        @:/// @(desc) 
        @if(item.DefaultValue!=null)
        {
        @:/// 默認值: @Raw(item.DefaultValue)
        }
        @:///</summary>
        @: [SugarColumn(ColumnName="@(column)",ColumnDescription ="@(desc)" @(isPrimaryKey) @(isIdentity) @(isIgnore) @(isJson) @(Length) ,IsNullable =@(isnullable))]
        @: public @Raw(item.Type)@isNull @newPropertyName{ get; set; }
    }
    }
}

在類建表模式中選擇要生成的表,點擊預覽並選擇模板,可以生成對應的實體類代碼。SqlSugar插件中的Entity文件夾新建對應的實體類,將預覽的代碼複製進去,根據情況選擇實體繼承的類,去掉公共字段即可。

 

四、使用CodeFist插件生成數據庫和表

系統默認引用CodeFirst插件,如果需要初始化數據庫,只需要在SqlSugar插件的配置文件中設置IsInitDb爲true。

系統啓動時,會自動創建對應的數據庫和表。

如果希望某個已經存在的表不重新初始化,只需要在實體類上加上IgnoreInitTable特性即可,系統會在初始化的時候忽略該實體。

五、種子數據

CodeFirtst插件同樣集成了種子數據功能,而且非常簡單。本系統的種子數據放在CodeFirst插件下的SeedData文件夾。二級文件夾對應不同的數據庫。

json文件夾下放置的就是種子數據的json文件,可以通過Navicat導出的json文件。

要注意時間格式要改成YMD

系統啓動時會自動讀取種子數據類,並將數據插入到數據庫中。

具體實現可以在插件的Startup類中查看。

記得在CodeFirst.json中排除種子數據json。

需要生成種子數據,只需要在Sqlsugar配置文件中設置IsSeedData爲true

如果希望有些表不生成種子數據,只需要在SeedDatal類加上IgnoreSeedDataAdd或者IgnoreSeedDataAddUpdate特性即可

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章