Roslyn 源代码生成器 SourceGenerator 获取代码文件的本地绝对路径

本文告诉大家如何在源代码生成器 SourceGenerator 里面获取代码文件的本地文件的绝对路径

从 compilation 的 Options 拿到 SourceReferenceResolver 对象，调用其 NormalizePath 方法，传入 SyntaxTree 的 FilePath 参数即可

正常项目的 SourceReferenceResolver 都是存在的，尽管 Options 的 SourceReferenceResolver 被标记为可空。但从单元测试等进来的，则取决于单元测试的写法，可能为空

如果无法将传入的 FilePath 转换为本地的绝对路径，则会返回 null 的值

演示代码如下

[Generator(LanguageNames.CSharp)]
public class IncrementalGenerator : IIncrementalGenerator
{
    public void Initialize(IncrementalGeneratorInitializationContext context)
    {
        IncrementalValuesProvider<GeneratorSyntaxContext> provider = context.SyntaxProvider.CreateSyntaxProvider((node, _) =>
        {
            return node.IsKind(SyntaxKind.ClassDeclaration);
        }, (syntaxContext, token) =>
        {
            return syntaxContext;
        });

        var pathProvider = provider.Combine(context.CompilationProvider).Select((tuple, _) =>
        {
            var (syntaxContext, compilation) = tuple;

            var path = compilation.Options.SourceReferenceResolver?.NormalizePath(syntaxContext.Node.SyntaxTree.FilePath,
                baseFilePath: null);
            // 找不到返回 path 为 null 的值
            return path;
        });

        context.RegisterSourceOutput(pathProvider, (productionContext, path) =>
        {
        });
    }
}

单元测试里面取决于 CSharpCompilationOptions 是否传入 sourceReferenceResolver 参数决定 Options 的 SourceReferenceResolver 是否是空。如以下代码就传入了 SourceFileResolver 对象，设置了代码查询路径

    private static CSharpCompilation CreateCompilation(string source)
        => CSharpCompilation.Create(...,
            new CSharpCompilationOptions(OutputKind.ConsoleApplication, sourceReferenceResolver: new SourceFileResolver([], @"C:\lindexi\Code")));

本文代码放在 github 和 gitee 上，可以使用如下命令行拉取代码。我整个代码仓库比较庞大，使用以下命令行可以进行部分拉取，拉取速度比较快

先创建一个空文件夹，接着使用命令行 cd 命令进入此空文件夹，在命令行里面输入以下代码，即可获取到本文的代码

git init
git remote add origin https://gitee.com/lindexi/lindexi_gd.git
git pull origin 0b5550ce0e2736df6f2aac01f1f65ca37103fbdf

以上使用的是国内的 gitee 的源，如果 gitee 不能访问，请替换为 github 的源。请在命令行继续输入以下代码，将 gitee 源换成 github 源进行拉取代码。如果依然拉取不到代码，可以发邮件向我要代码

git remote remove origin
git remote add origin https://github.com/lindexi/lindexi_gd.git
git pull origin 0b5550ce0e2736df6f2aac01f1f65ca37103fbdf

获取代码之后，进入 Workbench/KonanohallreGonurliyage 文件夹，即可获取到源代码

更多技术博客，请参阅博客导航

原文链接: http://blog.lindexi.com/post/Roslyn-%E6%BA%90%E4%BB%A3%E7%A0%81%E7%94%9F%E6%88%90%E5%99%A8-SourceGenerator-%E8%8E%B7%E5%8F%96%E4%BB%A3%E7%A0%81%E6%96%87%E4%BB%B6%E7%9A%84%E6%9C%AC%E5%9C%B0%E7%BB%9D%E5%AF%B9%E8%B7%AF%E5%BE%84

本作品采用知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议进行许可。欢迎转载、使用、重新发布，但务必保留文章署名林德熙 (包含链接: https://blog.lindexi.com )，不得用于商业目的，基于本文修改后的作品务必以相同的许可发布。如有任何疑问，请与我联系。