NullGuard 使用教程

NullGuard 使用教程

NullGuardAdds null argument checks to an assembly项目地址:https://gitcode.com/gh_mirrors/nu/NullGuard

项目介绍

NullGuard 是一个用于 C# 项目的开源库，通过在编译时自动添加空值检查来帮助开发者避免空引用异常。它是 Fody 生态系统的一部分，Fody 是一个允许在编译过程中修改 .NET 程序集的工具。NullGuard 可以配置为在方法参数、属性设置器和返回值中自动插入空值检查。

项目快速启动

安装 NullGuard

首先，确保你已经安装了 Fody 和 NullGuard.Fody 包。你可以通过 NuGet 包管理器控制台来安装：

Install-Package Fody
Install-Package NullGuard.Fody

配置 FodyWeavers.xml

在你的项目根目录下创建或编辑 FodyWeavers.xml 文件，添加以下内容：

<?xml version="1.0" encoding="utf-8"?>
<Weavers>
  <NullGuard />
</Weavers>

示例代码

以下是一个简单的示例，展示了如何在方法中自动插入空值检查：

public class Sample
{
    public void TheFunc(string o)
    {
        Console.WriteLine("I'm alive");
    }

    public static void Main(string[] args)
    {
        var sample = new Sample();
        sample.TheFunc(null); // 这将引发 ArgumentNullException
    }
}

应用案例和最佳实践

应用案例

NullGuard 特别适用于以下场景：

• 当你希望在公共 API 中强制执行空值检查时。
• 当你希望减少手动编写空值检查代码的工作量时。

最佳实践

• 明确配置模式：根据你的项目需求，明确配置 NullGuard 的模式（如 Implicit、Explicit 或 NullableReferenceTypes）。
• 使用特性：在需要允许空值的地方使用 [AllowNull] 特性，在需要强制非空值的地方使用 [NotNull] 特性。
• 测试覆盖：确保你的测试覆盖了所有可能的空值输入情况，以验证 NullGuard 的正确性。

典型生态项目

NullGuard 是 Fody 生态系统中的一个组件，Fody 本身包含多个类似的插件，用于在编译时修改和增强 .NET 程序集。以下是一些相关的项目：

• PropertyChanged.Fody：自动实现 INotifyPropertyChanged 接口。
• Costura.Fody：将依赖项嵌入到主程序集中，简化部署。
• Virtuosity.Fody：将所有方法和属性转换为虚拟方法，便于单元测试。

通过结合使用这些 Fody 插件，可以显著提高开发效率和代码质量。

NullGuardAdds null argument checks to an assembly项目地址:https://gitcode.com/gh_mirrors/nu/NullGuard