DCG的详细知识介绍

题外话，我最近怎么总是在周二写Blog啊？看看Blog上的日历，全都是周二写的！^_^

言规正传，最近为了一个项目需要动态生成代码特地写了另一个小“项目”，动态代码生成器。其实就是动态的模板，一个有差不多ASP.NET语法的模板，应该说与CodeSmith的功能是一样的，只不过现在还没有编辑器。目前提供了一个DLL，可以提供所有需要构建一个模板编辑器所需要的信息，包括动态模板的编译时错误以及运行时错误等。

我在这个小项目中运用了很多学到的新知识，自我感觉在这个小项目中运用的设计是目前为止运用的最好的一次。^_^

下面描述一下模板的语法与使用方法：

• <%@ Template Language="C#" Name="" Version="" %>：模板开头，必须要有这个模板才是有效的模板，它的Language属性是必须的，指定模板中所使用的动态语言类型，目前支持C#与VB.NET。

• <%@ Parameter Name="ParamName" DataType="System.String" AssemblyName="" %>：模板参数，其中的所有属性都是必须的，当参数类型的的所在程序集为mscorlib.dll时需要将AssemblyName属性设为空。一个模板可以有多个参数。

• <% code %>：模板中的动态代码，在其中可以用模板Language属性所指定的语言写入动态代码。

• <%= variable %>：模板中的动态代码，会将动态代码的结果返回，注意如果动态代码不返回任何结果的话，那么就会产生编译错误。

• <%# void Method() %>：动态方法，在模板中可以简单的定义动态方法，这样就可以直接在其他动态代码部分调用这个动态方法。

• <%-- comment --%>：动态模板中的注释。

模板本身不是Case Sensitive，不过每个Tag属性中的值就要根据模板运用的语言来定是否是Case Sensitive了。比如如果是C#，那么就是Case Sensitive，如果是VB.NET那就不是了。

下面是C#的示例：

模板为：

<%@ Template Name="Sample1" Version="1.0" language="C#" %>
<%@ Parameter Name="Entity" DataType="Kefroth.Entity" AssemblyName="DCGTest.exe" %>

using System;

// 这是一段中文注释。
<%--模板注释 --%>
namespace <%= Entity.Namespace %> {
public sealed class <%=Entity.Name%> {
public static void CallMe() {
ArrayList list = new ArrayList();
<% for (int i = 1; i <= 10; i++) { %>
list.Add("<%= GetEntityName() + i%>");
<% } %>
}
}
}
<%# string GetEntityName() {
return Entity.GetFullName();
} %>

调用模板的代码为：

string fileContent = this.ReadFile(Application.StartupPath + "//" + "Sample Template.dt");

Entity ent = new Entity();
ent.Namespace = "SampleNamespace";
ent.Name = "SampleEntity";
ITemplateManager templateManager = new TemplateManager();
try {
ITemplate template = templateManager.NewTemplate(fileContent);
this.textBox1.SelectedText += "This template's name is: " + template.Name + Environment.NewLine;
this.textBox1.SelectedText += "This template's language is: " + template.Language + Environment.NewLine + Environment.NewLine;
this.textBox1.SelectedText += template.GenerateCode(new object[] {ent});
} catch (CompileTimeException ex) {
this.textBox1.Clear();
foreach (CompilerError error in ex.CompilerResults.Errors) {
this.textBox1.SelectedText += error.ErrorText + Environment.NewLine;
}
return;
} catch (RunTimeException ex) {
this.textBox1.Clear();
this.textBox1.SelectedText += ex.InnerException.InnerException.ToString() + Environment.NewLine;
return;
} catch (TemplateException ex) {
this.textBox1.Clear();
this.textBox1.SelectedText += ex.ToString() + Environment.NewLine;
return;
}

结果为：

This template's name is: Sample1
This template's language is: C#

using System;

// 这是一段中文。
namespace SampleNamespace {
public sealed class SampleEntity {
public static void CallMe() {
ArrayList list = new ArrayList();
list.Add("SampleNamespace.SampleEntity1");
list.Add("SampleNamespace.SampleEntity2");
list.Add("SampleNamespace.SampleEntity3");
list.Add("SampleNamespace.SampleEntity4");
list.Add("SampleNamespace.SampleEntity5");
list.Add("SampleNamespace.SampleEntity6");
list.Add("SampleNamespace.SampleEntity7");
list.Add("SampleNamespace.SampleEntity8");
list.Add("SampleNamespace.SampleEntity9");
list.Add("SampleNamespace.SampleEntity10");
}
}
}

从代码中可以看出调用是非常简单的，而且可以非常轻松的集成在任何项目中，这就达到了我的初始目的。CodeSmith可以做到这一切，当却不能轻松的集成到其他项目中去。

这样一个动态代码生成器的用途无异是非常广的，不过我希望看到这篇文章的读者能够给我提出更好的意见，或是讨论，来使DCG更加完美！^_^