如何在Rider中以非侵入式方式为源码方法标注NotNull并消除空警告？

针对你无法修改源码添加[NotNull]注解或IDE注释的场景，有两种可行的非侵入式方案：

1. 利用Rider的DotSettings配置文件批量定义空值契约 #

Rider允许通过项目/解决方案级的.DotSettings文件配置代码的空值分析规则，无需修改源码。具体操作：

• 在解决方案根目录创建或编辑YourSolution.sln.DotSettings（或项目级的YourProject.csproj.DotSettings）文件。
• 添加针对目标方法的空值契约配置，格式示例：

  <wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
    <!-- 格式：DefaultNullability:M:完整方法元数据签名 -->
    <s:Boolean x:Key="DefaultNullability:M:YourNamespace.YourClass.Method">True</s:Boolean>
    <!-- 可批量添加多个方法条目 -->
    <s:Boolean x:Key="DefaultNullability:M:YourNamespace.OtherClass.AnotherMethod">True</s:Boolean>
  </wpf:ResourceDictionary>
  

  • YourNamespace.YourClass.Method是目标方法的完整元数据签名，可通过Rider的「Go to Metadata」功能查看。
  • True表示该方法返回值不为null，会覆盖悲观分析的默认判断。

保存配置后，Rider会自动读取并应用规则，消除对应方法的空值警告。

2. 开发自定义Rider插件动态注入空值契约 #

如果需要更灵活的规则（比如批量匹配符合特定命名/实现规则的方法），可以通过Rider插件API实现动态标注：

核心思路 #

实现Rider的INullabilityAnnotationProvider接口，在代码分析阶段为指定方法注入NotNull契约，完全不修改源码。

示例代码 #

[SolutionComponent]
public class CustomNullabilityProvider : INullabilityAnnotationProvider
{
    // 处理方法返回值的空值标注
    public NullabilityAnnotation? GetReturnValueNullability(IMethod method)
    {
        // 自定义匹配逻辑：比如匹配特定命名空间下返回空字符串的方法
        var containingType = method.GetContainingType();
        if (containingType.GetClrName().Namespace == "YourNamespace" 
            && method.ReturnType.IsString()
            && method.GetBody()?.Statements.OfType<IReturnStatement>().Any(s => s.Value is ILiteralExpression lit && lit.Value == "") == true)
        {
            return NullabilityAnnotation.NotNull;
        }
        return null; // 其他方法保留默认分析结果
    }

    // 以下方法返回null表示使用默认规则，按需实现即可
    public NullabilityAnnotation? GetParameterNullability(IParameter parameter) => null;
    public NullabilityAnnotation? GetFieldNullability(IField field) => null;
}

实现步骤 #

1. 使用JetBrains Rider SDK创建新插件项目。
2. 将上述代码添加到插件组件中。
3. 编译插件并安装到你的Rider实例。
4. 插件会在Rider分析代码时自动为匹配的方法添加NotNull标注，消除空值警告。

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