导航属性转JSON及JSON Schema生成错误排查与解决

一、先明确类结构（基于导航属性关联的典型场景，替换成你的实际代码即可） #

public class Schedule
{
    public int Id { get; set; }
    public string Name { get; set; }
    public ICollection<OperativeSchedule> OperativeSchedules { get; set; }
    // 对应"request字段缺失"错误中的Request属性
    public string Request { get; set; }
}

public class OperativeSchedule
{
    public int Id { get; set; }
    public int ScheduleId { get; set; }
    public Schedule Schedule { get; set; }
    public int OperativeId { get; set; }
    public Operative Operative { get; set; }
    public DateTime StartTime { get; set; }
}

public class Operative
{
    public int Id { get; set; }
    public string FullName { get; set; }
    public string Specialty { get; set; }
}

二、解决两个核心错误 #

1. "request字段缺失" 问题 #

• 先检查你的Schedule类是否存在Request属性（注意大小写：C#默认PascalCase，JSON里如果是小写request，要确保序列化/反序列化时处理大小写匹配）
• 如果类里确实有这个属性，JSON数据必须包含"request": "对应值"字段；如果不需要这个属性，检查是否有验证逻辑强制要求它存在，或者直接从Schema中移除该字段的必填约束

2. "JSON值无法转换为OperativeSchedule类型" 问题 #

这个错误基本是以下几种情况导致，逐一排查：

• 循环引用：OperativeSchedule同时关联Schedule和Operative，序列化时容易出现循环引用。解决方式是在序列化配置中忽略循环引用：
  • Newtonsoft.Json配置：

    var settings = new JsonSerializerSettings
    {
        ReferenceLoopHandling = ReferenceLoopHandling.Ignore,
        ContractResolver = new CamelCasePropertyNamesContractResolver() // 匹配JSON小写字段
    };
    string json = JsonConvert.SerializeObject(yourScheduleInstance, settings);
    

  • System.Text.Json配置：

    var options = new JsonSerializerOptions
    {
        ReferenceHandler = ReferenceHandler.IgnoreCycles,
        PropertyNamingPolicy = JsonNamingPolicy.CamelCase
    };
    string json = JsonSerializer.Serialize(yourScheduleInstance, options);
    

• JSON结构不匹配：确保JSON中operativeSchedules数组的每个对象和OperativeSchedule类属性完全对应，比如有没有缺scheduleId、operativeId，或者字段名大小写不对
• 导航属性初始化问题：如果反序列化时OperativeSchedule的Schedule或Operative属性是null，但代码期望被填充，要么在JSON里包含这些嵌套对象，要么配置反序列化允许null

三、生成可用的JSON Schema #

基于上述类结构，生成的JSON Schema（处理了循环引用、大小写匹配问题）：

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "title": "Schedule",
  "required": ["id", "name", "request"], // 如果request不是必填，直接移除该字段
  "properties": {
    "id": {
      "type": "integer",
      "description": "Schedule唯一ID"
    },
    "name": {
      "type": "string",
      "description": "Schedule名称"
    },
    "request": {
      "type": "string",
      "description": "请求相关内容"
    },
    "operativeSchedules": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/OperativeSchedule"
      }
    }
  },
  "definitions": {
    "OperativeSchedule": {
      "type": "object",
      "required": ["id", "scheduleId", "operativeId", "startTime"],
      "properties": {
        "id": {
          "type": "integer"
        },
        "scheduleId": {
          "type": "integer",
          "description": "关联的Schedule ID"
        },
        "operativeId": {
          "type": "integer",
          "description": "关联的Operative ID"
        },
        "startTime": {
          "type": "string",
          "format": "date-time",
          "description": "手术开始时间"
        },
        "operative": {
          "$ref": "#/definitions/Operative"
        }
        // 移除了schedule属性的引用，避免循环引用；如果需要保留，JSON中不要嵌套Schedule对象，只存scheduleId即可
      }
    },
    "Operative": {
      "type": "object",
      "required": ["id", "fullName"],
      "properties": {
        "id": {
          "type": "integer"
        },
        "fullName": {
          "type": "string",
          "description": "手术医生全名"
        },
        "specialty": {
          "type": "string",
          "description": "医生专长"
        }
      }
    }
  }
}

四、测试用JSON示例 #

以下是符合上述Schema的JSON，可用于验证反序列化：

{
  "id": 1,
  "name": "Q3心脏手术安排",
  "request": "2024年第三季度心脏手术排期",
  "operativeSchedules": [
    {
      "id": 101,
      "scheduleId": 1,
      "operativeId": 201,
      "startTime": "2024-07-01T09:00:00Z",
      "operative": {
        "id": 201,
        "fullName": "Smith医生",
        "specialty": "心血管外科"
      }
    }
  ]
}

内容的提问来源于stack exchange，提问作者virendra-vyas