调用CodeSmith类库实现代码生成(含源码)
CodeSmith的作用是不言而喻的,用过的人都会觉得它非常强大.根据自定义模板,快速生成代码.只是我们使用的时候,要在它提供的CodeSmith Studio环境下使用模板,再传入相应参数,最终生成NET的类文件.
如果我们可以通过编码方式,把CodeSmith功能融入NET代码中,这样就会比较灵活,方便我们控制了.根据下面的操作步骤我们就可以实现.
先说下环境,我安装的CodeSmith版本是5.1,当然是破解版(你懂的).居说CodeSmith注册费用还是比较昂贵滴.我们需要如下几个DLL文件,这几个文件在安装路径下都可以找到.
CodeSmith.Engine.dll
CodeSmith.Feedback.Client
SchemaExploer.dll
SchemaExploer.SqlSchemaProvider.dll
把这几个DLL文件引入项目文件之后,接下来就需要制作模板了,我们也可以直接使用CodeSmith自带的模板.打开CodeSmith Studio,右侧就是Template Exploer部分,选择一个模板,右键,选择Open Folder In Window Exploer菜单项,确定好模板路径后,就可以开始编码了.
在写代码之前,我们还是先看下模板的组成,如图-1所示
图-1
代码第2句,Property关键字,就表示这个模板的属性,也是需要我们传入的参数,看类型是SchemaExploer.DataBaseSchema,也就是说,我们只要传入这个类型的参数值即可
代码如图-2所示
图-2
代码非常简单,先要加载模板再编译,然后传入属性值,再输出就OK了.模板编译部分是CompileTemplate方法,如图-3所示
图-3
传入属性值的代码是CodeTemplate.SetProperty;
输出类文件的代码是RenderToFile;
OK,整个过程结束,看看我们的成果吧,如图-4所示
图-4
这个模板的作用是生成Db数据库中所有Db表的枚举类.
编码方式使用CodeSmith还是非常灵活的,比如我想生成数据库中Db表的CreateSQL语句,以前我们可能是自己拼写字符串实现,现在使用CodeSmith模板,就非常简单了.如图-5所示,大家参考这个代码自己试下,是不是非常简单呢?
图-5
完整代码如下
//引入的命名空间
//using SchemaExplorer;
//using System.CodeDom;
//using System.CodeDom.Compiler;
/// <summary>
/// 编译CodeSmith模板
/// </summary>
/// <param name="templateName"></param>
/// <returns></returns>
public CodeSmith.Engine.CodeTemplate CompileTemplate(string templateName,ref string errors)
{
CodeSmith.Engine.CodeTemplate codeTemplate = null;
//编译器
CodeSmith.Engine.CodeTemplateCompiler compiler = new CodeSmith.Engine.CodeTemplateCompiler(templateName);
compiler.Compile();
//判断是否编译成功
if (compiler.Errors.Count == 0)
{
codeTemplate = compiler.CreateInstance();
}
else
{
StringBuilder sbErrors = new StringBuilder();
for (int i = 0; i < compiler.Errors.Count; i++)
{
sbErrors.Append(compiler.Errors[i].ToString());
}
errors = sbErrors.ToString();
}
return codeTemplate;
}
private void btnCodeSmith_Click(object sender, EventArgs e)
{
string errors = string.Empty;
string templateName = string.Empty;
CodeSmith.Engine.CodeTemplate codeTemplate = null;
IDbSchemaProvider provider = new SqlSchemaProvider();
DatabaseSchema dbSchema = new DatabaseSchema(provider, DevelopToolManager.DbConnectionString);
//TableEnum模板
templateName = @"C:Program FilesNavi.KernelCodeSmith TemplateTableEnum.cst";
codeTemplate = this.CompileTemplate(templateName, ref errors);
if (string.IsNullOrEmpty(errors))
{
codeTemplate.SetProperty("SourceDatabase", dbSchema);
string csFileName = @"I:待整理文件tableEnum.cs";
codeTemplate.RenderToFile(csFileName, true);
}
//TableSchema模板
templateName = @"C:Program FilesNavi.KernelCodeSmith TemplateTableSchema.cst";
codeTemplate = this.CompileTemplate(templateName, ref errors);
if (string.IsNullOrEmpty(errors))
{
TableSchema tableSchema = dbSchema.Tables["AD_AUTHOR"];
codeTemplate.SetProperty("SourceTable", tableSchema);
codeTemplate.SetProperty("ScriptCreate", "true");
//生成字符串
string codeTotal = codeTemplate.RenderToString();
MessageBox.Show(codeTotal);
//生成文件
string csFileName = @"I:待整理文件TableSchema_AD_AUTHOR.cs";
codeTemplate.RenderToFile(csFileName, true);
}
}
- Android Material Design之Toolbar与Palette实践
- android-async-http框架源码分析
- 使用Buck构建Android工程
- android 实现淘宝收益图的折线
- React Native入门(三)组件的Props(属性)和State(状态)
- Spring Cloud构建微服务架构:服务容错保护(Hystrix服务降级)【Dalston版】
- PNG图片压缩对比分析
- 关于M4A文件的随机访问
- (whh仅供自己参考)进行ip网络请求的步骤
- HTML中的javascript交互
- Spring Cloud构建微服务架构:分布式配置中心【Dalston版】
- [Android] Toast问题深度剖析(二)
- [Android] Toast问题深度剖析(一)
- android离线缓存技术
- JavaScript 教程
- JavaScript 编辑工具
- JavaScript 与HTML
- JavaScript 与Java
- JavaScript 数据结构
- JavaScript 基本数据类型
- JavaScript 特殊数据类型
- JavaScript 运算符
- JavaScript typeof 运算符
- JavaScript 表达式
- JavaScript 类型转换
- JavaScript 基本语法
- JavaScript 注释
- Javascript 基本处理流程
- Javascript 选择结构
- Javascript if 语句
- Javascript if 语句的嵌套
- Javascript switch 语句
- Javascript 循环结构
- Javascript 循环结构实例
- Javascript 跳转语句
- Javascript 控制语句总结
- Javascript 函数介绍
- Javascript 函数的定义
- Javascript 函数调用
- Javascript 几种特殊的函数
- JavaScript 内置函数简介
- Javascript eval() 函数
- Javascript isFinite() 函数
- Javascript isNaN() 函数
- parseInt() 与 parseFloat()
- escape() 与 unescape()
- Javascript 字符串介绍
- Javascript length属性
- javascript 字符串函数
- Javascript 日期对象简介
- Javascript 日期对象用途
- Date 对象属性和方法
- Javascript 数组是什么
- Javascript 创建数组
- Javascript 数组赋值与取值
- Javascript 数组属性和方法
- Java 多线程编程(聊聊线程池)
- Java 多线程编程(“锁”事碎碎念)
- Spring Cloud Alibaba技术栈(下)
- Electron安装过程深入解析(读完此文解决Electron安装失败导致的无法启动,无法打包的问题)
- Kafka中副本机制的设计和原理
- Cocoapods更新出错
- 用 Wolfram 语言映射美国的山火
- Mathematica在中学数学教与学中的应用
- 总结一些ES不常用的filter
- 如何将炫酷的报表直接截图发送邮件——在Superset 0.37使用Schedule Email功能
- Kettle构建Hadoop ETL实践(五):数据抽取
- Kafka监控必备——Kafka-Eagle 2.0.2正式发布
- iOS Universal link 入门指南
- Flutter基础widgets教程-CupertinoAlertDialog篇
- Flutter基础widgets教程-cupertinoActivityIndicator篇