C#：如何实现和使用 NotNull 和 CanBeNull 属性

Question

我想让程序员和我自己知道，某个方法不需要 null，并且如果您无论如何都向它发送 null，结果将不会很漂亮。

Lokad 共享库< 中有一个 NotNullAttribute 和 CanBeNullAttribute /a>，位于 Lokad.Quality 命名空间中。

但这是如何运作的呢？ 我查看了这两个属性的源代码，它看起来像这样：

[AttributeUsage(AttributeTargets.Method | AttributeTargets.Parameter |
                AttributeTargets.Property | AttributeTargets.Delegate |
                AttributeTargets.Field, AllowMultiple = false, Inherited = true)]
[NoCodeCoverage]
public sealed class NotNullAttribute : Attribute
{
}

[AttributeUsage(AttributeTargets.Method | AttributeTargets.Parameter |
                AttributeTargets.Property | AttributeTargets.Delegate |
                AttributeTargets.Field, AllowMultiple = false, Inherited = true)]
[NoCodeCoverage]
public sealed class CanBeNullAttribute : Attribute
{
}

两个继承自 Attribute 的空类。 它们是如何使用的？ 您是否必须查找 xml 文档并知道它在那里？ 因为我尝试制作自己的属性副本并使用 Lokad 版本，但是当我尝试直接发送 null 时，我没有收到任何消息。 既不是来自 ReSharper，也不是来自 VS。 实际上我有点期待。 但它们是如何使用的呢？ 如果我尝试发送其中为空的内容，我可以以某种方式让 VS 为我生成警告吗？ 或者它只是用于某种测试框架？ 或者？

Answer 1

从中期来看，“代码契约”（4.0 中）将是对此的更好答案。 它们现已推出（学术或商业 许可证），但将在 VS2010 中更加集成。 这可以提供静态分析和运行时支持。

（编辑）示例：

Contract.RequiresAlways( x != null );

就这么简单...代码契约引擎在 IL 级别工作，因此它可以对其进行分析，并在构建期间或运行时调用代码抛出警告/错误。 为了向后兼容，如果您有现有的验证代码，您只需告诉它健全性检查在哪里结束，它就会完成剩下的工作：

if ( x == null ) throw new ArgumentNullException("x");
Contract.EndContractBlock();

Answer 2

这可以通过 AOP 来完成，其中建议在运行时验证方法参数是否是null 以及是否允许 null。 请参阅 PostSharp 和 Spring .NET 用于 AOP。

至于 ReSharper，请参阅带注释的框架：

我们分析了大部分 .NET Framework 类库以及 NUnit Framework，并使用 JetBrains.Annotations 命名空间中的一组自定义属性通过外部 XML 文件对其进行了注释，具体来说：

• StringFormatMethodAttribute（适用于采用格式字符串作为参数的方法）
• InvokerParameterNameAttribute（适用于具有应与调用方参数之一匹配的字符串文字参数的方法）
• AssertionMethodAttribute（用于断言方法）
• AssertionConditionAttribute（用于断言方法的条件参数）
• TerminatesProgramAttribute（用于终止控制流的方法）
• CanBeNullAttribute（适用于可以为 null 的值）
• NotNullAttribute（对于不能为空的值）

Answer 3

这些注释适用于 ReSharper，并且是从 JetBrains.Annotations 命名空间复制的。 框架可以将它们放在自己的命名空间中，但是，ReSharper 不会自动选取这些注释 - 您需要告诉 ReSharper 在选项对话框中使用自定义命名空间。 选择新的命名空间后，ReSharper 的分析将选取属性并为您提供突出显示和警告。

Answer 4

正如 Anton Gogolev 所指出的，可以使用 PostSharp 创建属性。（请注意，CodeContract 在主体内使用静态方法调用方法）

2013 年 2 月更新：新的 PostSharp 3.0 版本（目前处于测试版）将支持
验证参数、字段和属性

1) 文章 validate-parameters-using -attributes 已实现

公共类NotEmpty：ParameterAttribute

公共类NotNull：ParameterAttribute

[AttributeUsage(AttributeTargets.Parameter)]

公共抽象类ParameterAttribute：属性

{

public abstract void CheckParameter(ParameterInfo 参数，对象值);  
  

}

它还需要具有方法边界方面的方法属性来处理参数属性。

2) 在文章的评论中，有非常相似的实现< /a> 对于非空/非空    

[return: NonNull] public SomeObject SomeMethod([NonNull] AnotherObject param1)     
 

源代码位于google code Torch /DesignByContract

3) 另一个更复杂的示例在http://badecho.com/2011/11/validating-method-parameters-with-postsharp/