Swift struct JSON To Modelフレームワーク

4624 ワード

iOSの開発に使われていたOCを作り、最近はSwiftを研究しています.
開発に必要なホイールはJSON回転モデルです
OCが使い始めたばかりのMJExtensionは、YYModelの2つのフレームワーク機能が開発に必要な機能を満たしていることが分かった.
開発も比較的簡単で,コードへの侵入も小さい.
Swift公式推奨値タイプの開発であり、利点が多い.盲目的に値タイプを使いたい.
YYModelとMJExtensionはclassのJSON転Modelのみサポート
最初に見たいくつかのフレームワークstructは、上の2つのようにコードの侵入が少なく、解析が簡単で直接的なものを探したいと思っています.
探し始めたのは何人か次のように考えていました
[ObjectMapper] (https://github.com/IcyButterfly/MappingAce)
コードの侵入が深刻で、解析コードの大きなセグメントを書きます.個人的には怠け者で、map["username"]というスペルは間違いやすいです.
class User: Mappable {
    var username: String?
    var age: Int?
    var weight: Double!
    var array: [AnyObject]?
    var dictionary: [String : AnyObject] = [:]
    var bestFriend: User?                       // Nested User object
    var friends: [User]?                        // Array of Users
    var birthday: Date?

    required init?(map: Map) {

    }

    // Mappable
    func mapping(map: Map) {
        username    

自分でも書き始めて、底辺についてよく知らないことに気づきました.書くのが難しすぎる.
Githubで検索して車輪を見つけた
JSON回転Model MappingAce
structを宣言するときはMappingプロトコルJSONを守ってModelを回すときはコード1つで済むlet user = User(fromDic: dict) YYModelMJExtensionに比べて1つだけプロトコルを遵守する機能的にはこの2つのフレームワークがないが、Swiftを開発するには十分だ.
次に引用したMappingAce Githubの例を比較してみましょう
JSON -> Model

Raw struct


// It is recommend to implement protocol `Mapping`, and just implement `Mapping`, no more works
struct PhoneNumber: Mapping{
    var tel: String
    var type: String
}

let phoneInfo: [String : Any] = [
    "tel": "186xxxxxxxx",
    "type": "work"
]
let phone = PhoneNumber(fromDic: phoneInfo)

print(phone.tel) //"186xxxxxxxx"
print(phone.type) //"work"



// Struct did not implement the `Mapping` protocol
struct PhoneNumber {
    var tel: String
    var type: String
}

let phone = MappingAny(type: PhoneEntity.self, fromDic: phoneInfo)

Nested struct mapping

struct User{
    var age: Int
    var name: String
    var phone: PhoneNumber
}

// if you want your serilized nested struct, just implement the `Mapping` protocol
struct PhoneNumber: Mapping {
    var tel: String
    var type: String
}

let dic: [String : Any] = [
    "age" : 24,
    "name": "Binglin",
    "phone": phoneInfo 
]

let user = MappingAny(type: User.self, fromDic: dic)
Optional property

struct User{
    var age: Int?
    var name: String?
    var phone: PhoneNumber?
}

private struct PhoneNumber: Mapping {
    var tel: String
    var type: String
}

let dic: [String : Any] = [
    "name": "Binglin",
]

let user = MappingAny(type: User.self, fromDic: dic)

XCTAssertEqual(user.age, nil)
XCTAssertEqual(user.name, "Binglin")
XCTAssertEqual(user.phone?.tel, nil)
XCTAssertEqual(user.phone?.type, nil)
Enum

enum type of Int & String is support

// eg: EnumInt
enum Gender: Int, EnumInt{
    case male = 1
    case female = 2
}

struct User: Mapping{
    var gender: Gender
}

let dicGender: [String : Any] = ["gender": 1]
let userMale = User(fromDic: dicGender)

XCTAssertEqual(userMale.gender, Gender.male)
// when enum is string type
enum Gender: String, EnumString{
    case male = "m"
    case female = "f"
}
Struct or class has default property value

protocol: InitMapping (Struct or Class)

// struct
struct User: InitMapping{
    var name: String = "default"
    var age: Int?
}

let dic: [String : Any] = ["age": 14]
let user = User(fromDic: dic)

print(user.name) //"default"
print(user.age)  //14


// class
// need to implement an empty initializer.
class User: NSObject, InitMapping{
    var name: String = "default"
    var age: Int?

    required override init() {}/*required*/
}

let dic: [String : Any] = ["name" : "IB"]
let user = User(fromDic: dic)
Model -> JSON

// for object implement Mapping or InitMapping
struct PhoneNumber: Mapping {
    var tel: String
    var type: String
}

let phone = PhoneNumber(tel: "186xxxxxxxx", type: "work")
let toDic = phone.toDictionary()
print(toDic) // ["type": "work", "tel": "186xxxxxxxx"]


// for object do not implement Mapping or InitMapping
// just implement protocol Serializable
struct PhoneNumber: `Serializable` {
    var tel: String
    var type: String
}

let phone = PhoneNumber(tel: "186xxxxxxxx", type: "work")
let toDic = phone.toDictionary()
print(toDic) // ["type": "work", "tel": "186xxxxxxxx"]```