Swift Mirror & Error

前言

上篇文章Swift 內(nèi)存管理 & Runtime講解了Runtime的一個應(yīng)用場景:Swift類可繼承NSObject,配合使用@objc修飾符,讓OC端的Runtime API可調(diào)用Swift類的方法與屬性,同時使用Dynamic修飾符,也可實(shí)現(xiàn)方法交換,只不過這個交換是在編譯期就確定的。

那么問題來了,既然Swift是一門靜態(tài)語言,那到底它有沒有類似OC這樣的Runtime運(yùn)行時機(jī)制呢?當(dāng)然有,就是本篇文章即將介紹的Mirror反射,雖然沒有OC的Runtime強(qiáng)大,但是也能在運(yùn)行時獲取對象的類型成員變量,其中第三方庫HandyJSON就是基于Mirror的機(jī)制來實(shí)現(xiàn)的。

一、Mirror反射

什么是反射??? 可以動態(tài)獲取類型成員信息,在運(yùn)行時可以調(diào)用方法、屬性等行為的特性。

老規(guī)矩,還是先上示例代碼??

class LGTeacher {
    var age: Int = 18
    var name: String = "Luoji"
}
let mirror = Mirror(reflecting: LGTeacher().self)
for pro in mirror.children{
    print("\(pro.label ?? ""): \(pro.value)")
}


上述代碼是Mirror的一個簡單的應(yīng)用場景 ?? 通過reflecting初始化,接著通過.children讀取屬性名與值。

1.1 Mirror定義

接下來我們看看Mirror相關(guān)文檔的API的定義??

  • init(reflecting: Any)

傳入的類型是Any

  • .children

    接著查看代碼??
    /// A collection of `Child` elements describing the structure of the
    /// reflected subject.
    public let children: Mirror.Children

繼續(xù)查看Children??

    /// The type used to represent substructure.
    ///
    /// When working with a mirror that reflects a bidirectional or random access
    /// collection, you may find it useful to "upgrade" instances of this type
    /// to `AnyBidirectionalCollection` or `AnyRandomAccessCollection`. For
    /// example, to display the last twenty children of a mirror if they can be
    /// accessed efficiently, you write the following code:
    ///
    ///     if let b = AnyBidirectionalCollection(someMirror.children) {
    ///         for element in b.suffix(20) {
    ///             print(element)
    ///         }
    ///     }
    public typealias Children = AnyCollection<Mirror.Child>

最后看Child??

    /// An element of the reflected instance's structure.
    ///
    /// When the `label` component in not `nil`, it may represent the name of a
    /// stored property or an active `enum` case. If you pass strings to the
    /// `descendant(_:_:)` method, labels are used for lookup.
    public typealias Child = (label: String?, value: Any)

所以,回到示例代碼,通過print("\(pro.label ?? ""): \(pro.value)")打印的就是keyvalue

1.2 JSON解析

既然Mirror可以解析出類的屬性keyvalue,那它能做什么? ?? 第一時間聯(lián)想到的就是JSON解析。還是先看以下解析的實(shí)例代碼??

class LGPerson {
    var name = "Luoji"
    var age = 18
    var student = LGStudent() // 持有對象
}

class LGStudent {
    var score = 100.0
}

func test(_ obj: Any) -> Any{
    
    let mirror = Mirror(reflecting: obj)
    // 遞歸終止條件
    guard !mirror.children.isEmpty else { return obj }
    var keyValue: [String: Any] = [:] // 記錄屬性名和屬性內(nèi)容
    for children in mirror.children{
        if let keyName = children.label {
            keyValue[keyName] = test(children.value)  // 遞歸(model嵌套的場景)
        }else{
            print("children.label ")
        }
    }
    return keyValue
}
    
let t = LGPerson()
print(test(t))

代碼不難,也是通過reflecting初始化mirror對象,然后讀取其children屬性值,存儲到keyValue字典并返回。其中做了判空,以及遞歸處理(處理屬性也是model的場景)。

優(yōu)化一

上述的代碼,是在一個swift命名空間中聲明的解析方法,我們想讓其通用化,基于封裝的思想,自然的想到,將其抽離成一個協(xié)議,這樣讓每個model遵循該協(xié)議,那么model就具備了JSON解析的功能。廢話不多說,直接上代碼??

//1、定義一個JSON解析協(xié)議
protocol LGJSONMap {
    func jsonMap() -> Any
}
//2、在extension中實(shí)現(xiàn)jsonMap()解析方法
extension LGJSONMap {
    func jsonMap() -> Any{
        let mirror = Mirror(reflecting: self)
        //遞歸終止條件
        guard !mirror.children.isEmpty else {
            return self
        }
        //字典,用于存儲json數(shù)據(jù)
        var keyValue: [String: Any] = [:]
        //遍歷
        for children in mirror.children {
            if let value = children.value as? LGJSONMap {
                if let keyName = children.label {
                    //遞歸
                    keyValue[keyName] = value.jsonMap()
                }else{
                    print("key是nil")
                }
            }else{
                print("當(dāng)前-\(children.value)-沒有遵守協(xié)議")
            }
        }
        return keyValue
    }
}

//3、讓類遵守協(xié)議(注意:類中屬性的類型也需要遵守協(xié)議,否則無法解析)
class LGPerson : LGJSONMap {
    var name = "Luoji"
    var age = 18
    var student = LGStudent() // 持有對象
}

class LGStudent : LGJSONMap {
    var score = 100.0
}

//調(diào)用
var t = LGPerson()
print(t.jsonMap())

運(yùn)行??

上圖可知,沒有成功,提示屬性并沒有遵循協(xié)議,那么根據(jù)錯誤提示,我們修改代碼??

extension Int: LGJSONMap{}
extension String: LGJSONMap{}
extension Double: LGJSONMap{}

完美解決!這里將解析方法抽離成協(xié)議的方法,是一種封裝的思想。既然提到協(xié)議,那么我們再順便講解下Swift中的Protocol協(xié)議的用法吧。

Protocol

Swift的協(xié)議OC的協(xié)議功能多多了,非常強(qiáng)大,不僅可以聲明屬性、函數(shù),支持可選實(shí)現(xiàn),還可以在extension中完成屬性函數(shù)默認(rèn)實(shí)現(xiàn)(上述JSON解析就是這樣的場景)。

所以,以后大家在開發(fā)過程中,如果碰到了類似的這樣的場景,也可以封裝成協(xié)議的方法,很好的隔離代碼,而且讓代碼看起來非常簡潔。??

遇到一些通用功能的函數(shù),我們可以使用協(xié)議封裝起來,只要遵循這個協(xié)議,就可以直接調(diào)用相應(yīng)的屬性和函數(shù)

優(yōu)化二

上述解析方法中,對于錯誤的處理方式,只是簡單的print一下,那有沒有一種更好的方式,將這些錯誤封裝成一個對象,并拋出來給調(diào)用方,讓調(diào)用方自行處理呢?當(dāng)然有??

可以通過系統(tǒng)Error協(xié)議搭配throw關(guān)鍵字,優(yōu)雅的拋出錯誤或返回常規(guī)結(jié)果,讓開發(fā)者自己選擇處理方式。

二、Error處理

在Swift中,系統(tǒng)提供Error協(xié)議來表示當(dāng)前應(yīng)用程序發(fā)生錯誤的情況,并支持使用throw關(guān)鍵字,優(yōu)雅的拋出錯誤。

2.1 Error協(xié)議

public protocol Error {
}

上面源碼可知 ?? Error是一個協(xié)議,其中沒有任何實(shí)現(xiàn),這也就意味著你可以遵守該協(xié)議,然后自定義錯誤類型。所以不管是StructClassenum,我們都可以遵循這個Error協(xié)議來表示一個錯誤。我們就先用枚舉enum來標(biāo)識錯誤(枚舉的功能也十分強(qiáng)大,后續(xù)會有專門的一篇文章來講解)。

  1. 先定義錯誤類型
enum LGJSONMapError: Error{
    case emptyKey
    case notConformProtocol
}
  1. 然后調(diào)用
extension LGJSONMap{
    func jsonMap() -> Any{
        let mirror = Mirror(reflecting: self)
        //遞歸終止條件
        guard !mirror.children.isEmpty else {
            return self
        }
        //字典,用于存儲json數(shù)據(jù)
        var keyValue: [String: Any] = [:]
        //遍歷
        for children in mirror.children {
            if let value = children.value as? LGJSONMap {
                if let keyName = children.label {
                    //遞歸
                    keyValue[keyName] = value.jsonMap()
                }else{
                    return LGJSONMapError.emptyKey
                }
            }else{
                return LGJSONMapError.notConformProtocol
            }
        }
        return keyValue
    }
}

但是有個問題,現(xiàn)在return的數(shù)據(jù),無法區(qū)分是正常的dic還是錯誤枚舉,如何處理呢??? 可以利用throw關(guān)鍵字拋出錯誤??

extension LGJSONMap{
    func jsonMap() -> Any{
        let mirror = Mirror(reflecting: self)
        //遞歸終止條件
        guard !mirror.children.isEmpty else {
            return self
        }
        //字典,用于存儲json數(shù)據(jù)
        var keyValue: [String: Any] = [:]
        //遍歷
        for children in mirror.children {
            if let value = children.value as? LGJSONMap {
                if let keyName = children.label {
                    //遞歸
                    keyValue[keyName] = value.jsonMap()
                }else{
                    throw LGJSONMapError.emptyKey
                }
            }else{
                throw LGJSONMapError.notConformProtocol
            }
        }
        return keyValue
    }
}

return改成throw后,編譯器會報(bào)錯??

根據(jù)錯誤的提示信息,是因?yàn)槲覀兟暶鞯暮瘮?shù)沒有聲明throw,那么我們修改函數(shù)聲明??

protocol LGJSONMap {
    func jsonMap() throws ->  Any
}

仍舊會報(bào)錯,用了throw沒有用try,那么補(bǔ)齊??

我們把屬性遵循協(xié)議的注釋掉,運(yùn)行看看是否會拋出錯誤??

果然拋出了LGJSONMapError.notConformProtocol錯誤。

Error處理的方式

Swift中錯誤處理的方式主要有以下兩種:

  1. 使用try - throw
    最簡便的,即甩鍋,將這個拋出給別人(向上拋出,拋給上層調(diào)用方函數(shù))。
    但是需要注意以下兩點(diǎn):
    • try? ?? 返回一個可選類型,只有兩種結(jié)果:要么成功,返回具體的;要么錯誤,但并不關(guān)心是哪種錯誤,統(tǒng)一返回nil
print(try? t.jsonMap())
  • try! ?? 表示你對這段代碼有絕對的自信,這行代碼絕對不會發(fā)生錯誤
print(try! t.jsonMap())

從上面可以知道,錯誤是向上拋出的,即拋給了調(diào)用函數(shù),如果調(diào)用的上層函數(shù)也不處理,則直接拋給mainmain沒有辦法處理,則直接報(bào)錯

  1. 使用do - catch
    其中do處理正確結(jié)果catch處理error,catch有個隱藏參數(shù),就是error(Error類型)
do {
    // 處理正常結(jié)果
    try t.jsonMap()   // 這里try不會報(bào)錯了,因?yàn)殄e誤都分給了catch
} catch {
    // 處理錯誤類型(其中error為Error類型)
    print(error)
}
LocalizedError

上述的錯誤處理中,只知道了錯誤類型,如果還想知道錯誤相關(guān)的描述其它信息,則需要使用LocalizedError,定義??

/// Describes an error that provides localized messages describing why
/// an error occurred and provides more information about the error.
public protocol LocalizedError : Error {

    /// A localized message describing what error occurred.
    var errorDescription: String? { get }

    /// A localized message describing the reason for the failure.
    var failureReason: String? { get }

    /// A localized message describing how one might recover from the failure.
    var recoverySuggestion: String? { get }

    /// A localized message providing "help" text if the user requests help.
    var helpAnchor: String? { get }
}

接下來,我們來使用一下這個協(xié)議,修改上面的解析代碼??

//定義錯誤類型
enum LGJSONMapError: Error{
    case emptyKey
    case notConformProtocol
}

extension LGJSONMapError : LocalizedError {
    var errorDescription: String?{
            switch self {
            case .emptyKey:
                return "key為空"
            case .notConformProtocol:
                return "沒有遵守協(xié)議"
            }
        }
}

//調(diào)用
var t = LGPerson()
do {
    // 處理正常結(jié)果
    try t.jsonMap()   // 這里try不會報(bào)錯了,因?yàn)殄e誤都分給了catch
} catch {
    // 處理錯誤類型(其中error為Error類型)
    print(error.localizedDescription)
}

完美,錯誤描述被打印了出來!

CustomNSError協(xié)議

還有一個CustomNSError協(xié)議,相當(dāng)于OC中的NSError,其定義如下,有三個默認(rèn)屬性??

/// Describes an error type that specifically provides a domain, code,
/// and user-info dictionary.
public protocol CustomNSError : Error {

    /// The domain of the error.
    static var errorDomain: String { get }

    /// The error code within the given domain.
    var errorCode: Int { get }

    /// The user-info dictionary.
    var errorUserInfo: [String : Any] { get }
}

接著我們繼續(xù)修改JSON解析中的LGJSONMapError,讓其遵守CustomNSError協(xié)議??

extension LGJSONMapError: CustomNSError{
    var errorCode: Int{
        switch self {
        case .emptyKey:
            return 404
        case .notConformProtocol:
            return 504
        }
    }
}

//調(diào)用
var t = LGPerson()
do {
    // 處理正常結(jié)果
    try t.jsonMap()   // 這里try不會報(bào)錯了,因?yàn)殄e誤都分給了catch
} catch {
    // 處理錯誤類型(其中error為Error類型)
//    print(error.localizedDescription)
    print((error as? LGJSONMapError)?.errorCode)
}
rethorws

rethrows是處理這種場景的錯誤 ?? 函數(shù)1函數(shù)2入?yún)?/code>,其中函數(shù)1中有throws錯誤
上代碼

func add(_ a: Int, _ b: Int) throws -> Int {
    return a + b
}

func exec(_ f:(Int, Int) throws -> Int, _ a: Int, _ b: Int) rethrows {
    print(try f(a, b) )
}

do {
    try exec(add, 1, 2)
}catch {
    print(error.localizedDescription)
}

rethrows將函數(shù)參數(shù)add的錯誤再次拋出,統(tǒng)一交由外部do - catch處理。

defer(延后處理)
func functionDefer()  {
    print("begin")
    defer {
        print("defer")
    }
    print("end")
}

函數(shù)執(zhí)行完成之前才會執(zhí)行defer代碼塊內(nèi)部的邏輯。如果有多個defer代碼塊,執(zhí)行順序怎么樣?

func functionDefer()  {
    print("begin")
    defer {
        print("defer1")
    }
    defer {
        print("defer2")
    }
    print("end")
}

defer代碼塊的執(zhí)行順序是逆序的。

assert(斷言)

很多編程語言都有斷言機(jī)制不符合指定條件拋出運(yùn)行時錯誤,常用于調(diào)試(Debug)階段條件判斷。例如??

func devide(_ a: Int, _ b: Int) -> Int {
    assert(b != 0, "除數(shù)不能為0")
    return a / b
}

默認(rèn)情況下,Swift斷言只會在debug模式下生效,release模式下忽略??


總結(jié)

本篇文章主要利用Swift類中的Mirror反射機(jī)制,封裝了一套JSON解析協(xié)議,同時將解析時錯誤也進(jìn)行了封裝處理,順便講解了Error的幾個常用的協(xié)議。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,702評論 6 531
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 98,143評論 3 415
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,553評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經(jīng)常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,620評論 1 307
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 71,416評論 6 405
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 54,940評論 1 321
  • 那天,我揣著相機(jī)與錄音,去河邊找鬼。 笑死,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,024評論 3 440
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 42,170評論 0 287
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 48,709評論 1 333
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 40,597評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 42,784評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,291評論 5 357
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 44,029評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,407評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,663評論 1 280
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,403評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 47,746評論 2 370

推薦閱讀更多精彩內(nèi)容