T4+VSIX打造VS2010代码生成自定义工具

深藏阁楼爱情的钟 2022-05-14 04:48 228阅读 0赞

# [VS2010 在 C++ 项目中使用 T4 Template 的方法][VS2010 _ C_ _ T4 Template] #

http://www.cppblog.com/diryboy/archive/2010/08/17/vs2010addt4incppproject.html

## T4 简介 ##

T4，全称 [ Text Template Transformation Toolkit][Text Template Transformation Toolkit]，早在 VS2005 中就存在的东西，只是没有高度集成，VS2010 在托管项目中新增了添加 Text Template 文件的模板，但是并没有代码颜色和智能感知，可以说它是 Visual Studio 一个“隐藏”的特性。T4 一般用来从某种“模型”自动生成好用的代码，例如从XML模型生成操作它的强类型代码。不知道是不是 C++ 的宏和模板实在太强大，貌似这种代码生成器用在托管语言中用得广泛多，其实我想在 C++ 中用这个也是跟托管程序有关。

一般来说，在托管的项目中添加一个 .tt 后缀名的文本文件即可用到 T4，如图：

[![.tt Magic][]][.tt Magic 1]

对于生成什么扩展名的文件，其实并没有限制，可以在 .tt 文件的处理指令中指定：

<#@ template language="C#" #>
    <#@ output extension=".generated.cs" #>

然后就基本好像写 PHP 或者 ASP 那样了，不同之处在于 T4 的生成步骤是在一个方法中的，如果要自定一些帮助函数，需要用 <\#+ 和 \#> 包围。参见 MSDN 上一个简单的例子：[Walkthrough: Generating Code by using Text Templates][Walkthrough_ Generating Code by using Text Templates]。

## 尝试在 C++ 项目中添加 ##

第一步，肯定要先添加一个 .tt 文件。很不幸地发现，魔法没有自动出现，.tt 文件是在那里了，但是没有自动生成的文件，IDE 也没有显示什么文件跟这个 .tt 有关联关系。很显然，需要告诉 IDE 更多事情。

其实在尝试这个东西之前，我是有想过最终的成功率的，根据我的了解，1) Visual Studio 使用 MSBuild 的项目文件，2) VS2010 构建 C++ 项目使用 MSBuild，3）T4 可以作为 MSBuild 中的一个 Custom Build Tool 介入。从这三点理解的话，可知只要修改项目文件，即使 VS 不支持某些东西，只要它不乱改我们在项目文件中的设置，就可以保证构建的项目是正确的。

有了上面的知识，可以开始下一步的尝试了：新建一个 C\# 项目，添加一个 .tt 文件，然后观察项目文件如何变化，其实稍微了解 MSBuild 项目文件的结构是怎么样的话，很快就知道了。我的项目需要的是根据“旧的”文件自动生成上万个包装函数，而这个“旧的”意思是，这个文件会在其他社区不断地更新，增加更多函数，我做了这个自动生成的就无需每次都根据新文件手动查找替换修改了。于是我修改成这个样子：

［折叠代码］
     
      
     
      
      
       
    <
      
       ItemGroup
      
       >
      <
      
       None 
      
       Include
      
       ="
      
       Scripting.tt"
      
       >
        <
      
       Generator
      
       >TextTemplatingFileGenerator
      
       </
      
       Generator
      
       >
        <
      
       FileType
      
       >Asax
      
       </
      
       FileType
      
       >
      </
      
       None
      
       >
      <
      
       ClInclude 
      
       Include
      
       ="
      
       Scripting.h"
      
       >
        <
      
       AutoGen
      
       >True
      
       </
      
       AutoGen
      
       >
        <
      
       DependentUpon
      
       >Scripting.tt
      
       </
      
       DependentUpon
      
       >
        <
      
       DesignTime
      
       >True
      
       </
      
       DesignTime
      
       >
      </
      
       ClInclude
      
       >
      <
      
       None 
      
       Include
      
       ="
      
       Scripting_.h" 
      
       />
    </
      
       ItemGroup
      
       >
     
      
     
      
       
      ［折叠代码］

其实，这段东西的重点在于，.tt 有一个 Generator 子标签，内容是 TextTemplatingFileGenerator，标签 None 它表示不参与到 Build 中，只是 T4 用的。ClInclude 表示我生成的 .h 文件在 Build 过程中是头文件，AutoGen 表示这个文件由工具自动生成，DependentUpon 可以使 Visual Studio 知道这两个家伙有联系。

现在重新载入项目，可以看到 Visual Studio 将他们关联了，但是赶出了 Header Files，而我就将它们放到一个新的 Filter 中去：

[![Magic again][]][Magic again 1]

## 快搞定了！ ##

但是我们拿这个编辑过的项目文件构建的时候，并没有看到有输出文件。也就是说，T4 其实还没有介入。而在托管的项目中，当你保存 .tt 文件的时候，或者点击 Solution Explorer 上运行 Transform 的时候，T4 引擎就会自动运行生成输出，如果你改变 output 指令的 extension 参数，输出文件的扩展名还会自动更改，确切地说，旧的文件会被移到回收站。正当我快要放弃的时候，突然发现 MSDN 文档中有一节：[Code Generation in a Build Process][]，其中表示，只要装上 [ Visual Studio Visualization and Modeling SDK][Visual Studio Visualization and Modeling SDK] 然后在项目文件差不多最后的地方加上以下代码即可：

<Import Project="$(MSBuildExtensionsPath)\Microsoft\VisualStudio\TextTemplating\v10.0\Microsoft.TextTemplating.targets" />
    <PropertyGroup>
      <TransformOnBuild>True</TransformOnBuild>
    </PropertyGroup>

噢，终于胜利了！最后发现，仍然不能直接只在 .tt 文件中修改输出指令的 extension 参数，VS 不会帮你自动更改，需要自己动手修改项目文件，不过这个就无所谓了，因为我的目的达到了，思想也验证了。

最后附上[示例项目文件][Link 1]。

# T4+VSIX打造VS2010代码生成自定义工具 #

http://winsystem.ctocio.com.cn/179/11849679.shtml

使用过ADO.NET Entity框架的人应该都有接触过实体生成模板，也就是标题中所说的T4(Code Generation and Text Templates：由一些文本模板和控制逻辑组成的混合体……

使用过ADO.NET Entity框架的人应该都有接触过实体生成模板，也就是标题中所说的T4(Code Generation and Text Templates：由一些文本模板和控制逻辑组成的混合体，可以使用这些模板生成应用程序的部分源代码)，但如果通过其他的模板去生成实体，每次都需要将模板添加到项目中，然后修改模板中.edmx文件的路径才能生成相应的实体。那么能不能做到像提供的默认生成模板一样，直接运行自定义工具就生成相应的实体呢？

答案当然是“可以的”。那么接下首先介绍如何开发代码生成自定工具。

在进行开发之前首先需要下载Visual Studio 2010 SDK，因为需要使用VSPackage和Managed Extensibility Framework (MEF) 扩展来扩展 Visual Studio 2010。

安装完成之后，【新建项目】，在项目模板“Extensibility”分类里面可以看到“VSIX Project”，如下图所示：

![image][]

创建项目“Kevin.Develop.CodeGenerateCustomTool”，然后添加所需程序集的引用，如下图所示：

![image][image 1]

添加代码生成类MyCodeGenerator的定义，给类添加特性(Attribute)System.Runtime.InteropServices.Guid()，然后点击【工具】【创建GUID】，生成的Guid(注册表格式并删除左右大括号)作为特性的参数，代码如下所示：

注册MyCodeGenerator代码生成类，代码如下所示：

**以下是代码片段：**  
\[ProvideCodeGenerator(typeof(MyCodeGenerator),  
　　"MyCodeGenerator",  
　　"Generates C\# Code", true,  
　　ProjectSystem = ProvideCodeGeneratorAttribute.CSharpProjectGuid,  
　　RegisterCodeBase = true)\]  
　　internal sealed partial class MyCodeGeneratorPackage  
　　\{  
　　\}

在项目中添加文件“CodeGenerator.pkgdef”，并更改以下属性：

Include in VSIX设置为“True”

复制到输出目录设置为“如果较新则复制”

生成操作设置为“内容”

文件中添加内容如下所示，注意修改CLSID guid为前面生成的GUID：

<table style="border-bottom:#cccccc 1px dotted; border-left:#cccccc 1px dotted; table-layout:fixed; border-top:#cccccc 1px dotted; border-right:#cccccc 1px dotted"> 
 <tbody> 
  <tr> 
   <td style="word-wrap:break-word"><span style="color:#990000; font-weight:bold">以下是代码片段：</span><br> &nbsp;&nbsp;&nbsp; [$RootKey$\Generators] <br> 　　[$RootKey$\Generators\{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}] <br> 　　[$RootKey$\Generators\{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}\MyCodeGenerator] <br> 　　@="Generates C# Code" <br> 　　"CLSID"="{391B243E-DB88-42F8-8F64-A355042D7507}" <br> 　　"GeneratesDesignTimeSource"=dword:00000001 <br> 　　[$RootKey$\CLSID] <br> 　　[$RootKey$\CLSID\{391B243E-DB88-42F8-8F64-A355042D7507}] <br> 　　@="Generates C# Code" <br> 　　"Class"="Kevin.Develop.CodeGenerateCustomTool.MyCodeGenerator" <br> 　　"InprocServer32"="$WinDir$\system32\mscoree.dll" <br> 　　"ThreadingModel"="Both" <br> 　　"CodeBase"="$PackageFolder$\Kevin.Develop.CodeGenerateCustomTool.dll"</td> 
  </tr> 
 </tbody> 
</table>

简单解释下上面的内容：

在C\# Project 项目中定义了一个命名为“MyCodeGenerator”的用户自定义工具

自定义工具有唯一的GUID 391B243E-DB88-42F8-8F64-A355042D7507以及说明文本“Generates C\# ”

自定义工具关联Kevin.Develop.CodeGenerateCustomTool.MyCodeGenerator代码生成类

接下来将自定义工具添加至VISX中进行部署，在创建项目时会自动生成“source.extension.vsixmanifest”文件，双击该文件，修改ID等属性，需要注意的是需要修改Supported VS Editions，选择支持的VS版本，然后在最下面的栏目“Content”中添加内容，将本项目作为VS Package类型的内容添加进VSIX，如下图所示：

![image][image 2]

最后还需要修改下项目属性，保存当前项目，然后通过文本的方式打开项目文件“Kevin.Develop.CodeGenerateCustomTool.csproj”，将下图中的属性全部修改为true：

![image][image 3]

保存编辑结果，然后打开项目，并编译生成，在生成结果文件夹中可以找到“Kevin.Develop.CodeGenerateCustomTool.vsix”文件，运行该文件。

重新启动Visual Studio ，在【工具】【扩展管理器】中可以找到我们刚刚安装的Kevin.Develop.CodeGenerateCustomTool扩展，然后打开或者创建一个测试的C\#项目，添加一个“文本模板”类型的.tt文件，文件默认的自定义工具为“TextTemplatingFileGenerator”，修改自定义工具属性为前面开发的自定义工具名称“MyCodeGenerator”，然后在文本模板中写一些内容(符合T4模板的语法)，然后保存文件，会生成相应的文本文件。

到此为止我们已经实现了与“TextTemplatingFileGenerator”自定义工具一样功能的文本模板的代码生成器，那么下面会接着介绍如何将ADO.NET Entity的文本模板加入到我们的自定义工具中。

# [Tangible T4 Editor for Visual Studio 2010 RTM][] #

http://www.coderblog.in/2010/05/tangible-t4-editor-for-visual-studio-2010-rtm.html

tangible [T4 Editor][] for Visual Studio 2010 RTM 版出来了，这个是专门FOR[VS2010][]的，可以在[VS2010][]里使用T4智能提示和语法高亮等，需要的朋友快去下载吧：）

[![PreviewT4Editor][]][PreviewT4Editor 1]

T4Editor For Vs2010

安装方法有2种：  
1.直接在线安装：  
在 VS 2010 里选择 Tools Menu->Extension Manager. 然后点击 “Online Gallery” 选择 [T4 Editor][] 下载，然后重起VS 2010.

2.下载安装：  
你可以[点击这里][Link 2]下载，然后双击运行即会自动进行安装了。

# [VS2010 扩展 ProPowerTools][VS2010 _ ProPowerTools] #

http://www.coderblog.in/2011/04/vs2010-extensions-propowertools.html

这次为大家介绍一个[VS2010][]非常有用的扩展，此扩展功能就如其名[ProPowerTools][]

现在我为大家介绍感觉其中几个比较好用的功能。首先看看此扩展的后台功能，这里或以控制多项功能是否启用：

[![功能设置][PTSetting01-300x198.png]][PTSetting01-300x198.png 1]  
  
**1、标签固顶**  
其实我一直在使用此扩展，最让我喜欢的一个功能就是其标签固顶并且可分行显示，当同时打开多个文件进行编辑时，这个功能非常有用。一般情况下，如果打开的文件太多，因为一行显示不完，有部分标签就会被隐藏了，要使用滚动条拉过去才可以看到，而经常需要对应几个文件进行修改，这样找起文件来也很不方便，有了标签固顶功能就方便多了，可以将现常用的几个文件标签固顶，然后设置为分行显示，这样或大大节省了空间，也不会为了要多个文件间切换弄得找不到文件了，效果如下：

[![标签固顶][PinTab-300x50.png]][PinTab-300x50.png 1]

要使用分行显示功能，还需在扩展设置里打开以下选项（红色框的）

[![启用分行标签][PTSetting02-300x197.png]][PTSetting02-300x197.png 1]

除了可分行显示外，还有一个好处就是可以一次性关闭所有非固顶标签哦。

**2、直接查看类信息**  
当鼠标放到类名称上，就会显示此类的成员信息，还可以进行搜索：

[![鼠标悬停][class01-300x76.png]][class01-300x76.png 1]

[![查看类成员信息][class02-300x168.png]][class02-300x168.png 1]

3、解决方案浏览器的增强  
[ProPowerTools][ProPowerTools 1]会为VS增加一个加强版的解决方案浏览器，其可以直接输入文件名进行搜索，其中一个比较好用的功能是可以只查看某个项目或者目录下的文件，就如同进入了一级子目录一样，将其他的项目都隐藏起来了，这样可以方便集中修改某项目下文件时使用，特别是项目比较多的时候这个功能还是挺不错的![:biggrin:][biggrin]

[![悬停时点击右边图标][nav01.png]][nav01.png]

[![进去后就只看到此项目的文件了][nav02-282x300.png]][nav02-282x300.png 1]

4、滚动条预览  
此功能是最新版里才有的，感觉也挺不错的。就是把鼠标放在滚动条上，即可预览到当前滚动条位置的代码：

[![滚动条代码预览][mapBar-300x115.png]][mapBar-300x115.png 1]

以上只是我比较常用的一些功能，此扩展还有很多有趣的功能等着大家自己去发现哦（或者点击以下链接到官方网站查看详细介绍），如按Ctrl直接进行代码跳转等，使用[VS2010][]的朋友不防一试。![:wink:][wink]

不过最后要说说的是，如果你已经在使用旧版并想要升级的话，记得先要卸载旧版才可安装新版的，否则总会报出扩展签名不对然后不让安装的信息。

<table style="background-color:#e5e5e5; width:98%"> 
 <tbody> 
  <tr> 
   <td><img alt="File" title="File" src="http://www.coderblog.in/wp-content/plugins/download-monitor/img/filetype_icons/document-zipper.png">&nbsp;&nbsp;<strong><a href="http://www.coderblog.in/downloads/d0d33361-18e2-46c0-8ff2-4adea1e34fef%3FSRC%3DVSIDE" rel="nofollow">下载ProPowerTools</a></strong></td> 
   <td>&nbsp;</td> 
  </tr> 
 </tbody> 
</table>

http://visualstudiogallery.msdn.microsoft.com/d0d33361-18e2-46c0-8ff2-4adea1e34fef?SRC=VSIDE

[VS2010 _ C_ _ T4 Template]: http://www.cppblog.com/diryboy/archive/2010/08/17/VS2010AddT4InCppProject.html
[Text Template Transformation Toolkit]: http://msdn.microsoft.com/en-us/library/bb126445.aspx
[.tt Magic]: /images/20220514/2be3fd8dc96a47e1a1b633a1af7ccf7d.png
[.tt Magic 1]: http://www.cppblog.com/images/cppblog_com/diryboy/WindowsLiveWriter/VS2010CT4Template_11B7/image_2.png
[Walkthrough_ Generating Code by using Text Templates]: http://msdn.microsoft.com/en-us/library/dd820614.aspx
[Magic again]: /images/20220514/0e1d422985274fbf80a0aafb379ca191.png
[Magic again 1]: http://www.cppblog.com/images/cppblog_com/diryboy/WindowsLiveWriter/VS2010CT4Template_11B7/image_4.png
[Code Generation in a Build Process]: http://msdn.microsoft.com/en-us/library/ee847423.aspx
[Visual Studio Visualization and Modeling SDK]: http://go.microsoft.com/fwlink/?LinkID=185579
[Link 1]: http://www.cppblog.com/Files/diryboy/CppT4.rar
[image]: /images/20220514/8b0ab21ee3884857a685d9b8d2bad66e.png
[image 1]: /images/20220514/cf680799426941dfb570b0653233c62c.png
[image 2]: /images/20220514/970171f7f3074576a7513c18cbe980c4.png
[image 3]: /images/20220514/8da45ad2a845447ebe9592d98e29b56b.png
[Tangible T4 Editor for Visual Studio 2010 RTM]: http://www.coderblog.in/2010/05/tangible-t4-editor-for-visual-studio-2010-rtm.html
[T4 Editor]: http://www.coderblog.in/tag/t4-editor
[VS2010]: http://www.coderblog.in/tag/vs2010
[PreviewT4Editor]: /images/20220514/eebee31ae3184126a2e68bb74db5e20c.png
[PreviewT4Editor 1]: http://www.coderblog.in/wp-content/uploads/2010/05/PreviewT4Editor.jpg
[Link 2]: http://visualstudiogallery.msdn.microsoft.com/en-us/60297607-5fd4-4da4-97e1-3715e90c1a23
[VS2010 _ ProPowerTools]: http://www.coderblog.in/2011/04/vs2010-extensions-propowertools.html
[ProPowerTools]: http://visualstudiogallery.msdn.microsoft.com/d0d33361-18e2-46c0-8ff2-4adea1e34fef?SRC=VSIDE
[PTSetting01-300x198.png]: http://www.coderblog.in/wp-content/uploads/2011/04/PTSetting01-300x198.png
[PTSetting01-300x198.png 1]: /images/20220514/cad99f965ce14160987fed10012d57b5.png
[PinTab-300x50.png]: http://www.coderblog.in/wp-content/uploads/2011/04/PinTab-300x50.png
[PinTab-300x50.png 1]: /images/20220514/aa0c99acbc2d437ab5a64b2ebe39ec75.png
[PTSetting02-300x197.png]: http://www.coderblog.in/wp-content/uploads/2011/04/PTSetting02-300x197.png
[PTSetting02-300x197.png 1]: /images/20220514/ca2ee2b2507949dfa04000912aed20c6.png
[class01-300x76.png]: http://www.coderblog.in/wp-content/uploads/2011/04/class01-300x76.png
[class01-300x76.png 1]: /images/20220514/bb245c39914440afaac77f19756086ba.png
[class02-300x168.png]: http://www.coderblog.in/wp-content/uploads/2011/04/class02-300x168.png
[class02-300x168.png 1]: /images/20220514/b89c5497b785417eaaab696d19cf7cb3.png
[ProPowerTools 1]: http://www.coderblog.in/tag/propowertools
[biggrin]: /images/20220514/5bc65b98708345499dff79a2c433a1fe.png
[nav01.png]: /images/20220514/c1e41735f768421ebd5df93cbcc70238.png
[nav02-282x300.png]: http://www.coderblog.in/wp-content/uploads/2011/04/nav02-282x300.png
[nav02-282x300.png 1]: /images/20220514/247b6dab1b774025a8c1b3331a1ea6dd.png
[mapBar-300x115.png]: http://www.coderblog.in/wp-content/uploads/2011/04/mapBar-300x115.png
[mapBar-300x115.png 1]: /images/20220514/63157520588c42e2abf85cb906a7df56.png
[wink]: http://www.coderblog.in/wp-content/plugins/smilies-themer/Nomicons%20v2.0/wink.png