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

Go Decimal MarshalJSONWithoutQuotes 为什么会影响所有调用方

来源:17golang原创

时间:2026-10-29 14:28:07 476浏览 收藏

先说结论:decimal.MarshalJSONWithoutQuotes 不是某个字段的局部选项,而是 shopspring/decimal 的包级变量。默认值为 false 时,Decimal 的 JSON 通常以字符串输出;设为 true 后,进程内所有 Decimal 的 JSON 输出都会改成数字。因此它影响的不是“当前这一行代码”,而是所有调用方共享的接口契约。

官方地址:https://pkg.go.dev/github.com/shopspring/decimal

生产代码应在启动阶段一次性决定策略。若只有一个接口或一个字段需要数字形式,优先定义局部包装类型,不要用全局变量解决局部需求。

默认输出和无引号输出到底差在哪里

Decimal 实现了 JSON 编码接口,encoding/json 会调用它的 MarshalJSON。同一个值 12.50,两种设置对应两种不同的 JSON 类型:

package main

import (
    "encoding/json"
    "fmt"

    "github.com/shopspring/decimal"
)

func main() {
    amount := decimal.RequireFromString("12.50")

    // 默认值为 false:Decimal 作为 JSON 字符串输出,便于保留十进制文本契约。
    decimal.MarshalJSONWithoutQuotes = false
    quoted, err := json.Marshal(struct {
        Amount decimal.Decimal `json:"amount"`
    }{Amount: amount})
    if err != nil {
        panic(err)
    }
    fmt.Println(string(quoted))

    // 开启后:所有 Decimal 的 JSON 输出改为数字,调用方看到的类型也随之改变。
    decimal.MarshalJSONWithoutQuotes = true
    number, err := json.Marshal(struct {
        Amount decimal.Decimal `json:"amount"`
    }{Amount: amount})
    if err != nil {
        panic(err)
    }
    fmt.Println(string(number))
}

这里变化的是 JSON token:前者类似 {"amount":"12.5"},后者类似 {"amount":12.5}。它不会把 Decimal 变成浮点数参与计算,也不会自动替你处理客户端的类型兼容;真正变化的是序列化边界。

Decimal JSON 字符串与数字输出的静态结构说明图
图1:输出类型边界说明图,展示 Decimal、MarshalJSONWithoutQuotes 与 JSON 字符串或数字之间的关系,不是运行截图。

为什么一个开关会影响所有调用方

这个变量属于包级状态,所有导入同一包的代码都读取同一份配置。订单接口、审计日志、消息体和内部 RPC 即使没有修改自己的结构体,也会使用新的 Decimal JSON 规则。

常见影响有三类:

  • 客户端把金额字段声明为字符串时,收到数字后可能反序列化失败。
  • 签名、缓存键或快照把 JSON 文本作为输入时,字段类型变化会导致结果变化。
  • 同一进程内不同团队以为自己可以选择格式,实际上无法通过普通字段标签隔离包级变量。

官方文档同时提醒:包级设置应在程序启动时设定;当其它 goroutine 正在使用库时再修改,会产生数据竞争。不要在请求处理函数、灰度开关回调或测试用例中随意切换它。

Decimal 包级配置影响多个接口调用方的静态关系图
图2:全局配置影响面说明图,展示包级状态与多个调用方的静态关系,不是运行证据。

生产环境怎样安全设置

如果整个服务的接口契约都确定使用数字,放在进程启动入口设置,并且只执行一次:

package main

import "github.com/shopspring/decimal"

func initDecimalJSONPolicy() {
    // 在任何请求进入前固定策略,避免运行中并发读写包级变量。
    decimal.MarshalJSONWithoutQuotes = true
}

func main() {
    initDecimalJSONPolicy()
    // 这里再启动 HTTP、RPC 或消息消费协程。
}

更重要的是把这个决定写进接口契约和发布清单:确认客户端是否接受 JSON number,检查 OpenAPI 或示例响应,安排灰度期间的回滚方式。不要把“数字更方便计算”当成足够理由,因为 JSON number 在不同语言客户端里仍可能映射到不同的数值类型。

只改一个字段时不要动全局开关

如果只有一个接口需要数字,定义一个小包装类型并实现自己的 MarshalJSON。官方 README 也给出了按字段控制 JSON 格式的思路:

type NumberDecimal struct {
    decimal.Decimal
}

func (d NumberDecimal) MarshalJSON() ([]byte, error) {
    // String 返回合法的 JSON 数字文本;这里只改变这个字段的输出类型。
    return []byte(d.String()), nil
}

type Response struct {
    Amount decimal.Decimal `json:"amount"`
    Ratio  NumberDecimal   `json:"ratio"`
}

这样 Amount 仍沿用包的默认规则,Ratio 才输出为 JSON 数字。若金额必须固定两位小数,则可以返回带引号的 StringFixed(2) 结果;选择哪一种格式,应由消费者契约决定。

发布前的三项检查

  1. 检查类型:明确每个 Decimal 字段是字符串还是数字,特别关注前端、移动端和跨语言 SDK。
  2. 检查范围:搜索包级变量的写入点,确保它只在启动阶段设置,不在请求、定时任务或并发测试中切换。
  3. 检查回滚:若需求只是局部字段,改回包装类型;若必须全局切换,先更新契约、示例和兼容客户端。

一句话总结:MarshalJSONWithoutQuotes 改变的是 Decimal 的 JSON 表示,而包级变量决定了整个进程的影响范围。全局策略在启动时固定,局部需求用字段级 MarshalJSON 隔离。

常见问题

开启无引号输出会改变 Decimal 的计算精度吗?

不会。它针对 JSON 序列化形式;计算仍由 Decimal 类型完成,但消费者解析 JSON 时面对的类型发生了变化。

能不能在某个请求结束后恢复默认值?

不建议。包级变量被并发请求共享,运行中切换既会产生数据竞争,也会让同一接口的响应格式随时刻变化。

想固定两位小数应该怎么办?

使用字段包装类型,在自己的 MarshalJSON 中调用 StringFixed(2) 并按契约返回字符串或数字,不要为了一个字段打开全局开关。

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