CS8618 警告：构造函数退出时非空属性必须包含非空值

问题描述

当你在C#中定义了包含非空字符串属性的类时，可能会遇到以下编译器警告：

Warning CS8618: Non-nullable property 'PropertyName' must contain a non-null value when exiting constructor. Consider declaring the property as nullable.

这个警告出现在启用了可为空引用类型功能的项目中，它表示编译器检测到非空属性可能在构造函数退出时保持为null值。

示例代码

public class Greeting
{
    public string From { get; set; }
    public string To { get; set; } 
    public string Message { get; set; }
}

什么是可为空引用类型？

C# 8.0引入了可为空引用类型功能，它将所有引用类型默认设置为非空，需要使用 ? 后缀明确声明可为空类型。这是为了帮助开发者在编译时捕获潜在的null引用异常。

解决方案

方案一：明确声明可为空属性（推荐）

最简单的解决方案是使用 ? 后缀明确声明属性可为空：

public class Greeting
{
    public string? From { get; set; }
    public string? To { get; set; } 
    public string? Message { get; set; }
}

方案二：提供默认值

如果属性应该始终有值，可以在声明时提供默认值：

public class Greeting
{
    public string From { get; set; } = string.Empty;
    public string To { get; set; } = string.Empty;
    public string Message { get; set; } = string.Empty;
}

方案三：使用构造函数初始化

通过构造函数确保所有属性都被正确初始化：

public class Greeting
{
    public string From { get; set; }
    public string To { get; set; }
    public string Message { get; set; }

    public Greeting(string from, string to, string message)
    {
        From = from;
        To = to;
        Message = message;
    }
}

方案四：使用 required 修饰符（C# 11+）

C# 11引入了 required 修饰符，强制调用者必须在对象初始化时提供值：

public class Greeting
{
    public required string From { get; set; }
    public required string To { get; set; } 
    public required string Message { get; set; }
}

使用此类时必须提供所有必需属性的值：

var greeting = new Greeting()
{
    From = "Me",
    To = "You",
    Message = "Hello!"
};

方案五：使用 null宽容运算符

如果你确定属性将在使用时被正确初始化，可以使用null宽容运算符 !：

public class Greeting
{
    public string From { get; set; } = null!;
    public string To { get; set; } = null!;
    public string Message { get; set; } = null!;
}

谨慎使用

这种方法只是告诉编译器"我知道这里可能为null，但我会负责处理"，可能会掩盖潜在的问题。

特殊场景解决方案

Entity Framework 场景

对于Entity Framework实体类，属性应该与数据库的NULL约束保持一致：

public class Customer
{
    public int Id { get; set; }
    public string Name { get; set; } = string.Empty; // NOT NULL列
    public string? Description { get; set; } // NULL列
}

依赖注入场景

对于通过依赖注入初始化的属性，可以使用null宽容运算符：

public class MyService
{
    [Inject]
    private IOtherService? OtherService { get; init; }
    
    public void Execute()
    {
        OtherService!.DoWork(); // 使用!告诉编译器我们知道它不为null
    }
}

集合属性

对于集合属性，可以初始化为空集合：

public class MyClass
{
    public List<string> Items { get; set; } = new List<string>();
    // 或使用更简洁的语法
    public List<string> Items { get; set; } = [];
}

禁用警告（不推荐）

虽然可以完全禁用可为空引用类型检查，但这不推荐，因为它会使你失去编译时的null安全检查。

在项目中禁用

编辑 .csproj 文件：

<PropertyGroup>
  <Nullable>disable</Nullable>
</PropertyGroup>

在文件中禁用

在文件顶部添加：

#nullable disable

局部禁用警告

使用预处理指令局部禁用警告：

#pragma warning disable CS8618
public string From { get; set; }
#pragma warning restore CS8618

最佳实践

1. 优先使用明确的可为空声明：使用 string? 明确表达意图
2. 提供有意义的默认值：而不是使用null宽容运算符绕过检查
3. 利用构造函数：确保对象在构建时处于有效状态
4. 谨慎使用null宽容运算符：只在确实能保证非空时使用
5. 保持一致性：属性是否可为空应该与业务逻辑和数据存储要求一致

总结

CS8618警告是C#编译器提供的有用功能，帮助你在编译时捕获潜在的null引用异常。通过合理使用可为空类型注解、提供默认值或使用构造函数，可以消除这些警告并编写更健壮的代码。