MJExtension框架介紹

標簽： MJExtension

2015-05-01 08:22 1120人閱讀 評論(0) 收藏 舉報

 分類：

Foundation（14） 

版權聲明：本文為博主原創文章，未經博主允許不得轉載。

 

目錄(?)[+]

 

前兩節，我介紹了runtime的基本概念和基本使用，如果沒有看，請猛點這里。

 

這一節，我介紹一個基於runtime實現字典(JSON)與模型互轉的強大工具-- MJExtension 下載地址

 

MJExtension

 

• 世界上轉換速度最快、使用最簡單方便的字典轉模型框架

能做什么？

• MJExtension是一套字典和模型之間互相轉換的超輕量級框架
• MJExtension能完成的功能
  • 字典（JSON） --> 模型（Model）、CoreData模型（Core Data Model）
  • JSON字符串 --> 模型（Model）、CoreData模型（Core Data Model）
  • 模型（Model）、CoreData模型（Core Data Model） --> 字典（JSON）
  • 字典數組（JSON Array） --> 模型數組（Model Array）、Core Data模型數組（Core Data Model Array）
  • JSON字符串 --> 模型數組（Model Array）、Core Data模型數組（Core Data Model Array）
  • 模型數組（Model Array）、Core Data模型數組（Core Data Model Array） --> 字典數組（JSON Array）
  • 只需要一行代碼，就能實現模型的所有屬性進行Coding（歸檔和解檔）
• 詳盡用法主要參考 main.m中的各個函數 以及 NSObject+MJKeyValue.h

MJExtension和JSONModel、Mantle等框架的區別

• 轉換速率：
  • 最近一次測試表明：MJExtension > JSONModel > Mantle
  • 各位開發者也可以自行測試
• 具體用法：
  • JSONModel：要求所有模型類必須繼承自JSONModel基類
  • Mantle：要求所有模型類必須繼承自MTModel基類
  • MJExtension：不需要你的模型類繼承任何特殊基類，也不需要修改任何模型代碼，毫無污染，毫無侵入性

如何使用MJExtension

• cocoapods導入：pod 'MJExtension'
• 手動導入：
  • 將MJExtensionExample/MJExtensionExample/MJExtension文件夾中的所有源代碼拽入項目中
  • 導入主頭文件：#import "MJExtension.h"

MJExtension.h
MJConst.h               MJConst.m
MJFoundation.h          MJFoundation.m
MJIvar.h                MJIvar.m
MJType.h                MJType.m
NSObject+MJCoding.h     NSObject+MJCoding.m
NSObject+MJIvar.h       NSObject+MJIvar.m
NSObject+MJKeyValue.h   NSObject+MJKeyValue.m

最簡單的字典轉模型

typedef enum { SexMale, SexFemale } Sex; @interface User : NSObject @property (copy, nonatomic) NSString *name; @property (copy, nonatomic) NSString *icon; @property (assign, nonatomic) int age; @property (assign, nonatomic) double height; @property (strong, nonatomic) NSNumber *money; @property (assign, nonatomic) Sex sex; @end /***********************************************/ NSDictionary *dict = @{ @"name" : @"Jack", @"icon" : @"lufy.png", @"age" : @20, @"height" : @"1.55", @"money" : @100.9, @"sex" : @(SexFemale) }; // 將字典轉為User模型 User *user = [User objectWithKeyValues:dict]; NSLog(@"name=%@, icon=%@, age=%d, height=%@, money=%@, sex=%d", user.name, user.icon, user.age, user.height, user.money, user.sex); // name=Jack, icon=lufy.png, age=20, height=1.550000, money=100.9, sex=1

核心代碼

• [User objectWithKeyValues:dict]

JSON字符串轉模型

// 1.定義一個JSON字符串
NSString *jsonString = @"{\"name\":\"Jack\", \"icon\":\"lufy.png\", \"age\":20}"; // 2.將JSON字符串轉為User模型 User *user = [User objectWithKeyValues:jsonString]; // 3.打印User模型的屬性 NSLog(@"name=%@, icon=%@, age=%d", user.name, user.icon, user.age); // name=Jack, icon=lufy.png, age=20

核心代碼

• [User objectWithKeyValues:dict]

模型中嵌套模型

@interface Status : NSObject /** 微博文本內容 */ @property (copy, nonatomic) NSString *text; /** 微博作者 */ @property (strong, nonatomic) User *user; /** 轉發的微博 */ @property (strong, nonatomic) Status *retweetedStatus; @end /***********************************************/ NSDictionary *dict = @{ @"text" : @"是啊，今天天氣確實不錯！", @"user" : @{ @"name" : @"Jack", @"icon" : @"lufy.png" }, @"retweetedStatus" : @{ @"text" : @"今天天氣真不錯！", @"user" : @{ @"name" : @"Rose", @"icon" : @"nami.png" } } }; // 將字典轉為Status模型 Status *status = [Status objectWithKeyValues:dict]; NSString *text = status.text; NSString *name = status.user.name; NSString *icon = status.user.icon; NSLog(@"text=%@, name=%@, icon=%@", text, name, icon); // text=是啊，今天天氣確實不錯！, name=Jack, icon=lufy.png NSString *text2 = status.retweetedStatus.text; NSString *name2 = status.retweetedStatus.user.name; NSString *icon2 = status.retweetedStatus.user.icon; NSLog(@"text2=%@, name2=%@, icon2=%@", text2, name2, icon2); // text2=今天天氣真不錯！, name2=Rose, icon2=nami.png

核心代碼

• [Status objectWithKeyValues:dict]

模型中有個數組屬性，數組里面又要裝着其他模型

@interface Ad : NSObject @property (copy, nonatomic) NSString *image; @property (copy, nonatomic) NSString *url; @end @interface StatusResult : NSObject /** 存放着一堆的微博數據（里面都是Status模型） */ @property (strong, nonatomic) NSMutableArray *statuses; /** 存放着一堆的廣告數據（里面都是Ad模型） */ @property (strong, nonatomic) NSArray *ads; @property (strong, nonatomic) NSNumber *totalNumber; @end /***********************************************/ // StatusResult類中的statuses數組中存放的是Status模型 // StatusResult類中的ads數組中存放的是Ad模型 [StatusResult setupObjectClassInArray:^NSDictionary *{ return @{ @"statuses" : @"Status", @"ads" : @"Ad" }; }]; // 相當於在StatusResult.m中實現了+objectClassInArray方法 NSDictionary *dict = @{ @"statuses" : @[ @{ @"text" : @"今天天氣真不錯！", @"user" : @{ @"name" : @"Rose", @"icon" : @"nami.png" } }, @{ @"text" : @"明天去旅游了", @"user" : @{ @"name" : @"Jack", @"icon" : @"lufy.png" } } ], @"ads" : @[ @{ @"image" : @"ad01.png", @"url" : @"http://www.ad01.com" }, @{ @"image" : @"ad02.png", @"url" : @"http://www.ad02.com" } ], @"totalNumber" : @"2014" }; // 將字典轉為StatusResult模型 StatusResult *result = [StatusResult objectWithKeyValues:dict]; NSLog(@"totalNumber=%@", result.totalNumber); // totalNumber=2014 // 打印statuses數組中的模型屬性 for (Status *status in result.statuses) { NSString *text = status.text; NSString *name = status.user.name; NSString *icon = status.user.icon; NSLog(@"text=%@, name=%@, icon=%@", text, name, icon); } // text=今天天氣真不錯！, name=Rose, icon=nami.png // text=明天去旅游了, name=Jack, icon=lufy.png // 打印ads數組中的模型屬性 for (Ad *ad in result.ads) { NSLog(@"image=%@, url=%@", ad.image, ad.url); } // image=ad01.png, url=http://www.ad01.com // image=ad02.png, url=http://www.ad02.com

核心代碼

• 調用+ (void)setupObjectClassInArray:方法
• [StatusResult objectWithKeyValues:dict]
• 提醒一句：如果NSArray\NSMutableArray屬性中存放的不希望是模型，而是NSNumber、NSString等基本數據，那么就不需要調用+ (void)setupObjectClassInArray:方法

模型中的屬性名和字典中的key不相同(或者需要多級映射)

@interface Bag : NSObject @property (copy, nonatomic) NSString *name; @property (assign, nonatomic) double price; @end @interface Student : NSObject @property (copy, nonatomic) NSString *ID; @property (copy, nonatomic) NSString *desc; @property (copy, nonatomic) NSString *nowName; @property (copy, nonatomic) NSString *oldName; @property (copy, nonatomic) NSString *nameChangedTime; @property (strong, nonatomic) Bag *bag; @end /***********************************************/ // Student中的ID屬性對應着字典中的id // .... [Student setupReplacedKeyFromPropertyName:^NSDictionary *{ return @{@"ID" : @"id", @"desc" : @"desciption", @"oldName" : @"name.oldName", @"nowName" : @"name.newName", @"nameChangedTime" : @"name.info.nameChangedTime", @"bag" : @"other.bag" }; }]; // 相當於在Student.m中實現了+replacedKeyFromPropertyName方法 NSDictionary *dict = @{ @"id" : @"20", @"desciption" : @"孩子", @"name" : @{ @"newName" : @"lufy", @"oldName" : @"kitty", @"info" : @{ @"nameChangedTime" : @"2013-08" } }, @"other" : @{ @"bag" : @{ @"name" : @"小書包", @"price" : @100.7 } } }; // 將字典轉為Student模型 Student *stu = [Student objectWithKeyValues:dict]; // 打印Student模型的屬性 NSLog(@"ID=%@, desc=%@, oldName=%@, nowName=%@, nameChangedTime=%@", stu.ID, stu.desc, stu.oldName, stu.nowName, stu.nameChangedTime); // ID=20, desc=孩子, oldName=kitty, nowName=lufy, nameChangedTime=2013-08 NSLog(@"bagName=%@, bagPrice=%f", stu.bag.name, stu.bag.price); // bagName=小書包, bagPrice=100.700000

核心代碼

• 調用+ (void)setupReplacedKeyFromPropertyName:方法
• [Student objectWithKeyValues:dict]

將一個字典數組轉成模型數組

NSArray *dictArray = @[
                       @{
                           @"name" : @"Jack", @"icon" : @"lufy.png", }, @{ @"name" : @"Rose", @"icon" : @"nami.png", } ]; // 將字典數組轉為User模型數組 NSArray *userArray = [User objectArrayWithKeyValuesArray:dictArray]; // 打印userArray數組中的User模型屬性 for (User *user in userArray) { NSLog(@"name=%@, icon=%@", user.name, user.icon); } // name=Jack, icon=lufy.png // name=Rose, icon=nami.png

核心代碼

• [User objectArrayWithKeyValuesArray:dictArray]

將一個模型轉成字典

// 新建模型
User *user = [[User alloc] init]; user.name = @"Jack"; user.icon = @"lufy.png"; Status *status = [[Status alloc] init]; status.user = user; status.text = @"今天的心情不錯！"; // 將模型轉為字典 NSDictionary *statusDict = status.keyValues; NSLog(@"%@", statusDict); /* {  text = "今天的心情不錯！";  user = {  icon = "lufy.png";  name = Jack;  }; } */ // 多級映射的模型 Student *stu = [[Student alloc] init]; stu.ID = @"123"; stu.oldName = @"rose"; stu.nowName = @"jack"; stu.desc = @"handsome"; stu.nameChangedTime = @"2018-09-08"; Bag *bag = [[Bag alloc] init]; bag.name = @"小書包"; bag.price = 205; stu.bag = bag; NSDictionary *stuDict = stu.keyValues; NSLog(@"%@", stuDict); /* {  desciption = handsome;  id = 123;  name = {  info = {  nameChangedTime = "2018-09-08";  };  newName = jack;  oldName = rose;  };  other = {  bag = {  name = "小書包";  price = 205;  };  }; } */

核心代碼

• status.keyValues、stu.keyValues

將一個模型數組轉成字典數組

// 新建模型數組
User *user1 = [[User alloc] init]; user1.name = @"Jack"; user1.icon = @"lufy.png"; User *user2 = [[User alloc] init]; user2.name = @"Rose"; user2.icon = @"nami.png"; NSArray *userArray = @[user1, user2]; // 將模型數組轉為字典數組 NSArray *dictArray = [User keyValuesArrayWithObjectArray:userArray]; NSLog(@"%@", dictArray); /* (  {  icon = "lufy.png";  name = Jack;  },  {  icon = "nami.png";  name = Rose;  } ) */

核心代碼

• [User keyValuesArrayWithObjectArray:userArray]

Core Data

NSDictionary *dict = @{
                       @"name" : @"Jack", @"icon" : @"lufy.png", @"age" : @20, @"height" : @1.55, @"money" : @"100.9", @"sex" : @(SexFemale), @"gay" : @"true" }; // 這個Demo僅僅提供思路，具體的方法參數需要自己創建 NSManagedObjectContext *context = nil; User *user = [User objectWithKeyValues:dict context:context]; // 利用CoreData保存模型 [context save:nil];

Core code

• [User objectWithKeyValues:dict context:context]

Coding

#import "MJExtension.h" @implementation User // NSCoding實現 MJCodingImplementation @end /***********************************************/ // Bag類中的name屬性不參與歸檔 [Bag setupIgnoredCodingPropertyNames:^NSArray *{ return @[@"name"]; }]; // 相當於在Bag.m中實現了+ignoredCodingPropertyNames方法 // 創建模型 Bag *bag = [[Bag alloc] init]; bag.name = @"Red bag"; bag.price = 200.8; NSString *file = [NSHomeDirectory() stringByAppendingPathComponent:@"Desktop/bag.data"]; // 歸檔 [NSKeyedArchiver archiveRootObject:bag toFile:file]; // 解檔 Bag *decodedBag = [NSKeyedUnarchiver unarchiveObjectWithFile:file]; NSLog(@"name=%@, price=%f", decodedBag.name, decodedBag.price); // name=(null), price=200.800000

Core code

• MJCodingImplementation
• 調用+ (void)setupIgnoredCodingPropertyNames方法（如果全部屬性都要歸檔、解檔，那就不需要調用這個方法）