SweetXml 使用教程

SweetXml 使用教程

sweet_xml项目地址:https://gitcode.com/gh_mirrors/sw/sweet_xml

项目介绍

SweetXml 是一个围绕 :xmerl 的薄包装器，允许您将字符列表或 :xmerl 中定义的 xmlElement 记录转换为 Elixir 值，如 map、列表、字符串、整数、浮点数或这些的任何组合。

项目快速启动

安装

首先，将 SweetXml 添加到您的项目的 mix.exs 文件中：

def deps do
  [{:sweet_xml, "~> 0.7.4"}]
end

然后运行 mix deps.get 来安装依赖。

基本使用

以下是一个简单的示例，展示如何解析和查询 XML 文档：

import SweetXml

xml_str = """
<game>
  <matchups>
    <matchup winner-id="1">
      <name>Match One</name>
      <teams>
        <team>
          <id>1</id>
          <name>Team One</name>
        </team>
        <team>
          <id>2</id>
          <name>Team Two</name>
        </team>
      </teams>
    </matchup>
  </matchups>
</game>
"""

doc = parse(xml_str)

# 查询匹配的名称
match_name = doc |> xpath(~x"//matchup/name/text()")

# 查询获胜队伍的ID
winner_id = doc |> xpath(~x"//matchup/@winner-id")

IO.puts("Match Name: #{match_name}")
IO.puts("Winner ID: #{winner_id}")

应用案例和最佳实践

处理大型文档

对于大型文档，建议使用 discard 选项来避免内存泄漏：

result = file_stream |> stream_tags([:li, :special_match_key], discard: [:li, :special_match_key])

安全处理不受信任的文档

当处理非系统生成的 XML 文档时，建议将解析步骤与映射步骤分开，以通过选项防止某些默认行为：

doc |> parse(dtd: :none) |> xpath(spec, subspec)
enum |> stream_tags(tags, dtd: :none)

典型生态项目

SweetXml 通常与其他 Elixir 项目一起使用，例如用于处理 HTTP 请求的 HTTPoison 和用于处理 JSON 的 Jason。这些项目可以与 SweetXml 结合使用，以构建完整的 API 客户端。

示例：结合 HTTPoison 和 SweetXml

defmodule ApiClient do
  def fetch_game_data do
    url = "http://example.com/api/game"
    response = HTTPoison.get!(url)
    doc = SweetXml.parse(response.body)
    game_name = doc |> SweetXml.xpath(~x"//game/name/text()")
    IO.puts("Game Name: #{game_name}")
  end
end

通过这种方式，您可以构建一个完整的 API 客户端，从远程服务器获取 XML 数据并进行解析和处理。

sweet_xml项目地址:https://gitcode.com/gh_mirrors/sw/sweet_xml