使用 ProcessStartInfo 和 Process 类进行外部工具插件开发

下载源代码

引言

在本文中，我们将展示如何利用 System.Diagnostics 命名空间中的 ProcessStartInfo 和 Process 类为 PragmaSQL 编辑器开发一个非常常见的实用工具。

PragmaSQL T-SQL 编辑器具有非常广泛的插件支持。本文介绍的外部工具插件有两个目标：

1- 作为 PragmaSQL 插件开发的示例。
2- 提供所有开发 IDE 和编辑器中包含的非常常见的功能。

IC#Code 插件架构概述

PragmaSQL 使用 IC#Code 的插件架构。该架构提供了
出色的功能，使我们能够轻松地为应用程序开发插件，从而
使我们的应用程序具有可扩展性。IC#Code 插件架构提供了

1- 通过 .addin 文件进行简单而整洁的 XML 插件定义
2- 加载插件程序集
3- 通过宿主应用程序的菜单和工具栏公开插件功能
4- 以及许多实用服务，如 MenuService 和 MessageService

有关架构的详细信息，请参阅 SODA - SharpDevelop Open Development Architecture by Mike Krueger

PragmaSQL 服务概述

PragmaSQL 通过核心库向插件开发者公开了许多内置的宿主功能。
公开的功能包括

1- 宿主选项
2- 编辑器服务：访问 T-SQL 脚本编辑器和文本编辑器
3- 对象浏览器服务：访问数据库对象浏览器
4- 项目浏览器服务
5- 共享脚本和代码片段
6- 内部网络浏览器
7- 文本差异服务
8- 代码完成列表
9- 应用程序消息服务

所有这些服务的入口点是 HostServicesSingleton，顾名思义，这个类是一个单例。

PragmaSQL.ExternalTools 中的 HostServicesSingleton 用法示例

下面提供的示例代码展示了

1) 如何使用应用程序消息服务将消息打印到宿主应用程序消息窗口。
2) 使用 HostServices EvalMacro 函数评估宏并准备工具参数

private void process_Exited(object sender, EventArgs e)
{
    Process p = sender as Process;
    if (p == null)
        return;

    long handle = p.Handle.ToInt64();
    if (!_runningToolDefs.ContainsKey(handle))
        return;

    try
    {
        ExternalToolDef def = _runningToolDefs[handle];
        
        //Here we clear application messages window



        if (chkClearOutput.Checked)
            HostServicesSingleton.HostServices.MsgService.ClearMessages();

        bool shallShow = false;

        while (p.StandardOutput.Peek() > -1)
        {
            string info = p.StandardOutput.ReadLine();
            if (!String.IsNullOrEmpty(info))
            {
                // Print info message to Applicatin Messages Window



                HostServicesSingleton.HostServices.MsgService.InfoMsg(info, "Tool : " + def.Title, String.Empty, String.Empty);
                shallShow = true;
            }
        }

        while (p.StandardError.Peek() > -1)
        {
            string error = p.StandardError.ReadLine();
            if (!String.IsNullOrEmpty(error))
            {
                // Print error message to Applicatin Messages Window



                HostServicesSingleton.HostServices.MsgService.ErrorMsg(error, "Tool : " + def.Title, String.Empty, String.Empty);
                shallShow = true;
            }
        }

        if (shallShow == true)
            HostServicesSingleton.HostServices.MsgService.ShowMessages();
    }
    finally
    {
        _runningToolDefs.Remove(handle);
    }
}




private void RenderExternalToolDef(ExternalToolDef exDef)
{
    tbCmd.Text = String.Empty;
    tbArgs.Text = String.Empty;
    tbWorkingDir.Text = String.Empty;
    
    if (exDef == null)
        return;
        
    tbCmd.Text = exDef.Command;
    // Here we prepare arguments by evaluating macros



    tbArgs.Text = HostServicesSingleton.HostServices.EvalMacro(exDef.Args);
    tbWorkingDir.Text = exDef.WorkingDir; 
}

        

注意：为了开发 PragmaSQL 插件，您需要获取 PragmaSQL.Core.dll。所有宿主功能
和许多实用程序类都托管在此程序集中。从此处下载

PragmaSQL.ExternalTools

插件定义

<AddIn name        = "External Tools AddIn for PragmaSQL"
       author      = "Ali Özgür"
       description = "Enables you to define external tools for PragmaSQL">
    <Manifest>
        <Identity name = "PragmaSQL.ExternalTools"/>
    </Manifest>

    <Runtime>
        <Import assembly="PragmaSQL.ExternalTools.dll"/>
    </Runtime>

    <Path name = "/Workspace/ToolsMenu">
        <MenuItem id = "ExtTools.Configure"
                         label = "External Tools..."
                         class ="PragmaSQL.ExternalTools.ConfigureTools"/>
        <MenuItem id = "ExtTools.Run"
                         label = "Run External Tool"
                         shortcut     = "Control|Shift|E"
                         class ="PragmaSQL.ExternalTools.RunExternalTool"/>
    </Path>
</AddIn>

在上面的插件定义文件中，我们提供了插件的描述以及插件如何集成到 PragmaSQL。
此插件定义中最重要的部分是 Path 标签。我们提供了预定义的宿主路径以及我们希望为插件创建的 MenuItems
我们希望为我们的插件创建的菜单项。

另一个非常重要的标签是 Class。IC#Code 插件架构使用命令模式。
我们通过此标签使用 Command 类定义与指定菜单/工具栏项目关联的命令。
在上面的示例中，对于 External Tools... 菜单项，您可以看到我们希望调用 PragmaSQL.ExternalTools.ConfigureTools 命令。
ConfigureTools 命令类继承自 AbstractMenuCommand 并具有 Run() 方法。

注意：预定义的宿主路径可以在 PragmaSQL 安装附带的 Base.addin 文件中找到。

ExternalTools 插件特定类

private void RunTool()
{
    if (CurrentDef == null)
        return;

    ProcessStartInfo psi = new System.Diagnostics.ProcessStartInfo();
    tbArgs.Text = HostServicesSingleton.HostServices.EvalMacro(CurrentDef.Args);
    psi.FileName = CurrentDef.Command;
    psi.Arguments = tbArgs.Text;
    psi.WorkingDirectory = CurrentDef.WorkingDir;
    psi.RedirectStandardOutput = CurrentDef.UseOuput;
    psi.RedirectStandardError = CurrentDef.UseOuput;
    psi.CreateNoWindow = CurrentDef.UseOuput;
    psi.UseShellExecute = !CurrentDef.UseOuput;
    
    Process p = new Process();
    p.EnableRaisingEvents = CurrentDef.UseOuput;
    if (CurrentDef.UseOuput)
        p.Exited += new EventHandler(p_Exited);
    
    p.StartInfo = psi;
    p.Start();

    if (CurrentDef.UseOuput)
        _runningToolDefs.Add(p.Handle.ToInt64(), CurrentDef);
}