如何将Microsoft.Build的ConsoleLogger消息绑定到WPF的TextBox？

我正在开发一款简易C# IDE，已经通过以下代码实现了项目构建功能：

var path = ProjectPath;
var props = new Dictionary<string, string> 
{ 
    {"Configuration", "Debug"}, 
    {"Platform", "AnyCPU"}, 
    {"OutputPath", ProjectPath} 
};
var pc = new ProjectInstance(path, props, "14.0");
var logger = new ConsoleLogger();
logger.Verbosity = LoggerVerbosity.Diagnostic;
var buildParams = new BuildParameters() 
{ 
    DetailedSummary = true, 
    Loggers = new List<ILogger> { new ConsoleLogger() }, 
    DefaultToolsVersion = "14.0" 
};
var targets = new List<string> { "PrepareForBuild", "Build" };
var reqData = new BuildRequestData(pc, targets.ToArray());
BuildManager.DefaultBuildManager.BeginBuild(buildParams);
var buildResult = BuildManager.DefaultBuildManager.BuildRequest(reqData);

我希望将XAML文件中的TextBox与Microsoft.Build.BuildEngine.ConsoleLogger的消息进行绑定，但ConsoleLogger的工作机制和WPF的Control对象差异很大。我原本想通过事件处理器来处理错误和消息，但ConsoleLogger不支持这种方式，请问该怎么解决这个问题？

解决方案：自定义ILogger实现 #

ConsoleLogger是密封类，它的输出直接指向控制台，没办法直接绑定到WPF控件。解决思路是实现自己的ILogger，让它能够收集构建日志，并且安全地更新WPF UI（因为构建操作可能在非UI线程执行，需要用Dispatcher处理线程同步）。

步骤1：创建自定义日志器类 #

这个类要实现ILogger接口，同时实现INotifyPropertyChanged来支持WPF数据绑定，还要处理线程安全的UI更新：

using Microsoft.Build.Framework;
using System.ComponentModel;
using System.Windows.Threading;

public class BuildLogger : ILogger, INotifyPropertyChanged
{
    private readonly Dispatcher _dispatcher;
    private string _buildLog;

    public string BuildLog
    {
        get => _buildLog;
        set
        {
            _buildLog = value;
            OnPropertyChanged(nameof(BuildLog));
        }
    }

    public LoggerVerbosity Verbosity { get; set; }
    public string Parameters { get; set; }

    public BuildLogger(Dispatcher dispatcher)
    {
        _dispatcher = dispatcher;
        _buildLog = string.Empty;
    }

    public void Initialize(IEventSource eventSource)
    {
        // 订阅所有关键构建事件
        eventSource.ProjectStarted += OnProjectStarted;
        eventSource.MessageRaised += OnMessageRaised;
        eventSource.WarningRaised += OnWarningRaised;
        eventSource.ErrorRaised += OnErrorRaised;
        eventSource.ProjectFinished += OnProjectFinished;
    }

    private void AppendLog(string message)
    {
        // 确保在UI线程更新日志内容，避免跨线程访问控件的错误
        _dispatcher.Invoke(() =>
        {
            BuildLog += $"{message}{Environment.NewLine}";
        });
    }

    private void OnProjectStarted(object sender, ProjectStartedEventArgs e)
    {
        AppendLog($"开始构建项目: {e.ProjectFile}");
    }

    private void OnMessageRaised(object sender, BuildMessageEventArgs e)
    {
        if (e.Importance <= Verbosity)
        {
            AppendLog($"消息: {e.Message}");
        }
    }

    private void OnWarningRaised(object sender, BuildWarningEventArgs e)
    {
        AppendLog($"警告: {e.Message} (文件: {e.File}, 行: {e.LineNumber})");
    }

    private void OnErrorRaised(object sender, BuildErrorEventArgs e)
    {
        AppendLog($"错误: {e.Message} (文件: {e.File}, 行: {e.LineNumber})");
    }

    private void OnProjectFinished(object sender, ProjectFinishedEventArgs e)
    {
        AppendLog($"项目构建完成，状态: {(e.Succeeded ? "成功" : "失败")}");
    }

    public void Shutdown()
    {
        // 可在此处清理资源（如果需要）
    }

    public event PropertyChangedEventHandler PropertyChanged;
    protected virtual void OnPropertyChanged(string propertyName)
    {
        PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(propertyName));
    }
}

步骤2：在WPF窗口中配置绑定 #

1. 在窗口的代码后台创建自定义日志器实例，并设置为数据上下文：

private readonly BuildLogger _buildLogger;

public MainWindow()
{
    InitializeComponent();
    // 传入UI线程的Dispatcher，确保日志更新在UI线程执行
    _buildLogger = new BuildLogger(Dispatcher);
    DataContext = _buildLogger;
}

2. 修改XAML中的TextBox，绑定到BuildLog属性：

<TextBox 
    Text="{Binding BuildLog, Mode=OneWay}" 
    VerticalScrollBarVisibility="Auto"
    HorizontalScrollBarVisibility="Auto"
    IsReadOnly="True"
    Margin="10"/>

步骤3：更新构建代码使用自定义日志器 #

把原来的ConsoleLogger替换成我们的BuildLogger即可：

var path = ProjectPath;
var props = new Dictionary<string, string> 
{ 
    {"Configuration", "Debug"}, 
    {"Platform", "AnyCPU"}, 
    {"OutputPath", ProjectPath} 
};
var pc = new ProjectInstance(path, props, "14.0");

// 使用自定义日志器
_buildLogger.Verbosity = LoggerVerbosity.Diagnostic;

var buildParams = new BuildParameters() 
{ 
    DetailedSummary = true, 
    Loggers = new List<ILogger> { _buildLogger }, 
    DefaultToolsVersion = "14.0" 
};
var targets = new List<string> { "PrepareForBuild", "Build" };
var reqData = new BuildRequestData(pc, targets.ToArray());
BuildManager.DefaultBuildManager.BeginBuild(buildParams);
var buildResult = BuildManager.DefaultBuildManager.BuildRequest(reqData);

关键说明 #

• 线程安全：构建操作通常在后台线程执行，必须用Dispatcher.Invoke确保UI更新在UI线程进行，避免跨线程访问控件的异常。
• 数据绑定支持：实现INotifyPropertyChanged接口让WPF能自动检测到BuildLog的变化，实时更新TextBox内容。
• 全面日志捕获：通过订阅IEventSource的各类事件，我们可以完整收集构建过程中的消息、警告、错误等所有日志信息，按需展示。

这样就能完美实现构建日志与WPF TextBox的绑定了！

内容的提问来源于stack exchange，提问作者Alicja Barankiewicz