打造强大的BaseModel（2）：让Model实现自动映射，将字典转化成Model

打造强大的BaseModel（1）：让Model自我描述

这篇文章将讲述Model一项更高级也最常用的功能，让Model实现自动映射–将字典转化成Model(所有代码全由Swift实现)

将JSON转化为Model的意义

在iOS开发中，基于Model的数据流起到了至关重要的作用。从网络获取的数据需要进一步处理转到成View可用的Model,再通过ViewController传送给View展示出来,从View中反馈的数据也可以转为为Model,再将Model转化成JSON发送给服务器。通常开发过程中需要最频繁处理的还是将JOSN转化成对应的Model,目前市面上许多非常好用的JSON-Model库，比如MJ大神的MJExtension,还有Matle及JSONModel。

目前我还从未在项目里用到这些库，有兴趣的读者可以自行去试试这些开源库，也可以去看看它们的源码。这篇文章主要是讨论如何用简单的代码写一个基类Model，让子类可以自动实现从字典获取数据再转化为自身。功能并不算强大，但是还是比较实用的。

将字典转化为Model这个过程中，最简单便捷的情况就是字典的Key与Model的属性名是一一对应的，这样只要使用简单的KVC即可完成JOSN-Model转换。但是实际开发过程中很少出现这情况，也许你的命名风格和服务器开发的同事的命名风格不一样，也许同一个属性名在不同的接口有不一样的名字，总之很难达到这种理想的情况。我们最后还是要乖乖按服务器的同事给的Key名来转换。

先前我都是使用简单的Dict[Key]的取值方式来实现JOSN-Model转换，这种情况在Objc还是比较好用的，写起来很方便，但是在Swift里就完全行不通了，各种强制转换写起来很啰嗦很不爽。SwiftyJSON就是为了解决这种问题诞生的。用了SwiftyJSON看起来确实好了不少，但是还是要写很多重复的代码来转换，降低了开发效率。

使用KVC来实现字典-Model转换

所以最好还是让Model可以自动实现字典-Model映射。既然有这么强大的KVC可以用，那为什么不用呢？按照这个思路，我用Swift写下了以下代码,先定义一个协议，里面有一个静态方法，目的是将一个字典转化成一个Self对象

protocol MapAble{

static func mapModel(obj:AnyObject)->Self  //将一个字典转化成自己

}

需要在GrandModel里处理一些东西

//定义一个Model

class GrandModel:NSObject {

class var selfMapDescription:[String:String]?{

return nil

}

required override init() {

super.init()

}

在extension里面实现协议

extension GrandModel:MapAble{

static func mapModel(obj:AnyObject)->Self{

let model = self.init()

if let mapTable = self.selfMapDescription{

if let dict = obj as? [String:AnyObject]

{

for item in dict{

if let key = mapTable[item.0]{

print("key 为(item.0)将要被设成(mapTable[item.0),其值是 (item.1)")

model.setValue(item.1, forKey: key)

}

}

}

}

return model

}

}

代码层次比较深，看起来有点乱，但总体逻辑却很简单。selfMapDescription是一个Class静态属性，它描述了字典的Key是怎么和Model的属性名是怎么映射的。子类需要重写这个属性。

required override init()

这是一个构造器，并且标记为required，说明是必需的。作用是保证该类是可以初始化的，只有这样extension里的self.init()语句才不会报错。因为如果子类也不提供构造器的话，那么该类不能正常用构造器实例化，也就是不能用init()方法了。

let model = self.init()

let mapTable = self.selfMapDescription

这个就比较好解释了，在静态方法里面，self是一个Type类型，表示运行时的类型。它可以调用init()直接实例化一个运行时继承于GrandModel的类。接下来的代码就比较简单了，只要简单将字典里的Value用KVC一个一个给Model赋值就行了。赋值完成后再返回该对象

下面我们来看子类如何继承该类，并且怎么使用些功能

class DemoClass:GrandModel {

var name:String?

var age:Int?

var grade:Int?

//需要重写selfMapDescription

override static var selfMapDescription:[String:String]?{

return ["sName":"name","iAge":"age","iGrade":"grade"]

}

}

//下面来测试

let demoDict = ["sName":"Stan","iAge":"12","iGrade":"6"]

var demo = DemoClass()

demo = DemoClass.mapModel(demoDict)

print(demo)

//打印结果：

key 为sName将要被设成Optional("name"),其值是 Stan

key 为iGrade将要被设成Optional("grade"),其值是 6

没有这个字段-------grade

key 为iAge将要被设成Optional("age"),其值是 12

没有这个字段-------age

这里有奇怪的地方，明明DemoClass有两个Int类型的属性，但是又说找不到？其实在这里参考第一篇文章就很容易明白，这两个属性是Int?的类型的，而Objc里面是没有于之对应的类型的，可以在这个属性前面加上@objc试试

可以看见XCode报错了。Int？不能表现为Objc类型，所以在Objc运行时里面是找不到与之对应的类型，自然不能加上@Objc标记了。

那么怎么办？其实很简单，给它一个初始值就行了,在运行时可以将其转化成Objc的类型

class DemoClass:GrandModel {

var name:String?

var age:Int = 0

var grade:Int = 0

//后面的省略了

}

//下面打印的结果完全符合预期

key 为sName将要被设成Optional("name"),其值是 Stan

key 为iGrade将要被设成Optional("grade"),其值是 6

key 为iAge将要被设成Optional("age"),其值是 12

Optional(name)

DemoClass:["age": 12, "grade": 6, "name": Stan]

现在打印出的结果是完全符合我们的预期了。KVC的强大之处在这里表现得淋漓尽致，我们根本不需要理会这些基本数据类型，KVC可以帮我们搞定。

两个问题和解决方案

但是目前还有两个问题：一是如果接口有多种风格的属性名，比如这个接口将UserName，另一个叫做sUserName，又或者叫userName等，多种不同的属性名。至少我现在在做的项目至少有三种类型。其实这个非常简单，直接把所有属性的名字添加到selfMapDescription里面就行

//需要重写selfMapDescription

override static var selfMapDescription:[String:String]?{

return["sName":"name","iAge":"age","iGrade":"grade","UserName":"userName","sUserName":"userName","userName":"userName"]//将这个三属性名全部映射到userName

}

第二个问题，如果返回的数据里嵌套了复杂类型，比如Array，Dictionary或者是其他对象等，KVC就不能帮你自动转了

class DemoOther: GrandModel {

var userName:String?

override static var selfMapDescription:[String:String]?{

return [ "userName":"userName"]

}

}

class DemoClass:GrandModel {

var name:String?

var age:Int = 0

var grade:Int = 0

var userName:String?

var otherClass:DemoOther?

var otherClasses:[DemoOther]?

//需要重写selfMapDescription

override static var selfMapDescription:[String:String]?{

return ["sName":"name",

"iAge":"age",

"iGrade":"grade",

"UserName":"userName",

"sUserName":"userName",

"userName":"userName",

"DemoOther":"otherClass",

"DemoOthers":"otherClasses"]

}

}

//下面来测试

let demoDict = ["sName":"Stan","iAge":"12","iGrade":"6","UserName":"userName","DemoOther":["userName":"OtherUserName"],

"DemoOthers":[["userName":"OtherUserName1"],["userName":"OtherUserName2"]]

]

var demo = DemoClass()

demo = DemoClass.mapModel(demoDict)

print(demo.otherClass)

//打印出来是这东西，

//Optional({ userName = OtherUserName;})

打印出的数据虽然看起来好像是正确的，但是其实格式是错误的。也就是说，KVC不能转化复杂的或者自定义的对象。只能自己手动写了。

demo.otherClass = DemoOther.mapModel(demoDict["DemoOther"]!)

print(demo.otherClass)

//打印出来是这东西，

//**Optional(DemoOther:["userName": OtherUserName])**

这下打印出的东西就符合预期了，数组对象也一样，用个循环来转化即可。

总结

上面的轻量型字典-Model转换方案虽然在功能上不能和第三方的Json-Model库相比，但对于大部分项目来说，还是够用了。使用KVC带来的性能上的损失我还是可以接受的，我讨厌写重复的代码。好了，以上就是第二篇的全部内容。