[MappingAce]这可能是使用起来最简单的Swift JSON解析库了,从此可以告别手写key映射

2017-02-17 15:59

MappingAce github地址: https://github.com/IcyButterfly/MappingAce

序幕:开发者与MappingAce的对话

  • 开发者: 现在很多开源库都是采用的在源代码里添加属性与对应key的映射代码,你也是采用这样的方式吗?MappingAce: 不是的,基本可以告别这种方式
  • 开发者: 有些JSON解析库 虽然也是Swift写的,但是还是继承自NSObject来做的,你是继承自NSObject吗?MappingAce: 不是的
  • 开发者: 我需要有些属性可为nil,另一些属性非空,你可以给我自动处理吗?MappingAce: 嗯
  • 开发者: 那枚举类型你可以也帮我解析掉吗?MappingAce: 嗯
  • 开发者: 听起来还可以,那给我看看吧MappingAce: 好的,先给您做个简介,我是一个Swift JSON解析库,现在支持结构体与类的自动解析,在属性名字和字典里的key相同的时候,是不需要写字典key与属性的映射代码的,接下来给您演示如何使用

场景1 结构体映射


[开发者 问:] 假设有一个PhoneNumber结构体,有如下属性,该怎么做?

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

MappingAce: 只需要实现一下协议Mapping像这样:

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

然后即可使用Mapping里的方法,解析字典到对象了

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

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

场景2 结构体嵌套映射

[开发者 问:] 那如果是嵌套类型呢?MappingAce:一样的,嵌套的需要解析的结构体仅需要实现一下Mapping协议即可,假设上面的PhoneNumber是结构体User的子属性

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

使用方法和上面差不多

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

let user = User(fromDic: phoneInfo)

假设属性里有数组,数组的Element是需要解析的结构体,也只需要实现下协议Mapping,剩下的我都替你做好了

场景3 属性为Optional

MappingAce: 对于可空属性,我也是支持的

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

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

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

let user = User(fromDic: dic)
print(user.age)//nil
print(user.name)//Binglin
print(user.phone?.tel)//nil
print(user.phone?.type)//nil

场景4 枚举

MappingAce:对于枚举,目前我们支持Int和String类型对于Int 实现一下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)

String类型的话,也是实现一下协议EnumString,剩下的就可以交给我了

场景5 有默认值的结构体和类

MappingAce: 如果是结构体属性设置了默认值 或者是类(OC的或者Swift的类),是需要实现InitMapping而不是实现上面的Mapping协议的InitMapping里有一个方法需要实现一下

init()

对于结构体

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

对于类的话 情况会稍微复杂一点 会有一个required override init() {}

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)

场景5 Model -> JSON

MappingAce:这个也许是最容易的了,如果你实现了Mapping或者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"]

如果你没实现上面两个协议那么你只需要实现一下协议Serializable,就使用默认实现的方法了

struct `ABC`: `Serializable` {
    var tel: String
    var type: String
}

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

当然,如果想要正确获取嵌套类型的话,嵌套的类型还是建议实现一下协议Mapping, 不需要实现协议里的方法的啦

尾声

开发者: 嗯 看起来用MappingAce的话 开发上面还是挺有效率的,就是不知道性能和ObjectMapperUnbox相比怎么样MappingAce: 这个我也有测试以下面的结构体循环解析10000次为例子

struct User{
      var name: String
      var age:  Int
      var phoneNumber: PhoneNumber
}
struct PhoneNumber {
        var tel: String
        var type: String
}
[MappingAce]这可能是使用起来最简单的Swift JSON解析库了,从此可以告别手写key映射0
解析耗费时间 秒

MappingAce: MappingAce现已上传到github, 支持Carthage& CocoaPods,https://github.com/IcyButterfly/MappingAce欢迎拍砖