登录
推荐 文章 Go 技术 课程 下载 专题 AI
首页 >  Golang >  Go问答

Go JSONPatch Merge Patch 中的 null 为什么表示删除字段

来源:17golang原创

时间:2026-10-30 10:23:26 201浏览 收藏

在 Go evanphx/json-patch 的 Merge Patch 中,补丁对象里的 "phone": null 表示删除 phone 成员,这是 RFC 7396 规定的补丁语义,不是把成员值设成 JSON null。若需要保留字段并赋显式 null,应使用能区分操作与数据的 JSON Patch,或为接口设计另一套明确的更新协议。

官方地址:https://github.com/evanphx/json-patch

要注意这个结论的范围:它针对补丁对象成员中的 null。不要进一步推断成“JSON里的null都代表删除”,也不要把 JSON Patch 与 JSON Merge Patch 两种格式当作同一种输入。

对象成员里的 null 是操作约定

普通业务文档的 null 是数据值,补丁则还需要表达“想对原文档做什么”。Merge Patch 借用对象形状表达更新:未提及的成员保持原状,给出新值的成员被更新,而 null 被用作删除信号。这使常见对象更新简洁,也带来了无法直接用同一写法表达“赋null”的取舍。

比如联系方式对象原来有 email 和 phone,补丁只给出 phone:null,表示移除 phone,email 不受这项局部更新影响。缺省、删除和置空由此成为三个需要分别设计的动作,而不是三种可以随意替换的拼写。

Merge Patch对象成员的静态语义关系
Merge Patch 对象成员的静态语义说明图。

先把省略、删除与赋空值分开

输入意图Merge Patch写法含义
不修改phone不出现phone成员保留目标中原来的成员状态
删除phone{"phone":null}移除对应成员
写入空字符串{"phone":""}phone存在且值为空字符串
保留phone并写入null不能以同一成员null写法表达需要其他明确操作表示

如果目标本来就没有该成员,补丁中对应的删除标记不会凭空创建一个值为 null 的成员。另一方面,目标中原有的 null 成员,在补丁没有触及它时可以继续保留;Merge Patch 并不是遍历原文档删除所有 null。

用 Go 对照删除成员与保留 null

下面的完整示例对同一份原文档分别应用两种补丁。第一种调用 MergePatch;第二种通过 DecodePatch 解码操作列表后 Apply。它们使用不同的输入格式,不能交换解析入口。

package main

import (
    "fmt"
    "log"

    jsonpatch "github.com/evanphx/json-patch/v5"
)

func main() {
    original := []byte(`{"label":"仓库A","contact":{"email":"team@example.invalid","phone":"100"},"memo":"保留"}`)
    // Merge Patch 的对象成员null表示删除;未提到的成员保留。
    merge := []byte(`{"contact":{"phone":null}}`)
    removed, err := jsonpatch.MergePatch(original, merge)
    if err != nil {
        log.Fatalf("合并补丁失败: %v", err)
    }
    fmt.Println("删除phone成员:", string(removed))

    // JSON Patch 显式指定替换操作,null在这里作为要写入的数据。
    patch, err := jsonpatch.DecodePatch([]byte(
        `[{"op":"replace","path":"/contact/phone","value":null}]`,
    ))
    if err != nil {
        log.Fatalf("操作补丁解析失败: %v", err)
    }
    setNull, err := patch.Apply(original)
    if err != nil {
        log.Fatalf("操作补丁应用失败: %v", err)
    }
    fmt.Println("保留phone并赋null:", string(setNull))
}

按两种协议的定义,第一份结果中 contact 仍保留 email,但没有 phone 键;第二份结果中 phone 键仍然存在,值是 null。示例供读者自行运行,本文没有提供实际执行日志,也不依赖输出中的对象成员顺序。

JSON Patch 示例使用 replace,是因为原文档中 phone 已经存在。若路径不存在,replace 的前提不成立,应用会报错;是否改用 add,应根据接口的具体需求决定。不要为了“兼容”就一概忽略错误,否则可能掩盖目标文档与调用方认知不一致的问题。

Merge Patch与JSON Patch表达能力静态结构
两种补丁格式表达能力的静态结构说明图。

数组和顶层值不要套用成员删除规则

Merge Patch 对数组采用整体替换思路,不会因为数组里有 null 就把那个元素当成对象成员删除。若只想修改数组中的某一项,需要选择适合的操作格式,不能把索引更新误写成普通对象合并。

在规范中,补丁整体不是对象时,含义是用该补丁值替换整个目标。因此顶层补丁 null 与对象成员 phone:null 处在不同语义层级。若业务接口只接受对象更新,可以在自己的输入契约中明确拒绝非对象补丁;这是一项接口政策,不是把 RFC 的顶层含义重新定义掉。

同理,把非对象目标交给对象补丁时,也不能假定原始标量或数组内容仍会像对象成员那样保留。更新前应先确定资源的数据模型,而不是仅凭补丁是一段合法 JSON 就认定适合当前目标。

在接口文档中写清楚空值政策

面向调用方的更新接口,应明确“字段没传”“传null”“传空字符串”分别意味着什么。若采用标准 Merge Patch,使用 application/merge-patch+json 描述格式;若采用 JSON Patch,则使用对应的操作列表协议。不要只写一个含糊的“传JSON即可”。

Go 请求结构体若只用一个可空指针字段,也可能难以在普通解码后区分未传和显式null。需要保留这一区别时,可使用能记录成员存在性的输入表示,或专门的三态字段模型。如何解码属于应用设计,不能靠改变 MergePatch 的含义来弥补。

已有接口如果把null约定为置空,直接改用 Merge Patch 可能变成删除字段,应作为协议变更向调用方说明。这里解释的是已有标准的语义取舍,不是宣称某个新版本突然更改了null的含义。

  • 对象局部更新且很少需要显式null:Merge Patch较直观。
  • 需要明确区分删除与null数据:优先考虑显式操作格式。
  • 数组局部修改:不要误用整体数组替换。
  • 字段是否允许删除:仍由资源模型和业务规则决定。

空字符串能代替null吗?只有业务把空字符串视为合法数据时才合适;它与缺失字段、null不是同一个状态。

空对象补丁会清空整个目标对象吗?对对象目标而言,不包含成员的对象补丁不会删除已有成员;不要把它当成清空所有字段的命令。

Go nil 等同于补丁null吗?要看它最终序列化出的JSON和所在位置。理解协议应以实际JSON结构为准,不能只看Go变量名或零值。

参考:RFC 7396 JSON Merge Patch、Go JSON-Patch 官方用法。

声明:本文转载于:17golang原创 如有侵犯,请联系study_golang@163.com删除
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>