最近在自己实践一个异常扑捉设计,在模块中我觉得该给用户提供的是代码生成工具,而不是怎么去做,再自己去写代码。现在代码模板生成的有很多

但我选择了用微软的CODEDOM技术来实现,由于比较熟悉,以及感觉我将只用在.NET平台是已经够强大了。最近也总想写点博客,但是不知道写些什么,所以就准备写个CODEDOM的系列。仅是开篇,就写个简单的HelloWord程序吧。

CODEDOM在.NET Framework SDK文档里是这么讲述的:

.NET Framework 中包含一个名为“代码文档对象模型”(CodeDOM) 的机制,该机制使编写源代码的程序的开发人员可以在运行时,根据表示所呈现代码的单一模型,用多种编程语言生成源代码。

为表示源代码,CodeDOM 元素相互链接以形成一个数据结构(称为 CodeDOM 图),它以某种源代码的结构为模型。

System.CodeDom 命名空间定义可以表示源代码的逻辑结构(与具体的编程语言无关)的类型。System.CodeDom.Compiler 命名空间定义从 CodeDOM 图生成源代码的类型,和在受支持的语言中管理源代码编译的类型。编译器供应商或开发人员可以扩展受支持语言的集合。

还是先贴上代码:

  1. using System;  
  2. using System.Text;  
  3. using System.CodeDom;  
  4. using System.CodeDom.Compiler;  
  5.  
  6. namespace CodeDomDemo1  
  7. {  
  8.     class Program  
  9.     {  
  10.         static void Main(string[] args)  
  11.         {  
  12.             Program pro = new Program();  
  13.             CodeNamespace nspace = pro.CreateCodeDomHelloDemo();  
  14.             Console.WriteLine(pro.GengerCode(nspace));  
  15.             string filename = "HelloWorld.exe";  
  16.             CompilerResults result= pro.Execute(nspace,filename);  
  17.             if (result.Errors.HasErrors)//是否存在错误;  
  18.             {  
  19.                 for (int i = 0; i < result.Output.Count; i++)  
  20.  
  21.                     Console.WriteLine(result.Output[i]);  
  22.  
  23.                 for (int i = 0; i < result.Errors.Count; i++)  
  24.  
  25.                     Console.WriteLine(i.ToString() + ": " + result.Errors[i].ToString());  
  26.             }  
  27.             else 
  28.             {  
  29.                 System.Diagnostics.Process.Start(filename);//这里比较懒,不想动手去自己打开,呵呵;  
  30.             }  
  31.             Console.Read();  
  32.         }  
  33.  
  34.         public CodeNamespace CreateCodeDomHelloDemo()  
  35.         {  
  36.             CodeMemberMethod method = new CodeMemberMethod();//方法声明;   
  37.             method.Name = "SayHello";//  方法名  
  38.             method.Attributes = MemberAttributes.Public| MemberAttributes.Final;//属性  
  39.             method.ReturnType = new CodeTypeReference(typeof(string));//返回类型  
  40.             method.Statements.Add(new CodeMethodReturnStatement(new CodePrimitiveExpression("Hello  from code!")));//方法体,只有一句返回语句return "Hello  from code!";  
  41.  
  42.             CodeEntryPointMethod main = new CodeEntryPointMethod();//主方法Main  
  43.             main.Statements.Add(new CodeVariableDeclarationStatement("HelloWord","hw",  
  44.                 new CodeObjectCreateExpression("HelloWord", new CodeExpression[] { })));//变量声明:HelloWord hw = new HelloWord();  
  45.  
  46.          CodeMethodInvokeExpression methodinvoke=   new CodeMethodInvokeExpression(new CodeVariableReferenceExpression("hw"),"SayHello",new CodeExpression[]{});  
  47.             main.Statements.Add(new CodeMethodInvokeExpression(new CodeTypeReferenceExpression("System.Console"),"WriteLine", methodinvoke));  
  48.             main.Statements.Add(new CodeMethodInvokeExpression(new CodeTypeReferenceExpression("System.Console"), "Read"));//两个方法调用:System.Console.WriteLine(hw.SayHello());  
  49.              
  50.             CodeTypeDeclaration helloword = new CodeTypeDeclaration("HelloWord");//类型Class声明  
  51.             helloword.Attributes = MemberAttributes.Public;  
  52.             helloword.Members.AddRange(new CodeTypeMember[]{method,main});//添加方法到clss  
  53.  
  54.             CodeNamespace nspace = new CodeNamespace("HelloDemo1");//命名空间声明  
  55.             nspace.Imports.Add(new CodeNamespaceImport("System"));//引入程序命名空间:using System;  
  56.             nspace.Types.Add(helloword);//  
  57.             return nspace;  
  58.         }  
  59.  
  60.         public string GengerCode(CodeNamespace nspace)  
  61.         {  
  62.             StringBuilder sb = new StringBuilder();  
  63.             System.IO.StringWriter sw = new System.IO.StringWriter(sb);  
  64.             CodeGeneratorOptions geneOptions = new CodeGeneratorOptions();//代码生成选项  
  65.  
  66.                 geneOptions.BlankLinesBetweenMembers = false;  
  67.  
  68.                 geneOptions.BracingStyle = "C";  
  69.  
  70.                 geneOptions.ElseOnClosing = true;  
  71.  
  72.                 geneOptions.IndentString = "    ";  
  73.                 CodeDomProvider.GetCompilerInfo("c#").CreateProvider().GenerateCodeFromNamespace(nspace, sw, geneOptions);//代码生成  
  74.                 sw.Close();  
  75.                 return sb.ToString();  
  76.  
  77.         }  
  78.  
  79.         public CompilerResults Execute(CodeNamespace nspace, string filename)  
  80.         {  
  81.             CodeCompileUnit unit=new CodeCompileUnit();//code编译单元  
  82.             unit.Namespaces.Add(nspace);  
  83.            CodeDomProvider provider=  CodeDomProvider.CreateProvider("C#");    
  84.             CompilerParameters options=new CompilerParameters();//  
  85.              
  86.             options.GenerateInMemory =false;//是否在内存中生成;  
  87.              options.IncludeDebugInformation =true;// 包含调试信息;  
  88.             options.ReferencedAssemblies.Add("System.dll");  
  89.             options.OutputAssembly = filename;  
  90.             if (System.IO.Path.GetExtension(filename).ToLower() == ".exe")  
  91.             {  
  92.                 options.GenerateExecutable = true;//true为可执行exe,false:dll  
  93.             }  
  94.             else 
  95.             {  
  96.                 options.GenerateExecutable = false;//true为可执行exe,false:dll  
  97.             }  
  98.            return  provider.CompileAssemblyFromDom(options, unit);//编译程序集  
  99.         }  
  100.  
  101.     }  
  102. }  

结果截图

1.生成的代码 

2:运行结果:

上面代码很简单,我特意也把注释写上了,所以不用一句一句的讲解了,哈哈。

CodeDom提供了很多操作,如定义类,还可以定义结构、枚举;类里面的方法、属性、字段及构造函数;定义Attribute;事件及委托;赋值、条件(if)、循环(for)语句;变量声明;异常处理语句;甚至还可以加注释以及块(#region #endregion)。除了分支选择switch、while,dowhile循环及break、continue没发现外,其他大多数东西都有,着已经足够了,程序三大结构,足以实现很多的代码生成了。

msdn CodeDom参考:http://msdn.microsoft.com/zh-cn/library/f1dfsbhc(VS.80).aspx