遇到的問(wèn)題
- 上線(xiàn)了兩年的項(xiàng)目，沒(méi)有一丁點(diǎn)測(cè)試代碼妈倔，突然說(shuō)要開(kāi)始補(bǔ)單元測(cè)試
- 上百個(gè)Model，有
struct绸贡，有class盯蝴，全都沒(méi)有遵循Equatable協(xié)議...要比較兩個(gè)Model是否相同，需要逐條比較Model的property（屬性）
想做的事情
能否以最小的成本讓上百個(gè)Model在測(cè)試中可以自動(dòng)比較
使用Mirror獲取property list
動(dòng)態(tài)地獲取property list
Objective-C強(qiáng)大的運(yùn)行時(shí)系統(tǒng)使得開(kāi)發(fā)者可以在運(yùn)行時(shí)獲取class的property list听怕。
https://stackoverflow.com/questions/754824/get-an-object-properties-list-in-objective-c
因此碰到這個(gè)問(wèn)題時(shí)捧挺，我首先想的是，是否Swift也可以用類(lèi)似class_copyPropertyList這樣的API獲取對(duì)象的property list尿瞭。
但是發(fā)現(xiàn)想多了...Swift是一門(mén)靜態(tài)語(yǔ)言闽烙，在Swift官方主頁(yè)的介紹中就強(qiáng)調(diào)了
Swift code is safe by design
這樣的表述。在運(yùn)行時(shí)動(dòng)態(tài)地獲取和篡改對(duì)象的property顯然不是Swift所推崇的。
不過(guò)Swift還是很體貼地提供了一個(gè)工具：Mirror嘿棘，來(lái)滿(mǎn)足開(kāi)發(fā)者的一些運(yùn)行時(shí)需求诬烹。
Mirror的定義
A mirror describes the parts that make up a particular instance, such as the instance’s stored properties, collection or tuple elements, or its active enumeration case. Mirrors also provide a “display style” property that suggests how this mirror might be rendered.
Mirror描述了一個(gè)特定實(shí)例的結(jié)構(gòu)汞扎，
- 實(shí)例為class或struct侈沪，則描述該實(shí)例的儲(chǔ)存屬性 (stored properties)
- 實(shí)例為collection或tuple (元組) 仇祭，則描述其elements (元素)
- 實(shí)例為enumeration醋奠，則描述其當(dāng)前case
Playgrounds and the debugger use the Mirror type to display representations of values of any type. For example, when you pass an instance to the dump(::::) function, a mirror is used to render that instance’s runtime contents.
關(guān)于Mirror的用途贱纠，官方文檔提到Mirror主要是在Playgrounds或debug時(shí)使用莫换，Swift的調(diào)試用函數(shù)dump(_:name:indent:maxDepth:maxItems:)即是使用Mirror來(lái)反射實(shí)例霞玄。
https://developer.apple.com/documentation/swift/1539127-dump
雖然沒(méi)有明確禁止在生產(chǎn)環(huán)境中使用Mirror，但是Mirror強(qiáng)大的運(yùn)行時(shí)特性注定了它不是一個(gè)高效的選擇（參考自喵神這篇文章https://onevcat.com/2018/03/swift-meta/）拉岁。
嘛坷剧，單元測(cè)試?yán)锬脕?lái)用一下應(yīng)該問(wèn)題不大吧哈哈哈哈h...
Mirror的基礎(chǔ)用法
光說(shuō)不練假把式，我們來(lái)實(shí)際使用Mirror試試喊暖。
Mirror的使用方法非常簡(jiǎn)單惫企，使用Mirror的init(reflecting:)初始化方法，傳入想要反射的對(duì)象陵叽，就能生成反射對(duì)象的Mirror實(shí)例狞尔。
class AClass {
let storedProperty: String
var computedProperty: String {
return "hi"
}
init(title: String) {
storedProperty = title
}
}
let aObject = AClass(title: "a")
let aObjectMirror = Mirror(reflecting: aObject)
調(diào)用Mirror實(shí)例的children屬性可以得到一個(gè)Mirror.Child的collection，而Mirror.Child則是一個(gè)包含label和value兩個(gè)元素的元組巩掺。
label在反射對(duì)象為class或struct時(shí)為對(duì)象的屬性名偏序，value則是屬性值
注意此處label為Optional，在反射對(duì)象為collection(array, set, dictionary)時(shí)胖替，label為nil研儒，value為collection的元素，下文會(huì)再次提及独令。
typealias Mirror.Children = AnyCollection<Mirror.Child>
typealias Mirror.Child = (label: String?, value: Any)
遍歷aObjectMirror的children并打印端朵，可以看到AClass的儲(chǔ)存屬性都被反射，而計(jì)算屬性沒(méi)有被反射燃箭。
aObjectMirror.children.forEach { print($0) }
/* output:
(label: Optional("storedPropertyStr"), value: "a")
(label: Optional("storedPropertyInt"), value: 1)
*/
使用Mirror反射class實(shí)例的基本用法如上所示冲呢，按官方文檔的說(shuō)法，Mirror還可以作用于collection, tuple, enumeration招狸。那具體反射后得到的Mirror是什么樣的碗硬，我們一個(gè)個(gè)把玩下
https://github.com/itsuhi-shu/PropertyEquatable/blob/master/MirrorPlayground.playground/Contents.swift
因篇幅限制，挑一些比較在意的內(nèi)容總結(jié)：
- class, struct的計(jì)算屬性不會(huì)被反射
- collection(array, set, dictionary)反射后其child的
label為nil
-) array, set的value為其各個(gè)元素
-) dictionary的value為其單個(gè)鍵值對(duì)構(gòu)成的元組(key: Hashable, value: Any)
let aDictionary = ["key1": "a", "key2": "b", "key3": "c"]
let aDictionaryMirror = Mirror(reflecting: aDictionary)
print(aDictionaryMirror.displayStyle!) // dictionary
aDictionaryMirror.children.forEach { print($0) }
/*
(label: nil, value: (key: "key2", value: "b"))
(label: nil, value: (key: "key1", value: "a"))
(label: nil, value: (key: "key3", value: "c"))
*/
- tuple的label若有定義標(biāo)簽名則為標(biāo)簽名瓢颅，若沒(méi)有則為
.n（n為該元素的序列）
let aTuple = ("a", labeled: 2, 9)
let aTupleMirror = Mirror(reflecting: aTuple)
print(aTupleMirror.displayStyle!) // tuple
aTupleMirror.children.forEach { print($0) }
/*
(label: Optional(".0"), value: "a")
(label: Optional("labeled"), value: 2)
(label: Optional(".2"), value: 9)
*/
- enum只能反射associated中儲(chǔ)存的屬性
enum AEnum {
case first
case seconde
}
enum AEnumWithAssociatedValues {
case first
case second(with: String)
case third(title: String, Value: Int, complete: (() -> Void)?)
}
let aEnum = AEnum.seconde
let aEnumMirror = Mirror(reflecting: aEnum)
print(aEnumMirror.displayStyle!) // enum
aEnumMirror.children.forEach { print($0) }
/*
*/
print(aEnumMirror.children.count) // 0
let aEnumWithAssociatedValues = AEnumWithAssociatedValues.third(title: "a",
Value: 1,
complete: nil)
let aEnumWithAssociatedValuesMirror = Mirror(reflecting: aEnumWithAssociatedValues)
print(aEnumWithAssociatedValuesMirror.displayStyle!) // enum
aEnumWithAssociatedValuesMirror.children.forEach { print($0) }
/*
(label: Optional("third"), value: (title: "a", Value: 1, complete: nil))
*/
利用Mirror反射來(lái)自動(dòng)比較Model
了解了Mirror的基本用法恩尾，現(xiàn)在該思考如何將Mirror運(yùn)用在開(kāi)發(fā)中。
在上面提到挽懦，筆者想要寫(xiě)最少的代碼來(lái)實(shí)現(xiàn)Model的比較翰意，在有了Mirror之后，接下來(lái)很自然而言地就想到要定義一個(gè)protocol（協(xié)議），通過(guò)protocol的extension（擴(kuò)展協(xié)議）來(lái)為Model添加一個(gè)比較方法冀偶。
一開(kāi)始曾試過(guò)用protocol extension來(lái)讓Model遵循Equatable協(xié)議醒第，并添加對(duì)==的實(shí)現(xiàn)。但后來(lái)突然發(fā)現(xiàn)NSObject都遵循了Equatable協(xié)議进鸠，且其==實(shí)現(xiàn)為單純的地址比較（一部分子類(lèi)override了）稠曼。而protocol extension不能override類(lèi)已實(shí)現(xiàn)的方法。所以只能另外提供一個(gè)比較函數(shù)客年。
最終的實(shí)現(xiàn)如下：
protocol PropertyEquatable {}
extension PropertyEquatable {
// Do not use `==` because extension can NOT override methods,
// and most NSObjects conforms to `Equatable` by implementing `==` simply compare their addresses.
static func ~= (lhs: Self, rhs: Self) -> Bool {
func _recursiveCompareElements(lhs: Any, rhs: Any) -> Bool {
guard type(of: lhs) == type(of: rhs) else { return false }
let lMir = Mirror(reflecting: lhs)
let rMir = Mirror(reflecting: rhs)
return lMir.children.elementsEqual(rMir.children) { (lElm, rElm) -> Bool in
guard let lKey = lElm.label,
let rKey = rElm.label,
lKey == rKey else {
return false
}
// MARK: Collection
// Arrays, Sets, Dictionaries are all Hashable, and can easily fall down to AnyHashable.
// But if the Elements are MirrorEquatable, we need to compare the Elements using our methods.
// Arrays
if let lArr = lElm.value as? Array<PropertyEquatable>,
let rArr = rElm.value as? Array<PropertyEquatable> {
return lArr.elementsEqual(rArr) { _recursiveCompareElements(lhs: $0, rhs: $1) }
}
// Sets Elements must be Hashable, we don't need to consider about this case.
// Dictionaries
if let lDic = lElm.value as? [AnyHashable: PropertyEquatable],
let rDic = rElm.value as? [AnyHashable: PropertyEquatable] {
guard lDic.count == rDic.count else { return false }
for key in lDic.keys {
guard let lVal = lDic[key], let rVal = rDic[key] else { return false }
if !_recursiveCompareElements(lhs: lVal, rhs: rVal) {
return false
}
}
return true
}
// MARK: AnyHashable
if let lVal = lElm.value as? AnyHashable,
let rVal = rElm.value as? AnyHashable {
return lVal == rVal
}
// MARK: Classes, Structs and others that do not match the conditions above
return _recursiveCompareElements(lhs: lElm.value, rhs: rElm.value)
}
}
return _recursiveCompareElements(lhs: lhs, rhs: rhs)
}
}
主要想法如下：
- 定義一個(gè)協(xié)議霞幅，并擴(kuò)展該協(xié)議實(shí)現(xiàn)對(duì)比方法。
- 若該類(lèi)的屬性的類(lèi)也遵循該協(xié)議量瓜，則遞歸地往下挖掘并對(duì)比司恳。
- 直到挖到屬性不遵循該協(xié)議且為Hashable之后，調(diào)用
==方法比對(duì)屬性绍傲。 - 考慮屬性為collection的情況扔傅。
