运行操作的标准执行过程主要通过以下步骤:
- 用户选择一个运行配置 (例如,从运行配置下拉框中选择)或一个执行器 (例如,点击执行器创建的工具栏按钮);
- 通过轮询所有已注册的程序运行器并询问它们是否可以使用指定的执行器ID运行指定的运行配置,来选择将实际执行该进程的程序运行器;
- 创建
ExecutionEnvironment
对象。这个对象会合并所有执行进程和所选ProgramRunner
所需的设置; - 调用
ProgramRunner.execute()
,接收执行程序和执行环境。
ProgramRunner.execute()
的实现通过以下步骤来执行进程:
- 调用
RunProfile.getState()
方法创建RunProfileState
对象,它用来描述即将启动的进程。在这个阶段,启动进程所需的命令行参数,环境变量和其它信息被初始化; - 调用
RunProfileState.execute()
。它启动进程,附加ProcessHandler
到其输入输出流,创建控制台显示进程输出并返回合并控制台和进程处理程序的ExecutionResult
对象; - 创建
RunContentBuilder
对象并在运行或调试工具窗口的一个选项卡中显示执行控制台。
执行器
Executor
接口描述了执行任何可能的运行配置的特定方法。
IntelliJ平台 提供的三个默认执行器是Run,Debug和Run with Coverage。 每个执行器都有自己的工具栏按钮,它使用此执行器启动所选的运行配置,并使用自己的启动配置的上下文菜单项。
作为插件开发者,你一般不必实现Executor
接口。但是它可能是有用的,例如你正在实现整合profiler和想提供执行任何分析配置的可能性。
运行进程
RunProfileState
接口作为RunProfile.getState()
的返回值出现在每个运行配置的实现中。它描述了一个准备启动的进程,保存启动进程的命令行,当前工作目录和环境变量等信息(RunProfileState
的存在使得执行流程允许运行配置扩展和其他修补配置的组件并在执行之前修改参数)。
实现RunProfileState
的标准基类是CommandLineState
。它包含将运行的进程和控制台放在ExecutionResult
中的逻辑,但不知道进程实际是如何启动的。对于启动进程,最好使用GeneralCommandLine
类,它负责设置命令行参数和执行进程。
如果你需要运行的进程是基于JVM的,则可以使用JavaCommandLineState
基类。 它知道JVM的命令行参数,并处理一些细节,如计算JVM的类路径。
为了监视进程的执行和捕获输出,通常使用OSProcessHandler
类。从命令行或进程对象创建了OSProcessHandler
实例后,你需要调用startNotify()
方法启动捕获输出。 你还可能要将ProcessTerminatedListener
附加到OSProcessHandler
以便该进程的退出状态能显示在控制台中。
显示进程输出
如果你正在使用CommandLineState
,控制台视图将会自动创建并附加到进程输出。你也可以自己安排:
-
TextConsoleBuilderFactory.createBuilder(project).getConsole()
创建ConsoleView
实例; -
ConsoleView.attachToProcess()
将其附加到进程输出。
如果正在运行的进程使用ANSI转义代码对其输出进行着色,ColoredProcessHandler
类将解析它并在IntelliJ控制台中显示颜色。
控制台Filter
允许你转换进程输出中的某些字符串为超链接。要将过滤器附加到控制台可以使用CommandLineState.addConsoleFilters()
,如果你是手动创建控制台就使用TextConsoleBuilder.addFilter()
。
你可能想要重用的两个常见过滤器实现是RegexpFilter
和UrlFilter
。
从代码中启动运行配置
如果你有一个想要执行的现有运行配置,最简单的方式是使用ProgramRunnerUtil.executeConfiguration()
。这个方法需要的参数分别为Project
,RunnerAndConfigurationSettings
和Executor
。要获取现有配置的RunnerAndConfigurationSettings
,你可以使用RunManager.getConfigurationSettings(ConfigurationType)
。最后一个参数通常通过DefaultRunExecutor.getRunExecutorInstance()
或DefaultDebugExecutor.getDebugExecutorInstance()
。