codesmith mysql 注释_完美解决CodeSmith无法获取MySQL表及列Description说明注释的方案...

article/2025/9/15 19:26:19

问题描述：

CodeSmith是现在比较实用的代码生成器，但是我们发现一个问题：

使用CodeSmith编写MySQL模板的时候，会发现一个问题：MySQL数据表中的列说明获取不到，也就是column.Description。如图：

6da66decf2d5e5c064a306ef59200d25.png

我们打开CodeSmith编写一个简单的Model实体类的示例模板如下：

8f900a89c6347c561fdf2122f13be562.png

961ddebeb323a10fe0623af514929fc1.png

Author: 孤影[QQ:778078163]

Description: CodeSmith连接MySQL生成Model实体模板--%>

usingSystem;usingSystem.Collections.Generic;usingSystem.Linq;usingSystem.Text;namespace {///

///

///

public class {

//循环遍历 获取当前数据表中的所有列

foreach(ColumnSchema column inSourceTable.Columns){

Response.WriteLine(string.Format("// {0}",column.Description));

Response.WriteLine(string.Format("public {0} {1} ;",GetCSharpVariableType(column),column.Name));

}%>}

}

//获取指定列对应的C#数据类型

public stringGetCSharpVariableType(ColumnSchema column)

{if (column.Name.EndsWith("TypeCode")) returncolumn.Name;switch(column.DataType)

{case DbType.AnsiString: return "string";case DbType.AnsiStringFixedLength: return "string";case DbType.Binary: return "byte[]";case DbType.Boolean: return "bool";case DbType.Byte: return "byte";case DbType.Currency: return "decimal";case DbType.Date: return "DateTime";case DbType.DateTime: return "DateTime";case DbType.Decimal: return "decimal";case DbType.Double: return "double";case DbType.Guid: return "Guid";case DbType.Int16: return "short";case DbType.Int32: return "int";case DbType.Int64: return "long";case DbType.Object: return "object";case DbType.SByte: return "sbyte";case DbType.Single: return "float";case DbType.String: return "string";case DbType.StringFixedLength: return "string";case DbType.Time: return "TimeSpan";case DbType.UInt16: return "ushort";case DbType.UInt32: return "uint";case DbType.UInt64: return "ulong";case DbType.VarNumeric: return "decimal";default:

{return "__UNKNOWN__" +column.NativeType;

}

}

}一个简单的CodeSmith生成Model实体的模板

View Code

然后我们点击生成，生成的代码如下图：

21be081baeb6ec6caab79cb46ba32dd6.png

当然，使用SQL Server及其他数据库都是可以获取到的，这是为什么呢？

逼的没招没招了的时候，果断打开.NET Reflector，看看CodeSmith对SQL Server和MySQL二者，数据表生成操作的时候，有什么不同的地方，或者有什么缺少的地方。

CodeSmith中对MySQL操作的DLL组件位置是：“X:\...\CodeSmith\v7.0\SchemaProviders\SchemaExplorer.MySQLSchemaProvider.dll”

展开后，开始一个个找里面的方法，突然发现一个亮点：“GetTableColumns(string connectionString, TableSchema table);”

这个字面的意思不就是获取列数据么？打开看看。。。可惜，里面只是根据表查询所有列，并没有Description相关操作。

继续找，继续对比。。。最终终于找到问题了：

方法“GetExtendedProperties(string connectionString, SchemaObjectBase schemaObject);”里面的查询语句是：

string str = string.Format("SELECT EXTRA, COLUMN_DEFAULT, COLUMN_TYPE FROM INFORMATION_SCHEMA.COLUMNS WHERE TABLE_SCHEMA = '{0}' AND TABLE_NAME = '{1}' AND COLUMN_NAME = '{2}'", schema.Table.Database.Name, schema.Table.Name, schema.Name);

这个不就是获取Column列中的扩展属性的方法么？！

对比发现，SQL Server的dll里这个方法的下面，有返回Description，而MySQL正好没有！

二话不说，找到CodeSmith的源码包解压，翻出MySQL的项目：“X:\...\CodeSmith\v7.0\Samples\Samples\Projects\CSharp\MySQLSchemaProvider”

然后打开Visual Studio载入"MySQLSchemaProvider.csproj"，有很多错误，那是因为缺少了引用，添加CodeSmith\bin里面的相关引用即可。

79f7ff75124e7cd7418588843fcf0516.png

需要引用的组件你可以在下面两个CodeSmith安装目录中找到：

“X:\...\CodeSmith\v7.0\bin\”、“X:\...\CodeSmith\v7.0\AddIns\”

添加引用之后，错误就全部没了：

6ff7eeb5f155f8c5ab1aafdca63c64ec.png

然后我们果断开始修改代码、首先找到刚刚那个获取列扩展属性的方法：

“public ExtendedProperty[] GetExtendedProperties(string connectionString, SchemaObjectBase schemaObject)”

然后我们根据观察SQL Server的代码，发现MySQL里面这个方法：

820f890d90f47ea93023ae22316b2478.png

在SQL语句查询的时候少查询了一项数据：“COLUMN_COMMENT”，于是我们首先修改它查询的SQL语句如下：

string commandText = string.Format(@"SELECT EXTRA, COLUMN_DEFAULT, COLUMN_TYPE, COLUMN_COMMENT

FROM INFORMATION_SCHEMA.COLUMNS

WHERE TABLE_SCHEMA = '{0}' AND TABLE_NAME = '{1}' AND COLUMN_NAME = '{2}'",

columnSchema.Table.Database.Name, columnSchema.Table.Name, columnSchema.Name);

既然上面查询了，按照正常的数据查询流程，下面应该遍历读取，然后返回吧？

于是继续看，下面有一个while，正是将上面查询出来的数据返回的，我们对比SQL Server的代码发现：

565a2e0788b2ac291144a010a60e4df3.png

上面查询出来的每一项，下面都有获取返回，而我们刚刚添加的那个“COLUMN_COMMENT”则没有进行数据获取、没有怎么办？加呗~

获取每个数据后，最后统一将封装在“extendedProperties”中，于是我们也将获取到的Description添加进去，其与步骤省略。最终修改的代码如下：

8f900a89c6347c561fdf2122f13be562.png

961ddebeb323a10fe0623af514929fc1.png

public ExtendedProperty[] GetExtendedProperties(stringconnectionString, SchemaObjectBase schemaObject)

{

List extendedProperties = new List();if (schemaObject isColumnSchema)

{

ColumnSchema columnSchema= schemaObject asColumnSchema;string commandText = string.Format(@"SELECT EXTRA, COLUMN_DEFAULT, COLUMN_TYPE, COLUMN_COMMENT

FROM INFORMATION_SCHEMA.COLUMNS

WHERE TABLE_SCHEMA = '{0}' AND TABLE_NAME = '{1}' AND COLUMN_NAME = '{2}'",

columnSchema.Table.Database.Name, columnSchema.Table.Name, columnSchema.Name);using (DbConnection connection =CreateConnection(connectionString))

{

connection.Open();

DbCommand command=connection.CreateCommand();

command.CommandText=commandText;

command.Connection=connection;using (IDataReader reader =command.ExecuteReader(CommandBehavior.CloseConnection))

{while(reader.Read())

{string extra = reader.GetString(0).ToLower();bool columndefaultisnull = reader.IsDBNull(1);string columndefault = "";if (!columndefaultisnull)

{

columndefault= reader.GetString(1).ToUpper();

}string columntype = reader.GetString(2).ToUpper();string columncomment = reader.GetString(3);bool isIdentity = (extra.IndexOf("auto_increment") > -1);

extendedProperties.Add(newExtendedProperty(ExtendedPropertyNames.IsIdentity, isIdentity, columnSchema.DataType));if(isIdentity)

{/*MySQL auto_increment doesn't work exactly like SQL Server's IDENTITY

I believe that auto_increment is equivalent to IDENTITY(1, 1)

However, auto_increment behaves differently from IDENTITY when used

with multi-column primary keys. See the MySQL Reference Manual for details.*/extendedProperties.Add(new ExtendedProperty(ExtendedPropertyNames.IdentitySeed, 1, columnSchema.DataType));

extendedProperties.Add(new ExtendedProperty(ExtendedPropertyNames.IdentityIncrement, 1, columnSchema.DataType));

}

extendedProperties.Add(new ExtendedProperty("CS_ColumnDefaultIsNull", columndefaultisnull, DbType.Boolean)); //Added for Backwards Compatibility.

extendedProperties.Add(newExtendedProperty(ExtendedPropertyNames.DefaultValue, columndefault, DbType.String));

extendedProperties.Add(new ExtendedProperty("CS_ColumnDefault", columndefault, DbType.String)); //Added for Backwards Compatibility.

extendedProperties.Add(newExtendedProperty(ExtendedPropertyNames.SystemType, columntype, DbType.String));

extendedProperties.Add(new ExtendedProperty("CS_ColumnType", columntype, DbType.String)); //Added for Backwards Compatibility.

extendedProperties.Add(new ExtendedProperty("CS_ColumnExtra", extra.ToUpper(), DbType.String));

extendedProperties.Add(new ExtendedProperty("CS_Description", columncomment, DbType.String));

}if (!reader.IsClosed)

reader.Close();

}if (connection.State !=ConnectionState.Closed)

connection.Close();

}

}if (schemaObject isTableSchema)

{

TableSchema tableSchema= schemaObject asTableSchema;string commandText = string.Format(@"SHOW CREATE TABLE `{0}`.`{1}`", tableSchema.Database.Name, tableSchema.Name);using (DbConnection connection =CreateConnection(connectionString))

{

connection.Open();

DbCommand command=connection.CreateCommand();

command.CommandText=commandText;

command.Connection=connection;using (IDataReader reader =command.ExecuteReader(CommandBehavior.CloseConnection))

{while(reader.Read())

{string createtable = reader.GetString(1);

extendedProperties.Add(new ExtendedProperty("CS_CreateTableScript", createtable, DbType.String));

}if (!reader.IsClosed)

reader.Close();

}if (connection.State !=ConnectionState.Closed)

connection.Close();

}

}returnextendedProperties.ToArray();

}

最终修改完成的“GetExtendedProperties”方法

View Code

然后我们F6生成一个修改后的dll组件"SchemaExplorer.MySQLSchemaProvider.dll"。

找到默认的dll：“X:\...\CodeSmith\v7.0\SchemaProviders\SchemaExplorer.MySQLSchemaProvider.dll”，替.....不行，还是先备份一下。。。哈哈

然后替换。打开重启CodeSmith，再次生成。。。-_-#　我去！这是在逗我么。

985d981f6e2d2a33dc0f2230b21d95a9.png

再次回到Visual Studio中仔细看看整个方法，最后发现。。服了。它的这个方法的判断逻辑是：

1 public ExtendedProperty[] GetExtendedProperties(string connectionString, SchemaObjectBase schemaObject)

2

3 {

4

5 　　List......

6

7 　　if(schemaObject 是一个 ColumnSchema)// 如果是一个列对象

8

9 　　{

10

11 　　　　// 这里面也就是我们刚刚改的，获取列说明部分的代码

12

13 　　}

14

15 　　if(schemaObject 是一个 TableSchema)// 完全没有注意下面的这个判断，如果是一个表对象！！！

16

17 　　{

18

19 　　　　// 这里也就是我们下面要动手脚的地方了。

20

21 　　}

22

23 }

废话不多说。直接上这个方法最终的代码：

8f900a89c6347c561fdf2122f13be562.png

961ddebeb323a10fe0623af514929fc1.png

public ExtendedProperty[] GetExtendedProperties(stringconnectionString, SchemaObjectBase schemaObject)

{

List extendedProperties = new List();if (schemaObject isColumnSchema)

{

ColumnSchema columnSchema= schemaObject asColumnSchema;string commandText = string.Format(@"SELECT EXTRA, COLUMN_DEFAULT, COLUMN_TYPE, COLUMN_COMMENT

FROM INFORMATION_SCHEMA.COLUMNS

WHERE TABLE_SCHEMA = '{0}' AND TABLE_NAME = '{1}' AND COLUMN_NAME = '{2}'",

columnSchema.Table.Database.Name, columnSchema.Table.Name, columnSchema.Name);using (DbConnection connection =CreateConnection(connectionString))

{

connection.Open();

DbCommand command=connection.CreateCommand();

command.CommandText=commandText;

command.Connection=connection;using (IDataReader reader =command.ExecuteReader(CommandBehavior.CloseConnection))

{while(reader.Read())

{string extra = reader.GetString(0).ToLower();bool columndefaultisnull = reader.IsDBNull(1);string columndefault = "";if (!columndefaultisnull)

{

columndefault= reader.GetString(1).ToUpper();

}string columntype = reader.GetString(2).ToUpper();string columncomment = reader.GetString(3);bool isIdentity = (extra.IndexOf("auto_increment") > -1);

extendedProperties.Add(newExtendedProperty(ExtendedPropertyNames.IsIdentity, isIdentity, columnSchema.DataType));if(isIdentity)

{/*MySQL auto_increment doesn't work exactly like SQL Server's IDENTITY

I believe that auto_increment is equivalent to IDENTITY(1, 1)

However, auto_increment behaves differently from IDENTITY when used

with multi-column primary keys. See the MySQL Reference Manual for details.*/extendedProperties.Add(new ExtendedProperty(ExtendedPropertyNames.IdentitySeed, 1, columnSchema.DataType));

extendedProperties.Add(new ExtendedProperty(ExtendedPropertyNames.IdentityIncrement, 1, columnSchema.DataType));

}

extendedProperties.Add(new ExtendedProperty("CS_ColumnDefaultIsNull", columndefaultisnull, DbType.Boolean)); //Added for Backwards Compatibility.

extendedProperties.Add(newExtendedProperty(ExtendedPropertyNames.DefaultValue, columndefault, DbType.String));

extendedProperties.Add(new ExtendedProperty("CS_ColumnDefault", columndefault, DbType.String)); //Added for Backwards Compatibility.

extendedProperties.Add(newExtendedProperty(ExtendedPropertyNames.SystemType, columntype, DbType.String));

extendedProperties.Add(new ExtendedProperty("CS_ColumnType", columntype, DbType.String)); //Added for Backwards Compatibility.

extendedProperties.Add(new ExtendedProperty("CS_ColumnExtra", extra.ToUpper(), DbType.String));

extendedProperties.Add(new ExtendedProperty("CS_Description", columncomment, DbType.String));

}if (!reader.IsClosed)

reader.Close();

}if (connection.State !=ConnectionState.Closed)

connection.Close();

}

}if (schemaObject isTableSchema)

{

TableSchema tableSchema= schemaObject asTableSchema;string commandText = string.Format(@"SHOW CREATE TABLE `{0}`.`{1}`", tableSchema.Database.Name, tableSchema.Name);using (DbConnection connection =CreateConnection(connectionString))

{

connection.Open();

DbCommand command=connection.CreateCommand();

command.CommandText=commandText;

command.Connection=connection;using (IDataReader reader =command.ExecuteReader(CommandBehavior.CloseConnection))

{while(reader.Read())

{string createtable = reader.GetString(1);

extendedProperties.Add(new ExtendedProperty("TS_Description", createtable, DbType.String));int engineIndex = createtable.LastIndexOf("ENGINE");int commentIndex = createtable.LastIndexOf("COMMENT=");string tableDescription = reader.GetString(0);if (commentIndex >engineIndex)

{

tableDescription= createtable.Substring(commentIndex + 9).Replace("'", "");

}

extendedProperties.Add(new ExtendedProperty("CS_Description", tableDescription, DbType.String));

}if (!reader.IsClosed)

reader.Close();

}if (connection.State !=ConnectionState.Closed)

connection.Close();

}

}returnextendedProperties.ToArray();

}

最终的“GetExtendedProperties”方法

View Code

重新生成，替换。。。重启CodeSmith，链接MySQL生成。。。。必然果断Ok：

7ab4099c34701ed7cbdd40d79a2b4c91.png

网上当然也有很多例子，不过都是只处理了列的说明，没有处理表的说明。

我这个处理表说明是通过截取已获得的CreateTableScript里面的数据，获取的表说明。


http://chatgpt.dhexx.cn/article/gxfsYP7c.shtml

相关文章

codesmith mysql 模板_CodeSmith for MySQL template

codesmith mysql 模板_CodeSmith for MySQL template

对于.NET平台上的代码生成器来说，codesmith是一个非常好的选择。 以前在学院实验室用的都是SQL server数据库，老师给的一套codesmith模板用来生成model/DAL/BLL很是方便。 不过后来放弃SQL server 投入MySQL之后，刚开始都是手写SQL&#xff0…
阅读更多...
如何使用CodeSmith批量生成代码(原创系列教程)

如何使用CodeSmith批量生成代码(原创系列教程)

用它完成批量代码生成的工作啦. 下面我会一步步的解释如何用CodeSmith实现预期的结果的,事先声明一下,在此只做一个简单的Demo,并不详细的讲解CodeSmith各个强大的功能,有兴趣的朋友可以打开CodeSmith的帮助文档了解.我只做个抛砖引玉,希望能激起大家更多思想的火花~ 先看看C…
阅读更多...
codesmith生成SQLSERVER实体（带注释）

codesmith生成SQLSERVER实体（带注释）

记录用codesmith生成SQLSERVER数据库实体的一个模板&#xff0c;具体链接数据库和使用方式&#xff0c;大家可以百度&#xff0c;有非常多的资料&#xff0c;只记录一个模板&#xff1a; <% CodeTemplate Language"C#" TargetLanguage"C#" Debug"…
阅读更多...
mysql codesmith_CodeSmith MySql

mysql codesmith_CodeSmith MySql

CodeSmith MySql (2012-08-22 10:41:49) 标签&#xff1a; 杂谈 安装&#xff1a; mysql-connector-net-6.3.7.msi 否则在CodeSmith中链接数据库时提示需要框架程序。 connect string&#xff1a; 正确&#xff1a;DatabaseXXX;Data SourceXXX;User IdXXX;PasswordXXX;portXXX …
阅读更多...
CodeSmith模板代码生成实战详解

CodeSmith模板代码生成实战详解

为了提高开发效率&#xff0c;节约开发时间&#xff0c;我们采用了codesmith根据自定义模板&#xff0c;生成代码功能。让单表的增删改查功能从数据访问层到ui展示层一键批量生成。下面就开始codeSmith模板编写。 官网地址&#xff1a;http://www.codesmithtools.com 下载地址&…
阅读更多...
CodeSmith 简单使用和常用模板

CodeSmith 简单使用和常用模板

1、简介 CodeSmith 是一种基于模板的代码生成工具&#xff0c;它使用类似于 ASP.NET的语法来生成任意类型的代码或文本。 2、软件布局 整体布局和visual studio系列相似&#xff0c;用过VS开发对此软件布局会很熟悉&#xff0c;加上模板语句类似ASP.NET对.NET开发人员相对友…
阅读更多...
CodeSmith介绍

CodeSmith介绍

什么是CodeSmith&#xff1f;从字面上直译可以看作“代码工匠”。这倒是个很拟人化的名称&#xff0c;顾名思义&#xff0c;CodeSmith的目标就是根据模板生成规范可用的代码&#xff0c;为程序员减轻工作负担。程序员是软件开发团队中的最小单位&#xff0c;有什么任务都只能自…
阅读更多...
waf绕过详解

waf绕过详解

目录 waf防护原理讲解 目录扫描绕过waf 手工注入绕过waf sqlmap注入绕过waf 编写sqlmap绕过waf脚本 过waf一句话编写讲解 菜刀连接绕过waf webshell上传绕过waf 提权绕过waf waf绕过原理详解 了解waf防护原理 查看waf防护位置 熟悉防护规则 了解防护机制 查看拦截…
阅读更多...
WAF与网络防火墙的区别在哪？

WAF与网络防火墙的区别在哪？

WAF是英文Web Application Firewall的简称&#xff0c;也称为网站应用级入侵防御系统或Web应用防火墙&#xff0c;是通过执行一系列针对HTTP/HTTPS的安全策略来专门为Web应用提供保护的一款产品。 网络防火墙是一种用来加强网络之间访问控制的特殊网络互联设备。计算机流入流出…
阅读更多...
WAF(Web应用层防火墙)了解学习

WAF(Web应用层防火墙)了解学习

WAF---Web应用层防火墙了解学习 WAF是什么WAF预防的攻击类型WAF部署方式WAF安全模式开放Web应用安全项目&#xff08;OWASP&#xff09;WAF和DDosWAF测试WAF和传统防火墙的区别总结 参考文档: 安全文章相关Web应用防火墙WAF简介 WAF是什么 WAF全称叫Web Application Firewall…
阅读更多...
什么是 Web 应用防火墙(WAF)？

什么是 Web 应用防火墙(WAF)？

当下时候&#xff0c;网络攻击和针对网站的攻击与日俱增。同时&#xff0c;在我们的日常生活中&#xff0c;安全的重要性也迅速提升。因此&#xff0c;保证在线上世界的安全变得越来越重要。更重要的是&#xff0c;保护你的网站和所存储的数据的安全。所以&#xff0c;我们将介…
阅读更多...
【网络安全】如何在Apache 安装开源 WAF

【网络安全】如何在Apache 安装开源 WAF

说明&#xff1a; 本文以Windows环境下的Apache安装mod_security为例&#xff0c; 介绍开源WAF产品的安装使用。 http://www.modsecurity.cn/ https://github.com/SpiderLabs/ModSecurity一、WAF基本介绍 WAF全称Web Application Firewall&#xff0c;即Web应用防火墙。Web应用…
阅读更多...
WAF详解及WAF绕过

WAF详解及WAF绕过

waf&#xff08;web application firewall&#xff09;: 原理&#xff1a; web应用防火墙&#xff0c;一款集网站内容安全防护、网站资源安全防护及流量保护功能为一体的服务器工具。为用户提供实时网站安全防护&#xff0c;避免各类针对网站的攻击带来的危害。&#xff08;核心…
阅读更多...
waf入门

waf入门

文章目录 waf入门什么是wafwaf一般都有哪些功能WAF部署模式WAF工作模式 规则引擎原理WAF动作WAF规则与报表WAF特征 waf入门 什么是waf Web应用防护系统&#xff08;也称为&#xff1a;网站应用级入侵防御系统。英文&#xff1a;Web Application Firewall&#xff0c;简称&…
阅读更多...
WAF识别软件（WAFW00F）以及WAF绕过

WAF识别软件（WAFW00F）以及WAF绕过

责任声明&#xff1a; 本文章仅供学习交流使用&#xff0c;如有利用进行非法行为 上传者不承担任何责任&#xff0c;使用者后果自负 WAF防护分析 什么是WAF&#xff1f; Web应用防护系统分为两种&#xff1a;软件与硬件 安全公司内部的为硬件&#xff0c;个人或小企业为软件&…
阅读更多...
IPS和WAF区别

IPS和WAF区别

写在前面&#xff1a; “前些天发现了一个巨牛的人工智能学习网站&#xff0c;通俗易懂&#xff0c;风趣幽默&#xff0c;忍不住分享一下给大家。点击跳转到网站。” 前言 - 床长人工智能教程 WAF与IPS的区别总结 谁是最佳选择&#xff1f; Web应用防护无疑是一个热门话题。…
阅读更多...
waf详解

waf详解

文章目录 一、waf分类二、waf的工作原理 前言&#xff1a; 在实际的渗透测试过程中&#xff0c;经常会碰到网站存在WAF的情况。网站存在WAF&#xff0c;意味着我们不能使用安全工具对网站进行测试&#xff0c;因为一旦触碰了WAF的规则&#xff0c;轻则丢弃报文&#xff0c;重则…
阅读更多...
waf测试

waf测试

waf简介 WAF防火墙其实就是Web Application Firewall&#xff0c;是一个web应用防护系统。企业等用户一般采用防火墙作为安全保障体系的第一道防线。WAF工作在应用层&#xff0c;因此对Web应用防护具有先天的技术优势。基于对Web应用业务和逻辑的深刻理解&#xff0c;WAF对来自…
阅读更多...
云WAF概述

云WAF概述

云WAF&#xff08;Web应用防火墙&#xff09;是WAF的另一种表现形态&#xff0c;它将WAF的功能在云端进行实现。只需要把域名的解析权交给云WAF&#xff0c;它就可以利用DNS调度技术&#xff0c;改变网络流量的原始流向&#xff0c;将网络流量牵引到云端的WAF上&#xff0c;云端…
阅读更多...
WAF的原理

WAF的原理

一.WAF的原理 WAF是Web应用防火墙&#xff08;Web Application Firewall&#xff09;的简称&#xff0c;对来自Web应用程序客户端的各类请求进行内容检测和验证&#xff0c;确保其安全性与合法性&#xff0c;对非法的请求予以实时阻断&#xff0c;为Web应用提供防护&#xff0c…
阅读更多...
推荐文章

Copyright @ 2022~2023