在 C# 11 及更高版本中,required 关键字用于指定某个属性或字段在对象初始化时必须被显式赋值。这在定义 DTO(数据传输对象)时特别有用,可以确保关键字段不会被遗漏,提升代码的健壮性和可维护性。
什么是 required 关键字?
required 是 C# 11 引入的修饰符,配合 init 或 set 访问器使用,表示该成员是“必需的初始化成员”。如果一个类包含 required 成员,在创建实例时必须通过对象初始化器提供这些值,否则编译器会报错。
例如:
定义一个简单的用户信息 DTO:
public class UserDto { public required string Name { get; set; } public required int Age { get; set; } public string? Email { get; set; } // 非 required,可选 }
使用时必须初始化 Name 和 Age:
var user = new UserDto { Name = "Alice", Age = 30 // 编译通过,Email 可省略 };
若漏掉 required 属性:
var user = new UserDto { Name = "Bob" // ❌ 编译错误:未设置 required 成员 'Age' };
在 DTO 中的优势
DTO 通常用于 API 请求/响应、序列化、跨层数据传递等场景,要求结构清晰且关键字段不为空。required 提供了以下好处:
- 编译时检查:避免运行时才发现缺失必要字段
- 提高可读性**:开发者一看就知道哪些字段是必需的
- 与构造函数相比更灵活**:无需写大量构造函数或记录类型(record)也能强制初始化
- 兼容对象初始化语法**:保持代码简洁,尤其适合反序列化场景(如 ASP.NET Core 模型绑定)
与构造函数和 record 的对比
传统方式常使用构造函数保证必填字段:
public class UserDto { public string Name { get; set; } public int Age { get; set; } <pre class="brush:php;toolbar:false;"><pre class="brush:php;toolbar:false;">public UserDto(string name, int age) { Name = name; Age = age; }
}
虽然有效,但使用构造函数在反序列化或需要默认值时不够灵活。required 不依赖构造函数,仅靠初始化语法即可完成校验,更适合 DTO 场景。
而使用 record 虽然也可结合 with 语法实现不可变性,但 required 更轻量,适用于普通类。
注意事项
- 仅支持 C# 11+ 和 .NET 7+ 环境
- 只能用于具有 init 或 set 的属性或字段
- 不能用于自动实现的属性以外的某些复杂场景(如只读字段)
- 序列化框架(如 System.Text.Json)能正确处理 required 属性,但在反序列化时仍需配置是否验证缺失字段
基本上就这些。用好 required 能让 DTO 更安全、更清晰,减少低级错误。对于现代 C# 开发来说,是个实用的小特性。