0

0

Go 模板中正确渲染 JSON 数据供 JavaScript 使用的指南

心靈之曲

心靈之曲

发布时间:2025-11-21 12:20:50

|

502人浏览过

|

来源于php中文网

原创

Go 模板中正确渲染 JSON 数据供 JavaScript 使用的指南

本文详细阐述了在 go 模板中将 go 对象渲染为 json 字符串时,避免自动转义并直接输出有效 json 数据的方法。通过引入 `html/template` 包中的 `template.js` 类型,我们可以确保 json 数据在 javascript 上下文中被正确解析,从而实现 go 后端前端 javascript 之间的数据无缝传输,避免客户端进行额外的 `json.parse` 操作。

引言

在现代 Web 开发中,Go 后端常常需要将结构化数据传递给前端的 JavaScript 脚本。一种常见且高效的方式是将 Go 对象序列化为 JSON 格式,并通过 HTML 模板直接嵌入到页面中。然而,Go 的 html/template 包为了安全起见,会对输出内容进行自动转义,这可能导致嵌入的 JSON 字符串在 JavaScript 上下文中无法直接解析。本文将深入探讨这一问题,并提供一个标准且安全的解决方案。

问题所在:Go 模板的自动转义机制

当我们在 Go 模板中尝试直接打印一个经过 json.Marshal 序列化后的字符串时,html/template 包会将其中的特殊字符(如双引号 "、反斜杠 \ 等)转义为 HTML 实体或 JavaScript 字符串字面量中的转义序列。这是为了防止跨站脚本攻击(XSS),确保渲染到浏览器中的内容是安全的。

例如,如果我们有一个 Go 切片 []string{"o1", "o2"},并使用以下 marshal 函数将其转换为 JSON 字符串:

import "encoding/json"

// 错误的 marshal 函数示例
"marshal": func(v interface {}) string {
  a, _ := json.Marshal(v)
  return string(a)
},

并在模板中使用 {{ marshal .Arr }} 渲染,期望在前端得到 var arr=["o1","o2"] 这样的 JavaScript 数组。但实际输出很可能是 var arr="[\"o1\",\"o2\"]"。这里的整个 JSON 字符串被包裹在额外的双引号中,并且内部的双引号也被转义了,导致它成为了一个普通的 JavaScript 字符串字面量,而非一个可直接使用的 JavaScript 数组对象。前端需要额外调用 JSON.parse() 才能将其转换为 JavaScript 对象。

立即学习Java免费学习笔记(深入)”;

解决方案:使用 template.JS 类型

Go 语言的 html/template 包提供了一个特殊的类型 template.JS,用于明确告诉模板引擎:此字符串内容是安全的 JavaScript 代码,不应进行任何转义。通过将 json.Marshal 的结果转换为 template.JS 类型,我们可以确保 JSON 数据能够以其原始、未转义的形式直接嵌入到 HTML 中,供 JavaScript 引擎直接解析和使用。

arXiv Xplorer
arXiv Xplorer

ArXiv 语义搜索引擎,帮您快速轻松的查找,保存和下载arXiv文章。

下载

下面是修正后的 marshal 函数:

import (
    "encoding/json"
    "html/template" // 引入 html/template 包
)

// 正确的 marshal 函数
"marshal": func(v interface {}) template.JS {
  a, _ := json.Marshal(v)
  return template.JS(a) // 将字节切片转换为 template.JS 类型
},

在模板中使用方式保持不变:

当 marshal 函数返回 template.JS 类型时,模板引擎会识别出这是一个“已标记为安全”的 JavaScript 内容,并会原样输出 json.Marshal 产生的 JSON 字符串。这样,前端便可以直接获得 var arr=["o1","o2"] 这样的有效 JavaScript 数组,无需额外的 JSON.parse() 操作。

重要注意事项

  1. 安全性考量: template.JS 类型的核心在于“信任”。当你使用 template.JS 时,你是在告诉 Go 模板引擎,你对这段内容的安全负责,它不会引入任何 XSS 漏洞。因此,绝不能将任何来自用户输入或其他不可信源的数据直接转换为 template.JS,除非你已经对其进行了严格的验证和净化。如果 JSON 数据中可能包含恶意脚本,直接使用 template.JS 将会带来严重的安全风险。在处理不可信数据时,优先考虑在客户端使用 JSON.parse(),或者在服务端对数据进行严格的 HTML/JavaScript 转义后再输出。

  2. 性能与便利性: 相比于在客户端使用 JSON.parse(),直接输出 template.JS 可以在一定程度上简化前端代码,并避免客户端额外的解析开销。对于大型 JSON 数据,这种方式可能带来轻微的性能优势。然而,其主要优点在于代码的简洁性和数据传输的直观性。

  3. 错误处理: 在 marshal 函数中,json.Marshal 可能会返回错误。在实际生产代码中,应该对这个错误进行妥善处理,例如返回一个空的 template.JS 或记录错误,而不是简单地忽略。

总结

在 Go 模板中嵌入 JSON 数据供 JavaScript 使用时,理解 html/template 的自动转义机制至关重要。通过将 json.Marshal 的结果包装成 template.JS 类型,我们可以安全、高效地将 Go 对象以未转义的 JSON 格式直接渲染到 HTML 页面中。然而,务必牢记 template.JS 的安全含义,确保只有经过信任和验证的数据才会被标记为安全,以避免潜在的安全漏洞。正确运用 template.JS,将极大地提升 Go 后端与前端 JavaScript 之间的数据交互体验。

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

544

2023.06.20

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

372

2023.07.04

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

727

2023.07.04

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

470

2023.09.01

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

392

2023.09.04

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

990

2023.09.04

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

654

2023.09.12

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

544

2023.09.20

php源码安装教程大全
php源码安装教程大全

本专题整合了php源码安装教程,阅读专题下面的文章了解更多详细内容。

74

2025.12.31

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
React 教程
React 教程

共58课时 | 3.2万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 1.9万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 2.7万人学习

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

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