Класс ProcessBuilder

public final class ProcessBuilder
extends Object

Этот класс используется для создания процессов операционной системы.

Каждый ProcessBuilder экземпляр управляет набором атрибутов процесса. Метод start() создает новый экземпляр Process с этими атрибутами. Метод start() может вызываться многократно из одного экземпляра для создания новых дочерних процессов с идентичными или связанными атрибутами.

Метод startPipeline может быть вызван для создания цепочки новых процессов, передающих вывод каждого процесса непосредственно следующему. Каждый процесс имеет атрибуты своего соответствующего ProcessBuilder.

Каждый объект ProcessBuilder управляет следующими атрибутами процесса:

• команду, список строк, указывающий на исполняемый файл внешней программы и её аргументы (если есть). Какой список строк представляет собой допустимую команду операционной системы зависит от системы. Например, в большинстве случаев каждый концептуальный аргумент является элементом этого списка, но существуют операционные системы, где программы сами должны токенизировать строки командной строки — в такой системе Java-реализация может потребовать, чтобы команды содержали ровно два элемента.
• среду, которая является зависящим от системы отображением переменных на значения. Начальное значение — копия среды текущего процесса (см. System.getenv()).
• рабочую директорию. По умолчанию — текущая рабочая директория текущего процесса, обычно директория, указанная системной переменной user.dir.
• источник стандартного ввода. По умолчанию дочерний процесс считывает данные из канала. Java-код может получить доступ к этому каналу через поток вывода, возвращаемый методом Process.getOutputStream(). Однако стандартный ввод может быть перенаправлен на другой источник с помощью redirectInput. В этом случае Process.getOutputStream() вернёт пустой поток вывода, для которого:
  • методы write всегда выбрасывают IOException
  • метод close ничего не делает
• назначение стандартного вывода и стандартной ошибки. По умолчанию дочерний процесс записывает стандартный вывод и стандартную ошибку в каналы. Java-код может получить доступ к этим каналам через потоки ввода, возвращаемые Process.getOutputStream() и Process.getErrorStream(). Однако стандартный вывод и стандартная ошибка могут быть перенаправлены на другие назначения с помощью redirectOutput и redirectError. В этом случае Process.getInputStream() и/или Process.getErrorStream() вернут пустой поток ввода, для которого:
  • методы read всегда возвращают -1
  • метод available всегда возвращает 0
  • метод close ничего не делает
• свойство redirectErrorStream. Изначально это свойство равно false, что означает, что стандартный вывод и вывод ошибок дочернего процесса отправляются в два отдельных потока, к которым можно получить доступ с помощью методов Process.getInputStream() и Process.getErrorStream().

  Если значение установлено в true, то:

  • стандартная ошибка объединяется со стандартным выводом и всегда отправляется в одно и то же место (это облегчает сопоставление сообщений об ошибках с соответствующим выводом)
  • общее назначение стандартной ошибки и стандартного вывода может быть перенаправлено с помощью redirectOutput
  • любое перенаправление, установленное методом redirectError, игнорируется при создании дочернего процесса
  • поток, возвращаемый Process.getErrorStream(), всегда будет пустым потоком ввода

Изменение атрибутов объекта ProcessBuilder повлияет на процессы, запущенные позже с помощью метода 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(new File("myDir"));
 File log = new File("log");
 pb.redirectErrorStream(true);
 pb.redirectOutput(Redirect.appendTo(log));
 Process p = pb.start();
 assert pb.redirectInput() == Redirect.PIPE;
 assert pb.redirectOutput().file() == log;
 assert p.getInputStream().read() == -1;

Для запуска процесса со списком явных переменных среды, сначала вызовите Map.clear() перед добавлением переменных среды.

Если не указано иное, передача null аргумента в конструктор или метод этого класса приведёт к выбрасыванию исключения NullPointerException.