alpine/xml Docker镜像文档

镜像概述与主要用途

alpine/xml 是一个基于 Alpine Linux 的轻量级 Docker 镜像，集成了多种 XML 处理工具，旨在提供类似 jq 处理 JSON 文件的便捷方式来操作 XML 文档。该镜像适用于需要在命令行或自动化流程中快速解析、查询、转换 XML 文件的场景。

• GitHub 仓库：[***]
• 每日 Travis CI 构建日志：[***]
• Docker 镜像标签：[***]

核心功能与特性

集成工具及特性

该镜像预装以下工具，覆盖 XML 处理的核心需求：

1. xmllint

   • 命令行 XML 工具，支持 XML 解析、验证、格式化及 XPath 查询
   • 官网：[***]

2. jq

   • JSON 数据处理工具，可用于处理 XML 转换后的 JSON 结果（辅助 xq 使用）
   • 官网：[***]

3. xq

   • 命令行 XML 处理器，支持将 XML 转换为 JSON 并使用类 jq 语法查询/操作 XML 节点
   • 项目地址：[***]

使用场景与适用范围

• 开发环境中的 XML 快速处理：本地开发时解析、查询 XML 文件结构
• XML 与 JSON 格式转换：将 XML 配置文件或数据转换为 JSON 以便后续处理（如日志分析、API 交互）
• CI/CD 流程集成：在自动化构建/部署流程中验证 XML 配置文件合法性、提取关键节点值（如版本号）
• XML 数据清洗：通过 xq 删除/修改 XML 节点，生成处理后的 XML 文件

使用方法与配置说明

基础使用说明

该镜像无需额外配置，通过 docker run 命令直接调用工具即可。工具默认使用系统环境变量，无特殊配置参数。

常用命令示例

1. 从远程 XML 提取节点值（如版本号）

场景：从远程 POM.xml 中提取 project.version 节点值

bash
docker run -ti --rm alpine/xml sh -c "curl -s [***] | xq .project.version"

说明：

• curl -s：静默获取远程 XML 内容
• xq .project.version：通过 xq 查询 JSON 化后的 project.version 节点（xq 自动将 XML 转为 JSON 结构）

2. 从 XML 中排除指定节点并输出 XML

场景：删除 XML 中的 project.version 节点，保留其他内容并输出 XML

bash
docker run -ti --rm alpine/xml sh -c "curl [***] | xq 'del(.project.version)' --xml-output"

说明：

• del(.project.version)：xq 的 del 函数删除 JSON 结构中的 project.version 节点
• --xml-output：强制 xq 输出 XML 格式（默认输出 JSON）

3. 本地 XML 文件转换为 JSON

场景：将本地 pom.xml 转换为 JSON 并输出

bash
# Linux/macOS
docker run -ti --rm -v $(pwd):/apps -w /apps alpine/xml sh -c "xq . < pom.xml"

# Windows (PowerShell)
docker run -ti --rm -v ${PWD}:/apps -w /apps alpine/xml sh -c "xq . < pom.xml"

说明：

• -v $(pwd):/apps：将本地当前目录挂载到容器内 /apps 目录
• -w /apps：设置容器工作目录为 /apps（即本地挂载目录）
• xq . < pom.xml：读取本地 pom.xml，通过 xq . 输出完整 JSON 结构

4. 使用 xmllint 验证 XML 合法性

场景：验证本地 XML 文件格式是否合法

bash
# Linux/macOS
docker run -ti --rm -v $(pwd):/apps -w /apps alpine/xml xmllint --valid pom.xml

说明：

• xmllint --valid：启用 XML 有效性验证（需 XML 包含 DTD/XSD 定义，否则仅检查语法）
• 更多 xmllint 用法参见 ***文档

挂载本地文件注意事项

处理本地 XML 文件时，需通过 -v 参数将本地目录挂载到容器内（如示例 3、4），否则容器无法访问宿主机文件。挂载格式：

bash
-v <宿主机目录>:/<容器内目录>  # 如 -v $(pwd):/workspace 挂载当前目录到容器 /workspace

xmllint 详细使用指引

xmllint 支持 XML 验证、格式化、XPath 查询等高级功能，完整用法参见 xmllint ***文档。