JTObjectMapping 技术文档

1. 安装指南

原始方法

将 JTObjectMapping/ 目录下的所有文件复制到你的项目中。

使用 CocoaPods

在终端中运行以下命令：

$ pod search JTObjectMapping

然后在你的 Podfile 中指定正确的版本。

2. 项目的使用说明

假设你有一个 JSON 用户对象响应，解析后以 NSDictionary 表示：

{
    "create_date": "1970-01-01T00:00:00+0000",
    "p_age": 30,
    "p_childs": ["Mary", "James"],
    "p_name": "Bob",
    "p_title": "Manager",
    "social_networks": {
        "twitter": "@mystcolor",
        "facebook": "yourFacebookID"
    }
}

使用 [NSObject objectFromJSONObject:json mapping:mapping] 方法将其转换为 NSObject 子类对象。

示例代码：

NSDictionary *json = <Parsed JSON response from above>;

JTUserTest *user = [JTUserTest objectFromJSONObject:json mapping:mapping];

定义必要的映射，从字典键到属性键路径：

NSDictionary *socialNetworkMapping = @{
    @"twitterID": @"twitter",
    @"facebookID": @"facebook"
};

NSDictionary *mapping = @{
    @"name": @"p_name",
    @"title": @"p_title",
    @"age": @"p_age",
    @"childs": @"p_childs",
    [NSDate mappingWithKey:@"createDate" dateFormatString:@"yyyy-MM-dd'T'HH:mm:ssZ"]: @"create_date",
    [JTSocialNetworkTest mappingWithKey:@"socialNetwork" mapping:socialNetworkMapping]: @"social_networks"
};

你需要定义自己的用户对象，并使用相应的 @synthesize 属性。

3. 项目API使用文档

objectFromJSONObject:mapping:

将 NSDictionary 或 NSArray 转换为 NSObject 子类对象。

参数：

• json: 解析后的 JSON 数据。
• mapping: 映射字典，定义 JSON 键与对象属性之间的映射关系。

返回值：

• 转换后的 NSObject 子类对象。

mappingWithKey:dateFormatString:

创建一个日期映射，将 JSON 中的日期字符串转换为 NSDate 对象。

参数：

• key: 属性键。
• dateFormatString: 日期格式字符串。

返回值：

• 日期映射对象。

mappingWithKey:mapping:

创建一个嵌套对象映射，将 JSON 中的嵌套对象转换为自定义对象。

参数：

• key: 属性键。
• mapping: 嵌套对象的映射字典。

返回值：

• 嵌套对象映射对象。

4. 项目安装方式

原始方法

将 JTObjectMapping/ 目录下的所有文件复制到你的项目中。

使用 CocoaPods

在终端中运行以下命令：

$ pod search JTObjectMapping

然后在你的 Podfile 中指定正确的版本。