XMLDictionary 技术文档

1. 安装指南

XMLDictionary 是一个用于简化 iOS 和 macOS 下 XML 解析和生成的类。要使用 XMLDictionary，只需将类文件拖入您的项目即可。

• 支持的构建目标：iOS 10.2 / Mac OS 10.12 (Xcode 8.2, Apple LLVM 编译器 8.0)
• 最早支持的部署目标：iOS 8.0 / Mac OS 10.10
• 最早兼容的部署目标：iOS 4.3 / Mac OS 10.6

请注意，本项目已被弃用，将不会接收任何未来的更新或修复。如果您正在使用它，请迁移到其他解决方案。

2. 项目的使用说明

XMLDictionary 是基于 NSXMLParser 类构建的，但它表现得更像是一个 DOM 样式的解析器，而不是 SAX 解析器。它创建了一个对象树，而不是在节点的开始和结束时生成事件。

与大多数 DOM 解析器不同，XMLDictionary 不会尝试复制 XML 标准的所有细节，例如嵌套标签内的文本。如果您需要表示类似 HTML 文档的内容，那么 XMLDictionary 将无法满足您的需求。如果您想使用 XML 作为数据交换格式来传递嵌套数据结构，那么 XMLDictionary 可能会提供一个比其他 DOM 解析器更简单的解决方案。

线程安全

XMLDictionary 的所有方法都应该是线程安全的。可以在不同线程上同时使用多个 XMLDictionary 解析器，但不可以在多个线程上并发调用同一个解析器。

ARC 兼容性

从版本 1.1 开始，XMLDictionary 需要 ARC。如果您希望在非 ARC 项目中使用 XMLDictionary，只需将 -fobjc-arc 编译器标志添加到 XMLDictionary.m 类中。

3. 项目 API 使用文档

XMLDictionaryParser 类负责将 XML 文件解析成字典。通常您不需要显式使用这个类，因为您可以通过 NSDictionary 的扩展方法来使用它。但是，如果您想为不同的字典使用不同的设置，它可能会很有用。

创建新的 XMLDictionaryParser 实例后，您可以使用以下方法来使用特定的解析器实例解析 XML 文件：

• - (NSDictionary *)dictionaryWithData:(NSData *)data;
• - (NSDictionary *)dictionaryWithString:(NSString *)string;
• - (NSDictionary *)dictionaryWithFile:(NSString *)path;
• - (NSDictionary *)dictionaryWithParser:(NSXMLParser *)parser;

您还可以修改 [XMLDictionaryParser sharedInstance] 的设置，以影响后续使用 NSDictionary 类别扩展方法解析的所有字典。

使用以下属性来调整解析行为：

• @property (nonatomic, assign) BOOL collapseTextNodes; 如果为 YES（默认值），则将只包含文本且没有子元素、属性或注释的标签折叠为单个字符串对象。
• @property (nonatomic, assign) BOOL stripEmptyNodes; 如果为 YES（默认值），则将删除空的标签（没有子元素、属性、文本或注释的标签）。
• @property (nonatomic, assign) BOOL trimWhiteSpace; 如果为 YES（默认值），则会从文本节点中删除前导和尾随空白，并且会省略只包含空白的文本节点。
• @property (nonatomic, assign) BOOL alwaysUseArrays; 如果为 YES，则每个子节点都将表示为数组，即使只有一个子节点也是如此。
• @property (nonatomic, assign) BOOL preserveComments; 如果为 YES，XML 注释将被分组到 __comments 键下的数组中，可以通过 comments 方法访问。
• @property (nonatomic, assign) XMLDictionaryAttributesMode attributesMode; 此属性控制 XML 属性的处理方式。默认值为 XMLDictionaryAttributesModePrefixed，即属性会包含在字典中，并带有 _（下划线）前缀以避免命名空间冲突。
• @property (nonatomic, assign) XMLDictionaryNodeNameMode nodeNameMode; 此属性控制节点名称的处理方式。默认值为 XMLDictionaryNodeNameModeRootOnly，即节点名称只包含在根字典中。

4. 项目安装方式

为了在应用程序中使用 XMLDictionary，只需将类文件拖入您的项目即可。如果您希望在非 ARC 项目中使用 XMLDictionary，请按照上述说明添加 -fobjc-arc 编译器标志。