基于Roslyn的自定义C#编译器：动态读取.csproj与检测.NET版本

问题解答 #

1. 可以动态读取.csproj文件：.csproj本质是MSBuild格式的XML文件，借助MSBuild官方API可直接解析项目属性，包括TargetFramework字段。
2. 能将固定版本值改为动态获取的有效值：通过读取项目的TargetFramework属性，即可替换硬编码的固定版本字符串。

具体实现步骤 #

1. 引入MSBuild相关NuGet包 #

在自定义编译器项目中安装以下包：

Install-Package Microsoft.Build
Install-Package Microsoft.Build.Framework
Install-Package Microsoft.Build.Utilities.Core

2. 编写读取.csproj版本的方法 #

using Microsoft.Build.Evaluation;
using System.IO;

public static string GetTargetFrameworkFromProject(string projectPath)
{
    if (!File.Exists(projectPath))
        throw new FileNotFoundException("项目文件不存在", projectPath);

    using var projectCollection = new ProjectCollection();
    var project = projectCollection.LoadProject(projectPath);

    // 优先读取SDK风格项目的TargetFramework属性
    var targetFramework = project.GetPropertyValue("TargetFramework");
    
    // 兼容旧风格多目标项目（读取第一个目标框架）
    if (string.IsNullOrEmpty(targetFramework))
    {
        targetFramework = project.GetPropertyValue("TargetFrameworks")?.Split(';')[0];
    }

    // 空值兜底返回默认版本
    return string.IsNullOrEmpty(targetFramework) ? "net8.0" : targetFramework.Trim();
}

3. 集成到自定义Roslyn编译器中 #

假设你当前有返回固定版本的代码：

// 原固定版本逻辑
public string GetTargetFramework()
{
    return "net5.0";
}

替换为动态获取逻辑：

public string GetTargetFramework(string projectPath)
{
    return GetTargetFrameworkFromProject(projectPath);
}

4. 注意事项 #

• 多目标项目处理：如果项目是多目标配置（TargetFrameworks字段），上述代码默认取第一个目标框架，可根据需求调整为返回全部或让用户指定。
• 路径与权限：确保编译器有读取.csproj的权限，且传入的项目路径为绝对路径（可通过命令行参数获取）。
• 兼容性：该方法兼容从.NET Framework 4.5到.NET 8的所有项目格式（含旧非SDK风格与新SDK风格）。

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