Visual Studio是美国微软公司开发的一个基本完整的开发工具集，它包括了整个软件生命周期中所需要的大部分工具，如UML工具、代码管控工具、集成开发环境(IDE)等等,且所写的目标代码适用于微软支持的所有平台.可以说.NET开发人员离不开它,它可以极大的提高编写软件的效率. Visual Studio作为一个世界级开发工具,当然支持通过插件方式对其功能进行扩展,开发人员可以定制自己的插件来进一步提升Visual Studio的功能.
1 什么是Add In?
所谓的add-in就是一些被Visual Studio加载到内存中运行的,能给用户提供特定功能的DLL动态链接库. 对于一般的开发情景来说,最常见的add-in用法就是可以通过.NET语言访问 DTE2 对象. DTE2是Visual Studio Automation Model的顶层对象,它具有一组接口和对象可以与 Visual Studio进行交互.DTE2可以做以下这些事情:
- 访问和调用Visual Studio内置的函数和对象
- 执行编译
- 遍历解决方案中的项目
- 在Visual Studio IDE中定制UI
- 扩展Visual Studio功能...
2 创建VS Add In项目
用Visual Studio 2012创建名为MyVisualStudioAddin的项目(根据向导进行设置,这里不赘述),界面如下:
3 核心 Connect 类
插件入口就是Connect 类,先看一下Connect的类图:
- Connect 实现外接程序对象的构造函数。请将您的初始化代码置于此方法内。
- OnConnection 实现 IDTExtensibility2 接口的 OnConnection 方法。接收正在加载外接程序的通知。
- OnDisconnection 实现 IDTExtensibility2 接口的 OnDisconnection 方法。接收正在卸载外接程序的通知。
- OnAddInsUpdate 实现 IDTExtensibility2 接口的 OnAddInsUpdate 方法。当外接程序集合已发生更改时接收通知。
- OnStartupComplete 实现 IDTExtensibility2 接口的 OnStartupComplete 方法。接收宿主应用程序已完成加载的通知。
- OnBeginShutdown 实现 IDTExtensibility2 接口的 OnBeginShutdown 方法。接收正在卸载宿主应用程序的通知。
- QueryStatus 实现 IDTCommandTarget 接口的 QueryStatus 方法。此方法在更新该命令的可用性时调用。
- Exec 实现 IDTCommandTarget 接口的 Exec 方法。此方法在调用该命令时调用。
- _applicationObject 是DTE2实例,是宿主应用程序的根对象。
- _addInInstance是当前插件实例,表示此外接程序的对象。
首先定义一些内部的对象,主要是自定义的命令,如下所示:
1 ///
初始化插件UI的代码:
1 public void OnConnection(object application, ext_ConnectMode connectMode, object addInInst, ref Array custom)
2 {
3
4 _applicationObject = (DTE2)application;
5 _addInInstance = (AddIn)addInInst;
6
7
8 if (connectMode == ext_ConnectMode.ext_cm_UISetup)
9 {
10 object[] contextGUIDS = new object[] { };
11 Commands2 commands = (Commands2)_applicationObject.Commands;
12 string toolsMenuName = "Tools";
13
14 //将此命令置于“工具”菜单上。
15 //查找 MenuBar 命令栏，该命令栏是容纳所有主菜单项的顶级命令栏:
16 Microsoft.VisualStudio.CommandBars.CommandBar menuBarCommandBar = ((Microsoft.VisualStudio.CommandBars.CommandBars)_applicationObject.CommandBars)["MenuBar"];
17
18 //在 MenuBar 命令栏上查找“工具”命令栏:
19 CommandBarControl toolsControl = menuBarCommandBar.Controls[toolsMenuName];
20 CommandBarPopup toolsPopup = (CommandBarPopup)toolsControl;
21
22 //如果希望添加多个由您的外接程序处理的命令，可以重复此 try/catch 块，
23 // 只需确保更新 QueryStatus/Exec 方法，使其包含新的命令名。
24 try
25 {
26 //将一个命令添加到 Commands 集合:
27 Command command = commands.AddNamedCommand2(_addInInstance, "MyVisualStudioAddin", "MyVS外接程序", "Executes the command for MyVisualStudioAddin", true, 59, ref contextGUIDS, (int)vsCommandStatus.vsCommandStatusSupported + (int)vsCommandStatus.vsCommandStatusEnabled, (int)vsCommandStyle.vsCommandStylePictAndText, vsCommandControlType.vsCommandControlTypeButton);
28
29 //将对应于该命令的控件添加到“工具”菜单:
30 if ((command != null) && (toolsPopup != null))
31 {
32 command.AddControl(toolsPopup.CommandBar, 1);
33 }
34 }
35 catch (System.ArgumentException)
36 {
37 //如果出现此异常，原因很可能是由于具有该名称的命令
38 // 已存在。如果确实如此，则无需重新创建此命令，并且
39 // 可以放心忽略此异常。
40 }
41
42
43
44 bool logtoOutputWindow = System.Diagnostics.Debugger.IsAttached;
45 logger = new AddInLogger((DTE)_applicationObject, "MyVisualStudioAddin", logtoOutputWindow);
46 logger.LogMessage(string.Format("OnConnection() called with connectMode: '{0}'", connectMode));
47 try
48 {
49 switch (connectMode)
50 {
51 case ext_ConnectMode.ext_cm_UISetup:
52 // We should never get here, this is temporary UI
53 AddAddInUI();
54 break;
55
56 case ext_ConnectMode.ext_cm_Startup:
57 // The add-in was marked to load on startup
58 AddAddInUI();
59 break;
60
61 case ext_ConnectMode.ext_cm_AfterStartup:
62 // The add-in was loaded by hand after startup using the Add-In Manager
63 // Initialize it in the same way that when is loaded on startup
64 AddAddInUI();
65 break;
66 }
67 }
68 catch (Exception ex)
69 {
70 logger.LogError(ex.ToString());
71 }
72
73
74 }
75 }
1 ///
1 public void QueryStatus(string commandName, vsCommandStatusTextWanted neededText, ref vsCommandStatus status, ref object commandText)
2 {
3 try
4 {
5 if (neededText == vsCommandStatusTextWanted.vsCommandStatusTextWantedNone)
6 {
7 if (commandName == "MyVisualStudioAddin.Connect.MyVisualStudioAddin")
8 {
9 status = (vsCommandStatus)vsCommandStatus.vsCommandStatusSupported | vsCommandStatus.vsCommandStatusEnabled;
10 return;
11 }
12
13 if (commandName == string.Format("MyVisualStudioAddin.Connect.{0}", MY_COMMAND_FindInSolutionExplorer))
14 {
15 Solution solution = _applicationObject.Solution;
16 status = (vsCommandStatus)vsCommandStatus.vsCommandStatusSupported | vsCommandStatus.vsCommandStatusEnabled;
17 return;
18 }
19 if (commandName == string.Format("MyVisualStudioAddin.Connect.{0}", MY_COMMAND_CodeWindow))
20 {
21 Solution solution = _applicationObject.Solution;
22 status = (vsCommandStatus)vsCommandStatus.vsCommandStatusSupported | vsCommandStatus.vsCommandStatusEnabled;
23 return;
24 }
25 if (commandName == string.Format("MyVisualStudioAddin.Connect.{0}", MY_COMMAND_MenuBar))
26 {
27 Solution solution = _applicationObject.Solution;
28 status = (vsCommandStatus)vsCommandStatus.vsCommandStatusSupported | vsCommandStatus.vsCommandStatusEnabled;
29 return;
30 }
31 if (commandName == string.Format("MyVisualStudioAddin.Connect.{0}", MY_COMMAND_Project))
32 {
33 Solution solution = _applicationObject.Solution;
34 status = (vsCommandStatus)vsCommandStatus.vsCommandStatusSupported | vsCommandStatus.vsCommandStatusEnabled;
35 return;
36 }
37 if (commandName == string.Format("MyVisualStudioAddin.Connect.{0}", MY_COMMAND_Solution))
38 {
39 Solution solution = _applicationObject.Solution;
40 status = (vsCommandStatus)vsCommandStatus.vsCommandStatusSupported | vsCommandStatus.vsCommandStatusEnabled;
41 return;
42 }
43 if (commandName == string.Format("MyVisualStudioAddin.Connect.{0}", MY_COMMAND_Files))
44 {
45 Solution solution = _applicationObject.Solution;
46 status = (vsCommandStatus)vsCommandStatus.vsCommandStatusSupported | vsCommandStatus.vsCommandStatusEnabled;
47 return;
48 }
49 }
50 }
51 catch (Exception ex)
52 {
53 logger.LogError(ex.ToString());
54 }
55 }
1 public void Exec(string commandName, vsCommandExecOption executeOption, ref object varIn, ref object varOut, ref bool handled)
2 {
3 try
4 {
5 handled = false;
6 if (executeOption == vsCommandExecOption.vsCommandExecOptionDoDefault)
7 {
8 //命名空间.Connect.命名
9 if (commandName == string.Format("MyVisualStudioAddin.Connect.{0}", MY_COMMAND_FindInSolutionExplorer))
10 {
11 FindCurrentActiveDocumentInSolutionExplorer();
12 handled = true;
13 return;
14 }
15 if (commandName == string.Format("MyVisualStudioAddin.Connect.{0}", MY_COMMAND_CodeWindow))
16 {
17 string fullpath = this.GetActiveProjectFullPath();
18 if (fullpath != "")
19 {
20 POCOGenerator.ConnectionForm frm = new POCOGenerator.ConnectionForm(fullpath);
21 frm.Show();
22 }
23 handled = true;
24 return;
25 }
26 if (commandName == string.Format("MyVisualStudioAddin.Connect.{0}", MY_COMMAND_MenuBar))
27 {
28 string fullpath = this.GetActiveProjectFullPath();
29 if (fullpath != "")
30 {
31 POCOGenerator.ConnectionForm frm = new POCOGenerator.ConnectionForm(fullpath);
32 frm.Show();
33 }
34 handled = true;
35 return;
36 }
37 if (commandName == string.Format("MyVisualStudioAddin.Connect.{0}", MY_COMMAND_Project))
38 {
39 string fullpath = this.GetActiveProjectFullPath();
40 if (fullpath != "")
41 {
42 POCOGenerator.ConnectionForm frm = new POCOGenerator.ConnectionForm(fullpath);
43 frm.Show();
44 }
45
46 handled = true;
47 return;
48 }
49 if (commandName == string.Format("MyVisualStudioAddin.Connect.{0}", MY_COMMAND_Solution))
50 {
51 string fullpath = this.GetActiveProjectFullPath();
52 if (fullpath != "")
53 {
54 POCOGenerator.ConnectionForm frm = new POCOGenerator.ConnectionForm(fullpath);
55 frm.Show();
56 }
57 handled = true;
58 return;
59 }
60 if (commandName == string.Format("MyVisualStudioAddin.Connect.{0}", MY_COMMAND_Files))
61 {
62 string fullpath = this.GetActiveProjectFullPath();
63 if (fullpath != "")
64 {
65 POCOGenerator.ConnectionForm frm = new POCOGenerator.ConnectionForm(fullpath);
66 frm.Show();
67 }
68 handled = true;
69 return;
70 }
71
72 if (commandName == "MyVisualStudioAddin.Connect.MyVisualStudioAddin")
73 {
74 string fullpath = this.GetActiveProjectFullPath();
75 if (fullpath != "")
76 {
77 POCOGenerator.ConnectionForm frm = new POCOGenerator.ConnectionForm(fullpath);
78 frm.Show();
79 }
80 handled = true;
81 return;
82 }
83
84
85 }
86 }
87 catch (Exception ex)
88 {
89 logger.LogError(ex.ToString());
90 }
91
92 }
获取当前IDE激活项目的路径:
1 ///
关于如何根据数据库结构生成C# Code代码,可以参加此文章.
4 插件发布
创建了外接程序后，必须先向 Visual Studio 注册此外接程序，然后才能在“外接程序管理器”中激活它。 使用具有 .addin 文件扩展名的 XML 文件来完成此操作。.addin 文件描述了 Visual Studio 在“外接程序管理器”中显示外接程序所需的信息。 在 Visual Studio 启动时，它会查找 .addin 文件位置，获取任何可用的 .addin 文件。 如果找到相应文件，则会读取 XML 文件并向“外接程序管理器”提供在单击外接程序进行启动时所需的信息。使用外接程序向导创建外接程序时，会自动创建一个 .addin 文件。 你也可以使用本主题中的信息手动创建 .addin 文件。我是用Visual Studio2012 所以将.addin文件和对应的dll拷贝到C:\Users\wangming\Documents\Visual Studio 2012\Addins文件下:
如果发布没有错误,那么重新启动Visual Studio2012后,在项目文件上右击弹出菜单,可以看到下面的界面:
同时在菜单栏创建了一个JackWang的命令按钮和工具菜单下还添加了一个MyVS外接程序的命令按钮,如下图:
5 代码生成器
代码生成器(此处用的是可以根据用户选择的数据库,选择对应的表,然后生成表结构对应的C#类:
6 插件卸载
如果自己定义的插件想卸载怎么办?可参见https://msdn.microsoft.com/en-us/library/ms228765.aspx.
-
删除插件对应的.addin文件. 默认路径为..\Users\username\My Documents\Visual Studio 2012\Addins\(请根据实际情况查看具体路径)
-
在 Visual Studio开发人员命令行中, 输入devenv /resetaddin MyVisualStudioAddin.Connect 进行卸载(MyVisualStudioAddin.Connect 是MyVisualStudioAddin.AddIn文件中的FullClassName;
-
至此, add-in 不会出现在IDE中,卸载完成. 但是要完整去除必须手动删除插件对应的项目文件(如果你再次调试,可能会再次进行注册);
7 总结
通过插件机制可以方便的定制VS IDE, 一般软件公司都有自己的一套框架,其代码也有一定的封装,且各不相同,可以通过扩展VS,通过定制的代码生成工具来快速生成符合本公司所需的代码,从而从重复机械的劳动中解放出来(虽然完全自动生成的代码不可能直接能用,但是人工在此基础上进行调整,也提升了代码的编写效率,而且减少类似于拼写/标点等人为的错误点等.
虽然我们不生产代码,是代码的搬运工,但是正确的打开方式是用代码去帮我们搬运代码!!!