Incremental Source Generator中AttributeData的ApplicationSyntaxReference不稳定问题

问题背景 #

实现了一个增量源生成器，遍历引用程序集提取带特定特性的代码，核心逻辑如下：

var sampleText = attributeData.ApplicationSyntaxReference is {} a 
    ? a.GetSyntax().GetLocation().SourceTree is {} b 
        ? b.GetText().ToString()
        : "InnerNull"
    : "OuterNull";

该逻辑存在不稳定失效情况：IDE的源生成器列表输出正常，但EmitCompilerGeneratedFiles生成的文件有问题，Release模式运行Composition项目时也会出现相同故障，排查发现失效场景下attributeData.ApplicationSyntaxReference为null。

可能原因及解决方案 #

1. 引用程序集无语法树元数据保留 #

当特性应用在已编译完成的引用程序集中时，编译器不会保留SyntaxReference——编译后的程序集仅包含IL和元数据，没有原始语法树信息。只有当前正在编译的主项目内的特性应用，才会有有效的ApplicationSyntaxReference。

解决办法：

• 区分当前编译项目与引用程序集的特性：通过Compilation.Assembly判断当前编译的程序集，仅对当前项目内的特性应用尝试获取SyntaxReference；
• 对于引用程序集中的特性，改为通过AttributeData.ConstructorArguments或NamedArguments传递必要信息，而非依赖原始语法树。

2. 增量源生成器输入筛选不严谨 #

增量源生成器依赖IncrementalValuesProvider的筛选逻辑，若未正确过滤无语法引用的特性实例，就会出现偶尔null的情况。

解决办法：

• 在筛选阶段提前过滤无效实例：

var validAttributeData = context.SyntaxProvider
    .CreateSyntaxProvider(...)
    .Where(ad => ad.ApplicationSyntaxReference != null);

• 或在处理逻辑中增加兜底：

var sampleText = attributeData.ApplicationSyntaxReference?.GetSyntax()?.GetLocation().SourceTree?.GetText().ToString() 
    ?? "无法获取语法树信息";

3. Release模式编译优化导致信息丢失 #

Release模式下编译器启用的优化可能会移除语法相关元数据，导致ApplicationSyntaxReference无法保留。

解决办法：

• 在项目文件的Release配置中添加编译选项，保留必要元数据：

<PropertyGroup Condition="'$(Configuration)' == 'Release'">
  <DebugType>pdbonly</DebugType>
  <DebugSymbols>true</DebugSymbols>
  <EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles>
</PropertyGroup>

4. IDE预览与实际编译上下文差异 #

Rider的源生成器预览可能使用特殊编译上下文，保留了更多调试信息，而实际编译（尤其是Release）未保留，导致预览正常但实际生成失效。

解决办法：

• 以命令行dotnet build的编译结果为准进行测试，避免依赖IDE预览；
• 在Rider中设置编译配置与命令行一致，关闭IDE特有优化或预览模式。

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