调用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 Files\Navi.Kernel\CodeSmith Template\TableEnum.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 Files\Navi.Kernel\CodeSmith Template\TableSchema.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);
            }

        }

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏Java开发者杂谈

RocketMQ专题2:三种常用生产消费方式(顺序、广播、定时)以及顺序消费源码探究

​ 在进行常用的三种消息类型例子展示的时候,我们先来说一说RocketMQ的几个重要概念:

50710
来自专栏大内老A

通过添加HTTP Header实现上下文数据在WCF的自动传递

多年之前,我写了一篇通过WCF扩展实现上下文信息从客户端自动传递到服务端的文章,其实现机制很简单:将上下文信息存放到SOAP Header进行传递。那么对于非S...

507100
来自专栏菩提树下的杨过

Ado.Net连接池的速度测试

晚上闲来无事,突然想测试一下Ado.Net连接池带来的连接速度提升,写了以下代码: using System; using System.Configura...

22360
来自专栏技术博客

设计模式之四(抽象工厂模式第一回合)

首先关于抽象工厂模式的学习,我们需要慢慢的,由浅入深的进入。不能单刀直入,否则可能达不到预期学明白的目标。

11910
来自专栏更流畅、简洁的软件开发方式

【实体类变形】—— 元数据(另类ORM) 描述字段的数据

     放假了,不知道有没有加班的,先祝大家国庆节快乐!      上次说得有点乱,“行列转换”这个词可能误导了大家,那么把这个词扔掉吧。我们重新开始。假设我...

230100
来自专栏大内老A

Enterprise Library深入解析与灵活应用(1):通过Unity Extension实现和Policy Injection Application Block的集成

Enterprise Library是微软P&P部门开发的众多Open source框架中的一个,最新的版本已经出到了4.0。由于接触Enterprise Li...

19160
来自专栏惨绿少年

Redis 数据库

1.1 Redis简介 ? 1.1.1 介绍 Redis是一个使用ANSI C编写的开源、支持网络、基于内存、可选持久性的键值对(key-value)存储数据库...

867130
来自专栏Core Net

Xcode 单元测试

33770
来自专栏GreenLeaves

C# 多线程学习系列三之CLR线程池系列之ThreadPool

1、进程和CLR的关系 一个进程可以只包含一个CLR,也可以包含多个CLR 2、CLR和AppDomain的关系 一个CLR可以包含多个AppDomain 3、...

15920
来自专栏WebApiClient

WebApiClient高级

这是一个用于调试追踪的过滤器,可以将请求与响应内容写入统一日志,统一日志工厂需要在HttpApiConfig的LoggerFactory配置。

44600

扫码关注云+社区

领取腾讯云代金券