如何在非Task类中记录日志并在MsBuild中查看？

核心思路 #

MSBuild的Task类通过Log属性（类型为TaskLoggingHelper）实现日志输出，要让非Task类也能输出日志，本质是把Task的日志对象传递给非Task类，利用TaskLoggingHelper或底层的IBuildEngine接口完成日志记录。

方法一：构造函数注入TaskLoggingHelper（推荐） #

通过构造函数将Task的Log对象注入到非Task类中，依赖关系明确，避免空引用风险。

Task类代码 #

using Microsoft.Build.Utilities;

public class CustomBuildTask : Task
{
    public override bool Execute()
    {
        // 实例化非Task类时传入当前Task的Log对象
        var businessService = new BusinessLogicService(Log);
        businessService.ProcessBuildTask();
        
        return true;
    }
}

非Task类代码 #

using Microsoft.Build.Utilities;

public class BusinessLogicService
{
    private readonly TaskLoggingHelper _logger;

    // 构造函数接收日志对象
    public BusinessLogicService(TaskLoggingHelper logger)
    {
        _logger = logger ?? throw new ArgumentNullException(nameof(logger));
    }

    public void ProcessBuildTask()
    {
        // 直接使用_logger输出日志，用法和Task类中完全一致
        _logger.LogMessage(MessageImportance.Normal, "非Task类执行中：开始处理业务逻辑");
        _logger.LogWarning("非Task类警告：检测到潜在的配置问题");
        _logger.LogError("非Task类错误：业务逻辑执行失败");
    }
}

方法二：属性注入TaskLoggingHelper #

如果构造函数参数过多，也可以通过属性的方式注入日志对象，注意要确保属性在调用日志方法前已赋值。

非Task类代码 #

using Microsoft.Build.Utilities;

public class BusinessLogicService
{
    // 公开日志属性供Task类赋值
    public TaskLoggingHelper Logger { get; set; }

    public void ProcessBuildTask()
    {
        if (Logger == null)
        {
            throw new InvalidOperationException("Logger属性未初始化，请先注入TaskLoggingHelper对象");
        }

        Logger.LogMessage("通过属性注入的日志：业务逻辑处理完成");
    }
}

Task类代码 #

public override bool Execute()
{
    var businessService = new BusinessLogicService();
    // 赋值日志属性
    businessService.Logger = this.Log;
    businessService.ProcessBuildTask();
    
    return true;
}

方法三：传递IBuildEngine接口 #

如果需要更底层的日志控制，可以传递Task的BuildEngine属性（实现了IBuildEngine接口），手动创建日志事件参数来输出日志。

非Task类代码 #

using Microsoft.Build.Framework;

public class BusinessLogicService
{
    private readonly IBuildEngine _buildEngine;

    public BusinessLogicService(IBuildEngine buildEngine)
    {
        _buildEngine = buildEngine ?? throw new ArgumentNullException(nameof(buildEngine));
    }

    public void ProcessBuildTask()
    {
        // 记录普通消息
        var messageArgs = new BuildMessageEventArgs(
            "通过IBuildEngine记录的消息：开始处理",
            subcategory: null,
            senderName: nameof(BusinessLogicService),
            importance: MessageImportance.Normal
        );
        _buildEngine.LogCustomEvent(messageArgs);

        // 记录警告
        var warningArgs = new BuildWarningEventArgs(
            code: null,
            file: null,
            lineNumber: 0,
            columnNumber: 0,
            message: "非Task类警告：资源文件缺失",
            helpKeyword: null,
            senderName: nameof(BusinessLogicService)
        );
        _buildEngine.LogCustomEvent(warningArgs);
    }
}

Task类代码 #

public override bool Execute()
{
    var businessService = new BusinessLogicService(this.BuildEngine);
    businessService.ProcessBuildTask();
    
    return true;
}

注意事项 #

• 优先选择构造函数注入，它能明确依赖关系，避免因忘记注入而导致的空引用异常。
• 不要直接持有整个Task对象的引用，仅传递日志相关的接口（TaskLoggingHelper或IBuildEngine），减少类之间的耦合。
• 日志的重要性级别（MessageImportance）会影响MSBuild是否显示该日志，可根据需求选择Low、Normal或High。

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