有关在.Net Core中以TEXT类型将Json格式字段存到数据库的学习

导言

在写个值日接口时发现值日表中的值日时段是可以分多段的，想了想可以使用Json类型来存，不过之前没接触过在后端操作Json格式存到数据库的情况，之后学也了解到了一下方法来实现，故记录一下。

过程

从前端到后端再到数据库的 JSON 字段传递过程通常涉及以下几个步骤：前端发送 JSON 数据，后端接受并处理，最终将数据存储到数据库。我们可以通过DTO限制前端传回的字段。

1. 前端发送 JSON 数据

假设前端使用的是 JSON 格式的数据，可以通过 POST 请求将数据发送到后端的 API。通常，这些数据通过一个表单或 AJAX 请求来提交。

2. 后端接收 JSON 数据（DTO）

后端通过控制器接收来自前端的 JSON 数据。在 ASP.NET Core 中，通常会定义一个 DTO（Data Transfer Object）类来接受和限制前端传入的字段。假设我们有一个 DutyDto 来定义允许前端传入的字段。

DTO 类：

/// <summary>
/// 值日创建Dto
/// </summary>
public class DutyCreateDto
{
    ...
    /// <summary>
    /// 值日时段
    /// </summary>
    [Display(Name = "值日时段")]
    [Required(ErrorMessage = "请设置值日时段/正确格式")]
    [JsonProperty("dutyInPeriods")]
    public List<DutyPeriodDto> DutyInPeriods { get; set; }

   ...
}

 /// <summary>
 /// 值日时段
 /// </summary>
 public class DutyPeriodDto
 {

     /// <summary>
     /// 描述:值日时间
     /// 空值:False
     /// 默认:
     /// </summary>
     [Display(Name = "值日时间")]
     [SugarColumn(IsPrimaryKey = true)]
     public int DutyTime { get; set; }

     /// <summary>
     /// 描述 : 开始时间
     /// 空值 : True
     /// 默认 : 
     /// </summary>
     [Display(Name = "开始时间")]
     public DateTime StartTime { get; set; }

     /// <summary>
     /// 描述 : 结束时间
     /// 空值 : True
     /// 默认 : 
     /// </summary>
     [Display(Name = "结束时间")]
     public DateTime EndTime { get; set; }
 }

swagger接口测试大概长这样：

3.接收数据的 API 控制器：将DTO映射为对应实体

/// <summary>
/// 新增值日
/// </summary>
/// <param name="parm"></param>
/// <param name="DeptID"></param>
/// <returns></returns>
[HttpPost]
[Authorization(Power = "PRIV_DUTY_CREATE")]
public IActionResult Create([FromBody] DutyCreateDto parm,string DeptID)
{
    ...
    
        var duty = parm.Adapt<Base_Duty>().ToCreate(_tokenManager.GetSessionInfo());

        // 使用 JSON 序列化将 Period 列表转换为字符串
        duty.DutyInPeriods = JsonConvert.SerializeObject(parm.DutyInPeriods);

        //插入值日表
        var respose = _dutyService.Add(duty);

    ...

}

4. 数据库中的 JSON 存储

在数据库中，JSON 数据通常存储为 TEXT 或 JSON 类型（取决于数据库的支持），注意不要用varchar来存，因为varchar能存的字符很少，如果单条数据的json数据过大的话会报错。

5. 从数据库读取 JSON 数据

说是json其实真正存的还是字符串类型所以正常拿就行。不过要把string类型再反序列变成json类型

//从数据库拿到数据
 var signIn = _signInService.GetId(parm.SignInID); 

// 将JSON字符串反序列化为List<SignInPeriods>对象列表
 var signInPeriodsList = JsonConvert.DeserializeObject<List<SignInPeriodsDto>>(signIn.SignInPeriods);

//之后当List<SignInPeriodsDto>用就行
//...

数据库存json方式：JSON和TEXT的比较

JSON:

优点：

• 结构化存储：数据库会验证 JSON 格式的正确性，并确保存储的数据是有效的 JSON。
• 高效查询：数据库提供对 JSON 字段的内置操作，可以直接在 SQL 查询中对 JSON 数据进行查询、筛选、修改。例如，查询 JSON 中的某个键值，或者使用 JSON 函数提取嵌套数据。
• 索引支持：有些数据库支持对 JSON 字段的键值进行索引，从而提升查询性能。

使用场景：

• 需要频繁对 JSON 数据进行查询和操作时。
• 需要验证和保持 JSON 数据的完整性和格式一致性。
• 需要数据库层面对 JSON 数据进行优化和索引。

TEXT：

优点：

• 兼容性高：适用于那些不支持原生 JSON 类型的数据库（如较老版本的数据库）。
• 简单存储：如果你不需要对 JSON 数据进行复杂的数据库操作，只需要保存和读取 JSON，这种方式可以满足需求。

缺点：

• 无法验证数据：数据库无法验证存储的数据是否是有效的 JSON 格式。
• 查询和操作不方便：如果需要在 SQL 中操作 JSON 字符串，必须手动解析 JSON，不能利用数据库的 JSON 函数。
• 性能较差：查询和操作 JSON 数据时，性能不如使用 JSON 类型。

这里我用了TEXT

总结

1. 前端到后端的 JSON 传递 ：前端通过 POST 请求发送 JSON 数据，后端通过 DTO 接收和限制字段。
2. DTO 到实体映射 ：后端将 DTO 数据映射为实体，并通过 JsonConvert.SerializeObject 将 JSON 数据存储为字符串。
3. 数据库中的 JSON 存储 ：数据库将 JSON 数据存储在 JSON 或 TEXT 类型字段中。
4. 从数据库读取 JSON ：从数据库读取 JSON 字符串时，使用 JsonConvert.DeserializeObject 反序列化为 C# 对象。