swagger2配置实体类不生效（swagger怎么配置）

科技前沿 • 2025-05-27 13:41 • 阅读 33

大家好，我是讯享网，很高兴认识大家。

 </nav><p>从 .NET 9 开始， 在序列化和反序列化中都（有限地）支持不可为 null 的引用类型强制实施。 可以使用 JsonSerializerOptions.RespectNullableAnnotations 标志切换此支持。</p>

讯享网

例如，以下代码片段在序列化过程中引发，并显示如下消息：

类型“Person”的属性或字段“Name”不允许获取 null 值。请考虑更新其可为 Null 性批注。

讯享网

同样，RespectNullableAnnotations 对反序列化强制执行可为 Null 性。以下代码片段在序列化过程中引发，并显示如下消息：

类型“Person”上的构造函数参数“Name”不允许 null 值。请考虑更新其可为 Null 性批注。

讯享网

由于不可为 null 引用类型的实现方式，此功能存在一些重要限制。在启用该功能之前，请熟悉这些限制。问题的根是引用类型可为 Null 性在中间语言 (IL) 中没有一流的表示形式。因此，从运行时反射的角度来看，表达式和是无法区分的。虽然编译器试图通过发出属性元数据来弥补这一点（请参阅 sharplab.io 示例），但此元数据仅限于特定类型定义范围内的非通用成员注释。此限制是因为该标志仅验证存在于非通用属性、字段和构造函数参数上的可为 Null 性注释。 System.Text.Json 不支持对以下对象强制执行可为 Null 性：

顶级类型，或在进行第一次或调用时传递的类型。
集合元素类型，例如，和类型无法区分。
任何通用属性、字段或构造函数参数。

如果要在这些情况下添加可为 null 性强制，要么将你的类型建模为结构（因为它们不允许 null 值），要么编写一个自定义转换器，将其 HandleNull 属性重写为。

可以使用功能开关全局打开设置。将以下 MSBuild 项添加到项目文件（例如，.csproj 文件）：

讯享网

API 在 .NET 9 中作为选择加入标志实现，以避免中断现有应用程序。如果要编写新应用程序，强烈建议在代码中启用此标志。

RespectNullableAnnotations 不会将强制措施扩展到未指定的 JSON 值，因为 System.Text.Json 将必需和不可为 null 的属性视为正交概念。例如，以下代码段在反序列化过程中不会引发异常：

此行为源于 C# 语言本身，你可以在其中具有可以为 Null 的必需属性：

讯享网

还可以具有不可为 Null 的可选属性：

同样的正交性也适用于构造函数参数：

讯享网

非可选构造函数参数

swagger2配置实体类不生效（swagger怎么配置）

相关推荐