在實(shí)際項(xiàng)目開(kāi)發(fā)過(guò)程中，很多時(shí)候移動(dòng)終端設(shè)備都要與服務(wù)器進(jìn)行數(shù)據(jù)交互。兩者之間的數(shù)據(jù)格式通常為 JSON 和 XML。而 JSON 數(shù)據(jù)格式因其簡(jiǎn)單、易操作、高效率的特點(diǎn)而被廣大開(kāi)發(fā)者所使用。
在項(xiàng)目開(kāi)發(fā)中，根據(jù)不同的業(yè)務(wù)我們需要?jiǎng)?chuàng)建不同 Model。在成功接收到從服務(wù)器返回過(guò)來(lái)的數(shù)據(jù)后，我們可以將 JSON 數(shù)據(jù)當(dāng)作一個(gè)個(gè)的鍵值對(duì)然后進(jìn)行解析，雖然這也算是一種解決方式，但一定程度上加大開(kāi)發(fā)者的工作量。為了能夠快速解析數(shù)據(jù)并更新到應(yīng)用界面上，我們更希望能將 JSON 數(shù)據(jù)快速的解析成一個(gè) Object。于是乎就有了 ObjectMappper 這個(gè)第三方開(kāi)源庫(kù)。
ObjectMapper 是一個(gè)基于 Swift 語(yǔ)言開(kāi)發(fā)的能夠讓 JSON 與 Object 之間輕易轉(zhuǎn)換的類庫(kù)。通過(guò) ObjectMapper 我們可以將 JSON 數(shù)據(jù)轉(zhuǎn)換成 Model 對(duì)象或?qū)?Model 對(duì)象轉(zhuǎn)換成 JSON 數(shù)據(jù)。
ObjectMapper 有如下幾大特點(diǎn)：
- Mapping JSON to Object（JSON 映射成對(duì)象）
- Mapping Object to JSON（對(duì)象轉(zhuǎn)換成 JSON）
- Nested Object（支持內(nèi)嵌對(duì)象功能，包括數(shù)據(jù)和字典），這個(gè)功能確實(shí)很贊??
- Support Struct（也對(duì)結(jié)構(gòu)體做了支持）
一、基本操作
ObjectMapper 類庫(kù)有一個(gè) Mappable 協(xié)議，我們的 Model 實(shí)體類只有實(shí)現(xiàn)了這個(gè) Protocol 能實(shí)現(xiàn)真正的映射解析功能。
public protocol Mappable {
init?(_ map: Map)
mutating func mapping(map: Map)
}
同時(shí)使用 "<-" 操作符來(lái)實(shí)現(xiàn) JSON 字段與 Object 對(duì)象中屬性之間的映射關(guān)系。以下為官方事例：
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: NSDate?
required init?(_ map: Map) {
}
// Mappable
func mapping(map: Map) {
username <- map["username"]
age <- map["age"]
weight <- map["weight"]
array <- map["arr"]
dictionary <- map["dict"]
bestFriend <- map["best_friend"]
friends <- map["friends"]
birthday <- (map["birthday"], DateTransform())
}
}
struct Temperature: Mappable {
var celsius: Double?
var fahrenheit: Double?
init?(_ map: Map) {
}
mutating func mapping(map: Map) {
celsius <- map["celsius"]
fahrenheit <- map["fahrenheit"]
}
}
這里順便補(bǔ)充一下：Swift 語(yǔ)言中，在 Struct 中定義的方法默認(rèn)情況下對(duì)其屬性只有讀取權(quán)限，沒(méi)有修改權(quán)限。因此，為了實(shí)現(xiàn)在 Struct 中的方法實(shí)體里也能像 Class 的方法實(shí)體里讀寫成員屬性，需要在方法定義前面添加一個(gè) mutating 關(guān)鍵字，表示這個(gè)方法也能修改 Struct 定義的屬性。（注：class 的方法實(shí)體中默認(rèn)就能對(duì)屬性進(jìn)行讀寫操作）
一旦你完成上面操作，我們就可以通過(guò)這個(gè) Mappable 類來(lái)實(shí)現(xiàn)很多功能，如：
- JSON 映射成對(duì)象： let temperature = Mapper<Temperature>().map(jsonString)
- 對(duì)象轉(zhuǎn)換成 json 字符串：let json = Mapper().toJSONString(temperature, prettyPrint: true)
其中 prettyPrint 字段表示是否以一種優(yōu)雅的方式輸出，當(dāng) prettyPrint = true 時(shí)在控制臺(tái)輸出的格式為：
{
"age" : 12,
"name" : "zhangsan"
}
當(dāng) prettyPrint = false 時(shí)在控制臺(tái)的輸出格式為：
{"age":12,"name":"zhangsan"}
相當(dāng)于 prettyPrint 字段會(huì)在每個(gè)鍵值對(duì)的基礎(chǔ)上插入換行符"\n"。
ObjectMapper 支持映射的類的屬性的類型有：
- Int
- Bool
- Double
- Float
- String
- Array<AnyObject>
- Dictionary<String, Object>
- RawRepresentable (Enums)
- Object<T: Mappable>
- Array<T: Mappable>
- Set<T: Mappable>
- Dictionary<String, T: Mappable>
- Dictionary<String, Array<T: Mappable>>
- Optionals of all above（以上類型的可選值）
- Implictily unwrapped Optionals all above（以上類型的隱私解析可選值）
二、嵌套對(duì)象的映射
在鍵Key字段里可以通過(guò)圓點(diǎn)"."來(lái)實(shí)現(xiàn)嵌套對(duì)象的映射，下面為嵌套對(duì)象的 JSON 數(shù)據(jù)
{
"distance" : {
"text" : "102 ft",
"value" : 31
}
}
通過(guò)如下方式直接取出 distance 對(duì)象中 value 的值，也可以理解為級(jí)聯(lián)取值或是嵌套鍵Key:
func mapping(map: Map) {
distance <- map["distance.value"]
}
注意： Error Domain=NSCocoaErrorDomain Code=3840 "Garbage at end." UserInfo={NSDebugDescription=Garbage at end.} distanceValue: nil
出錯(cuò)的原因是你所提供待解析的不是一個(gè)完整 JSON 格式的數(shù)據(jù)，比如：
"distance" : {
"text" : "102 ft",
"value" : 31
}
只要將上述內(nèi)容通過(guò)一個(gè)大括號(hào)括起來(lái)那就是一個(gè)完整JSON格式的數(shù)據(jù)了。
針對(duì)下面的 JSON 字符串呢, distance 里包含的是一個(gè)對(duì)象數(shù)組 Array：
{
"distance" : {
[
"text" : "102 ft",
"value" : 31
],
[
"text" : "102 ft",
"value" : 31
],
[
"text" : "102 ft",
"value" : 31
]
}
}
其實(shí)，ObjectMapper 也對(duì)對(duì)象數(shù)組做了很好的支持：
func mapping(map: Map) {
distance <- map["distance.0.value"]
}
通過(guò)在 distance 后面添加數(shù)字充當(dāng)數(shù)組的游標(biāo)就可以訪問(wèn)數(shù)組中指定位置的數(shù)據(jù)了。是不是很方便??
當(dāng)然，如果 JSON 字符串中的鍵 Key 本身就帶有圓點(diǎn)"."的，如：
{
"name.length": 10
}
這種情況如果再直接使用上面的解析方式就會(huì)出錯(cuò)，真正的解決方案為：
func mapping(map: Map) {
identifier <- map["app.identifier", nested: false]
}
其中nested字段表示不進(jìn)行嵌套解析。
三、自定義轉(zhuǎn)換規(guī)則
ObjectMapper 允許開(kāi)發(fā)者在數(shù)據(jù)映射過(guò)程中指定轉(zhuǎn)換規(guī)則。常見(jiàn)的操作就是將一個(gè) Long 類型的日期轉(zhuǎn)換成 NSDate 類型的。
class People: Mappable {
var birthday: NSDate?
required init?(_ map: Map) {
}
func mapping(map Map) {
birthday <- (map["birthday"], DateTransform())
}
}
let JSON = "\"birthday\":1458117795332"
let result = Mapper<People>().map(JSON)
上面的操作在解析 JSON 數(shù)據(jù)的時(shí)候會(huì)將 Long 解析成一個(gè) NSDate，同時(shí)在轉(zhuǎn)換成 JSON 數(shù)據(jù)的時(shí)候會(huì)將 NSDate 類型轉(zhuǎn)換成 Long 類型。
當(dāng)然，我們也可以很方便的通過(guò)實(shí)現(xiàn) TransformType 協(xié)議來(lái)自定義我們的轉(zhuǎn)換規(guī)則。
public protocol TransformType {
typealias Object
typealias JSON
func transformFromJSON(value: AnyObject?) -> Object?
func transformToJSON(value: Object?) -> JSON?
}
大多數(shù)情況下我們使用類庫(kù)自帶的 TransformOf 類就能實(shí)現(xiàn)我們想要的轉(zhuǎn)換結(jié)果，TransformOf 實(shí)際就是實(shí)現(xiàn)了 TransformType 協(xié)議的。TransformOf 有兩個(gè)類型的參數(shù)和兩個(gè)閉包參數(shù)，類型表示參與轉(zhuǎn)換的數(shù)據(jù)的類型，閉包表示轉(zhuǎn)換規(guī)則。
let transform = TransformOf<Int, String>(fromJSON: { (value: String?) -> Int? in
// transform value from String? to Int?
return Int(value!)
}, toJSON: { (value: Int?) -> String? in
// transform value from Int? to String?
if let value = value {
return String(value)
}
return nil
})
id <- (map["id"], transform)
我們也可以對(duì)上面代碼做進(jìn)一步優(yōu)化：
id <- (map["id"], TransformOf<Int, String>(fromJSON: { Int($0!) }, toJSON: { $0.map { String($0) } }))
其中，TransformOf 的第一個(gè)數(shù)據(jù)為最終解析后的類型，第二個(gè)參數(shù)為 JSON 數(shù)據(jù)原始的類型，后面指定的是解析規(guī)則和轉(zhuǎn)換規(guī)則。上面代碼的意思是將 json 數(shù)據(jù)中鍵為 "id" 的值從 String 類型轉(zhuǎn)換為 Int 類型。這里需要注意一下，如果 "id" 鍵對(duì)應(yīng)的值不是 String 類型則會(huì)運(yùn)行錯(cuò)誤。
四、類的繼承
當(dāng)父類實(shí)現(xiàn)了 Mappable 協(xié)議，子類在繼承父類后需要重寫 Mappable 協(xié)議的兩個(gè)方法。同時(shí)請(qǐng)確保在重寫這兩個(gè)方法時(shí)調(diào)用了父類對(duì)應(yīng)的方法。
class Base: Mappable {
var base: String?
required init?(_ map: Map) {
}
func mapping(map: Map) {
base <- map["base"]
}
}
class Subclass: Base {
var sub: String?
required init?(_ map: Map) {
super.init(map)
}
override func mapping(map: Map) {
super.mapping(map)
sub <- map["sub"]
}
}
let JSON = "{\"base\":\"base\", \"sub\":\"sub\"}"
let result = Mapper<SubClass>().map(JSON)
五、泛型對(duì)象
ObjectMappper 同樣可以處理泛型類型的參數(shù)。不過(guò)這個(gè)泛型類型需要在實(shí)現(xiàn)了 Mappable 協(xié)議的基礎(chǔ)上才可以正常使用。
class User: Mappable {
var name: String?
required init?(_ map; Map) {
}
func mappping(_ map: Map) {
name <- map["name"]
}
}
class Result<T: Mappable>: Mappable {
var result: T?
required init?(_ map: Map){
}
func mapping(map: Map) {
result <- map["result"]
}
}
let JSON = "{\"result\": {\"name\": \"anenn\"}}"
let result = Mapper<Result<User>>().map(JSON)
如果你現(xiàn)在正在使用 Alamofire 這個(gè)第三方網(wǎng)絡(luò)請(qǐng)求工具包的話，其實(shí)我們還可選擇 ObjectMappper 的衍生產(chǎn)品 AlamofireObjectmapper 來(lái)實(shí)現(xiàn) JSON 與 Object 的關(guān)系映射。
同理，ObjectMapper 也支持 Realm ORM 框架的并同使用。具體可參照官方文檔
好吧，關(guān)于 ObjectMapper 使用就介紹到這，若在使用過(guò)程有什么問(wèn)題，可以一起交流學(xué)習(xí)。
