MJExtension

KO | EN

gitlite — search

#javascript #hacktoberfest #ai #go #golang #deep-learning #macos #kubernetes #awesome-list #vue #pytorch #security #ios #openai

(★ 8,494)

JSON과 모델 간의 빠르고 편리하며 비침습적인(nonintrusive) 변환 프레임워크입니다. 모델 클래스가 어떤 베이스 클래스도 상속할 필요가 없습니다. 어떤 모델 파일도 수정할 필요가 없습니다.

MJExtension 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

MJExtension
===
[![SPM supported](https://img.shields.io/badge/SPM-supported-4BC51D.svg?style=flat)](https://github.com/apple/swift-package-manager)
[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)
[![podversion](https://img.shields.io/cocoapods/v/MJExtension.svg)](https://cocoapods.org/pods/MJExtension)
![Platform](https://img.shields.io/cocoapods/p/MJExtension.svg?style=flat)
- 빠르고, 편리하며, 비침투적인 JSON과 모델 간 변환 프레임워크입니다.
- 转换速度快、使用简单方便的字典转模型框架
[📜✍🏻\*\*Release Notes\*\*: 더 자세히 보기](https://github.com/CoderMJLee/MJExtension/releases)
## Contents
\* [Getting Started 【开始使用】](#Getting\_Started)
\* [Features 【能做什么】](#Features)
\* [Installation 【安装】](#Installation)
\* [Examples 【示例】](#Examples)
\* [Usage in Swift](#usage\_in\_swift)
\* [JSON -> Model](#JSON\_Model)
\* [JSONString -> Model](#JSONString\_Model)
\* [Model contains model](#Model\_contains\_model)
\* [Model contains model-array](#Model\_contains\_model\_array)
\* [Model name - JSON key mapping](#Model\_name\_JSON\_key\_mapping)
\* [JSON array -> model array](#JSON\_array\_model\_array)
\* [Model -> JSON](#Model\_JSON)
\* [Model array -> JSON array](#Model\_array\_JSON\_array)
\* [Core Data](#Core\_Data)
\* [Coding](#Coding)
\* [Secure Coding](#SecureCoding)
\* [Camel -> underline](#Camel\_underline)
\* [NSString -> NSDate, nil -> @""](#NSString\_NSDate)
\* [NSDate -> NSString](#NSDate\_NSString)
\* [More use cases](#More\_use\_cases)
---
##  Getting Started【开始使用】
###  Features【能做什么】
- MJExtension은 딕셔너리와 모델 간의 상호 변환을 위한 초경량 프레임워크입니다.
\* `JSON` --> `Model`、`Core Data Model`
\* `JSONString` --> `Model`、`Core Data Model`
\* `Model`、`Core Data Model` --> `JSON`
\* `JSON Array` --> `Model Array`、`Core Data Model Array`
\* `JSONString` --> `Model Array`、`Core Data Model Array`
\* `Model Array`、`Core Data Model Array` --> `JSON Array`
\* 단 한 줄의 코드로 모델의 모든 속성을 Coding할 수 있습니다.
\* 只需要一行代码，就能实现模型的所有属性进行Coding / SecureCoding（归档和解档）
###  Installation【安装】
#### CocoaPods【使用CocoaPods】
```ruby
pod 'MJExtension'
```
#### Carthage
```ruby
github "CoderMJLee/MJExtension"
```
#### Swift Package Manager
[`3.4.0`](https://github.com/CoderMJLee/MJExtension/releases/) 버전부터 지원됩니다.
#### Manually【手动导入】
- `MJExtension` 폴더 아래의 모든 소스 파일을 프로젝트로 드래그하세요.【将`MJExtension`文件夹中的所有源代码拽入项目中】
- 메인 헤더 파일을 임포트합니다: `#import "MJExtension.h"`【导入主头文件：`#import "MJExtension.h"`】
##  Examples【示例】
\*\*필요한 경우 모델에 `MJKeyValue` 프로토콜을 추가하세요【如果有需要, 请在模型中加入 `MJKeyValue` 协议】\*\*
###  Usage in Swift [关于在Swift中使用MJExtension] ‼️
> 예시:
>
> - [Model - MJTester.swift](MJExtensionTests/SwiftModel/MJTester.swift)
>
> - [Usage - SwiftModelTests.swift](MJExtensionTests/SwiftModelTests.swift)
```swift
@objc(MJTester)
@objcMembers
class MJTester: NSObject {
// make sure to use `dynamic` attribute for basic type & must use as Non-Optional & must set initial value
dynamic var isSpecialAgent: Bool = false
dynamic var age: Int = 0
var name: String?
var identifier: String?
}
```
1. Objc 접근성을 선언하기 위해 클래스나 프로퍼티에 `@objc` 또는 `@objcMembers` 어트리뷰트를 추가해야 합니다 [在 Swift4 之后, 请在属性前加 `@objc` 修饰或在类前增加 `@objcMembers`. 以保证 Swift 的属性能够暴露给 Objc 使用. ]
2. `Bool` 및 `Int`를 프로퍼티 타입으로 사용하는 경우, 반드시 `dynamic` 어트리뷰트를 사용해야 합니다. 또한 `Non-Optional` 타입이어야 하며 `기본값(default value)`을 할당해야 합니다.[如果要使用 `Bool` 和 `Int` 等 Swfit 专用基本类型, 请使用 `dynamic` 关键字修饰, 类型为 `Non-Optional`, 並且给定初始值.]
> 순수 Swift 버전의 JSON 및 Model 변환 프레임워크가 오픈소스화되어 출시되었습니다.
>
> - [KakaJSON](https://github.com/kakaopensource/KakaJSON)
> - [中文教程](https://www.cnblogs.com/mjios/p/11352776.html)
> - 프로젝트의 모델이 Swift로 작성된 경우 [KakaJSON](https://github.com/kakaopensource/KakaJSON)을 강력히 추천합니다.
> - 다양한 자주 사용되는 데이터 시나리오에 대해 대규모 단위 테스트가 진행되었습니다.
> - 간단하고 사용하기 쉬우며, 기능이 풍부하고, 변환이 빠릅니다.
###  The most simple JSON -> Model【最简单的字典转模型】
```objc
typedef enum {
SexMale,
SexFemale
} Sex;
@interface User : NSObject
@property (copy, nonatomic) NSString \*name;
@property

(copy, nonatomic) NSString \*icon;
@property (assign, nonatomic) unsigned int age;
@property (copy, nonatomic) NSString \*height;
@property (strong, nonatomic) NSNumber \*money;
@property (assign, nonatomic) Sex sex;
@property (assign, nonatomic, getter=isGay) BOOL gay;
@end
/\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*/
NSDictionary \*dict = @{
@"name" : @"Jack",
@"icon" : @"lufy.png",
@"age" : @20,
@"height" : @"1.55",
@"money" : @100.9,
@"sex" : @(SexFemale),
@"gay" : @"true"
// @"gay" : @"1"
// @"gay" : @"NO"
};
// JSON -> User
User \*user = [User mj\_objectWithKeyValues:dict];
NSLog(@"name=%@, icon=%@, age=%zd, height=%@, money=%@, sex=%d, gay=%d", user.name, user.icon, user.age, user.height, user.money, user.sex, user.gay);
// name=Jack, icon=lufy.png, age=20, height=1.550000, money=100.9, sex=1
```
###  JSONString -> Model【JSON 문자열을 모델로 변환】
```objc
// 1.Define a JSONString
NSString \*jsonString = @"{\"name\":\"Jack\", \"icon\":\"lufy.png\", \"age\":20}";
// 2.JSONString -> User
User \*user = [User mj\_objectWithKeyValues:jsonString];
// 3.Print user's properties
NSLog(@"name=%@, icon=%@, age=%d", user.name, user.icon, user.age);
// name=Jack, icon=lufy.png, age=20
```
###  Model contains model【모델 내부에 모델 포함】
```objc
@interface Status : NSObject
@property (copy, nonatomic) NSString \*text;
@property (strong, nonatomic) User \*user;
@property (strong, nonatomic) Status \*retweetedStatus;
@end
/\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*/
NSDictionary \*dict = @{
@"text" : @"Agree!Nice weather!",
@"user" : @{
@"name" : @"Jack",
@"icon" : @"lufy.png"
},
@"retweetedStatus" : @{
@"text" : @"Nice weather!",
@"user" : @{
@"name" : @"Rose",
@"icon" : @"nami.png"
}
}
};
// JSON -> Status
Status \*status = [Status mj\_objectWithKeyValues:dict];
NSString \*text = status.text;
NSString \*name = status.user.name;
NSString \*icon = status.user.icon;
NSLog(@"text=%@, name=%@, icon=%@", text, name, icon);
// text=Agree!Nice weather!, 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=Nice weather!, name2=Rose, icon2=nami.png
```
###  Model contains model-array【모델 안에 배열 속성이 있고, 배열 내부에 다른 모델들이 포함됨】
```objc
@interface Ad : NSObject
@property (copy, nonatomic) NSString \*image;
@property (copy, nonatomic) NSString \*url;
@end
@interface StatusResult : NSObject
/\*\* Contatins status model \*/
@property (strong, nonatomic) NSMutableArray \*statuses;
/\*\* Contatins ad model \*/
@property (strong, nonatomic) NSArray \*ads;
@property (strong, nonatomic) NSNumber \*totalNumber;
@end
/\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*/
// Tell MJExtension what type of model will be contained in statuses and ads.
[StatusResult mj\_setupObjectClassInArray:^NSDictionary \*{
return @{
@"statuses" : @"Status",
// @"statuses" : [Status class],
@"ads" : @"Ad"
// @"ads" : [Ad class]
};
}];
// Equals: StatusResult.m implements +mj\_objectClassInArray method.
NSDictionary \*dict = @{
@"statuses" : @[
@{
@"text" : @"Nice weather!",
@"user" : @{
@"name" : @"Rose",
@"icon" : @"nami.png"
}
},
@{
@"text" : @"Go camping tomorrow!",
@"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"
};
// JSON -> StatusResult
StatusResult \*result = [StatusResult mj\_objectWithKeyValues:dict];
NSLog(@"totalNumber=%@", result.totalNumber);
// totalNumber=2014
// Printing
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=Nice weather!, name=

Rose, icon=nami.png
// text=Go camping tomorrow!, name=Jack, icon=lufy.png
// Printing
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
```
###  Model name - JSON key mapping【모델 속성 이름과 딕셔너리의 key가 다른 경우(또는 다중 계층 매핑이 필요한 경우)】
```objc
@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
/\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*/
// How to map
[Student mj\_setupReplacedKeyFromPropertyName:^NSDictionary \*{
return @{
@"ID" : @"id",
@"desc" : @"description",
@"oldName" : @"name.oldName",
@"nowName" : @"name.newName",
@"nameChangedTime" : @"name.info[1].nameChangedTime",
@"bag" : @"other.bag"
};
}];
// Equals: Student.m implements +mj\_replacedKeyFromPropertyName method.
NSDictionary \*dict = @{
@"id" : @"20",
@"description" : @"kids",
@"name" : @{
@"newName" : @"lufy",
@"oldName" : @"kitty",
@"info" : @[
@"test-data",
@{
@"nameChangedTime" : @"2013-08"
}
]
},
@"other" : @{
@"bag" : @{
@"name" : @"a red bag",
@"price" : @100.7
}
}
};
// JSON -> Student
Student \*stu = [Student mj\_objectWithKeyValues:dict];
// Printing
NSLog(@"ID=%@, desc=%@, oldName=%@, nowName=%@, nameChangedTime=%@",
stu.ID, stu.desc, stu.oldName, stu.nowName, stu.nameChangedTime);
// ID=20, desc=kids, oldName=kitty, nowName=lufy, nameChangedTime=2013-08
NSLog(@"bagName=%@, bagPrice=%f", stu.bag.name, stu.bag.price);
// bagName=a red bag, bagPrice=100.700000
```
###  JSON array -> model array【딕셔너리 배열을 모델 배열로 변환】
```objc
NSArray \*dictArray = @[
@{
@"name" : @"Jack",
@"icon" : @"lufy.png"
},
@{
@"name" : @"Rose",
@"icon" : @"nami.png"
}
];
// JSON array -> User array
NSArray \*userArray = [User mj\_objectArrayWithKeyValuesArray:dictArray];
// Printing
for (User \*user in userArray) {
NSLog(@"name=%@, icon=%@", user.name, user.icon);
}
// name=Jack, icon=lufy.png
// name=Rose, icon=nami.png
```
###  Model -> JSON【모델을 딕셔너리로 변환】
```objc
// New model
User \*user = [[User alloc] init];
user.name = @"Jack";
user.icon = @"lufy.png";
Status \*status = [[Status alloc] init];
status.user = user;
status.text = @"Nice mood!";
// Status -> JSON
NSDictionary \*statusDict = status.mj\_keyValues;
NSLog(@"%@", statusDict);
/\*
{
text = "Nice mood!";
user = {
icon = "lufy.png";
name = Jack;
};
}
\*/
// More complex situation
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 = @"a red bag";
bag.price = 205;
stu.bag = bag;
NSDictionary \*stuDict = stu.mj\_keyValues;
NSLog(@"%@", stuDict);
/\*
{
ID = 123;
bag = {
name = "\U5c0f\U4e66\U5305";
price = 205;
};
desc = handsome;
nameChangedTime = "2018-09-08";
nowName = jack;
oldName = rose;
}
\*/
```
###  Model array -> JSON array【모델 배열을 딕셔너리 배열로 변환】
```objc
// New model array
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];
// Model array -> JSON array
NSArray \*dictArray = [User mj\_keyValuesArrayWithObjectArray:userArray];
NSLog(@"%@", dictArray);
/\*
(
{
icon = "lufy.png";
name = Jack;
},
{
icon = "nami.png";
name = Rose;
}
)
\*/
```
###  Core Data
```swift
func json2CoreDataObject() {
context.performAndWait {
let object = MJCoreDataTester.mj\_object(withKeyValues: Values.testJSONObject, context: context)
// use the object
}
}
func coreDataObject2JSON() {
context.performAndWait {
let dict = coreDataObject.mj\_keyValues

()
// use dict
}
}
```
###  코딩 (Archive 및 Unarchive 메서드는 iOS 12에서 지원 중단되었습니다)
```objc
#import "MJExtension.h"
@implementation MJBag
// NSCoding 구현
MJCodingImplementation
@end
/\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*/
// 인코딩에서 제외할 프로퍼티 지정
[MJBag mj\_setupIgnoredCodingPropertyNames:^NSArray \*{
return @[@"name"];
}];
// 동일한 의미: MJBag.m이 +mj\_ignoredCodingPropertyNames 메서드를 구현합니다.
// 모델 생성
MJBag \*bag = [[MJBag alloc] init];
bag.name = @"Red bag";
bag.price = 200.8;
NSString \*file = [NSHomeDirectory() stringByAppendingPathComponent:@"Desktop/bag.data"];
// 아카이빙을 통한 인코딩
[NSKeyedArchiver archiveRootObject:bag toFile:file];
// 언아카이빙을 통한 디코딩
MJBag \*decodedBag = [NSKeyedUnarchiver unarchiveObjectWithFile:file];
NSLog(@"name=%@, price=%f", decodedBag.name, decodedBag.price);
// name=(null), price=200.800000
```
###  보안 코딩 (Secure Coding)
`MJSecureCodingImplementation(class, isSupport)` 매크로를 사용합니다.
```objc
@import MJExtension;
// NSSecureCoding 구현
MJSecureCodingImplementation(MJBag, YES)
@implementation MJBag
@end
/\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*/
// 인코딩에서 제외할 프로퍼티 지정
[MJBag mj\_setupIgnoredCodingPropertyNames:^NSArray \*{
return @[@"name"];
}];
// 동일한 의미: MJBag.m이 +mj\_ignoredCodingPropertyNames 메서드를 구현합니다.
// 모델 생성
MJBag \*bag = [[MJBag alloc] init];
bag.name = @"Red bag";
bag.price = 200.8;
bag.isBig = YES;
bag.weight = 200;
NSString \*file = [NSTemporaryDirectory() stringByAppendingPathComponent:@"bag.data"];
NSError \*error = nil;
// 아카이빙을 통한 인코딩
NSData \*data = [NSKeyedArchiver archivedDataWithRootObject:bag requiringSecureCoding:YES error:&error];
[data writeToFile:file atomically:true];
// 언아카이빙을 통한 디코딩
NSData \*readData = [NSFileManager.defaultManager contentsAtPath:file];
error = nil;
MJBag \*decodedBag = [NSKeyedUnarchiver unarchivedObjectOfClass:MJBag.class fromData:readData error:&error];
MJExtensionLog(@"name=%@, price=%f", decodedBag.name, decodedBag.price);
```
###  Camel -> underline【프로퍼티 이름 일괄 변환 (예: 카멜 케이스를 스네이크 케이스로 변환)】
```objc
// Dog
#import "MJExtension.h"
@implementation Dog
+ (NSString \*)mj\_replacedKeyFromPropertyName121:(NSString \*)propertyName
{
// nickName -> nick\_name
return [propertyName mj\_underlineFromCamel];
}
@end
// NSDictionary
NSDictionary \*dict = @{
@"nick\_name" : @"완차이",
@"sale\_price" : @"10.5",
@"run\_speed" : @"100.9"
};
// NSDictionary -> Dog
Dog \*dog = [Dog mj\_objectWithKeyValues:dict];
// 출력
NSLog(@"nickName=%@, scalePrice=%f runSpeed=%f", dog.nickName, dog.salePrice, dog.runSpeed);
```
###  NSString -> NSDate, nil -> @""【딕셔너리 값 필터링 (예: 문자열 날짜를 NSDate로 처리, nil 문자열을 @""로 처리)】
```objc
// Book
#import "MJExtension.h"
@implementation Book
- (id)mj\_newValueFromOldValue:(id)oldValue property:(MJProperty \*)property
{
if ([property.name isEqualToString:@"publisher"]) {
if (oldValue == nil) return @"";
} else if (property.type.typeClass == [NSDate class]) {
NSDateFormatter \*fmt = [[NSDateFormatter alloc] init];
fmt.dateFormat = @"yyyy-MM-dd";
return [fmt dateFromString:oldValue];
}
return oldValue;
}
@end
// NSDictionary
NSDictionary \*dict = @{
@"name" : @"5분 만에 마스터하는 iOS 개발",
@"publishedTime" : @"2011-09-10"
};
// NSDictionary -> Book
Book \*book = [Book mj\_objectWithKeyValues:dict];
// 출력
NSLog(@"name=%@, publisher=%@, publishedTime=%@", book.name, book.publisher, book.publishedTime);
```
###  NSDate -> NSString【모델을 딕셔너리로 변환할 때 Date 타입을 String으로 수정】
```objc
- (void)mj\_objectDidConvertToKeyValues:(NSMutableDictionary \*)keyValues {
// NSDateFormatter \*formatter = [[NSDateFormatter alloc] init];
// formatter.dateFormat = @"yyy-MM-dd";
// 더 나은 성능을 위해 sharedFormatter를 사용하는 것이 좋습니다.
keyValues[@"publishedTime"] = [sharedFormatter stringFromDate:self.publishedTime];
}
```
###  More use cases【더 많은 사용법】
- `NSObject+MJKeyValue.h` 및 `NSObject+MJCoding.h`를 참고하세요.
## 기대
\* 사용 중 버그를 발견하신 경우

，希望你能Issues我，谢谢（或者尝试下载最新的框架代码看看BUG修复没有）
* 如果在使用过程中发现功能不够用，希望你能Issues我，我非常想为这个框架增加更多好用的功能，谢谢
* 如果你想为MJExtension输出代码，请拼命Pull Requests我

MJExtension

MJExtension 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

MJExtension

MJExtension 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README