Cải tiến cách đọc đầu ra của Process trong .NET 11

Đây là bài thứ năm trong loạt bài Khám phá bản xem trước .NET 11.

Trong bài này, chúng ta sẽ tìm hiểu các cập nhật quan trọng dành cho API Process trong .NET 11. Những cải tiến này giúp các kịch bản đơn giản như chạy một tiến trình và đọc đầu ra trở nên dễ dàng hơn, đồng thời bổ sung các khả năng mới như chạy không cần chờ kết quả hoặc tự động kết thúc tiến trình con khi tiến trình cha thoát.

Bài viết tập trung vào việc đọc đầu ra của tiến trình con. Cách làm mới giúp tránh các lỗi nghiêm trọng như deadlock. Trước hết, chúng ta sẽ xem cách xử lý trong .NET 10, sau đó tìm hiểu các API mới trong .NET 11 và cách chúng hoạt động.

Đọc đầu ra của Process trong .NET 10

Trong một thời gian dài, API Process của .NET khá ổn định. Một số cải tiến nhỏ đã được bổ sung, chẳng hạn Process.WaitForExitAsync() trong .NET 5, cho phép chờ tiến trình kết thúc thông qua một Task. Tuy nhiên, nhiều vấn đề trong API vẫn khó xử lý hơn mức cần thiết, thậm chí một số thao tác gần như không thể thực hiện an toàn.

Nguy cơ deadlock với ReadToEnd()

Một ví dụ kinh điển là việc khởi chạy tiến trình rồi đọc lần lượt đầu ra chuẩn và lỗi chuẩn. Đoạn mã sau đây có thể gây deadlock:

var startInfo = new ProcessStartInfo("git")<br>{<br>    RedirectStandardOutput = true,<br>    RedirectStandardError = true,<br>};<br>startInfo.ArgumentList.Add("status");<br><br>using Process process = Process.Start(startInfo)!;<br><br>string output = process.StandardOutput.ReadToEnd();<br>string error = process.StandardError.ReadToEnd();<br><br>process.WaitForExit();

Vấn đề nằm ở cách hai đường ống đầu ra được đọc:

  • Tiến trình con ghi dữ liệu vào stdout và hoặc stderr.
  • StandardOutput.ReadToEnd() tiếp tục đọc cho đến khi đường ống đóng, thường là khi tiến trình kết thúc.
  • Trong lúc đó, StandardError.ReadToEnd() chưa bắt đầu đọc.
  • Nếu tiến trình con ghi vào stderr nhiều hơn sức chứa của bộ đệm, nó sẽ bị chặn vì không thể ghi thêm dữ liệu.
  • Tiến trình cha đang chờ tiến trình con kết thúc, còn tiến trình con lại chờ tiến trình cha đọc stderr. Đây chính là deadlock.

Có hai cách chính để tránh tình huống này. Điểm quan trọng trong cả hai cách là phải đọc và làm cạn cả hai đường ống song song.

Dùng Task để tránh deadlock

Cách đơn giản nhất là dùng phiên bản bất đồng bộ ReadToEndAsync(). Các phương thức này trả về Task, cho phép việc đọc diễn ra ở nền thay vì chặn luồng hiện tại:

using Process process = Process.Start(startInfo)!;<br><br>Task<string> outputTask = process.StandardOutput.ReadToEndAsync();<br>Task<string> errorTask = process.StandardError.ReadToEndAsync();<br><br>await Task.WhenAll(outputTask, errorTask, process.WaitForExitAsync());<br><br>string output = await outputTask;<br>string error = await errorTask;

Hai tác vụ đọc đồng thời giúp làm cạn bộ đệm của cả stdout và stderr, từ đó loại bỏ nguy cơ deadlock. Đây thường là cách dễ nhất, nhưng không phù hợp với mọi kịch bản.

Dùng sự kiện để đọc đầu ra ngay khi được ghi

Đôi khi ứng dụng cần phản ứng với dữ liệu ngay khi dữ liệu xuất hiện, thay vì chờ tiến trình kết thúc. Trong trường hợp đó, có thể dùng các trình xử lý sự kiện:

using Process process = new() { StartInfo = startInfo };<br><br>StringBuilder stdOut = new();<br>StringBuilder stdErr = new();<br><br>void HandleOutput(string data, bool isStandardError)<br>{<br>    var buffer = isStandardError ? stdErr : stdOut;<br>    buffer.AppendLine(data);<br>    // Xử lý thêm dữ liệu nếu cần<br>}<br><br>process.OutputDataReceived += (_, e) => HandleOutput(e.Data, false);<br>process.ErrorDataReceived += (_, e) => HandleOutput(e.Data, true);<br><br>process.Start();<br>process.BeginOutputReadLine();<br>process.BeginErrorReadLine();<br><br>process.WaitForExit();

Cách này hoạt động và gần như là lựa chọn tốt nhất với API .NET 10. Tuy vậy, lượng mã cần viết khá nhiều. .NET 11 giải quyết trực tiếp những hạn chế này.

Đọc đầu ra của Process trong .NET 11

.NET 11 bổ sung nhiều API giúp đơn giản hóa từng kịch bản:

  • Process.ReadAllText() và Process.ReadAllTextAsync()
  • Process.RunAndCaptureText() và Process.RunAndCaptureTextAsync()
  • Process.ReadAllLines() và Process.ReadAllLinesAsync()
  • Process.ReadAllBytes() và Process.ReadAllBytesAsync()

Đọc toàn bộ stdout và stderr vào một chuỗi

ReadAllText() và ReadAllTextAsync() là lựa chọn thay thế cho cách gọi StandardOutput.ReadToEnd() trước đây. Cả phiên bản đồng bộ và bất đồng bộ đều xử lý an toàn hai đường ống:

using Process process = Process.Start(startInfo)!;<br><br>(string output, string error) = process.ReadAllText();<br><br>process.WaitForExit();

Thời gian chạy tự động đọc song song cả hai đường ống để tránh deadlock. Trên Windows, việc này dựa trên I/O chồng lấp và các đối tượng chờ. Trên Unix, .NET dùng cơ chế ghép kênh dựa trên poll cùng thao tác đọc không chặn. Bạn không cần tự triển khai các chi tiết này; điều quan trọng là API an toàn để sử dụng.

Với phiên bản bất đồng bộ, mã cũng rất gọn:

using Process process = Process.Start(startInfo)!;<br><br>(string output, string error) = await process.ReadAllTextAsync();<br><br>process.WaitForExit();

Các API này hỗ trợ thời gian chờ cho phiên bản đồng bộ và CancellationToken cho phiên bản bất đồng bộ:

public (string StandardOutput, string StandardError) ReadAllText(TimeSpan? timeout = default);<br><br>public Task<(string StandardOutput, string StandardError)> ReadAllTextAsync(CancellationToken cancellationToken = default);

Nếu vượt quá thời gian chờ hoặc token bị hủy, thao tác đọc sẽ ném ngoại lệ. Vì vậy, hãy xử lý trường hợp này. Trong thực tế, nên luôn cung cấp thời gian chờ hoặc token hủy, kể cả khi giá trị thời gian chờ khá lớn.

Đọc stdout và stderr ngay khi dữ liệu được tạo

ReadAllText() và ReadAllTextAsync() tiếp tục đọc cho đến khi các đường ống đóng, thường là khi tiến trình kết thúc. Nếu cần xử lý từng dòng ngay khi được tạo, .NET 11 cung cấp ReadAllLines() và ReadAllLinesAsync().

Với API đồng bộ, có thể dùng foreach:

using Process process = Process.Start(startInfo)!;<br><br>StringBuilder stdOut = new();<br>StringBuilder stdErr = new();<br><br>foreach (ProcessOutputLine line in process.ReadAllLines())<br>{<br>    var buffer = line.StandardError ? stdErr : stdOut;<br>    buffer.AppendLine(line.Content);<br>    // Xử lý thêm dữ liệu nếu cần<br>}<br><br>process.WaitForExit();

Cách viết này rõ ràng hơn nhiều so với mô hình dựa trên sự kiện. Bạn chỉ cần lặp qua các dòng dữ liệu và kiểm tra thuộc tính StandardError để biết dữ liệu đến từ stderr hay stdout.

Phiên bản bất đồng bộ gần như giống hệt, chỉ khác ở từ khóa await:

using Process process = Process.Start(startInfo)!;<br><br>StringBuilder stdOut = new();<br>StringBuilder stdErr = new();<br><br>await foreach (ProcessOutputLine line in process.ReadAllLinesAsync())<br>{<br>    var buffer = line.StandardError ? stdErr : stdOut;<br>    buffer.AppendLine(line.Content);<br>    // Xử lý thêm dữ liệu nếu cần<br>}<br><br>process.WaitForExit();

Phía sau, phiên bản đồng bộ dùng I/O chồng lấp trên Windows hoặc cơ chế ghép kênh dựa trên poll trên Unix. Phiên bản bất đồng bộ dùng Channel để triển khai mô hình nhà sản xuất và người tiêu dùng mà không chặn luồng.

Cả hai phương thức đều nhận tham số tùy chọn để tránh chờ vô hạn:

public IEnumerable<ProcessOutputLine> ReadAllLines(TimeSpan? timeout = default);<br><br>public IAsyncEnumerable<ProcessOutputLine> ReadAllLinesAsync(CancellationToken cancellationToken = default);

Kiểu dữ liệu trả về là một cấu trúc chỉ đọc:

public readonly struct ProcessOutputLine<br>{<br>    public string Content { get; }<br>    public bool StandardError { get; }<br>}

StandardError có giá trị true nếu nội dung đến từ stderr; nếu không, dữ liệu đến từ stdout.

Đọc stdout và stderr dưới dạng byte

Không phải lúc nào bạn cũng muốn nhận kết quả dưới dạng chuỗi. Có thể bạn cần dữ liệu byte thô để tự xử lý theo bộ mã hóa mà tiến trình sử dụng. .NET 11 cung cấp ReadAllBytes() và ReadAllBytesAsync() cho trường hợp này:

using Process process = Process.Start(startInfo)!;<br><br>(byte[] output, byte[] error) = await process.ReadAllBytesAsync();<br><br>process.WaitForExit();

Về cơ bản, các API đọc văn bản cũng sử dụng cách đọc byte này ở bên dưới, sau đó chuyển byte sang chuỗi. Vì vậy, cách sử dụng hai nhóm API rất tương tự nhau.

Chạy tiến trình và thu thập văn bản đầu ra

Chuỗi thao tác chạy tiến trình, thu thập toàn bộ đầu ra rồi chờ tiến trình kết thúc xuất hiện rất thường xuyên. .NET 11 gói toàn bộ quy trình vào một lời gọi bằng RunAndCaptureText() và RunAndCaptureTextAsync():

ProcessTextOutput result = Process.RunAndCaptureText(startInfo);<br><br>ProcessTextOutput result = await Process.RunAndCaptureTextAsync(startInfo);

Kết quả chứa các thông tin thường cần dùng: mã tiến trình, đầu ra chuẩn, lỗi chuẩn và trạng thái kết thúc:

public sealed class ProcessTextOutput<br>{<br>    public ProcessExitStatus ExitStatus { get; }<br>    public string StandardOutput { get; }<br>    public string StandardError { get; }<br>    public int ProcessId { get; }<br>}<br><br>public sealed class ProcessExitStatus<br>{<br>    public int ExitCode { get; }<br>    public PosixSignal? Signal { get; }<br>    public bool Canceled { get; }<br>}

Trên Unix, nếu tiến trình bị kết thúc bởi một tín hiệu, ExitCode có giá trị bằng 128 cộng với số hiệu tín hiệu. Thuộc tính Signal luôn là null trên Windows và chỉ có giá trị khi tiến trình Unix kết thúc bởi tín hiệu.

Ngoài phiên bản nhận ProcessStartInfo, còn có các phiên bản chỉ yêu cầu tên tệp và danh sách tham số:

public static ProcessTextOutput RunAndCaptureText(<br>    ProcessStartInfo startInfo,<br>    TimeSpan? timeout = default);<br><br>public static ProcessTextOutput RunAndCaptureText(<br>    string fileName,<br>    IList<string>? arguments = null,<br>    TimeSpan? timeout = default);<br><br>public static Task<ProcessTextOutput> RunAndCaptureTextAsync(<br>    ProcessStartInfo startInfo,<br>    CancellationToken cancellationToken = default);<br><br>public static Task<ProcessTextOutput> RunAndCaptureTextAsync(<br>    string fileName,<br>    IList<string>? arguments = null,<br>    CancellationToken cancellationToken = default);

Tóm tắt

Các phiên bản .NET trước đây cho phép xảy ra deadlock nếu đọc stdout và stderr không đúng cách. .NET 11 bổ sung các API an toàn và dễ sử dụng hơn:

  • Process.ReadAllText() và Process.ReadAllTextAsync() để đọc toàn bộ đầu ra dưới dạng văn bản.
  • Process.ReadAllLines() và Process.ReadAllLinesAsync() để duyệt từng dòng ngay khi dòng đó được tạo.
  • Process.ReadAllBytes() và Process.ReadAllBytesAsync() để đọc đầu ra dưới dạng byte thô.
  • Process.RunAndCaptureText() và Process.RunAndCaptureTextAsync() để khởi chạy tiến trình, đọc đầu ra và chờ tiến trình kết thúc trong một API duy nhất.

Các API mới giúp làm việc với tiến trình dễ dàng hơn đáng kể trong .NET 11. Đây mới chỉ là một phần trong toàn bộ cải tiến dành cho Process; còn nhiều khả năng khác đáng để tìm hiểu thêm.