天天看点

Visual Studio Package 插件开发(Visual Studio SDK)

  这段时间公司新做了一个支付系统,里面有N个后台服务,每次有更新修改,拷贝打包发布包“不亦乐乎”。。。于是我想要不要自己定制个打包插件。

  部分朋友可能会认为,有现成的可以去找一个,干嘛不用持续集成工具啊。

  1、公司没用,也不打算用

  2、自己想折腾下,好奇

  因此主要是分享这次的学习过程和结果。

  大概构想下,选择需要打包的项目-重新编译-拷贝生成文件到指定目录-OK,剩下就是交给测试去做了。

  1、Visual Studio Package 初步使用

  2、.Net 执行Dos命令

  3、MSBuild简单运用

  4、File.Copy的使用

  Visual Studio 2013 SDK包的下载地址:http://www.microsoft.com/en-us/download/details.aspx?id=40758&fa43d42b-25b5-4a42-fe9b-1634f450f5ee=True

  完毕后,在新建项目-C#-扩展性,可以见到Visual Studio Package模板选项(见下图)

  

Visual Studio Package 插件开发(Visual Studio SDK)
Visual Studio Package 插件开发(Visual Studio SDK)
Visual Studio Package 插件开发(Visual Studio SDK)

  下一步,勾选Menu Command;下一步,修改Command Name;下一步,取消单元测试,Finish。恭喜,您的第一个插件程序就这么诞生了。

  编译后,到生成目录下,执行.vsix文件,安装完后,重启VS,点击[工具]就会见到您的插件工具。同时你也可以在扩展与更新界面进行对您的插件进行卸载。

Visual Studio Package 插件开发(Visual Studio SDK)
Visual Studio Package 插件开发(Visual Studio SDK)

  初建项目,有很多文件,有几个下面是需要了解一下的。

  1、PackingTools.vsct

  2、PackingToolsPackage.cs

  3、source.extension.vsixmanifest

     vsct是个Xml文件,它用来对插件按钮进行配置的。

     Group是组节点,项目初建,它的Parent为IDM_VS_MENU_TOOLS,对于这个我们可以查看  您的vs安装目录\Visual Studio2013\VSSDK\VisualStudioIntegration\Common\Inc\vsshlids.h,打开文件,我们可以看到除IDM_VS_MENU_TOOLS以外还有IDM_VS_MENU_ADDINS、IDM_VS_MENU_HELP等等,我们尝试改成IDM_VS_MENU_HELP。

      Buttons节点下,可以添加多个Button信息,我们尝试添加一个Button进去,同时GuidSymbol加多一个IDSymbol进去。修改对应新按钮的id 和 priority。

      

Visual Studio Package 插件开发(Visual Studio SDK)

      我们启动F5,调试看看,插件按钮位置变了,也是我们第一次修改了按钮布局。

Visual Studio Package 插件开发(Visual Studio SDK)

      插件程序的入口,我们细看代码,发现在Initialize方法里,就对批量打包这个按钮进行事件绑定,我们尝试一下,把MenuItemCallback里的逻辑删了,展示一个wpf窗体出来。

      添加新建项-添加wpf窗体后,需要在项目里新引用一个System.Xaml.dll才能编译通过。

      接着,我们在PackingToolsPackage.cs的MenuItemCallback的方法里写new MainWindow().Show(),F5运行->点击批量打包,则会弹出下图。

Visual Studio Package 插件开发(Visual Studio SDK)

      主界面就这么出来了,当然,你可以单例一个窗体,不用new。。。 

      对Visual Studio 扩展的配置,如:文件模板,项目工程模板,依赖程序集,Visual Studio 工具包logo,VS安装的版本等等。

  这个其实并没什么特别难的逻辑,只是开始找资料花了一些时间,直接上代码。

Visual Studio Package 插件开发(Visual Studio SDK)
Visual Studio Package 插件开发(Visual Studio SDK)

View Code

  对于IVsSolution这个接口的命名空间下,还有各种各样的类,对Visual Studio Package开发有兴趣的同学可以去看看。传送门

  Microsoft Build Engine 是MSBuild的全称,是一个独立的存在生成平台,不需要依赖vs,但是vs的生成、发布等等功能都是基于MSBuild去构建的,它能读取.sln、.csproj、.pubxml等xml文件里的参数进行生成解决和项目。这里就不做过多的介绍和深入,有需要可以点击这里进行查看文档

  MSBuild.exe在C:\Windows\Microsoft.NET\Framework\v4.0.30319 这个路径下,值得注意的是Framework 的位数和版本,这个影响选择MSBuild.exe的路径。

  尝试一下,打开cmd,输入-> C:\Windows\Microsoft.NET\Framework\v4.0.30319 "您的项目文件路径" /t:Rebuild /p:Configuration=Release /p:VisualStudioVersion=12.0

Visual Studio Package 插件开发(Visual Studio SDK)

  这句话指,用msbuild重新生成Release版本,注意项目路径是有双引号的。

  然而,我们需要在.net程序里使用这段dos指令,因此我们写编写一个dos指令帮助类

Visual Studio Package 插件开发(Visual Studio SDK)
Visual Studio Package 插件开发(Visual Studio SDK)

  从上面我们已经读取到了解决方案对应的项目信息,包括路径,新建的项目默认生成到.csproj文件目录下的bin/Release里。

  我们利用Path.GetDirectoryName和Path.Combine方法,获取对应路径,再自己编写文件操作帮助类,对应Release里的文件复制到指定位置。

Visual Studio Package 插件开发(Visual Studio SDK)
Visual Studio Package 插件开发(Visual Studio SDK)

  最后我们只需要完善发布按钮事件,获取列表选择项->获取打包到的指定路径->遍历列表项数据->执行MSBuild指令->复制文件到指定路径->完毕

Visual Studio Package 插件开发(Visual Studio SDK)
Visual Studio Package 插件开发(Visual Studio SDK)

  源码我这里没有提供,还是希望读了这篇文章感兴趣的小伙伴动手折腾下,Visual Studio Package还可以做模版开发等等,我也没太多的去深入了解,感兴趣的可以去google一下关键字Visual Studio Package、vssdk、vsix、插件开发。

  以上纯属自己初步折腾的结果,为了写文章弄出来的简单demo,还有很多可优化的地方,例如各种验证判断,插件按钮的动态显示、读取项目的类型过滤、web项目的发布,文件过滤复制等等。。。。

  本篇文章有什么写错的或者更好的建议麻烦大家在评论写给我,我会一一补充修改。如果对大家有帮助,还希望推荐一下,谢谢。

作  者:

陈珙

出  处:http://www.cnblogs.com/skychen1218/

关于作者:专注于微软平台的项目开发。如有问题或建议,请多多赐教!

版权声明:本文版权归作者和博客园共有,欢迎转载,但未经作者同意必须保留此段声明,且在文章页面明显位置给出原文链接。

声援博主:如果您觉得文章对您有帮助,可以点击文章右下角推荐一下。您的鼓励是作者坚持原创和持续写作的最大动力!