Go encoding/xml 中创建 CDATA 节点的教程

在处理 xml 数据时，我们经常需要将包含特殊字符（如 <、>、&）或 html 片段的文本内容嵌入到 xml 元素中。如果直接将这些内容作为普通文本进行 xml 序列化，encoding/xml 包默认会将这些特殊字符转义为对应的实体引用（例如，< 变为

理解 CDATA 及其必要性

CDATA 节的格式是 <![CDATA[...]]>。在 <![CDATA[ 和 ]]> 之间的所有内容都会被 XML 解析器视为纯字符数据，不会进行解析或转义。这对于嵌入 HTML 片段、脚本代码或任何包含 XML 语法敏感字符的文本非常有用。

例如，如果有一个产品名称 "<Go & Learn>"，直接序列化可能得到 <product_name></product_name>。而我们希望得到的是 <product_name><![CDATA[<Go & Learn>]]></product_name>。

使用 encoding/xml 的 ,cdata 标签

自 Go 1.6 版本起，encoding/xml 包引入了一个便捷的结构体标签选项 ,cdata，专门用于指示某个字符串字段的内容应该被包裹在 CDATA 节中。

基本用法

要使用 ,cdata 标签，你需要遵循以下规则：

1. 字段类型： 目标字段必须是字符串类型。
2. 标签格式： 在结构体字段的 xml 标签中添加 ,cdata。
3. 无显式节点名： 带有 ,cdata 的字段不能同时指定 XML 节点名称（即不能写成 xml:"fieldName,cdata"）。这是因为 CDATA 节是其父元素的文本内容，而不是一个独立的子元素。

为了指定包含 CDATA 节的 XML 元素的名称，通常需要结合使用嵌入式结构体和 xml.Name。

示例代码

假设我们有一个字符串内容需要输出为 CDATA 节，并将其包含在一个名为 summary 的 XML 元素中。我们可以这样定义结构体：

php中级教程之ajax技术

AJAX即“Asynchronous Javascript And XML”（异步JavaScript和XML），是指一种创建交互式网页应用的网页开发技术。它不是新的编程语言，而是一种使用现有标准的新方法，最大的优点是在不重新加载整个页面的情况下，可以与服务器交换数据并更新部分网页内容，不需要任何浏览器插件，但需要用户允许JavaScript在浏览器上执行。《php中级教程之ajax技术》带你快速

2114

查看详情

package main

import (
    "encoding/xml"
    "fmt"
)

// Summary 结构体用于包裹需要 CDATA 的文本
type Summary struct {
    XMLName xml.Name `xml:"summary"` // 定义该元素的名称，有助于反序列化
    Text    string   `xml:",cdata"`  // 文本内容将作为 CDATA
}

// RootElement 是 XML 的根元素
type RootElement struct {
    XMLName xml.Name `xml:"root"`    // 定义根元素的名称
    Summary *Summary `xml:"summary"` // 包含 Summary 元素的字段，并指定其 XML 节点名为 "summary"
}

func main() {
    // 包含特殊字符和HTML标签的字符串
    cdataContent := `<a href="http://example.org">My Example Website & More</a>`

    // 创建 RootElement 实例并填充数据
    v := RootElement{
        Summary: &Summary{
            Text: cdataContent,
        },
    }

    // 将结构体序列化为 XML
    b, err := xml.MarshalIndent(v, "", "  ")
    if err != nil {
        fmt.Println("序列化错误:", err)
        return
    }
    fmt.Println(string(b))

    // 演示反序列化
    fmt.Println("\n--- 反序列化示例 ---")
    var unmarshaled RootElement
    err = xml.Unmarshal(b, &unmarshaled)
    if err != nil {
        fmt.Println("反序列化错误:", err)
        return
    }
    fmt.Printf("反序列化后的 Summary.Text: %s\n", unmarshaled.Summary.Text)
}

代码解释：

1. Summary 结构体：
   • XMLName xml.Namexml:"summary"`：这个字段用于定义Summary结构体在 XML 中对应的元素名称为summary`。这对于反序列化和明确元素结构非常有用。
   • Text stringxml:",cdata"`：这是关键所在。Text字段将被序列化为 CDATA 节。注意，这里没有为Text字段指定一个独立的 XML 节点名，因为它将作为summary` 元素的字符数据内容。
2. RootElement 结构体：
   • Summary *Summaryxml:"summary"`：这个字段将Summary结构体嵌入到RootElement中，并指定其在 XML 中的节点名为summary。当RootElement被序列化时，它会查找Summary字段，并根据Summary结构体的定义来生成summary` 元素，其中包含 CDATA 节。

输出结果：

<root>
  <summary><![CDATA[<a href="http://example.org">My Example Website & More</a>]]></summary>
</root>

--- 反序列化示例 ---
反序列化后的 Summary.Text: <a href="http://example.org">My Example Website & More</a>

从输出可以看出，cdataContent 中的 HTML 标签和 & 符号都被完整地保留在 <![CDATA[...]]> 块中，没有被转义。同时，反序列化也能正确地将 CDATA 节的内容还原到 Text 字段中。

注意事项与最佳实践

1. Go 版本要求： xml:",cdata" 标签功能是在 Go 1.6 版本中引入的。如果使用更早的 Go 版本，此功能将不可用。
2. 字段命名与结构体嵌入：
   • 带有 ,cdata 的字段本身不能有 xml:"fieldName" 这样的标签来指定元素名。
   • 为了给包含 CDATA 的元素命名（例如 <summary>），你需要将带有 ,cdata 字段的结构体（如 Summary）嵌入到另一个结构体中，并在嵌入字段上使用 xml:"elementName" 标签。
   • 在嵌入式结构体中添加 XMLName xml.Namexml:"elementName"`` 是一个好的实践，它使得该结构体在作为独立元素或进行反序列化时能正确识别其自身名称。
3. 反序列化兼容性： 示例中也展示了反序列化的过程。使用 xml:",cdata" 标签不仅适用于序列化，也兼容反序列化，Go 会自动识别并提取 CDATA 节中的内容。
4. 适用场景： CDATA 节主要用于包裹那些可能包含 XML 特殊字符，但又不希望被 XML 解析器处理为标记的文本内容。例如，HTML 片段、JavaScript 代码、CSS 样式或任何其他纯文本数据。

总结

通过 Go 1.6 引入的 xml:",cdata" 结构体标签，encoding/xml 包为开发者提供了一种简洁高效的方式来处理 XML 中的 CDATA 节。通过合理地设计结构体，将需要 CDATA 化的字符串字段放置在嵌入式结构体中，并配合 xml.Name 和父字段的 xml 标签，可以轻松实现复杂 XML 结构的序列化与反序列化，同时确保特殊字符的正确处理，避免不必要的转义。这极大地提升了 Go 在 XML 处理方面的灵活性和便利性。

以上就是Go encoding/xml 中创建 CDATA 节点的教程的详细内容，更多请关注php中文网其它相关文章！