0

0

如何在 Go 中自定义 JSON 序列化以动态拼接字段值

花韻仙語

花韻仙語

发布时间:2026-02-16 11:16:00

|

192人浏览过

|

来源于php中文网

原创

如何在 Go 中自定义 JSON 序列化以动态拼接字段值

本文介绍如何通过实现 json.Marshaler 接口,在不修改结构体原始字段值的前提下,优雅地为 JSON 输出中的字符串字段(如 URL)自动添加前缀(如主机地址)。

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

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

最佳实践是使用自定义类型 + json.Marshaler 接口。它将序列化逻辑封装在类型内部,使 json.Marshal 自动调用定制方法,完全透明且可复用。

以下是一个完整、生产就绪的示例:

芦笋演示
芦笋演示

一键出成片的录屏演示软件,专为制作产品演示、教学课程和使用教程而设计。

下载
package main

import (
    "encoding/json"
    "fmt"
)

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

type Post struct {
    URL URLString `json:"url"` // 字段类型改为自定义的 URLString
}

type URLString string // 底层仍为 string,便于赋值和比较

// MarshalJSON 实现 json.Marshaler 接口
func (u URLString) MarshalJSON() ([]byte, error) {
    // 拼接 Host + 原始值,并手动构造带双引号的 JSON 字符串
    // 注意:需转义特殊字符(本例中 u 为纯路径,暂可忽略;生产环境建议用 json.Marshal 处理)
    return []byte(fmt.Sprintf(`"%s%s"`, Host, string(u))), nil
}

// (可选)补充 UnmarshalJSON,保证反序列化时仍能正确解析原始路径
func (u *URLString) UnmarshalJSON(data []byte) error {
    var s string
    if err := json.Unmarshal(data, &s); err != nil {
        return err
    }
    // 反序列化时剥离 Host 前缀,只保留路径部分
    if len(s) >= len(Host) && s[:len(Host)] == Host {
        *u = URLString(s[len(Host):])
    } else {
        *u = URLString(s)
    }
    return nil
}

func main() {
    post := Post{URL: "/thisurl"}
    data, err := json.Marshal(post)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(data)) // 输出:{"url":"http://myhost.com/thisurl"}

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

关键优势

  • 零副作用:post.URL 始终保持原始相对路径,业务逻辑不受影响;
  • 强一致性:所有 json.Marshal 调用自动应用前缀,无需人工干预;
  • 高内聚:序列化规则与类型绑定,易于测试、复用和维护;
  • 符合 Go 习惯:使用驼峰常量名 Host,字段名 URL(而非 Url),遵循 Go Code Review Comments 规范。

⚠️ 注意事项

  • MarshalJSON 中直接拼接字符串虽简洁,但若 u 可能含双引号、换行等 JSON 特殊字符,应改用 json.Marshal 安全编码:
    full := Host + string(u)
    return json.Marshal(full)
  • 若需支持反序列化(如接收前端传来的完整 URL),务必实现 UnmarshalJSON,并合理处理前缀剥离逻辑;
  • 此方案适用于单字段定制。若多个字段需类似处理,可抽象为泛型工具函数或组合类型,但需权衡复杂度。

总之,通过 json.Marshaler 接口定制序列化行为,是 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、自定义数据转换函数。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

238

2024.02.23

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

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

347

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数组用法,想了解更多的相关内容,请阅读专题下面的文章。

888

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号