SBJson 5 技术文档

1. 安装指南

SBJson 5 可以通过以下几种方式进行安装：

CocoaPods

推荐使用 CocoaPods 进行安装。在您的 Podfile 文件中添加以下内容：

pod 'SBJson', '~> 5.0.0'

Carthage

SBJson 也与 Carthage 兼容。请遵循 iOS 的入门指南。

github "SBJson/SBJson" == 5.0.2

源文件打包

一种不再推荐的安装方式是将所有源文件（Classes 文件夹的内容）复制到您的 Xcode 项目中。

2. 项目使用说明

SBJson 5 支持基于块的 JSON 解析和生成，适用于 Objective-C。

块基础解析

首先定义一个简单的块和错误处理程序：

SBJson5ValueBlock block = ^(id v, BOOL *stop) {
    BOOL isArray = [v isKindOfClass:[NSArray class]];
    NSLog(@"Found: %@", isArray ? @"Array" : @"Object");
};

SBJson5ErrorBlock eh = ^(NSError* err) {
    NSLog(@"OOPS: %@", err);
    exit(1);
};

然后创建一个解析器并将数据添加到其中：

id parser = [SBJson5Parser parserWithBlock:block
                              errorHandler:eh];

id data = [@"[true," dataWithEncoding:NSUTF8StringEncoding];
[parser parse:data]; // 返回 SBJson5ParserWaitingForData

// 块尚未被调用...

// 现在，添加另一个值并关闭数组

data = [@"false]" dataWithEncoding:NSUTF8StringEncoding];
[parser parse:data]; // 返回 SBJson5ParserComplete

// 上述 -parse: 方法在返回前调用您的块。

处理多个文档

对于像 Twitter 的馈送一样，每行包含一个 JSON 文档的情况，这种方式非常有用。以下是一个解析多个连续 JSON 文档的示例，其中您的块将对每个文档调用一次：

id parser = [SBJson5Parser multiRootParserWithBlock:block
                                       errorHandler:eh];

// 注意：这个输入包含多个顶级 JSON 文档
id data = [@"[]{}" dataWithEncoding:NSUTF8StringEncoding];
[parser parse:data];
[parser parse:data];

上面的示例将打印：

Found: Array
Found: Object
Found: Array
Found: Object

解析顶级大数组

通常您无法控制要解析的输入，因此无法使用 multiRootParser。但是，如果您正在解析一个长数组，可以使用 unwrapRootArrayParser 达到相同的效果：

id parser = [SBJson5Parser unwrapRootArrayParserWithBlock:block
                                             errorHandler:eh];

// 注意：这个输入包含一个单一的顶级文档
id data = [@"[[],{},[],{}]" dataWithEncoding:NSUTF8StringEncoding];
[parser parse:data];

其他功能

• 为安全起见，所有输入都有一个最大嵌套级别。默认值为 32，但可配置。
• 写入器可以排序字典键，以使输出在不同写入之间保持一致。
• 写入器可以创建易于阅读的输出，包含换行符和缩进。
• 您可以在同一应用程序中并排安装 SBJson v3、v4 和 v5。这是可能的，因为所有类和公共符号都包含主版本号。

3. 项目 API 使用文档

请查看 API 文档 以获取更多详细信息。

4. 项目安装方式

请参考“安装指南”部分，选择适合您项目的安装方式。