在Swift开发场景中,处理XML格式数据是很多项目会遇到的需求,原生Codable协议默认仅支持JSON格式的编解码,无法直接处理XML数据。XMLCoder是一款基于Codable协议扩展的第三方库,能够让我们沿用熟悉的Codable使用习惯完成XML数据的解析与生成,大幅降低XML处理的开发成本。

XMLCoder库的环境配置
使用XMLCoder前需要先将其集成到项目中,如果你使用Swift Package Manager管理依赖,可以在项目的Package依赖中添加XMLCoder的仓库地址,选择对应的版本后完成集成。如果是使用CocoaPods管理项目,可以在Podfile中添加对应的库引用,执行pod install命令完成安装。
定义符合Codable的XML数据模型
XMLCoder的核心思路和原生Codable一致,需要先定义和数据结构对应的模型,模型需要遵循Codable协议,同时可以根据XML的结构添加对应的映射配置。比如我们要解析一个包含用户信息的XML数据,首先定义对应的模型:
import XMLCoder
// 定义用户模型,遵循Codable协议
struct User: Codable {
let id: Int
let name: String
let age: Int
// XMLCoder支持配置节点和属性的映射
enum CodingKeys: String, CodingKey {
case id
case name
case age
}
}
// 定义外层XML对应的根模型
struct UserList: Codable {
let users: [User]
}
使用XMLCoder解码XML数据
完成模型定义后,就可以使用XMLCoder提供的XMLDecoder来完成XML数据的解码。XMLDecoder的使用方式和原生的JSONDecoder非常相似,只需要传入XML数据和对应的模型类型即可:
// 待解析的XML字符串
let xmlString = """
<user_list>
<user>
<id>1</id>
<name>张三</name>
<age>25</age>
</user>
<user>
<id>2</id>
<name>李四</name>
<age>28</age>
</user>
</user_list>
"""
// 将XML字符串转换为Data
guard let xmlData = xmlString.data(using: .utf8) else {
fatalError("XML字符串转Data失败")
}
do {
// 创建XMLDecoder实例
let decoder = XMLDecoder()
// 解码XML数据到UserList模型
let userList = try decoder.decode(UserList.self, from: xmlData)
print("解析到的用户数量:(userList.users.count)")
for user in userList.users {
print("用户ID:(user.id),姓名:(user.name),年龄:(user.age)")
}
} catch {
print("XML解码失败,错误:(error)")
}
处理XML属性和嵌套结构
实际场景中的XML往往包含节点属性,或者结构更加复杂,XMLCoder也支持对应的配置。比如XML节点的属性可以通过给模型添加CodingKeys的同时标记属性映射来实现:
// 带属性的XML节点对应的模型
struct Book: Codable {
let bookId: String
let title: String
let price: Double
enum CodingKeys: String, CodingKey {
case bookId = "id" // XML节点属性名
case title
case price
}
}
// 对应的XML示例
let bookXML = """
<book id="b001">
<title>Swift开发实战</title>
<price>89.9</price>
</book>
"""
如果需要解析带有属性的XML节点,还需要在解码前配置XMLDecoder的节点属性策略,确保能够正确识别属性值:
do {
let decoder = XMLDecoder()
// 配置属性解码策略,将属性映射到对应的CodingKeys
decoder.attrKey = "id"
let bookData = bookXML.data(using: .utf8)!
let book = try decoder.decode(Book.self, from: bookData)
print("图书ID:(book.bookId),书名:(book.title),价格:(book.price)")
} catch {
print("带属性的XML解码失败:(error)")
}
使用XMLCoder编码模型为XML数据
除了解码XML数据,XMLCoder还提供了XMLEncoder,可以将遵循Codable的模型编码为XML格式的字符串,使用方式同样和原生的JSONEncoder类似:
do {
// 创建待编码的模型实例
let user = User(id: 3, name: "王五", age: 30)
// 创建XMLEncoder实例
let encoder = XMLEncoder()
// 编码模型为XML Data
let encodedData = try encoder.encode(user, withRootKey: "user")
// 转换为字符串输出
if let xmlString = String(data: encodedData, encoding: .utf8) {
print("编码后的XML:n(xmlString)")
}
} catch {
print("模型编码为XML失败:(error)")
}
常见问题与注意事项
- XML的节点名称和模型的属性名需要对应,如果不一致可以通过CodingKeys做映射,和原生Codable的映射逻辑一致。
- 处理XML属性时,需要正确配置XMLEncoder和XMLDecoder的属性相关参数,避免属性值无法正确解析。
- 如果XML结构存在命名空间,需要在解码时配置对应的命名空间策略,XMLCoder提供了相关的配置选项支持命名空间处理。
- XMLCoder的版本需要和Swift版本兼容,集成时注意查看官方文档的版本适配说明。