使用带有 ORM 的 DTO 类时，C#8 中的可空引用类型

Question

我在具有数据传输对象 (DTO) 类的项目中激活了此功能，如下所示：

public class Connection
    {
        public string ServiceUrl { get; set; }
        public string? UserName { get; set; }
        public string? Password { get; set; }
        //... others 
    }

但我得到了错误：

CS8618：不可为空的属性“ServiceUrl”未初始化。考虑将属性声明为可为空。

这是一个 DTO 类，所以我没有初始化属性。这将是初始化类以确保属性不为空的代码的责任。

例如，调用者可以这样做：

var connection = new Connection
{
  ServiceUrl=some_value,
  //...
}

我的问题：启用 C#8 的可空性上下文时如何处理 DTO 类中的此类错误？

Answer 1

您可以执行以下任一操作：

1. EF Core 建议 initializing to null! 和 null-forgiving operator

   public string ServiceUrl { get; set; } = null! ;
   //or
   public string ServiceUrl { get; set; } = default! ;
   

2. 使用支持字段：

   private string _ServiceUrl;
   public string ServiceUrl
   {
       set => _ServiceUrl = value;
       get => _ServiceUrl
              ?? throw new InvalidOperationException("Uninitialized property: " + nameof(ServiceUrl));
   }
   

Answer 2

如果它不可为空，那么在初始化对象时编译器可以做什么？

字符串的默认值为null，所以你会

1. 要么需要在声明中指定一个字符串默认值

   public string ServiceUrl { get; set; } = String.Empty;

2. 或者在默认构造函数中初始化值，这样你就可以摆脱警告了

3. 使用! 运算符（您不能使用）

4. 如 robbpriestley 所述，使其可以为空。

Answer 3

我一直在使用新的 Nullable Reference Types (NRT) 功能，我必须承认我最大的抱怨是编译器在类中给你这些警告' 声明。

在我的工作中，我构建了一个微服务，试图解决所有导致代码相当复杂的警告，尤其是在处理作为 Nuget 包共享给 .NET Core 消费者的 EF Core、AutoMapper 和 DTO 时。 这个非常简单的微服务很快就变得一团糟，仅仅因为 NRT 功能导致我疯狂地使用非流行的编码风格。

在阅读了 Cezary Piątek 的文章 Improving non-nullable reference types handling 后，我发现了很棒的 SmartAnalyzers.CSharpExtensions.Annotations Nuget 包。

此 Nuget 包将不可为空的责任转移到实例化对象的调用者代码，而不是类声明。

在他的文章中，他说我们可以通过在您的 .cs 文件之一中写入以下行来在整个程序集中激活此功能

[assembly: InitRequiredForNotNull]

例如，您可以将其放入您的 Program.cs 文件中，但我个人更喜欢直接在我的 .csproj 中激活它

<ItemGroup>
    <AssemblyAttribute Include="SmartAnalyzers.CSharpExtensions.Annotations.InitRequiredForNotNullAttribute" />
</ItemGroup>

此外，我通过在我的 .editorconfig 文件中进行设置，将默认的 CSE001 Missing initialization for properties 错误更改为警告

[*.cs]
dotnet_diagnostic.CSE001.severity = warning

您现在可以像往常一样使用您的 Connection 类，而不会出现任何错误

var connection = new Connection()
{
    ServiceUrl = "ServiceUrl"
};

只需注意一件事。让我们这样考虑你的班级

public class Connection
{
    public string ServiceUrl { get; }
    public string? UserName { get; }
    public string? Password { get; }

    public Connection(string serviceUrl, string? userName = null, string? password = null)
    {
        if (string.IsNullOrEmpty(serviceUrl))
            throw new ArgumentNullException(nameof(serviceUrl));

        ServiceUrl = serviceUrl;
        UserName = userName;
        Password = password;
    }
}

在这种情况下，当您像这样实例化对象时

var connection = new Connection("serviceUrl");

SmartAnalyzers.CSharpExtensions.Annotations Nuget 包没有分析您的构造函数来检查您是否真的在初始化所有不可为空的引用类型。它只是信任它并相信您在构造函数中正确地做事。因此，即使您忘记了这样的不可为空的成员，它也不会引发任何错误

public Connection(string serviceUrl, string? userName = null, string? password = null)
{
    if (string.IsNullOrEmpty(serviceUrl))
        throw new ArgumentNullException(serviceUrl);

    UserName = userName;
    Password = password;
}

我希望你会喜欢这个 Nuget 包背后的想法，它已成为我在所有新的 .NET Core 项目中安装的默认包。

Answer 4

在某些情况下可能会派上用场的另一件事：

[SuppressMessage("Compiler", "CS8618")]

可以在成员或整个类型之上使用。

---

要考虑的另一件事是在文件顶部添加#nullable disable 以禁用整个文件的可空引用。

Answer 5

通常 DTO 类存储在单独的文件夹中，因此我只需根据路径模式在 .editorconfig 文件中禁用此诊断：

[{**/Responses/*.cs,**/Requests/*.cs}]
# CS8618: Non-nullable field is uninitialized. Consider declaring as nullable.
dotnet_diagnostic.CS8618.severity = none

Answer 6

可空引用类型的好处是可以有效地管理空引用异常。所以最好使用指令#nullable enable。它可以帮助开发人员在运行时避免空引用异常。

如何帮助避免空引用异常： 在静态流分析期间，编译器将确保以下两件事。

1. 变量已明确分配给非空值。
2. 变量或表达式之前已针对 null 进行过检查 取消引用它。

如果不满足以上条件，编译器会抛出警告。 注意：所有这些活动都是在编译时发出的。

空引用类型有什么特别之处：

在 C# 8.0 之后，引用类型被视为不可为空。如果引用类型变量没有正确处理空值，那么编译器会及时发出警告。

如果我们知道引用变量是 NULLABLE，我们可以做什么：

1. 附加“？”在变量（示例）字符串之前？姓名
2. 使用“null forgiving operator”（示例）字符串名称 {get;set;} = 空值！;或字符串名称 {get;set;} = 默认！;

3. 使用“支持字段” （示例）：

   私有字符串_name; 公共字符串名称 {get { return _name; } 设置 {_name = value;} }

如果我们知道引用变量是非空的，我们可以做什么：

如果它不可为空，则使用构造函数初始化属性。

不可为空的引用类型的好处：

1. 更好地处理空引用异常
2. 借助编译时警告，开发人员可以及时更正他们的代码。
3. 开发人员在设计类时会将意图传达给编译器。 此后编译器将在整个代码中强制执行意图。

Answer 7

要消除 DTO 上的警告，请在 DTO 的 cs 文件的开头指定： #pragma 警告禁用 CS8618

最后： #pragma 警告恢复 CS8618