0

0

C#的required关键字是什么意思?怎么标记必需属性?

畫卷琴夢

畫卷琴夢

发布时间:2025-09-21 10:52:01

|

565人浏览过

|

来源于php中文网

原创

C#的required关键字在C# 11中引入,用于强制对象初始化时必须赋值,提升代码健壮性。2. 它通过编译时检查确保标记属性被初始化,避免运行时NullReferenceException。3. 与构造函数相比,required避免重载爆炸,保留无参构造函数便利性。4. 与可空引用类型(NRTs)互补:NRTs关注是否可为null,required关注是否必须初始化。5. 适用于DTO、配置对象和不可变对象,明确必需属性的契约。6. 挑战包括破坏性变更风险、序列化兼容性和继承中不自动传递,需通过版本控制、更新库和显式声明应对。7. 反射可通过[RequiredMember]特性检测required属性,增强框架兼容性。

c#的required关键字是什么意思?怎么标记必需属性?

C#的

required
关键字在C# 11中引入,它最核心的作用就是强制要求对象在初始化时必须为其标记的属性赋值。简单来说,它让编译器在编译阶段就能检查出那些“必填”的属性是否被遗漏了,极大地提高了代码的健壮性。当一个属性被标记为
required
时,创建该类型的新实例时,必须通过对象初始化器(object initializer)为这个属性提供一个值,否则编译器会报错。

解决方案

required
关键字提供了一种声明性方式,来明确一个属性在对象构建时是不可或缺的。它解决了一个长期存在的痛点:如何在不依赖构造函数重载爆炸或运行时检查的情况下,确保关键数据在对象生命周期开始时就已就绪。

要标记一个必需属性,只需在属性声明前加上

required
关键字即可。例如:

public class UserProfile
{
    public required string Username { get; set; }
    public required string Email { get; set; }
    public int Age { get; set; } // 这是一个可选属性
}

当你尝试创建一个

UserProfile
的实例时,如果你遗漏了
Username
Email
属性的赋值,编译器会立即给出错误提示:

// 正确的初始化方式
var user1 = new UserProfile
{
    Username = "alice",
    Email = "alice@example.com",
    Age = 30
};

// 错误的初始化方式:缺少Email属性,编译时会报错
// var user2 = new UserProfile
// {
//     Username = "bob"
// };

这种机制让开发者在编写代码时就能发现这些潜在的初始化错误,而不是等到运行时才因为

NullReferenceException
或其他逻辑错误而头疼。它将“这个属性必须有值”的意图,从注释或文档提升到了语言层面,成为了一种强制性的契约。

C#
required
关键字与构造函数、可空引用类型有什么区别

这确实是个好问题,因为在

required
出现之前,我们通常会用构造函数或者结合可空引用类型(Nullable Reference Types, NRTs)来处理类似的需求。但它们解决的侧重点是不同的。

首先说说构造函数。我们当然可以通过构造函数来强制初始化。比如:

public class Product
{
    public string Name { get; }
    public decimal Price { get; }

    public Product(string name, decimal price)
    {
        Name = name;
        Price = price;
    }
}

这样,每次创建

Product
实例时,都必须提供
name
price
。这很有效,但当一个类有很多属性,或者有多种初始化路径时,构造函数可能会变得非常臃肿,需要大量的重载来应对不同的组合。而且,如果一个类是POCO(Plain Old CLR Object)类型,主要用于数据传输或序列化,我们往往更倾向于使用无参构造函数和属性初始化器,这样更简洁,也更方便序列化框架工作。
required
关键字正好弥补了这一空白,它允许我们保留无参构造函数的便利性,同时又强制了关键属性的初始化。

再来看可空引用类型(NRTs)。NRTs(从C# 8开始)的目的是帮助我们处理

null
。它关注的是一个引用类型变量是否可能为
null
,并试图在编译时警告我们潜在的
null
引用。例如,
string?
表示一个字符串可能为
null
,而
string
(在启用NRTs的上下文中)则表示它不应该为
null
。如果一个
string
类型的属性没有被赋值,NRTs会警告你它可能为
null

然而,

required
和NRTs解决的问题维度不同。NRTs关心的是“这个引用可以
null
吗?”,而
required
关心的是“这个属性在对象初始化时必须被赋值吗?”。一个
required string
属性,意味着它在对象创建时必须被赋予一个非
null
的字符串值。你不能用
null
去初始化一个
required string
,除非这个
required
属性本身就是
string?
类型(但这种情况很少见,因为
required
通常就是为了确保非空)。所以,
required
关键字是关于“存在性”和“初始化完整性”的,而NRTs是关于“可空性”的。它们是互补的,而不是替代关系。

在实际项目中,何时应该使用
required
关键字?

在我看来,

required
关键字在很多场景下都能显著提升代码质量和可维护性。

最直接的应用场景是数据传输对象(DTOs)或模型类。想象一下,你正在构建一个API,前端发送数据到后端,或者后端服务之间进行数据交换。这些数据模型往往有很多属性,其中一些是核心业务逻辑所必需的。例如,一个

Order
对象,
OrderId
CustomerId
OrderDate
可能都是必需的,而
DiscountCode
则可能是可选的。使用
required
,你可以清晰地在代码层面表达这种契约,避免了在控制器或服务层写一堆
if (obj.Property == null)
的检查代码,将这些检查前置到编译时。这不仅让代码更简洁,也降低了运行时出错的风险。

虎课网
虎课网

虎课网是超过1800万用户信赖的自学平台,拥有海量设计、绘画、摄影、办公软件、职业技能等优质的高清教程视频,用户可以根据行业和兴趣爱好,自主选择学习内容,每天免费学习一个...

下载

其次,配置对象也是一个非常适合的场景。应用程序的配置往往包含许多设置,有些是可选的,有些则是应用程序正常运行所必需的。比如数据库连接字符串、某些API密钥等。如果这些关键配置在初始化时缺失,应用程序根本无法启动或正常工作。通过将这些配置属性标记为

required
,可以确保在应用程序启动时,配置加载逻辑能够正确地提供所有必需的值,否则直接在编译阶段就报错,这比运行时抛出配置错误要友好得多。

还有,当你在设计不可变对象时,

required
也能发挥作用。虽然
required
属性默认是可读写的(
get; set;
),但如果结合
init
访问器(从C# 9开始),可以创建在初始化后就不能再修改的必需属性:

public class ImmutableSettings
{
    public required string ApiKey { get; init; } // 必须在初始化时赋值,之后不可修改
    public int TimeoutSeconds { get; init; } = 30; // 可选,有默认值
}

这让不可变对象的构建更加灵活,避免了必须通过复杂构造函数来初始化所有属性的限制。

总之,每当一个属性对于其所属对象的有效性或核心功能是不可或缺的,且你希望这种强制性在编译时就能被检查出来时,

required
关键字就是你的首选。它让代码的意图更加明确,也让潜在的错误无处遁形。

使用
required
关键字可能遇到的挑战及应对策略?

尽管

required
关键字带来了诸多便利,但在实际应用中,也可能会遇到一些挑战,需要我们提前考虑和应对。

一个主要的挑战是与现有代码库的兼容性。如果你在一个已经存在的、被广泛使用的公共API或库中引入

required
关键字,那这无疑是一个破坏性变更。因为消费者代码在更新你的库后,如果它们没有为这些新标记的
required
属性提供值,就会立即遇到编译错误。对于新的项目或内部服务,这通常不是问题,但在发布到外部的库时,你需要仔细权衡,并可能需要通过版本迭代来逐步引入,或者提供明确的迁移指南。

序列化和反序列化也是一个需要注意的点。大多数现代的JSON序列化库(如

System.Text.Json
Newtonsoft.Json
)已经对
required
关键字有了很好的支持。当它们反序列化JSON字符串到C#对象时,如果JSON中缺少了对应的
required
属性,这些库通常会抛出异常,这正是我们期望的行为。例如,
System.Text.Json
会抛出
JsonException
,提示缺少必需的属性。这很好地将运行时数据完整性检查与编译时检查结合起来。如果遇到不支持
required
的旧版序列化器,可能需要自定义序列化逻辑或更新库版本。

继承场景下,

required
属性的行为也值得探讨。
required
关键字不会被子类继承。也就是说,如果基类有一个
required
属性,子类不需要强制实现或声明它为
required
。如果子类也需要某个属性是必需的,它需要自己声明这个属性为
required
。这提供了灵活性,但也意味着在设计继承体系时,你需要明确每个层次的“必需”契约。

public class BaseEntity
{
    public required Guid Id { get; set; }
}

public class DerivedEntity : BaseEntity
{
    // Id属性在DerivedEntity的实例中仍然是required,因为它继承自BaseEntity
    // 但DerivedEntity可以有自己独有的required属性
    public required string Name { get; set; }
}

// var d = new DerivedEntity { Name = "Test" }; // 编译错误:缺少Id
// var d2 = new DerivedEntity { Id = Guid.NewGuid() }; // 编译错误:缺少Name
var d3 = new DerivedEntity { Id = Guid.NewGuid(), Name = "Test" }; // 正确

最后,反射(Reflection)操作也需要留意。

required
属性在编译后会带有一个
[RequiredMember]
特性。如果你有基于反射的代码(例如,自定义的ORM、DI容器或验证框架),并且需要根据属性是否为
required
来调整行为,你可以通过反射检查这个特性。

// 示例:通过反射检查属性是否为required
var property = typeof(UserProfile).GetProperty("Username");
var isRequired = property.GetCustomAttributes(typeof(System.Runtime.CompilerServices.RequiredMemberAttribute), false).Any();
Console.WriteLine($"Username is required: {isRequired}"); // 输出:Username is required: True

总的来说,

required
关键字是一个强大的工具,它强化了类型安全和代码契约。在引入时,考虑其对现有系统的影响,并确保你的序列化、反序列化以及任何基于反射的逻辑都能正确处理它,就能充分发挥其价值。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

414

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

533

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

310

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

75

2025.09.10

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

338

2023.08.02

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

232

2023.09.22

java中null的用法
java中null的用法

在Java中,null表示一个引用类型的变量不指向任何对象。可以将null赋值给任何引用类型的变量,包括类、接口、数组、字符串等。想了解更多null的相关内容,可以阅读本专题下面的文章。

437

2024.03.01

if什么意思
if什么意思

if的意思是“如果”的条件。它是一个用于引导条件语句的关键词,用于根据特定条件的真假情况来执行不同的代码块。本专题提供if什么意思的相关文章,供大家免费阅读。

755

2023.08.22

Python GraphQL API 开发实战
Python GraphQL API 开发实战

本专题系统讲解 Python 在 GraphQL API 开发中的实际应用,涵盖 GraphQL 基础概念、Schema 设计、Query 与 Mutation 实现、权限控制、分页与性能优化,以及与现有 REST 服务和数据库的整合方式。通过完整示例,帮助学习者掌握 使用 Python 构建高扩展性、前后端协作友好的 GraphQL 接口服务,适用于中大型应用与复杂数据查询场景。

1

2026.01.21

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 8.4万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 3.2万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号