标签 github 下的文章

关于Go错误处理新提案的一个想法:?操作符这样用行不行

本文永久链接 – https://tonybai.com/2025/02/08/personal-idea-about-using-question-mark-operator-in-go-error-handling-new-proposal

0. 背景

Ian Taylor在关闭了旨在消除Go错误处理样板代码的issue之后,又另起了一个“同名”的discussion。错误处理真不愧是Go社区呼声最高的问题,几天之内又收到了近500条回复!不过到目前为止,依然没有形成统一和高赞的意见。

关于error handling的样板代码过多,其实我个人是可以接受的,即便不做出任何改变也是ok的,估计Go社区与我有相同看法的也不在少数。比如就有人引用了Rob Pike的权威观点,并认为Go应该按照Rob大神的思路,保持Go语法稳定:
 

 
不过自然也会有另外一批人强烈希望错误处理的样板代码得到改进。

Ian Taylor在discussion中明确了该提案的目标是引入一种新语法,在不影响控制流清晰度的前提下,减少正常情况下检查错误所需的代码量
 
Ian最初的Proposal由于隐式声明变量err以及可选代码块等问题而备受“批评”,并且似乎该proposal违反了他自己提出的目标。
 
今天在discussion中看到一位名为Mukunda Johnson的gopher的评论,我觉得很有道理。其核心观点就是:尽量保持Go的传统语法形式。他还给出了期望中的语法示例:

// 当前错误处理样板代码过多的示例
f, err := open(file)
if err != nil {
   return err
}
defer f.Close()

if err = binwrite(f, signature); err != nil {
   return err
}
if err = binwrite(f, header); err != nil {
   return err
}
if err = binwrite(f, zeroSegment); err != nil {
   return err
}

for _, s := range segments {
   if err = binwrite(f, s); err != nil {
      return err
   }
}

if err = binwrite(f, footer); err != nil {
   return err
}

vs. 

// 使用新语法改进后的代码
f, err := open(file)?
defer f.Close()

binwrite(f, signature)?
binwrite(f, header)?
binwrite(f, zeroSegment)?

for _, s := range segments {
   binwrite(f, s)?
}

binwrite(f, footer)?

这给了我很大启发:我们可以引入?语法,但是如果结合原先err变量的声明形式岂不是更好!比如:

f, err := open(file)?

岂不是要比下面两种形式更好!

f := open(file)?

或

f := open(file)? err { }

通过仅引入一个问号(?)操作符,并避免引入过多的新语法形式,却能解决60%的错误处理样板问题。根据jba对Go开源代码中错误处理的抽样统计,超过60%的错误处理都是直接返回err,而没有对err进行任何修饰。此外,显式声明err可以最大程度地避免隐式声明带来的问题,同时提升代码的可读性。

因此,基于尽量使用已有Go代码风格、最大程度避免隐式声明,并仅解决最常见的错误处理样板代码的原则,下面我基于Ian提案的错误处理改进语法,谈点自己关于新?操作符使用的想法,大家看看是否可行。

1. 对于最常见的未经修饰的错误处理代码

err := SomeFunction2()
if err != nil {
    return err
}

或是

if err := SomeFunction2(); err != nil {
    return err
}

我们使用下面的新语法做等价替代:

err := SomeFunction2() ?

如果声明的错误变量名为err,也可省略赋值操作符左侧代码,从而简化为:

SomeFunction2() ? // 这里略带隐式

2. 如果函数返回值有多个,甚至有多个错误变量的情况

比如下面代码:

a, b, err0, err1, err2 := SomeFunction3()
if err2 != nil {
    return err2
}

我们可以将其改写为:

a, b, err0, err1, err2 := SomeFunction3()?

其语义是如果err2不为nil,返回err2,但前提要保证赋值语句的左侧的最后一个变量err2必须是实现error接口的类型的变量。

如果是像下面这样在err2 != nil时有多个返回值,又该如何处理呢?

a, b, err0, err1, err2 := SomeFunction3()
if err2 != nil {
    return a, b, err2
}

对于这种情况,我认为可以不在新方案的考虑范围之内,现在怎么写,请继续这么写。如果非要解决,请继续看后面支持可选代码块的情况。

实现以上两种情况,就能解决60%以上的错误样板代码问题了!

3. 对于对返回的error值进行修饰的情况

对于像下面两种对返回的error变量进行修饰的情况:

r, err := SomeFunction()
if err != nil {
    return fmt.Errorf("something failed: %v", err)
}

if err := SomeFunction2(); err != nil {
    return fmt.Errorf("something else failed: %v", err)
}

我的第一想法是保持现状 ,不在新方案考虑范围之内。

不过如果非要在新方案中解决,那就需要引入可选代码块(optional block)了!比如:

r, err := SomeFunction() ? {
    return fmt.Errorf("something failed: %v", err)
}

err := SomeFunction2() ? {
    return fmt.Errorf("something else failed: %v", err)
}

和Ian的原proposal中语法不同,这里我们依然显式声明了err,当然你也可以不用err这个名字,由于是显式声明,你用任何名字均可,比如:

r, e := SomeFunction() ? {
    return fmt.Errorf("something failed: %v", e)
}

myErr := SomeFunction2() ? {
    return fmt.Errorf("something else failed: %v", myErr)
}

这将避免隐式声明带来的诸多问题!

基于可选代码块,我们也可以处理一下前面提到的返回多个值的情况。下面代码

a, b, err0, err1, err2 := SomeFunction3()
if err2 != nil {
    return a, b, err2
}

可以改写为:

a, b, err0, err1, err2 := SomeFunction3() ? {
    return a, b, err2
}

这里加入可选代码块后,我建议开发人员负责显式调用return,而不是由?操作符来自动return,也就是说完全将控制权交给你。如果你没有在可选代码块中调用return,那么代码在执行完可选代码块中的代码后,还会继续向下执行。可选代码块相当于一个error handler,而不带可选代码块的情况,默认的error handler其实就是一个return err,伪代码类似这样:

err := SomeFunction2() ?

<=>

err := SomeFunction2() ? {
    return err
}

这样解释后,你是不是觉得在语义层面,不带可选代码块与带有可选代码块的情况就统一和一致了呢!

本质上来说,?+可选代码块仅是让你少敲了个if以及err != nil

4. 综合示例

Mukunda Johnson给出的示例其实已经可以很好地展示?操作符+显式声明err方案带来的消除样板代码的效果,这里再回顾一下(这里没用到可选代码块,因此代码显得格外清晰):

f, err := open(file)?
defer f.Close()

binwrite(f, signature)?
binwrite(f, header)?
binwrite(f, zeroSegment)?

for _, s := range segments {
   binwrite(f, s)?
}

binwrite(f, footer)?

此外,在原discussion中,另外一个gopher提出的示例,我们也可以用上面的想法改写一下:

// 最常见的情况
SomeFunc() ?

// 多个返回值,最后一个为error变量
a, err1 := SomeFunction2() ?

// 返回前对err进行修饰
err := SomeFunc() ? {
  return fmt.Errorf("oh no: %w", err)
}

// 显式声明避免变量遮蔽
err := SomeFunc() ?  {
  otherErr := OtherFunc() ?  {
    err = errors.Wrap(err, otherErr) // 在可选代码块中没有显式调用return,代码还会继续向后执行
  }
  return fmt.Errorf("oh no: %w", err)
}

5. 小结

再来简单总结一下上面想法中的语法形式的优势:

  • 与传统Go语法形式几乎一致,尽量避免引入过多新语法形式,在不使用可选代码块的时候,只是多了一个问号(?)。
  • 显式声明err变量,最大程度避免隐式声明带来的问题。
  • 专注解决最常见的错误处理样板情景,其他场景保持当前写法即可。
  • 即便引入可选代码块,本质上与不用可选代码块的语法在语义层面也是统一和一致的。

这一语法方案保留了原Ian提案中的优势,并能消除一些缺点,如变量遮蔽和隐式声明等。不过,仍然有些原proposal中的劣势问题无法完全消除,但这些问题显然不是主要关注点。

需要注意的是,以上想法目前仅停留在形式讨论层面,技术层面是否可行尚不确定。

大家认为我的想法可行吗?希望大家能提出更具建设性的意见^_^。


Gopher部落知识星球在2025年将继续致力于打造一个高品质的Go语言学习和交流平台。我们将继续提供优质的Go技术文章首发和阅读体验。并且,2025年将在星球首发“Go陷阱与缺陷”和“Go原理课”专栏!此外,我们还会加强星友之间的交流和互动。欢迎大家踊跃提问,分享心得,讨论技术。我会在第一时间进行解答和交流。我衷心希望Gopher部落可以成为大家学习、进步、交流的港湾。让我相聚在Gopher部落,享受coding的快乐! 欢迎大家踊跃加入!

img{512x368}
img{512x368}

img{512x368}
img{512x368}

著名云主机服务厂商DigitalOcean发布最新的主机计划,入门级Droplet配置升级为:1 core CPU、1G内存、25G高速SSD,价格6$/月。有使用DigitalOcean需求的朋友,可以打开这个链接地址:https://m.do.co/c/bff6eed92687 开启你的DO主机之路。

Gopher Daily(Gopher每日新闻) – https://gopherdaily.tonybai.com

我的联系方式:

  • 微博(暂不可用):https://weibo.com/bigwhite20xx
  • 微博2:https://weibo.com/u/6484441286
  • 博客:tonybai.com
  • github: https://github.com/bigwhite
  • Gopher Daily归档 – https://github.com/bigwhite/gopherdaily
  • Gopher Daily Feed订阅 – https://gopherdaily.tonybai.com/feed

商务合作方式:撰稿、出书、培训、在线课程、合伙创业、咨询、广告合作。

Go encoding/json/v2提案:JSON处理新引擎

本文永久链接 – https://tonybai.com/2025/02/05/go-encoding-json-v2-proposal-json-processing-new-engine

Go标准库中的encoding/json包,作为Go社区广泛使用的JSON处理工具,至今已走过十余年。凭借其将JSON数据与原生Go类型相互转换的能力、通过struct tag自定义字段表示的灵活性,以及Go类型自定义JSON格式的特性,赢得了Go开发者的青睐。

然而,随着时间的推移,encoding/json的局限性也逐渐显现。孤立地解决这些问题可能会导致非正交特性之间产生意外的交互。因此,Go团队在2023年下旬发起了关于encoding/json/v2的讨论,旨在全面审视现有encoding/json包,并提出一个面向未来十年的Go JSON处理方案,打造一个 JSON处理新引擎

经过近一年多的讨论、设计调整以及参考实现的优化,Go团队于近期正式提出了关于encoding/json/v2的提案issue。在该issue中,Go团队梳理并总结了讨论结果以及初始设计与后续调整之间的差异,以供Go社区进一步审阅与反馈。

为了让大家更好地了解该提案issue的核心内容,本文将对提案的背景、主要内容、相对于v1版本的主要改进,以及与v1版本的联系等进行全面介绍,希望通过这篇文章,大家能够及时了解到Go标准库json包的演进与变化。

1. 提案背景:现有encoding/json包的局限与改进的需求

在过去十年中,开发者在使用encoding/json的过程中,逐渐意识到了它在功能、API设计、性能和行为上存在的不足。这些问题可以归纳为以下几个方面,也正是encoding/json/v2提案希望解决的核心痛点:

1.1 功能缺失 (Missing functionality)

尽管encoding/json功能完善,但仍存在一些重要的功能缺失,社区也为此提出了诸多Feature Request,其中最突出的包括:

  • time.Time的自定义格式化 (#21990): 缺乏灵活的方式来指定time.Time类型在JSON中的格式,例如自定义日期时间字符串格式。
  • Marshal时忽略特定Go值 (#11939, #22480, #50480, #29310, #52803, #45669): 现有的omitempty标签在某些场景下无法满足需求,开发者希望更精细地控制哪些Go值在Marshal时被忽略,例如忽略零值、空值或特定条件下的值。Go 1.24版本增加了omitzero tag,将在一定层度缓解这个问题。
  • 将nil切片和mapMarshal为空JSON数组和对象 (#37711, #27589): encoding/json默认将nil切片和mapMarshal为JSONnull,但在某些场景下,开发者更期望将其Marshal为空的JSON数组[]和对象{}。
  • 无Go嵌入的Inline类型 (#6213): 希望能够更灵活地将Go类型内联到JSON对象中,而无需依赖Go的struct嵌入机制。

虽然这些功能缺失大部分可以通过向现有encoding/json包添加新功能来解决,但可能会导致API变得臃肿和复杂。

1.2 API 设计缺陷 (API deficiencies)

encoding/json的API设计存在一些尖锐或限制性的问题,影响了开发者的使用体验:

  • 难以正确地从io.Reader进行Unmarshal: 常用的json.NewDecoder(r).Decode(v)方法并不能正确处理JSON payload末尾的垃圾数据 (#36225),容易导致数据解析错误。
  • Marshal和Unmarshal函数无法使用Options: 虽然Encoder和Decoder类型支持Options配置,但Marshal和Unmarshal函数却无法使用,同样,实现Marshaler和Unmarshaler接口的类型也无法利用Options,缺乏选项配置的传递机制(#41144)。
  • Compact, Indent, HTMLEscape函数输出目标受限: 这些格式化函数只能将结果写入bytes.Buffer,而不是更灵活的[]byte或io.Writer,限制了函数的使用场景。

这些API缺陷可以通过向现有encoding/json包引入新的API来修复,但这可能会导致同一个任务在同一个包中存在多种不同的实现方式,增加学习成本和使用困惑。

1.3 性能限制 (Performance limitations)

encoding/json的性能表现一直备受关注,存在诸多限制性能提升的因素:

  • MarshalJSON接口: 强制实现者分配[]byte返回值,且encoding/json需要再次解析返回值以验证JSON的有效性并重新格式化,造成不必要的性能开销。
  • UnmarshalJSON接口: 要求提供完整的JSON value,导致encoding/json需要预先完整解析JSON值以确定边界,之后UnmarshalJSON方法本身还需要再次解析,如果UnmarshalJSON递归调用Unmarshal,则会导致O(N²)的性能退化,例如Kubernetes kube-openapi项目在Unmarshalspec.Swagger时遇到的性能瓶颈 (kubernetes/kube-openapi#315)。
  • Encoder.WriteToken: 缺乏流式Encoder API,虽然提案已被接受(#40127),但尚未实现,且可能同样存在性能问题。
  • Decoder.Token: Token类型是一个接口,可以容纳多种类型 (Delim, bool, float64, Number, string, nil),当boxing数字或字符串到Token接口类型时,会频繁发生内存分配 (#40128)。
  • 缺乏真正的流式处理: 即使Encoder.Encode和Decoder.Decode方法操作io.Writer和io.Reader,它们仍然会将整个JSON value缓冲到内存中,需要二次扫描JSON,与流式处理的初衷背道而驰 (#33714, #7872, #11046)。

encoding/json应该默认以真正的流式方式操作io.Writer和io.Reader。缓冲整个JSON value违背了使用io.Reader和io.Writer的意义。希望避免在发生错误时输出JSON 的用例应该调用Marshal,并在错误为nil时才写入输出。不幸的是,encoding/json无法默认切换到流式处理,因为这将是一个破坏性的行为变更,暗示着需要一个v2版本的json包来实现这个目标。

1.4 行为缺陷 (Behavioral flaws)

encoding/json在行为上存在诸多缺陷,随着JSON规范的日益严格 (RFC 4627, RFC 7159, RFC 7493, RFC 8259),这些缺陷显得愈发突出:

  • JSON 语法处理不严谨: encoding/json允许无效UTF-8字符,而最新的互联网标准 (RFC 8259) 要求使用有效的UTF-8编码。默认行为至少应符合RFC 8259,将无效UTF-8视为错误。
  • 允许重复的对象成员名称: RFC8259规定,重复的对象成员名称会导致未指定的行为。从安全角度考虑,默认行为应更严格,拒绝重复名称,正如 RFC 7493 所建议的那样。
  • Unmarshal时大小写不敏感: Unmarshal时,JSON对象名称与Go struct字段名称使用大小写不敏感匹配 (#14750),这既令人意外,也可能存在安全漏洞和性能瓶颈。
  • 类型定义方法调用不一致: 由于encoding/json及其对Go反射的使用,MarshalJSON和UnmarshalJSON方法在底层值不可寻址时无法调用 (#22967, #27722, #33993, #55890)。
  • Merge语义不一致: Unmarshal到非空的Go值时,是否清除目标、重置并重用目标内存、或合并到目标的行为不一致 (#27172, #31924, #26946)。
  • Error 类型不一致: encoding/json返回的Error类型不一致,难以可靠地检测Syntactic error, Semantic error, I/O error等不同类型的错误。

这些行为缺陷在不破坏向后兼容性的前提下难以修复。虽然可以添加选项来指定不同的行为,但这并非理想方案,因为期望的行为不应作为非默认选项存在。改变默认行为同样意味着需要一个v2版本的json包。

为了解决上述encoding/json包的种种问题,并为Go语言构建更强大、更现代化的JSON处理能力,Go团队正式提出了encoding/json/v2提案。正如“JSON处理新引擎”这个本文标题所寓意的,encoding/json/v2并非简单的修补和改进,而是一次对Go语言JSON处理的彻底革新。下面我们就来介绍一下这个新json引擎的主要功能和特点。

2. encoding/json/v2:Go JSON处理的新引擎

encoding/json/v2提案并非简单地对现有encoding/json进行升级,而是引入了两个全新的包:

  • encoding/json/jsontext: 这是一个纯语法层面的JSON处理包,专注于JSON语法的解析和生成,不依赖Go反射。它提供了对JSON令牌(Token)和原始值(Value)的操作,允许开发者在语法层面精细地控制JSON的编解码过程。
  • encoding/json/v2: 这是一个语义层面的JSON处理包,基于jsontext包实现,并依赖Go反射。它继承了encoding/json的核心功能,负责将Go值与JSON数据进行语义上的转换(Marshal 和 Unmarshal),并提供了更丰富的功能和更优的性能。

提案中还给出了两者的关系图,通过该图大家可以更直观地看出两个包之间的关系:

此外,提案还考虑了与现有encoding/json的兼容性,并提供了选项来实现互操作。encoding/json包本身也将被重构,底层实现将基于encoding/json/v2来重新实现

下面是对jsontext包和json/v2包的核心API的介绍。

2.1 encoding/json/jsontext包的关键API

jsontext包提供了Encoder和Decoder类型,用于JSON的编码和解码,以及Token和Value类型来表示JSON的语法元素。

package jsontext // "encoding/json/jsontext"

type Encoder struct { /* no exported fields */ }
func NewEncoder(io.Writer, ...Options) *Encoder
func (*Encoder) WriteToken(Token) error
func (*Encoder) WriteValue(Value) error

type Decoder struct { /* no exported fields */ }
func NewDecoder(io.Reader, ...Options) *Decoder
func (*Decoder) PeekKind() Kind
func (*Decoder) ReadToken() (Token, error)
func (*Decoder) ReadValue() (Value, error)
func (*Decoder) SkipValue() error

type Kind byte // JSON 令牌类型
type Token struct { /* no exported fields */ } // JSON 令牌
type Value []byte // JSON 原始值

其中:

  • Encoder和Decoder: 提供流式的JSON编码和解码能力,操作io.Writer和io.Reader。
  • Token: 表示JSON的基本语法单元,例如null, true, false, 字符串, 数字, 对象开始{, 对象结束}, 数组开始[, 数组结束]等。
  • Value: 表示JSON的原始值,可以是完整的JSON对象或数组,类似于encoding/json中的RawMessage。
  • Kind: 枚举类型,表示Token和Value的类型,例如’n'(null),’t'(true),’”‘(string),’{‘(object start) 等。

jsontext包还提供了格式化JSON的函数,例如AppendFormat, AppendQuote, AppendUnquote等,以及用于配置行为的Options类型。

2.2 encoding/json/v2包的关键API

encoding/json/v2包提供了Marshal, Unmarshal等核心函数,以及MarshalWrite, MarshalEncode, UnmarshalRead, UnmarshalDecode等变体,用于不同场景下的JSON编解码。

package json // "encoding/json/v2"

func Marshal(in any, opts ...Options) (out []byte, err error)
func MarshalWrite(out io.Writer, in any, opts ...Options) error
func MarshalEncode(out *jsontext.Encoder, in any, opts ...Options) error

func Unmarshal(in []byte, out any, opts ...Options) error
func UnmarshalRead(in io.Reader, out any, opts ...Options) error
func UnmarshalDecode(in *jsontext.Decoder, out any, opts ...Options) error

其中:

  • Marshal和Unmarshal: 核心的Marshal和Unmarshal函数,与encoding/json中的函数签名类似,但行为有所改进。
  • MarshalWrite, UnmarshalRead: 直接操作io.Writer和io.Reader,避免中间[]byte的分配。
  • MarshalEncode, UnmarshalDecode: 操作jsontext.Encoder和jsontext.Decoder,提供更底层的流式编解码能力。
  • Options: 用于配置Marshal和Unmarshal的行为,例如大小写敏感性、omitempty语义、错误处理等。

encoding/json/v2包还引入了更丰富的struct tag选项,例如omitzero, omitempty, string, nocase, strictcase, inline,unknown,format等,提供更灵活的字段映射和格式化控制。

2.3 设计原则

下面是该proposal的一些设计原则梳理:

  • 分离语法与语义: 明确区分JSON的语法处理(jsontext)和语义处理(json/v2),使得开发者可以根据需求选择合适的API。
  • 流式处理: 提供流式的Encoder和Decoder,支持高效处理大规模JSON数据,避免一次性加载整个JSON文档到内存。
  • 选项化配置: 通过Options类型提供丰富的配置选项,允许开发者根据具体需求定制JSON编解码的行为,例如大小写敏感性、格式化风格、错误处理方式等。
  • 改进错误处理: 引入SyntacticError和SemanticError类型,提供更详细的错误信息,包括错误发生的位置 (JSON Pointer) 和具体的错误原因,方便问题定位和调试。
  • 兼容性与迁移: encoding/json/v2尽可能兼容现有的encoding/json的行为,并提供选项 (DefaultOptionsV1) 来模拟v1的行为,方便用户平滑迁移。

接下来,我们再来看看json/v2相对于之前版本的提升与改进!

3. 相对于encoding/json的提升与改进

encoding/json/v2相对于现有的encoding/json包,在多个方面进行了显著的提升和改进:

3.1 性能提升

jsontext包采用更高效的语法解析算法,json/v2在语义处理方面也进行了优化,整体性能相比encoding/json有显著提升,尤其在反序列化和流式处理方面。Benchmark 测试显示,encoding/json/v2的反序列化速度比encoding/json快2.7x到10.2x:

以具体类型为例,下面是github.com/go-json-experiment/jsonbench给出的benchmark结果:


3.2 更正的行为

encoding/json/v2修正了encoding/json中一些行为不一致性和历史遗留问题,例如:

  • 大小写敏感的字段匹配: 默认采用严格的大小写敏感匹配,更符合JSON规范,并通过MatchCaseInsensitiveNames和nocasetag选项提供大小写不敏感匹配的灵活性。
  • 重新定义omitempty语义: omitempty基于JSON类型系统重新定义,更加清晰和一致,并通过OmitEmptyWithLegacyDefinition选项提供兼容v1 行为的选择。
  • nil切片和map的处理: 默认将nil切片和mapMarshal为空JSON数组和对象,而非null,并通过FormatNilSliceAsNull和FormatNilMapAsNull选项提供Marshal为null的选择。
  • 字节数组的表示: 默认将[]\byteMarshal为Base64编码的JSON字符串,而非JSON数字数组,并通过FormatBytesWithLegacySemantics和format:arraytag 选项提供兼容v1行为的选择。
  • 方法调用的可寻址性: MarshalJSON方法无论Go值是否可寻址都可调用,更符合预期。
  • Map Key 的方法调用: MarshalJSON和UnmarshalJSON方法可以用于 Map Key,提供更强大的自定义能力。
  • 确定性输出: 通过Deterministic选项,可以保证相同输入Marshal出相同的JSON字节序列。
  • 最小化转义: 默认使用最小化的JSON字符串转义,仅在必要时进行转义,例如只在HTML或JavaScript环境下才进行特殊字符的转义。
  • UTF-8 验证: 默认严格验证UTF-8编码,拒绝包含无效UTF-8的JSON输入,并通过AllowInvalidUTF8选项允许处理无效UTF-8。
  • 重复Key错误: 默认拒绝JSON对象中存在重复的Key,更符合JSON 规范,并通过AllowDuplicateNames选项允许处理重复Key。
  • Null值的Unmarshal: Unmarshal JSONnull时,始终一致地将Go值置零。
  • Unmarshal合并行为: Unmarshal JSON对象时,默认合并到已有的Go值,而非完全替换,提供更灵活的更新语义。
  • time.Duration的表示: 默认将time.DurationMarshal为JSON 字符串,而非纳秒数字,并通过FormatTimeWithLegacySemantics和format:nanotag选项提供兼容v1行为的选择。
  • 运行时错误报告: 对Go结构体类型中的结构性错误(例如错误的tag选项)进行运行时错误报告,提前发现问题。

3.3 更灵活的 API

jsontext包提供了更底层的API,允许开发者直接操作JSON token和原始值,实现更精细的JSON处理逻辑。json/v2提供了更多的选项和 struct tag 选项,支持更丰富的自定义需求。

3.4 更清晰的错误信息

SyntacticError和SemanticError类型提供了更详细的错误信息,包括错误位置 (JSON Pointer) 和错误原因,方便问题排查。

4. encoding/json与encoding/json/v2的联系

encoding/json/v2提案的一个重要目标是实现与现有encoding/json的平滑过渡。为此,提案采取了以下策略:

  • encoding/json基于encoding/json/v2实现: 未来的encoding/json包将完全基于encoding/json/v2包进行重构,这意味着encoding/json/v2将成为Go语言官方JSON处理的核心引擎。
  • DefaultOptionsV1选项: encoding/json包将提供DefaultOptionsV1选项,该选项预设了一系列兼容v1行为的配置,使得encoding/json的默认行为尽可能与旧版本保持一致。
  • 互操作选项: encoding/json/v2和encoding/json都提供了大量的选项,允许开发者在v1和v2行为之间进行灵活切换,逐步迁移到v2的新特性。

5. 示例代码

以下示例展示了encoding/json/v2的基本用法(示例改自https://github.com/go-json-experiment/json/blob/master/example_test.go):

package main

import (
    "fmt"
    "log"

    "github.com/go-json-experiment/json"
    "github.com/go-json-experiment/json/jsontext"
)

func main() {
    var value struct {
        // This field is explicitly ignored with the special "-" name.
        Ignored any `json:"-"`
        // No JSON name is not provided, so the Go field name is used.
        GoName any
        // A JSON name is provided without any special characters.
        JSONName any `json:"jsonName"`
        // No JSON name is not provided, so the Go field name is used.
        Option any `json:",nocase"`
        // An empty JSON name specified using an single-quoted string literal.
        Empty any `json:"''"`
        // A dash JSON name specified using an single-quoted string literal.
        Dash any `json:"'-'"`
        // A comma JSON name specified using an single-quoted string literal.
        Comma any `json:"','"`
        // JSON name with quotes specified using a single-quoted string literal.
        Quote any `json:"'\"\\''"`
        // An unexported field is always ignored.
        unexported any
    }

    b, err := json.Marshal(value)
    if err != nil {
        log.Fatal(err)
    }
    (*jsontext.Value)(&b).Indent() // indent for readability
    fmt.Println(string(b))
}

这段示例代码旨在演示github.com/go-json-experiment/json (即提案中encoding/json/v2的参考实现) 在处理Go结构体字段的json tag时,对于不同命名约定和特殊字符的处理方式。结构体value定义了多个字段,每个字段都使用了不同的json tag,用于演示不同的命名和选项,具体选项含义可以参考proposal中的说明。

(*jsontext.Value)(&b).Indent() // indent for readability

前面说过,jsontext是操作json语法的包,json缩进的工作就交给了该包的Value的Indent方法。在encoding/json中,我们通常直接用MarshalIndent来进行格式化json的工作。

运行上述示例将输出如下结果:

$go run main.go
{
    "GoName": null,
    "jsonName": null,
    "Option": null,
    "": null,
    "-": null,
    ",": null,
    "\"'": null
}

更多示例,可以参见 https://github.com/go-json-experiment/json/blob/master/example_test.go源文件。

6. 小结

encoding/json/v2提案代表了Go语言在JSON处理方面的一次重大升级。通过引入jsontext和json/v2两个包,并提供更强大的API、更丰富的选项和更优的性能,encoding/json/v2将为Go开发者带来更高效、更灵活、更可靠的JSON处理体验。同时,该提案也充分考虑了与现有encoding/json的兼容性,为用户平滑迁移提供了保障。encoding/json/v2的引入,无疑将进一步提升Go语言在Web开发、数据处理等领域的竞争力,为Go开发者构建下一代应用提供更强大的JSON处理新引擎

7. 参考资料


Gopher部落知识星球在2025年将继续致力于打造一个高品质的Go语言学习和交流平台。我们将继续提供优质的Go技术文章首发和阅读体验。并且,2025年将在星球首发“Go陷阱与缺陷”和“Go原理课”专栏!此外,我们还会加强星友之间的交流和互动。欢迎大家踊跃提问,分享心得,讨论技术。我会在第一时间进行解答和交流。我衷心希望Gopher部落可以成为大家学习、进步、交流的港湾。让我相聚在Gopher部落,享受coding的快乐! 欢迎大家踊跃加入!

img{512x368}
img{512x368}

img{512x368}
img{512x368}

著名云主机服务厂商DigitalOcean发布最新的主机计划,入门级Droplet配置升级为:1 core CPU、1G内存、25G高速SSD,价格6$/月。有使用DigitalOcean需求的朋友,可以打开这个链接地址:https://m.do.co/c/bff6eed92687 开启你的DO主机之路。

Gopher Daily(Gopher每日新闻) – https://gopherdaily.tonybai.com

我的联系方式:

  • 微博(暂不可用):https://weibo.com/bigwhite20xx
  • 微博2:https://weibo.com/u/6484441286
  • 博客:tonybai.com
  • github: https://github.com/bigwhite
  • Gopher Daily归档 – https://github.com/bigwhite/gopherdaily
  • Gopher Daily Feed订阅 – https://gopherdaily.tonybai.com/feed

商务合作方式:撰稿、出书、培训、在线课程、合伙创业、咨询、广告合作。

如发现本站页面被黑,比如:挂载广告、挖矿等恶意代码,请朋友们及时联系我。十分感谢! Go语言第一课 Go语言精进之路1 Go语言精进之路2 Go语言编程指南
商务合作请联系bigwhite.cn AT aliyun.com

欢迎使用邮件订阅我的博客

输入邮箱订阅本站,只要有新文章发布,就会第一时间发送邮件通知你哦!

这里是 Tony Bai的个人Blog,欢迎访问、订阅和留言! 订阅Feed请点击上面图片

如果您觉得这里的文章对您有帮助,请扫描上方二维码进行捐赠 ,加油后的Tony Bai将会为您呈现更多精彩的文章,谢谢!

如果您希望通过微信捐赠,请用微信客户端扫描下方赞赏码:

如果您希望通过比特币或以太币捐赠,可以扫描下方二维码:

比特币:

以太币:

如果您喜欢通过微信浏览本站内容,可以扫描下方二维码,订阅本站官方微信订阅号“iamtonybai”;点击二维码,可直达本人官方微博主页^_^:
本站Powered by Digital Ocean VPS。
选择Digital Ocean VPS主机,即可获得10美元现金充值,可 免费使用两个月哟! 著名主机提供商Linode 10$优惠码:linode10,在 这里注册即可免费获 得。阿里云推荐码: 1WFZ0V立享9折!


View Tony Bai's profile on LinkedIn
DigitalOcean Referral Badge

文章

评论

  • 正在加载...

分类

标签

归档



Statcounter View My Stats