Java-API简析_java.lang.ProcessBuilder类（基于 Latest JDK）（浅析源码）

【版权声明】未经博主同意，谢绝转载！（请尊重原创，博主保留追究权）
https://blog.csdn.net/m0_69908381/article/details/131729933
出自【进步*于辰的博客】

注：依赖类：Process。

1、概述

继承关系：

• java.lang.Object
  • java.lang.ProcessBuilder

---

public final class ProcessBuilder extends Object

此类用于创建操作系统进程。

每个 ProcessBuilder 实例管理一个进程属性集。start() 方法利用这些属性创建一个新的 Process 实例。start() 方法可以从同一实例重复调用，以利用相同的或相关的属性创建新的子进程。

每个进程生成器管理这些进程属性：

• $命令$是一个字符串列表，它表示要调用的外部程序文件 及其 参数（如果有）。在此，表示有效的操作系统命令的字符串列表是依赖于系统的。例如，每一个总体变量，通常都要成为此列表中的元素，但有一些操作系统，希望程序能自己标记命令行字符串——在这种系统中，Java 实现可能需要命令确切地包含这两个元素。
• $环境$是从变量 到 值 的依赖于系统的映射。初始值是当前进程环境的一个副本（请参阅 System.getenv()（见源博文第2.7项））。
• $工作目录$。默认值是当前进程的当前工作目录，通常根据系统属性 user.dir 来命名。
• redirectErrorStream 属性。最初，此属性为 false，意思是子进程的标准输出和错误输出被发送给两个独立的流，这些流可以通过 Process.getInputStream()（见源博文第2.4项）和 Process.getErrorStream() 方法来访问。如果将值设置为 true，标准错误将与标准输出合并。这使得关联错误消息和相应的输出变得更容易。在此情况下，合并的数据可从 Process.getInputStream() 返回的流读取，而从 Process.getErrorStream() 返回的流读取将直接到达文件尾。

修改进程构建器的属性将影响后续由该对象的 start() 方法启动的进程，但从不会影响以前启动的进程或 Java 自身的进程。

大多数错误检查由 start() 方法执行。可以修改对象的状态，但这样 start() 将会失败。例如，将命令属性设置为一个空列表将不会抛出异常，除非包含了 start()。

注意，此类不是同步的。 如果多个线程同时访问一个 ProcessBuilder，而其中至少一个线程从结构上修改了其中一个属性，它*必须保持外部同步。

很容易启动一个使用默认工作目录和环境的新进程：

Process p = new ProcessBuilder("myCommand", "myArg").start();

下面是一个利用修改过的工作目录和环境启动进程的例子：

ProcessBuilder pb = new ProcessBuilder("myCommand", "myArg1", "myArg2");
Map<String, String> env = pb.environment();
env.put("VAR1", "myValue");
env.remove("OTHERVAR");
env.put("VAR2", env.get("VAR1") + "suffix");
pb.directory("myDir");
Process p = pb.start();

要利用一组明确的环境变量启动进程，在添加环境变量之前，首先调用 Map.clear()。

从以下版本开始：
1.5

2、构造方法摘要

属性说明：

private List<String> command;// 命令集合
private File directory;// 执行目录
private Map<String,String> environment;// 执行环境
private boolean redirectErrorStream;
private Redirect[] redirects;

2.1 List<String> command

利用指定的操作系统程序和参数构造一个进程生成器。

public ProcessBuilder(List<String> command) {
    if (command == null)
        throw new NullPointerException();
    this.command = command;
}

2.2 String… command

利用指定的操作系统程序和参数构造一个进程生成器。

public ProcessBuilder(String... command) {
    this.command = new ArrayList<>(command.length);
    for (String arg : command)
        this.command.add(arg);
}

3、方法摘要

3.1 List<String> command()

返回此进程生成器的操作系统程序和参数。

3.2 ProcessBuilder command(List<String> command)

设置此进程生成器的操作系统程序和参数。

public ProcessBuilder command(List<String> command) {
    if (command == null)
        throw new NullPointerException();
    this.command = command;
    return this;
}

3.3 ProcessBuilder command(String… command)

设置此进程生成器的操作系统程序和参数。

public ProcessBuilder command(String... command) {
    this.command = new ArrayList<>(command.length);
    for (String arg : command)
        this.command.add(arg);
    return this;
}

3.4 File directory()

返回此进程生成器的工作目录。

3.5 ProcessBuilder directory(File directory)

设置此进程生成器的工作目录。

3.6 Map<String, String> environment()

返回此进程生成器环境的字符串映射视图。

public Map<String,String> environment() {
    SecurityManager security = System.getSecurityManager();
    if (security != null)
        security.checkPermission(new RuntimePermission("getenv.*"));

    if (environment == null)
        environment = ProcessEnvironment.environment();

    assert environment != null;

    return environment;
}

后续解析。

3.7 boolean redirectErrorStream()

通知进程生成器是否合并标准错误和标准输出。

3.8 ProcessBuilder redirectErrorStream(boolean redirectErrorStream)

设置此进程生成器的 redirectErrorStream 属性。

3.9 Process start()

使用此进程生成器的属性启动一个新进程。

4、方法摘要（不开放）

4.1 ProcessBuilder environment(String[] envp)

将指定环境设置为运行环境。

ProcessBuilder environment(String[] envp) {
    assert environment == null;
    if (envp != null) {
        environment = ProcessEnvironment.emptyEnvironment(envp.length);
        assert environment != null;

        for (String envstring : envp) {
            // Before 1.5, we blindly passed invalid envstrings
            // to the child process.
            // We would like to throw an exception, but do not,
            // for compatibility with old broken code.

            // Silently discard any trailing junk.
            if (envstring.indexOf((int) '\u0000') != -1)
                envstring = envstring.replaceFirst("\u0000.*", "");

            int eqlsign =
                envstring.indexOf('=', ProcessEnvironment.MIN_NAME_LENGTH);
            // Silently ignore envstrings lacking the required `='.
            if (eqlsign != -1)
                environment.put(envstring.substring(0,eqlsign),
                                envstring.substring(eqlsign+1));
        }
    }
    return this;
}

后续解析。

最后

如果大家需要Java-API文档，我上传了《Java-API文档-包含5/8/11三个版本》。

---

本文暂缓更新。