使用System.Text.Json简化.NET 6中JSON对象值的存在性校验

我在.NET 6里用System.Text.Json做JSON序列化和反序列化，现在碰到个麻烦事：没法方便地验证那些可选类是否存在、属性有没有有效值。我的类结构是这样的：

class Request
{
    public string RequestID { get; set; }
    public User User { get; set; }
    // 其他属性...
}

class User
{
    public string UserID { get; set; }
    public string Username { get; set; }
    public bool? SomeOptionalBoolean { get; set; }
}

JSON反序列化成Request实例后，Request里可能没有User对象，直接访问request.User.UserID会触发空引用异常。我现在只能逐个检查类和属性是否为null，比如：

internal static bool IsUserValid(Request request)
{
    if (request.User == null || request.User.UserID == null || request.User.Username == null)
    {
        return false;
    }
    return true;
}

static void Main(string[] args)
{
    if (IsUserValid(request))
    {
        Console.WriteLine(request.User.UserID);
    }
}

这种方法能安全访问必填属性，但太繁琐了，肯定有更优的方案。我搜过JsonRequired属性这类方法，但没找到匹配我场景的模式，想知道怎么不用给每个类都写验证逻辑来简化这个过程？

1. 用模式匹配简化多层空检查 #

不用单独写验证方法，直接在访问时用C#的模式匹配语法，把多层空判断合并成一行：

static void Main(string[] args)
{
    // 一次性匹配User不为null，且UserID、Username都不为null的场景
    if (request is { User: { UserID: not null, Username: not null } })
    {
        Console.WriteLine(request.User.UserID);
    }
}

这种写法简洁直观，省去了单独编写验证函数的麻烦，可读性也很强。

2. 结合Nullable引用类型+数据注解做反序列化校验 #

先在项目文件中开启Nullable引用类型（添加<Nullable>enable</Nullable>），然后给必填属性加上[Required]和[JsonRequired]注解，让反序列化阶段自动校验必填项：

修改类定义：

using System.ComponentModel.DataAnnotations;
using System.Text.Json.Serialization;

class Request
{
    [Required, JsonRequired]
    public string RequestID { get; set; }
    // User是可选对象，所以不加必填注解
    public User? User { get; set; }
}

class User
{
    [Required, JsonRequired]
    public string UserID { get; set; }
    [Required, JsonRequired]
    public string Username { get; set; }
    public bool? SomeOptionalBoolean { get; set; }
}

反序列化时启用校验：

var options = new JsonSerializerOptions
{
    PropertyNameCaseInsensitive = true
};

try
{
    var request = JsonSerializer.Deserialize<Request>(jsonString, options);
    // 只要User不为null，那它的必填属性肯定已经通过反序列化校验了
    if (request?.User != null)
    {
        Console.WriteLine(request.User.UserID);
    }
}
catch (JsonException ex)
{
    // 捕获必填项缺失或无效的异常
    Console.WriteLine($"校验失败：{ex.Message}");
}

如果JSON里存在User对象但缺少UserID/Username，反序列化时会直接抛出JsonException，不用手动编写检查逻辑。

3. 封装通用验证方法复用逻辑 #

如果需要在多个地方复用验证逻辑，可以写一个通用扩展方法，通过反射自动检查带有[Required]注解的属性（包括嵌套对象）：

using System.ComponentModel.DataAnnotations;
using System.Reflection;

public static class ValidationExtensions
{
    public static bool IsValid<T>(this T obj) where T : class
    {
        if (obj == null) return false;
        
        var properties = typeof(T).GetProperties(BindingFlags.Public | BindingFlags.Instance);
        foreach (var prop in properties)
        {
            // 检查带有Required注解的属性是否为null
            if (prop.GetCustomAttribute<RequiredAttribute>() != null)
            {
                var value = prop.GetValue(obj);
                if (value == null)
                {
                    return false;
                }
                // 嵌套引用类型递归验证（排除string）
                if (prop.PropertyType.IsClass && prop.PropertyType != typeof(string))
                {
                    if (!IsValid(value))
                    {
                        return false;
                    }
                }
            }
        }
        return true;
    }
}

使用时直接调用扩展方法：

static void Main(string[] args)
{
    if (request?.User.IsValid() == true)
    {
        Console.WriteLine(request.User.UserID);
    }
}

这个方法会自动遍历对象的必填属性，包括嵌套对象的校验，不用为每个类单独编写验证函数。

内容的提问来源于stack exchange，提问作者roccne