模版引擎XTemplate与代码生成器XCoder(源码)

模版引擎XTemplate是一个仿T4设计的引擎,功能上基本与T4一致(模版语法上完全兼容T4,模版头指令部分兼容)。

    自己设计模版引擎,就是为了代码生成器、网站模版、邮件模版等多种场合,也就是要能拿出来单独使用、功能强大并且容易控制的。T4是个很好的引擎,但是它的设计基本上倾向于vs,几乎不顾别的场合。

    XTemplate特点如下:

    1,完全使用C#作为模版语言。跟ASP、ASP.Net页面的解析一样,把<##>标签外的文本内容当作字符串,用一个StringBuilder,标签内作为C#原生代码,拼在一起编译,进行模版替换时,实质上就是执行编译后的程序集,这就是XTemplate的核心原理!网络上现有的许许多多模版引擎,要么采用标签替换,要么自创模版语言,这些都增加了使用者的学习难度。XTemplate使用C#作为模版语言,这个世界安静了!

    2,支持“调试”。不是运行时调试,而是XTemplate能够把模版编译的中间类文件以及程序集等输出,方便检查错误。如果把模版编译后的程序集保存下来,可以在没有模版文件的情况下直接使用模版功能。

    3,不需要ASP.Net支持。有部分模版引擎,是模拟一个ASP.Net服务器,然后以ASP.Net作为模版来实现,这就要求有一个ASP.Net服务器作为宿主,限制了模版引擎的使用范围。

    4,支持批量编译。可以把多个模版放入模版处理器,进行一次编译(所有模版类都编译到一个程序集里面去)。

    5,支持类成员。模版内容默认情况下将会统一编译到一个类的Render方法里面去,但是有时候我们需要给这个类增加一些属性和方法,此时可以使用<#! #>标签,序数为单数表示开始,序数为偶数表示结束,所以不限制类成员代码的位置(T4要求只能写在模版的最后面)。

    6,支持自定义基类。默认情况下,所有编译生成的模版类都继承自TemplateBase,你也可以创建自己的模版基类,然后在模版头通过指令,或者通过外部宿主指定自定义的模版基类,模版中可以直接使用自定义模版基类的成员(因为继承嘛),比如代码生成器XCoder中的XCoderBase。

    7,自动引用宿主程序集。T4在使用上最大的麻烦就是引用外部程序集和命名空间,毕竟不是在vs里面编写C#代码。XTemplate在编译的时候,自动引用宿主(就是调用者,比如XCoder)的所有应用程序集,同时引用大部分常用的明明空间,因为这样,生成的类很臃肿,但是编译的时候,编译器会自动去掉无用的引用。XTemplate从完成到现在为止,还没有用过引用程序集和命名空间的问题,因为一般来说,模版中需要用到的程序集,宿主里面一般都有用到,非常符合我们的使用习惯。

    8,与宿主的良好交互。在XTemplate中,编译的模版程序集是直接加载在默认域,这点与T4不同,T4会新建一个域,应该是为了防止模版代码弄脏默认域的数据吧(比如干扰vs运行)。因为在同一个域,XTemplate与宿主进行交互,就不需要“FQ”(跨域)了。XTemplate的处理过程分为分析、编译和执行三步,都可以由外部控制,比如有时候我们只是需要检查一下模版的语法,只需要检查一下模版语法是否正确,这个时候编译一下就可以了。

    9,更多的特点需要大家来发现!

    XCoder使用XTemplate代码(后面有XCoder的项目代码):

Dictionary<String, Object> data = new Dictionary<string, object>();
data["Config"] = Config;
data["Tables"] = Tables;
data["Table"] = table;

// 声明模版引擎
Template tt = new Template();
Template.Debug = Config.Debug;
foreach (String item in ss)
{
    if (item.EndsWith("scc", StringComparison.Ordinal)) continue;

    String tempFile = item;
    if (!Path.IsPathRooted(tempFile) && !tempFile.StartsWith(TemplatePath, StringComparison.OrdinalIgnoreCase))
        tempFile = Path.Combine(TemplatePath, tempFile);

    String content = File.ReadAllText(tempFile);

    // 添加文件头
    if (Config.UseHeadTemplate && !String.IsNullOrEmpty(Config.HeadTemplate))
        content = Config.HeadTemplate + content;

    tt.AddTemplateItem(item, content);
}
tt.Process();

// 编译模版
tt.Compile();

List<String> rs = new List<string>();
foreach (String item in ss)
{
    if (item.EndsWith("scc", StringComparison.Ordinal)) continue;

    //String content = RenderFile(table, item, data);
    String content = tt.Render(item, data);

    // 计算输出文件名
    String fileName = Path.GetFileName(item);
    String className = CutPrefix(table.Name);
    className = FixWord(className);
    String remark = table.Description;
    if (String.IsNullOrEmpty(remark)) remark = ENameToCName(className);
    if (Config.UseCNFileName && !String.IsNullOrEmpty(remark)) className = remark;
    fileName = fileName.Replace("类名", className).Replace("类说明", remark).Replace("连接名", Config.EntityConnName);

    fileName = Path.Combine(OuputPath, fileName);
    File.WriteAllText(fileName, content, Encoding.UTF8);

    rs.Add(content);
}

    XTemplate设计图(我喜欢先做图再编码):

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

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏代码GG之家

android MVVM开发模式(四)

android MVVM开发模式(四) 上节我们讲了自定义的@BindingAdapter,来扩展属性功能的时候,第一步添加了一个自定义属性 这个其实是多余的。...

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

分页解决方案 之 数据访问函数库——另类的思路、另类的写法,造就了不一样的发展道路。

    如何访问数据库?一个老掉牙的问题,方法多了去了,什么直接使用ado.net、使用SQLHelp、使用微软的企业库、使用ORM、使用LinQ to SQL...

2418
来自专栏小灰灰

Java可以如何实现文件变动的监听

应用中使用logback作为日志输出组件的话,大部分会去配置 logback.xml 这个文件,而且生产环境下,直接去修改logback.xml文件中的日志级别...

2408
来自专栏GopherCoder

『简书API:Golang 处理 json 用法讲解(4):视频版』

1966
来自专栏枕边书

PHP模拟发送POST请求之二、用PHP和JS处理URL信息

明白了HTTP请求的头信息后,我们还需要对请求地址有所了解。再者,HTTP GET请求是靠URL实现的,所以了解URL的构造,处理URL的重要性不言而喻。 在P...

2095
来自专栏大内老A

ASP.NET Core中如影随形的”依赖注入”[上]: 从两个不同的ServiceProvider说起

我们一致在说 ASP.NET Core广泛地使用到了依赖注入,通过前面两个系列的介绍,相信读者朋友已经体会到了这一点。由于前面两章已经涵盖了依赖注入在管道构建过...

3957
来自专栏北京马哥教育

linux bash环境变量简单总结

一.环境变量简介 Linux是一个多用户的操作系统。每个用户登录系统后,都会有一个专用的运行环境。通常每个用户默认的环境都 是相同的,这个默认环境实际...

3326
来自专栏Jackson0714

干货分享:详解线程的开始和创建

2816
来自专栏大内老A

ASP.NET MVC的客户端验证:jQuery验证在Model验证中的实现

在简单了解了Unobtrusive JavaScript形式的验证在jQuery中的编程方式之后,我们来介绍ASP.NET MVC是如何利用它实现客户端验证的。...

2026
来自专栏从零开始学自动化测试

Selenium2+python自动化60-异常后截图(screenshot)

前言 在执行用例过程中由于是无人值守的,用例运行报错的时候,我们希望能对当前屏幕截图,留下证据。 在写用例的时候,最后一步是断言,可以把截图的动作放在断言这里,...

3755

扫码关注云+社区