CodePlex上TlbImp新版本发布：基于规则的自定义功能

谁践踏了优雅 2022-08-13 00:46 151阅读 0赞

大家好。距离上次我们发布在CodePlex上的新版本TlbImp已经过了快半年了。在这半年的时间内，除了主要进行.NET 4.0相关的新功能开发之外，我们上海CLR小组也没有忘记进行TlbImp相关功能的继续开发，于今年3月9日再次发布了TlbImp的一个新版本：

[http://www.codeplex.com/clrinterop/Release/ProjectReleases.aspx?ReleaseId=17579][http_www.codeplex.com_clrinterop_Release_ProjectReleases.aspx_ReleaseId_17579]

这次版本中我们引入了两个重要功能：

1. 通过规则自定义互操作程序集以及规则自定义编辑器

2. 回归测试工具

**基于规则的自定义功能**

我们先来看一下自定义功能。这个新版本的TlbImp允许用户通过自定义的一系列的规则来指定TlbImp如何生成最终的互操作程序集。之前有不少用户向我们提到在使用TlbImp的时候，经常需要对TlbImp生成的结果做一些修改，而且必须是自动化的修改。他们通常使用的方法是先使用ILDASM反汇编，使用Perl脚本修改反汇编代码，然后再使用ILASM重新生成互操作程序集。为了解决这个问题，我们引入了一个新功能，允许用户以非常自由的方式来定义他们最终想要看到的结果。

让我们先来看一个简单的例子：假设我们希望改变互操作程序集中的某个类型的名称。先双击打开TlbImpConfigFileEditor.exe启动自定义文件的编辑器，然后打开我们需要自定义的Type Library，这里我们选择发布版本中Samples/ChangeManagedName/ChangeManagedNameSample.tlb文件，如下：

[![clip\_image002][clip_image002]][clip_image002_clip_image002]

左边显示的是我们需要自定义的Type Library，而右边，则是我们需要自定义的规则，这些规则可以告诉TlbImp如何修改最终生成的互操作程序集。首先，将我们需要修改的IComparable接口结点从左边拖到右边，松开鼠标，出现如下的对话框：

[![clip\_image004][clip_image004]][clip_image004_clip_image004]

上面这个对话框是用来创建一个新的规则，规则指定TlbImp对于哪些对象应用何种动作。在这个对话框中我们需要定义这个规则所对应的动作（Action），因此需要在Action下拉框中选择ChangeManagedName，然后点击OK即可。之后编辑器状态如下（需要自己展开结点）：

[![clip\_image006][clip_image006]][clip_image006_clip_image006]

大家可以看到右边已经出现了一个新的规则叫做Change interface name，对应的Category是Type，也就是说这个规则是针对互操作程序集中的类型设置的。Condition指定了规则所需要满足的条件，选中Condition节点（或者其子节点）可以在下面的Condition Expression中看到对应的规则表达式，也就是NativeName Equal ‘ICompareable’，意思是该规则是针对任何名字叫做IComparable的类型。注意因为我们是从IComparable节点直接拖到右边，因此这些条件是编辑器自动生成的。大家如果需要也可以自己通过点击Native Equal IComparable条件来修改，或者点击 来增加新的条件。现在我们可以点击 节点，在下拉框中选择TypeKind，第二个下拉框选择Equal，第三个下拉框选择Interface，最终的结果如下：

[![clip\_image008][clip_image008]][clip_image008_clip_image008]

注意表达式节点的组织方式是类似语法树的样子，也就是说And节点下面的互相之间是And关系，最终的结果总是可以在Condition Expression一栏看到：

( NativeName Equal 'IComparable' ) And ( TypeKind Equal 'Interface')

当编辑好了规则的时候，我们需要指定对应的具体动作的参数。因为我们需要修改对象类型的名称，双击Action下面的NewName子结点会弹出如下对话框：

[![clip\_image010][clip_image010]][clip_image010_clip_image010]

输入我们想修改成的名字，然后点击OK。

这样一个规则就完成了：

[![clip\_image012][clip_image012]][clip_image012_clip_image012]

修改完毕之后存盘为ChangeInterfaceName.xml，然后在命令行下面调用TlbImp，使用/config参数引用之前存盘的Config文件（黄色加亮部分：

[![clip\_image014][clip_image014]][clip_image014_clip_image014]

之后通过ILDASM打开我们生成的结果：

[![clip\_image016][clip_image016]][clip_image016_clip_image016]

可以看到IComparable已经被改名成了IMyInterface。

TlbImp总共支持下面几种动作（Action）：

1. ChangeManagedName：修改类型、函数的名称

2. ResolveTo：将一个类型替换为另外一个类型（可以是另外一个程序集的类型）。现在已经有用户在CodePlex上面提出这个功能需求了：[http://clrinterop.codeplex.com/WorkItem/View.aspx?WorkItemId=2565][http_clrinterop.codeplex.com_WorkItem_View.aspx_WorkItemId_2565]

3. AddAttribute：为任意类型添加任意Attribute

4. PreserveSig：为单个函数或者类型中的所有函数添加PreserveSigAttribute并相应修改函数的原型

5. ConvertTo：修改函数中的参数类型

每种对应的动作在Samples目录下面都有对应的例子，有兴趣的朋友可以参照文档自行实验。

**回归测试工具**

为了帮助用户在修改TlbImp代码的时候可以更容易保证自己的修改不会引起其他问题，我们引入了一个简单的回归测试工具，大家可以到这里下载：

[http://clrinterop.codeplex.com/Release/ProjectReleases.aspx?ReleaseId=17579][http_clrinterop.codeplex.com_Release_ProjectReleases.aspx_ReleaseId_17579]

下载完毕之后打开Bin目录下面的TlbImpRegressionTestTool.exe，然后通过File菜单打开Testcase目录下面的testcases.xml文件：

[![clip\_image018][clip_image018]][clip_image018_clip_image018]

可以看到所有的Testcase都被列出来了。下一步在Run菜单里面选择Settings，输入TlbImp2.exe和WinDiff.exe所在位置：

[![clip\_image020][clip_image020]][clip_image020_clip_image020]

完毕之后，选择Run下面的Run All Testcases或者Run Selected Testcases，该工具便会调用TlbImp2.exe依次运行Testcase来检查TlbImp2的相应功能是否正确：

[![clip\_image022][clip_image022]][clip_image022_clip_image022]

绿色为测试成功，红色为失败。如果有失败的情况，双击该行可以打开WinDiff比较TlbImp2当前生成的结果和应该生成的结果之间的区别。

最后，希望大家能够积极试用TlbImp的新功能。如果有希望看到的TlbImp的新功能，或者对目前的TlbImp有哪些觉得做的不够好的地方，都可以到下面的地址提出你的宝贵意见: [http://clrinterop.codeplex.com/WorkItem/List.aspx][http_clrinterop.codeplex.com_WorkItem_List.aspx]

[http_www.codeplex.com_clrinterop_Release_ProjectReleases.aspx_ReleaseId_17579]: http://www.codeplex.com/clrinterop/Release/ProjectReleases.aspx?ReleaseId=17579
[clip_image002]: https://p-blog.csdn.net/images/p_blog_csdn_net/silverlightshanghai/523409/o_clip_image002_thumb.jpg
[clip_image002_clip_image002]: /images/20220810/7219c8597db949fe99ae97b8caa77189.png
[clip_image004]: https://p-blog.csdn.net/images/p_blog_csdn_net/silverlightshanghai/523409/o_clip_image004_thumb.jpg
[clip_image004_clip_image004]: /images/20220810/6fc1934f1b0c4a41b948ae2bd1a8c00b.png
[clip_image006]: https://p-blog.csdn.net/images/p_blog_csdn_net/silverlightshanghai/523409/o_clip_image006_thumb.jpg
[clip_image006_clip_image006]: /images/20220810/bc0ae32fd57c4300a033b4eaeb2888db.png
[clip_image008]: https://p-blog.csdn.net/images/p_blog_csdn_net/silverlightshanghai/523409/o_clip_image008_thumb.jpg
[clip_image008_clip_image008]: /images/20220810/11289239431c4f59a8737111bbed270e.png
[clip_image010]: https://p-blog.csdn.net/images/p_blog_csdn_net/silverlightshanghai/523409/o_clip_image010_thumb.jpg
[clip_image010_clip_image010]: /images/20220810/78ea6652b97d4e4cb442db35b12ebb43.png
[clip_image012]: https://p-blog.csdn.net/images/p_blog_csdn_net/silverlightshanghai/523409/o_clip_image012_thumb.jpg
[clip_image012_clip_image012]: /images/20220810/ed4c056098854c07b378280f8ebfc09a.png
[clip_image014]: https://p-blog.csdn.net/images/p_blog_csdn_net/silverlightshanghai/523409/o_clip_image014_thumb.jpg
[clip_image014_clip_image014]: /images/20220810/15714a7eb892471a8f9e3b52c9566ed2.png
[clip_image016]: https://p-blog.csdn.net/images/p_blog_csdn_net/silverlightshanghai/523409/o_clip_image016_thumb.jpg
[clip_image016_clip_image016]: /images/20220810/8033e74a89104963bf47c77ddcaf0c68.png
[http_clrinterop.codeplex.com_WorkItem_View.aspx_WorkItemId_2565]: http://clrinterop.codeplex.com/WorkItem/View.aspx?WorkItemId=2565
[http_clrinterop.codeplex.com_Release_ProjectReleases.aspx_ReleaseId_17579]: http://clrinterop.codeplex.com/Release/ProjectReleases.aspx?ReleaseId=17579
[clip_image018]: https://p-blog.csdn.net/images/p_blog_csdn_net/silverlightshanghai/523409/o_clip_image018_thumb.jpg
[clip_image018_clip_image018]: /images/20220810/2cd67a146775415a9e220daaf5a33bb5.png
[clip_image020]: https://p-blog.csdn.net/images/p_blog_csdn_net/silverlightshanghai/523409/o_clip_image020_thumb.jpg
[clip_image020_clip_image020]: /images/20220810/dfc8e9361984474bba71b1eda5faa837.png
[clip_image022]: https://p-blog.csdn.net/images/p_blog_csdn_net/silverlightshanghai/523409/o_clip_image022_thumb.jpg
[clip_image022_clip_image022]: /images/20220810/d2c947858c3d476981b6896439d5f555.png
[http_clrinterop.codeplex.com_WorkItem_List.aspx]: http://clrinterop.codeplex.com/WorkItem/List.aspx