您的位置:

iOS MJExtension 插件实现模型数据转换

一、MJExtension简介

MJExtension是一个iOS开发中常用的第三方库,它可以将JSON格式的数据转化为OC对象。MJExtension的自定义转换方法和快速地将OC对象转为JSON格式的数据。使用MJExtension可以大大减少一些重复性的工作,提高开发效率。

MJExtension可以在github上直接下载,也可以使用CocoaPods进行引入,具体方法可参照官方文档。下面我们将介绍MJExtension的使用方法。

二、如何使用MJExtension

在使用MJExtension之前,需要对我们需要的OC对象进行扩展。

以MJExtension默认做法举例,对象扩展代码示例如下:

#import "Person.h"
#import 

@implementation Person
MJExtensionCodingImplementation 
@end

  

其中,MJExtensionCodingImplementation就是对象扩展的一部分。在使用过程中,一定要注意,在需要转换的OC对象中的.h文件中进行对象扩展,否则我们会发现在进行转换时编译会报出一些类似“unrecognized selector sent to instance…”这样的错误。

接下来我们来实践一下如何使用MJExtension。

在实际开发中,我们一般是通过JSON格式的字符串或者字典(NSDictionary)来构建OC对象的。MJExtension针对这两种情况都提供了相应的API。

1、将JSON格式的字符串转成OC对象

首先,在.h文件中包含MJExtension.h文件,代码示例如下:

#import 
#import "Person.h"

  

现在假设我们已经有一个JSON格式的字符串,我们可以使用下面的代码将其转换成OC对象。

NSString *jsonString = @"{\"name\":\"琳琳\",\"age\":26}";
Person *p = [Person mj_objectWithKeyValues:jsonString];

2、将NSDictionary对象转成OC对象

在进行NSDictionary对象转换时,我们需要将对象中所有的键值对进行提取,并将其转换成对应的OC对象。可以使用下面的代码实现:

NSDictionary *dict = @{@"name":@"小明",@"age":@20};
Person *p = [Person mj_objectWithKeyValues:dict];

你可能会发现,在NSDictionary对象转换中键值对的键值类型必须是OC对象,如NSString、NSNumber等,否则将会出现错误。

三、MJExtension高级特性

1、忽略转换字段

有些时候,在转换OC对象时,我们需要忽略一些对象不需要的字段,此时可以使用MJExtension提供的 ignoreKeysInCoding 方法。

例如:

+ (NSArray *)mj_ignoredCodingPropertyNames {
    return @[@"address"];
}

此例中,代码返回一个包含字符串“address”的NSArray,表示在进行对象转换时忽略“address”字段。

2、字典和模型的转换

在经常进行JSON对象转换时,有时还需要对需要转换的数据类型进行更进一步的处理。这时,可以使用MJExtension提供的字典和模型的转换方法。

正如我们所知,在字典和模型转换时,我们需要书写一些代码。在使用MJExtension时,我们可以利用一些设置来避免这种重复性的工作。例如:

+ (NSDictionary *)mj_objectClassInArray {
    return @{
             @"dataList": @"Person"
            };
}

此例中,代码告诉MJExtension每当它在转换字典到模型时遇到"dataList"这个字段,它应该把"dataList"字段里的数据转换成名为"Person"的类型。

3、时间戳和时间格式转换

iOS中经常需要在JSON数据中处理时间戳和字符串。MJExtension为这些工作也提供了比较完善的支持。

1)将模型对象的NSDate类型字段转成指定格式的NSString类型。

+ (NSDictionary *)mj_replacedKeyFromPropertyName {
    return @{
             @"dateTime" : @"dt"
            };
}
+ (NSDictionary *)mj_dateFormatters {
    return @{
             @"dateTime" : @"yyyy-MM-dd HH:mm:ss"
            };
}

MJExtension提供了mj_dateFormatters API,可以将NSDate类型的字段直接转换成指定格式的NSString类型。以上两块代码告诉MJExtension哪个NSDate字段应该在何时被按照哪种格式转换成NSString类型。如这里所示,如果Person.h文件中存在一个名为“dt”的NSDate字段,那么它会被转换成yyyy-MM-dd HH:mm:ss这样的格式。

2)将JSON数据中的时间戳直接转成NSDate对象。

+ (NSDictionary *)mj_replacedKeyFromPropertyName {
    return @{
             @"time" : @"t"
            };
}
+ (NSDictionary *)mj_objectClassInArray {
    return @{
             @"dataList": @"Person"
            };
}
+ (NSDictionary *)mj_dateObjectClassInArray {
    return @{
             @"dataList": [Person class]
            };
}

以上代码告诉MJExtension,在JSON数据中将名为“t”的时间戳直接转换成NSDate类型字段。代码中的mj_objectClassInArray表示思路同2)。

总结

通过本文的介绍,相信大家已经对MJExtension有了一定的了解。它可以在iOS的开发中有很多的用处,可以大大提高我们的开发效率,减少我们编写代码的重复性工作。因此,在开发中使用MJExtension也是非常明智的选择。