30分鍾教您打造自己的代碼生成器

     

      哇咔咔，離上次寫文又有幾個月了。不過上次寫的《這些開源項目，你都知道嗎？（持續更新中...）[原創]》受到廣大讀者的贊賞和推薦，也使得自己更有動力去寫技術文章。好了，廢話不多說，直接切入正題。

      前方高能預警，由於此篇博文適合初學者入門或者各種大牛老男孩懷念那些年我們一起寫過的代碼生成器，所以請各路時間寶貴的大神慎重查看此篇博文，誤入者后果自負！！！ 

一、前言背景（3分鍾）

      博主清晰的記得，大三的時候，老師會布置各種課外作業，不過大多是基於數據庫增刪改查的XX管理系統。此類系統，想必大家伙都懂，自然是無法避免的要編寫很多重復性的簡單代碼。基於XX表的DAL、BLL，其實都不必用三層架構，直接兩層多清爽。不過學生時代很多時候都是為了學習而生搬硬套。不像現在各種ORM，寫個錘子的DAL。至於大名鼎鼎的T4，用起來似乎智能提示不怎么友好，另外就是針對特性化需求實現起來也麻煩。還有就是各種各樣成熟的代碼生成器（比如動軟），也始終難以滿足團隊內部的代碼生成規則。再加上那時的博主本着一顆造輪子的心，開始腦海中浮現，是否可以做一個工具？主要用以實現對應數據庫中表的基礎代碼的自動生成，包括生成屬性、增刪改查、實體類等基礎代碼片斷。使開發人員可以節省大量機械式編寫代碼的時間和重復勞動，而將精力集中於核心業務邏輯的開發。從而使得開發人員能夠快速開發項目，縮短開發周期，減少開發成本，大大提高了項目的研發效率，使得開發人員在同樣的時間創造出更大的價值。

 

二、技術儲備（2分鍾）

1、既然要生成數據庫表所對應的代碼，那么想必得從數據庫獲取相關表和字段的基礎信息吧？

2、有了相關表和字段的基礎信息了，怎么樣按照特性化需求和規則生成對應的代碼呢？

3、生成的代碼如何展現？直接打印到界面還是生成代碼文件呢？

 

三、開始構建（20分鍾）

此例子，博主將使用SQL Server 2008 R2 做數據庫，使用Winform做工具的UI展示。

1、執行以下sql，即可從SQL server 數據庫得到相關表和字段的基礎信息（SQL Server 2008 R2 親測有效）

SELECT *
FROM master..sysdatabases

select  
    [表名]=c.Name, 
    [表說明]=isnull(f.[value],''),  
    [列序號]=a.Column_id,  
    [列名]=a.Name,  
    [列說明]=isnull(e.[value],''),  
    [數據庫類型]=b.Name,    
    [類型]= case when b.Name = 'image' then 'byte[]'
                 when b.Name in('image','uniqueidentifier','ntext','varchar','ntext','nchar','nvarchar','text','char') then 'string'
                 when b.Name in('tinyint','smallint','int','bigint') then 'int'
                 when b.Name in('datetime','smalldatetime') then 'DateTime'
                 when b.Name in('float','decimal','numeric','money','real','smallmoney') then 'decimal'
                 when b.Name ='bit' then 'bool' else b.name end ,
    [標識]= case when is_identity=1 then '是' else '' end,  
    [主鍵]= case when exists(select 1 from sys.objects x join sys.indexes y on x.Type=N'PK' and x.Name=y.Name  
                        join sysindexkeys z on z.ID=a.Object_id and z.indid=y.index_id and z.Colid=a.Column_id)  
                    then '是' else '' end,      
    [字節數]=case when a.[max_length]=-1 and b.Name!='xml' then 'max/2G'  
                  when b.Name='xml' then '2^31-1字節/2G' 
                  else rtrim(a.[max_length]) end,  
    [長度]=case when ColumnProperty(a.object_id,a.Name,'Precision')=-1 then '2^31-1' 
                else rtrim(ColumnProperty(a.object_id,a.Name,'Precision')) end,  
    [小數位]=isnull(ColumnProperty(a.object_id,a.Name,'Scale'),0),  
    [是否為空]=case when a.is_nullable=1 then '是' else '' end,      
    [默認值]=isnull(d.text,'')      
from  
    sys.columns a  
left join 
    sys.types b on a.user_type_id=b.user_type_id  
inner join 
    sys.objects c on a.object_id=c.object_id and c.Type='U' 
left join 
    syscomments d on a.default_object_id=d.ID  
left join 
    sys.extended_properties e on e.major_id=c.object_id and e.minor_id=a.Column_id and e.class=1   
left join 
    sys.extended_properties f on f.major_id=c.object_id and f.minor_id=0 and f.class=1 

獲取數據庫所有表字段信息

2、構建自定義模板，然后替換模板中的標識符

說到自定義模板，無非就是一堆字符串，那這一堆字符串究竟是用XML存儲還是TXT文本存儲還是其他方式呢？好吧，咱不糾結到底采用哪種存儲介質了。基於本文的“30分鍾”，博主決定短平快，直接硬編碼寫死吧！用字符串對象存儲起來。 

string modelTmp = @"
using System;

namespace #ModelNamespace#
{
    /// <summary>
    /// #ModelClassDescription#
    /// Create By Tool #CreateDateTime#
    /// </summary>
    public class #ModelClassName#
    {
#PropertyInfo#
    }
}";

實體類模板

string modelPropertyTmp = @"
         /// <summary>
         /// #PropertyDescription#
         /// </summary>
         public  #PropertyType# #PropertyName# { get; set; }";

propertyInfo += modelPropertyTmp.Replace(" #PropertyDescription#", propertyDescription)
                                                        .Replace(" #PropertyType#", propertyType)
                                                        .Replace("#PropertyName#", propertyName);


modelTmp = modelTmp.Replace("#ModelClassDescription#", this.treeView1.SelectedNode.Tag.ToString())
                                       .Replace("#CreateDateTime#", DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss"))
                                       .Replace("#ModelNamespace#", modelNamespace)
                                       .Replace("#ModelClassName#", modelClassName)
                                       .Replace("#PropertyInfo#", propertyInfo);

標識符替換

3、采用文本控件將生成的代碼打印出來

由於本文旨在讓各位讀者了解代碼生成的原理，故博主花了10多分鍾寫了一個簡單的代碼生成器，代碼自然有些粗糙，請各位見諒！

using System;
using System.Collections.Generic;
using System.Data;
using System.Data.SqlClient;
using System.Linq;
using System.Windows.Forms;

namespace WindowsTest
{
    public partial class CodeCreate : Form
    {
        private static string S_conStr = "Data Source=127.0.0.1;Initial Catalog=master;Integrated Security=False;user=sa;password=******;";

        public CodeCreate()
        {
            InitializeComponent();
        }

        public static DataTable ExcuteQuery(string connectionString, string cmdText, List<SqlParameter> pars = null)
        {
            using (SqlConnection conn = new SqlConnection(connectionString))
            {
                using (SqlCommand cmd = new SqlCommand(cmdText, conn))
                {
                    if (pars != null && pars.Count > 0) cmd.Parameters.AddRange(pars.ToArray());
                    using (SqlDataAdapter adp = new SqlDataAdapter(cmd))
                    {
                        DataTable dt = new DataTable();
                        adp.Fill(dt);
                        return dt;
                    }
                }
            }
        }

        private void CodeCreate_Load(object sender, EventArgs e)
        {
            #region 獲取所有數據庫的信息
            string sql = @" SELECT *
                            FROM master..sysdatabases
                            where dbid>6
                            ORDER BY dbid";
            #endregion

            DataTable dt = ExcuteQuery(S_conStr, sql);
            this.treeView1.Nodes.Add("192.168.30.69");
            foreach (DataRow dr in dt.Rows)
            {
                this.treeView1.Nodes[0].Nodes.Add(dr["name"].ToString());
            }

            this.treeView1.ExpandAll();
        }

        private void treeView1_AfterSelect(object sender, TreeViewEventArgs e)
        {
            this.tabControl1.SelectedIndex = 0;

            if (e.Node.Level == 0) return;

            #region 獲取數據庫所有表字段信息的sql
            string sql = @"
select  
    [表名]=c.Name, 
    [表說明]=isnull(f.[value],''),  
    [列序號]=a.Column_id,  
    [列名]=a.Name,  
    [列說明]=isnull(e.[value],''),  
    [數據庫類型]=b.Name,    
    [類型]= case when b.Name = 'image' then 'byte[]'
                 when b.Name in('image','uniqueidentifier','ntext','varchar','ntext','nchar','nvarchar','text','char') then 'string'
                 when b.Name in('tinyint','smallint','int','bigint') then 'int'
                 when b.Name in('datetime','smalldatetime') then 'DateTime'
                 when b.Name in('float','decimal','numeric','money','real','smallmoney') then 'decimal'
                 when b.Name ='bit' then 'bool' else b.name end ,
    [標識]= case when is_identity=1 then '是' else '' end,  
    [主鍵]= case when exists(select 1 from sys.objects x join sys.indexes y on x.Type=N'PK' and x.Name=y.Name  
                        join sysindexkeys z on z.ID=a.Object_id and z.indid=y.index_id and z.Colid=a.Column_id)  
                    then '是' else '' end,      
    [字節數]=case when a.[max_length]=-1 and b.Name!='xml' then 'max/2G'  
                  when b.Name='xml' then '2^31-1字節/2G' 
                  else rtrim(a.[max_length]) end,  
    [長度]=case when ColumnProperty(a.object_id,a.Name,'Precision')=-1 then '2^31-1' 
                else rtrim(ColumnProperty(a.object_id,a.Name,'Precision')) end,  
    [小數位]=isnull(ColumnProperty(a.object_id,a.Name,'Scale'),0),  
    [是否為空]=case when a.is_nullable=1 then '是' else '' end,      
    [默認值]=isnull(d.text,'')      
from  
    sys.columns a  
left join 
    sys.types b on a.user_type_id=b.user_type_id  
inner join 
    sys.objects c on a.object_id=c.object_id and c.Type='U' 
left join 
    syscomments d on a.default_object_id=d.ID  
left join 
    sys.extended_properties e on e.major_id=c.object_id and e.minor_id=a.Column_id and e.class=1   
left join 
    sys.extended_properties f on f.major_id=c.object_id and f.minor_id=0 and f.class=1 ";
            #endregion

            if (e.Node.Level == 1)
            {
                DataTable dt = ExcuteQuery(S_conStr.Replace("master", e.Node.Text), sql);
                this.dataGridView1.DataSource = dt;

                if (dt.Rows.Count > 0)
                {
                    e.Node.Nodes.Clear();
                    DataRow[] aryDr = new DataRow[dt.Rows.Count];
                    dt.Rows.CopyTo(aryDr, 0);
                    List<string> listTableName = aryDr.Select(a => a["表名"].ToString()).Distinct().ToList();
                    listTableName.ForEach(a =>
                    {
                        e.Node.Nodes.Add(a, a);
                    });
                    e.Node.ExpandAll();
                }
            }

            if (e.Node.Level == 2)
            {
                sql += "where c.Name=@TableName ";
                List<SqlParameter> listSqlParameter = new List<SqlParameter>()
                {
                    new SqlParameter("@TableName",e.Node.Text),
                };
                DataTable dt = ExcuteQuery(S_conStr.Replace("master", e.Node.Parent.Text), sql, listSqlParameter);
                if (dt.Columns.Count > 0)
                {
                    if (dt.Rows.Count > 0)
                    {
                        e.Node.Tag = dt.Rows[0]["表說明"].ToString();
                    }
                    dt.Columns.Remove("表名");
                    dt.Columns.Remove("表說明");
                }
                this.dataGridView1.DataSource = dt;
            }
        }

        private void tabControl1_SelectedIndexChanged(object sender, EventArgs e)
        {
            if (this.tabControl1.SelectedTab.Text == "Model")
            {
                if (this.treeView1.SelectedNode.Level == 2 && this.dataGridView1.Rows.Count > 0)
                {
                    string modelTmp = @"
using System;

namespace #ModelNamespace#
{
    /// <summary>
    /// #ModelClassDescription#
    /// Create By Tool #CreateDateTime#
    /// </summary>
    public class #ModelClassName#
    {
#PropertyInfo#
    }
}";

                    string modelNamespace = "Model";
                    string modelClassName = this.treeView1.SelectedNode.Text;

                    string propertyInfo = string.Empty;
                    foreach (DataGridViewRow dgvr in this.dataGridView1.Rows)
                    {
                        string modelPropertyTmp = @"
        /// <summary>
        /// #PropertyDescription#
        /// </summary>
        public  #PropertyType# #PropertyName# { get; set; }";

                        string propertyDescription = dgvr.Cells["列說明"].Value.ToString().Trim();
                        string propertyName = dgvr.Cells["列名"].Value.ToString().Trim();
                        string propertyType = dgvr.Cells["類型"].Value.ToString().Trim();

                        propertyInfo += modelPropertyTmp.Replace(" #PropertyDescription#", propertyDescription)
                                                        .Replace(" #PropertyType#", propertyType)
                                                        .Replace("#PropertyName#", propertyName);
                        propertyInfo += Environment.NewLine;
                    }

                    modelTmp = modelTmp.Replace("#ModelClassDescription#", this.treeView1.SelectedNode.Tag.ToString())
                                       .Replace("#CreateDateTime#", DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss"))
                                       .Replace("#ModelNamespace#", modelNamespace)
                                       .Replace("#ModelClassName#", modelClassName)
                                       .Replace("#PropertyInfo#", propertyInfo);

                    this.richTextBox1.Text = modelTmp;
                    Clipboard.SetDataObject(this.richTextBox1.Text);
                }
            }
        }
    }
}

主要代碼

 

四、結語思考（5分鍾）

怎么樣，相信各位讀者對代碼生成有了基本認識了吧！我想普通的代碼生成無非就是替換，當然你要是想做一個好一點的代碼生成工具，自然是要考慮可擴展性，可維護性，健壯性等。比如可以在左側的樹形菜單那里加上下文菜單，新建連接，斷開連接，刷新等擴展功能。在代碼打印的區域可以增加另存為，復制等功能。還可以增加相關配置界面，例如命名空間，數據庫連接，代碼文件默認保存路徑等等。自己做的代碼生成器可以由自己一直不斷的維護，針對特性化需求可以馬上實現。好了，本文主要是簡潔明了的讓各位讀者對代碼生成原理有一個基本認識，畢竟就30分鍾呀！