一起谈.NET技术,从数据到代码—通过代码生成机制实现强类型编程[下篇]

简介:   在《上篇》中,我们实现了将保存有消息条目的XML向CodeDOM的转换,即是将XML文件生成一个CodeCompileUnit对象,而该CodeCompileUnit对象反映出来的DOM层次和我们将会生成的代码文件向匹配。

  在《上篇》中,我们实现了将保存有消息条目的XML向CodeDOM的转换,即是将XML文件生成一个CodeCompileUnit对象,而该CodeCompileUnit对象反映出来的DOM层次和我们将会生成的代码文件向匹配。在下篇中,我们将实现整个代码生成系统的第二个步骤——通过VS的Custom Tool实现数据(保存消息条目的XML)向代码文件的自动转换。

  一、让MessageCodeGenerator继承BaseCodeGeneratorWithSite

  在《上篇》我们创建了MessageCodeGenerator类,定义了如下一个BuildCodeObject方法实现将一个XmlDocument转换成一个CodeCompileUnit对象。

   1: namespace Artech.CodeDomGenerator
   2: {
   3:     public class MessageCodeGenerator
   4:     {     
   5:          // Others...
   6:         public CodeCompileUnit BuildCodeObject(XmlDocument messages);
   7:     }
   8: }

  现在我们需要做的是让这个MessageCodeGenerator继承一个特殊的类:BaseCodeGeneratorWithSiteBaseCodeGeneratorWithSite所在的程序集名称为Microsoft.VisualStudio.TextTemplating.VSHost.10.0.dll,这是一个Visual Studio SDK的程序集。我们例子采用的是Visual Studio 2010,你可以在如下的目录中找到该程序集:%ProgramFiles%Microsoft Visual Studio 2010 SDK\VisualStudioIntegration\Common\Assemblies\v4.0。如果你没有安装VS 2010 SDK,你可以从这里下载。

  除了添加对Microsoft.VisualStudio.TextTemplating.VSHost.10.0.dll程序集的引用外,你还需要添加两个额外的程序集引用:Microsoft.VisualStudio.OLE.Interop.dll和Microsoft.VisualStudio.Shell.Interop.dll,它们所在的目录分别是%ProgramFiles%Microsoft Visual Studio 2010 SDK\VisualStudioIntegration\Common\Assemblies\v4.0和%ProgramFiles%Microsoft Visual Studio 2010 SDK\VisualStudioIntegration\Common\Assemblies\v2.0。

  添加了相应的程序集引用,并将BaseCodeGeneratorWithSite这个抽象类作为MessageCodeGenerator的基类后,需要实现如下两个抽象方法:GenerateCode和GetDefaultExtension。

   1: namespace Artech.CodeDomGenerator
   2: {   
   3:     public class MessageCodeGenerator : BaseCodeGeneratorWithSite
   4:     {      
   5:         public CodeCompileUnit BuildCodeObject(XmlDocument messages)
   6:         {
   7:             //......
   8:         }              
   9:         protected override byte[] GenerateCode(string inputFileName, string inputFileContent)
  10:         {
  11:            var messageDoc = new XmlDocument();
  12:             messageDoc.LoadXml(inputFileContent);
  13:             var codeObject = BuildCodeObject(messageDoc);
  14:             CodeDomProvider provider = CodeDomProvider.CreateProvider("CSharp");
  15:             CodeGeneratorOptions options = new CodeGeneratorOptions();
  16:             options.BracingStyle = "C";
  17:             using (StringWriter writer = new StringWriter())
  18:             {               
  19:                 provider.GenerateCodeFromCompileUnit(codeObject, writer, options);
  20:                 string code = writer.ToString();
  21:                 byte[] preambleBytes = Encoding.Unicode.GetPreamble();
  22:                 byte[] codeBytes = Encoding.Unicode.GetBytes(code);
  23:                 byte[] result = new byte[preambleBytes.Length + codeBytes.Length];
  24:                 Buffer.BlockCopy(preambleBytes, 0, result, 0, preambleBytes.Length);
  25:                 Buffer.BlockCopy(codeBytes, 0, result, preambleBytes.Length, codeBytes.Length);
  26:                 return result; 
  27:             }
  28:         }
  29:  
  30:         public override string GetDefaultExtension()
  31:         {
  32:             return ".cs";
  33:         }
  34:     }
  35: }

  GenerateCode返回的字节数组表示最终生成的的代码的内容,在这里的逻辑很简单,就是通过CodeDomProviderCodeCompileUnit转化成基于具体编程语言(在这里我们只考虑C#)的代码。而GetDefaultExtension返回生成的代码文件的扩展名,在这里自然是“.cs”。

  二、将MessageCodeGenerator注册成COM组件

  到目前我们MessageCodeGenerator完全通过托管程序编写,但是VS和扩展是通过COM的方式进行交互的,所以我们需要将MessageCodeGenerator注册成COM组件。我们首先需要做的是对MessageCodeGenerator所在的程序集进行注册。一般地,进行注册的程序集都具有一个强名称,所以我们先对程序集进行签名。这只需要对定义MessageCodeGenerator所在的项目的“签名”选项进行如下设置就可以了。

image  我们还需要对程序集的COM可见性进行相应的设置。对于COM可见性的设置,我们只需在AssemblyInfo.cs文件中,添加如下一个ComVisibleAttribute特性并将参数设置成true即可(默认为false)。

   1: // Setting ComVisible to false makes the types in this assembly not visible 
   2: // to COM components.  If you need to access a type in this assembly from 
   3: // COM, set the ComVisible attribute to true on that type.
   4: [assembly: ComVisible(true)]

  为了让我们定义的MessageCodeGenerator通过COM组件的形式暴露出来,我们需要功过在器类型上通过应用一个GuidAttribute指定一个唯一标识。这个唯一标识可以通过VS自带的GUID生成器生成。

   1: [Guid("F9A0FCB3-864F-4B87-885B-FAEBC860BD64")]
   2: public class MessageCodeGenerator : BaseCodeGeneratorWithSite
   3: {  
   4:     //Others...
   5: }

  程序集的注册通过命令行工具RegAsm.exe完成,我们只需要启动通过VS 2010的命名行工具,执行RegAsm.exe命令对编译生成的程序集进行注册。

   1: RegAsm "c:\CodeDOMGenerator\Artech.CodeDomGenerator.CodeGenerator.dll"

  实际上,我们也可以直接通过VS对相应的项目进行相应的设置,让VS在编译完成后自动完成对目标程序基的注册。你只需要在项目设置对话框中的Build页,钩选“Register for COM interop”即可。

image

  注:由于我们的MessageCodeGenerator内部引用到了另一个程序集Microsoft.VisualStudio.Shell.Interop.dll中的某些类型,你需要通过执行如下RegAsm.exe命令行对该程序基进行注册,并采用/tlb开关生成类型库。

1: RegAsm /tlb "%ProgramFiles%Microsoft Visual Studio 2010 SDK\VisualStudioIntegration\Common\Assemblies\v2.0\Microsoft.VisualStudio.Shell.Interop.dll"

  三、设置注册表

  到目前为止,我们定义的代码生成器MessageCodeGenerator已经通过COM组件的形式暴露出来了,我们需要作的就是让VS能够正常地加载该COM组件,这通过设置VS相关的注册表信息来完成。VS2010与代码生成相关的注册表项定义在HKLM\Software\Microsoft\VisualStudio\10.0\Generators\节点下。该节点下的子节点(Key)均通过相应的GUID表示,不同的GUID实际上表示的是相应的编程语言。其中{164B10B9-B200-11D0-8C61-00A0C91E29D5}代表VB.NET,而C#对应的GUID为下图选中的{FAE04EC1-301F-11d3-BF4B-00C04F79EFBC}。

image   现在我们需要在表示C#的节点下创建一个Key,并起名为MessageCodeGenerator,即我们约定的代码生成器的名称。

image 

  如上图所示,我们需要对我们添加的注册表键进行如下三项设置:

  • (Default)[REG_SZ]:设置代码生成器的表述性信息;
  • CLSID[REG_SZ]:作为COM组件的代码生成器的GUID,即我们在定义MessageCodeGenerator类新通过GuidAttribute特性指定的GUID,注意不要忘了花括号;
  • GeneratesDesignTimeSource[REG_WWORD]: 0或者1,表明是否提供设计时原代码生成的支持

  四、通过Custom Tool直接通过XML生成C#代码

  现在我们就可以来直接使用我们我们的MessageCodeGenerator了。现在我们创建一个项目,添加一个用于保存消息的XML文件,比如起名为Messages.xml,内容如下:

   1: <?xml version="1.0" encoding="utf-8" ?>
   2: <messages>
   3:   <message id="MandatoryField" value="The {0} is mandatory."  category="Validation"/>
   4:   <message id="GreaterThan" value="The {0} must be greater than {1}."  category="Validation"/>
   5:   <message id="ReallyDelete" value="Do you really want to delete the {0}."  category="Confirmation"/>
   6: </messages>

  然后右击该XML文件,在弹出的上下文菜单中选择Properties选项。你会发现在属性对话框中有个叫作Custom Tool的属性名称,在该项上填写上我们的代码生成器的名称:MessageCodeGenerator。

image   此后,当你右击该XML文件时,在上下文菜单中都会多出一个叫做Run Custom Tool的项目,选择它我们的.cs文件将会自动生成,

image  该.cs文件和我们在《上篇》给出的代码一模一样。那么我们就可以借助于生成出来的代码,以一种强类型的方式获取相应的、被格式化的消息文本。

   1: //------------------------------------------------------------------------------
   2: // <auto-generated>
   3: //     This code was generated by a tool.
   4: //     Runtime Version:4.0.30319.1
   5: //
   6: //     Changes to this file may cause incorrect behavior and will be lost if
   7: //     the code is regenerated.
   8: // </auto-generated>
   9: //------------------------------------------------------------------------------
  10:  
  11: namespace Artech.CodeDomGenerator
  12: {
  13:     
  14:     
  15:     public class Messages
  16:     {
  17:         
  18:         public class Validation
  19:         {
  20:             
  21:             public static Artech.CodeDomGenerator.MessageEntry MandatoryField = new Artech.CodeDomGenerator.MessageEntry("MandatoryField", "The {0} is mandatory.", "Validation");
  22:             
  23:             public static Artech.CodeDomGenerator.MessageEntry GreaterThan = new Artech.CodeDomGenerator.MessageEntry("GreaterThan", "The {0} must be greater than {1}.", "Validation");
  24:         }
  25:         
  26:         public class Confirmation
  27:         {
  28:             
  29:             public static Artech.CodeDomGenerator.MessageEntry ReallyDelete = new Artech.CodeDomGenerator.MessageEntry("ReallyDelete", "Do you really want to delete the {0}.", "Confirmation");
  30:         }
  31:     }
  32: }

  五、将MessageCodeGenerator和文件扩展名绑定

  实际上我们可以看出VS代码生成机制的本质:将一个文件作为源文件(Source),利用相应的生成器生成目标文件(Destination)。至于采用怎样的生成器,则是通过源文件的Custom Tool属性进行匹配的。除了这种需要手工设置文件属性的方式进行源文件和生成器之间的匹配关系外,还具有另一种更为方便的匹配方式:基于源文件扩展名的匹配。

  现在我们的消息文件时通过一个XML文件(文件的结构和扩展名均是XML),如果我们现在给它一种特殊的扩展名,并且将设置源文件扩展名和代码生成器的匹配关系,就无需再手工地为源文件设置Custom Tool这一属性了。

  实际上,我们可以一个简单的注册表设置就可以实现这样的功能。假设作为MessageCodeGenerator的源文件的扩展名为msg(不要认为是OutLook邮件消息),我们住需要在上面提到过的基于某种编程语言的注册表节点下,创建一个以扩展名命名的Key,并将Default值直接设置成代码生成器的名称即可。image  现在当你添加一个扩展名为.msg的文件后,Custom Tool自动为你设置成MessageCodeGenerator。无需手工设置,你就可以直接通过Run Custom Tool生成相应的代码文件了。

image

目录
相关文章
|
6月前
|
监控 Cloud Native 测试技术
.NET技术深度解析:现代企业级开发指南
每日激励:“不要一直责怪过去的自己,他曾经站在雾里也很迷茫”。我是蒋星熠Jaxonic,一名在代码宇宙中探索的极客旅人。从.NET Framework到.NET 8,我深耕跨平台、高性能、云原生开发,践行领域驱动设计与微服务架构,用代码书写技术诗篇。分享架构演进、性能优化与AI融合前沿,助力开发者在二进制星河中逐光前行。关注我,共探技术无限可能!
.NET技术深度解析:现代企业级开发指南
|
网络协议 定位技术 网络安全
IPIP.NET-IP地理位置数据
IPIP.NET 是一家专注于 IP 地理位置数据的提供商,基于 BGP/ASN 数据与全球 800+ 网络监测点技术,提供高精度的 IPv4 和 IPv6 定位服务。其核心服务包括地理位置查询、详细地理信息和网络工具等,广泛应用于网络安全、广告营销、CDN 优化等领域。数据覆盖全球,支持多语言,每日更新确保实时性。IPIP.NET 提供 API 接口、离线数据库及多种语言 SDK,方便开发者集成使用。
2499 0
|
SQL 小程序 API
如何运用C#.NET技术快速开发一套掌上医院系统?
本方案基于C#.NET技术快速构建掌上医院系统,结合模块化开发理念与医院信息化需求。核心功能涵盖用户端的预约挂号、在线问诊、报告查询等,以及管理端的排班管理和数据统计。采用.NET Core Web API与uni-app实现前后端分离,支持跨平台小程序开发。数据库选用SQL Server 2012,并通过读写分离与索引优化提升性能。部署方案包括Windows Server与负载均衡设计,确保高可用性。同时针对API差异、数据库老化及高并发等问题制定应对措施,保障系统稳定运行。推荐使用Postman、Redgate等工具辅助开发,提升效率与质量。
500 0
|
开发框架 算法 .NET
C#/.NET/.NET Core技术前沿周刊 | 第 15 期(2024年11.25-11.30)
C#/.NET/.NET Core技术前沿周刊 | 第 15 期(2024年11.25-11.30)
267 6
|
开发框架 Cloud Native .NET
C#/.NET/.NET Core技术前沿周刊 | 第 16 期(2024年12.01-12.08)
C#/.NET/.NET Core技术前沿周刊 | 第 16 期(2024年12.01-12.08)
294 6
|
机器学习/深度学习 人工智能 Cloud Native
在数字化时代,.NET 技术凭借其跨平台兼容性、丰富的类库和工具集以及卓越的性能与效率,成为软件开发的重要平台
在数字化时代,.NET 技术凭借其跨平台兼容性、丰富的类库和工具集以及卓越的性能与效率,成为软件开发的重要平台。本文深入解析 .NET 的核心优势,探讨其在企业级应用、Web 开发及移动应用等领域的应用案例,并展望未来在人工智能、云原生等方面的发展趋势。
375 3
|
敏捷开发 缓存 中间件
.NET技术的高效开发模式,涵盖面向对象编程、良好架构设计及高效代码编写与管理三大关键要素
本文深入探讨了.NET技术的高效开发模式,涵盖面向对象编程、良好架构设计及高效代码编写与管理三大关键要素,并通过企业级应用和Web应用开发的实践案例,展示了如何在实际项目中应用这些模式,旨在为开发者提供有益的参考和指导。
173 3
|
监控 前端开发 API
一款基于 .NET MVC 框架开发、功能全面的MES系统
一款基于 .NET MVC 框架开发、功能全面的MES系统
601 5
|
开发框架 前端开发 .NET
ASP.NET CORE 3.1 MVC“指定的网络名不再可用\企图在不存在的网络连接上进行操作”的问题解决过程
ASP.NET CORE 3.1 MVC“指定的网络名不再可用\企图在不存在的网络连接上进行操作”的问题解决过程
667 0
|
开发框架 前端开发 JavaScript
ASP.NET MVC 教程
ASP.NET 是一个使用 HTML、CSS、JavaScript 和服务器脚本创建网页和网站的开发框架。
352 7

热门文章

最新文章