0

0

如何在 Go 中自定义 JSON 序列化:为字段值动态添加前缀

霞舞

霞舞

发布时间:2026-02-15 20:46:01

|

582人浏览过

|

来源于php中文网

原创

如何在 Go 中自定义 JSON 序列化:为字段值动态添加前缀

本文介绍如何通过实现 json.marshaler 接口,在不修改结构体原始字段值的前提下,优雅地控制 go 结构体字段的 json 输出格式(如为 url 字段自动拼接主机地址前缀)。

本文介绍如何通过实现 json.marshaler 接口,在不修改结构体原始字段值的前提下,优雅地控制 go 结构体字段的 json 输出格式(如为 url 字段自动拼接主机地址前缀)。

在 Go 的 JSON 编码场景中,常遇到这类需求:结构体字段存储的是相对路径(如 "/thisurl"),但对外暴露的 JSON API 需返回完整绝对 URL(如 "https://www.php.cn/link/91edf9918caf23ade612be8a563a676b")。若每次调用 json.Marshal 前手动拼接(post.Url = HOST + post.Url),不仅侵入业务逻辑、易遗漏,还会意外污染原始数据——这违背了“序列化行为与数据表示分离”的设计原则。

最佳实践是使用自定义类型 + 接口实现。Go 的 encoding/json 包会自动识别实现了 json.Marshaler 接口的类型,并优先调用其 MarshalJSON() 方法,从而完全接管该字段的序列化逻辑。

以下是一个完整、可运行的示例:

网易外贸通
网易外贸通

网易旗下专为外贸企业打造的一站式海外营销管理平台

下载
package main

import (
    "encoding/json"
    "fmt"
)

type Post struct {
    URL URLString `json:"url"` // 使用自定义类型替代 string
}

const Host = "http://myhost.com" // 符合 Go 命名规范:首字母大写 + 驼峰,非全大写

type URLString string

// MarshalJSON 实现 json.Marshaler 接口
func (u URLString) MarshalJSON() ([]byte, error) {
    // 手动构造带双引号的 JSON 字符串(注意转义)
    // 等价于: return json.Marshal(Host + string(u))
    return []byte(fmt.Sprintf(`"%s%s"`, Host, u)), nil
}

func main() {
    post := Post{URL: "/thisurl"}
    data, err := json.Marshal(post)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(data)) // 输出: {"url":"https://www.php.cn/link/91edf9918caf23ade612be8a563a676b"}

    // 验证原始值未被修改
    fmt.Printf("Raw URL value: %q\n", string(post.URL)) // 输出: "/thisurl"
}

关键要点说明:

  • 零侵入性:结构体字段仍保持语义清晰(URL URLString),业务层完全感知不到序列化逻辑;
  • 类型安全:自定义类型 URLString 可进一步封装校验、解析等能力;
  • 可复用性高:同一 URLString 类型可被多个结构体复用;
  • 符合 Go 习惯:常量命名使用 Host 而非 HOST,字段名使用 URL(而非 Url),遵循 Go Code Review Comments 规范。

⚠️ 注意事项:

  • MarshalJSON() 返回的字节切片必须是合法的 JSON 值(含外层引号、正确转义)。直接返回 json.Marshal(Host + string(u)) 更安全(推荐用于复杂场景);
  • 若需反序列化支持,应同时实现 UnmarshalJSON([]byte) error;
  • 避免在 MarshalJSON 中执行耗时或阻塞操作,以免影响 JSON 编码性能。

通过接口驱动的序列化定制,你既能保持领域模型的纯粹性,又能灵活满足外部协议要求——这是 Go “组合优于继承”哲学的典型体现。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
golang如何定义变量
golang如何定义变量

golang定义变量的方法:1、声明变量并赋予初始值“var age int =值”;2、声明变量但不赋初始值“var age int”;3、使用短变量声明“age :=值”等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

206

2024.02.23

golang有哪些数据转换方法
golang有哪些数据转换方法

golang数据转换方法:1、类型转换操作符;2、类型断言;3、字符串和数字之间的转换;4、JSON序列化和反序列化;5、使用标准库进行数据转换;6、使用第三方库进行数据转换;7、自定义数据转换函数。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

236

2024.02.23

golang常用库有哪些
golang常用库有哪些

golang常用库有:1、标准库;2、字符串处理库;3、网络库;4、加密库;5、压缩库;6、xml和json解析库;7、日期和时间库;8、数据库操作库;9、文件操作库;10、图像处理库。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

346

2024.02.23

golang和python的区别是什么
golang和python的区别是什么

golang和python的区别是:1、golang是一种编译型语言,而python是一种解释型语言;2、golang天生支持并发编程,而python对并发与并行的支持相对较弱等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

212

2024.03.05

golang是免费的吗
golang是免费的吗

golang是免费的。golang是google开发的一种静态强类型、编译型、并发型,并具有垃圾回收功能的开源编程语言,采用bsd开源协议。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

403

2024.05.21

golang结构体相关大全
golang结构体相关大全

本专题整合了golang结构体相关大全,想了解更多内容,请阅读专题下面的文章。

344

2025.06.09

golang相关判断方法
golang相关判断方法

本专题整合了golang相关判断方法,想了解更详细的相关内容,请阅读下面的文章。

197

2025.06.10

golang数组使用方法
golang数组使用方法

本专题整合了golang数组用法,想了解更多的相关内容,请阅读专题下面的文章。

886

2025.06.17

pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法
pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法

本专题系统整理pixiv网页版官网入口及登录访问方式,涵盖官网登录页面直达路径、在线阅读入口及快速进入方法说明,帮助用户高效找到pixiv官方网站,实现便捷、安全的网页端浏览与账号登录体验。

145

2026.02.13

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 9.3万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 3.3万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号