Swift Mirror & Error

Swift靜態語言,他不能像OC一樣,直接獲取對象的屬性和方法,但是Swift標準庫依舊提供了反射機制,用來訪問成員信息,即Mirror

一、Mirror反射

反射:是指可以動態獲取類型、成員信息,在運行時可以調用方法、屬性等行為的特性。
使用Mirror的初始化方法reflecting,接著通過.children讀取屬性名與值。代碼:

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

//打印結果:
//age: 18
//name: Cat
1.1 Mirror源碼

進入Mirror初始化方法,發現傳入的類型是Any,則可以直接傳t

// Creates a mirror that reflects on the given instance.
// - Parameter subject: The instance for which to create a mirror.
public init(reflecting subject: Any)

查看children

/// A collection of `Child` elements describing the structure of the reflected subject.
public let children: Mirror.Children
??
//進入Children,發現是一個AnyCollection,接收一個泛型
public typealias Children = AnyCollection<Mirror.Child>
??
//進入Child,發現是一個元組類型,由可選的標簽和值構成,
public typealias Child = (label: String?, value: Any)

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

1.2 JSON解析

我們定義了一個Animal類,然后通過一個test方法來解析:

class Animal {
    var age = 18
    var name = "Cat"
}

//JSON解析
func test(_ obj: Any) -> Any{
    let mirror = Mirror(reflecting: obj)
    //判斷條件 - 遞歸終止條件
    guard !mirror.children.isEmpty else {
        return obj
    }
    //字典
    var keyValue: [String: Any] = [:]
    //遍歷
    for children in mirror.children {
        if let keyName = children.label {
            //遞歸調用
            keyValue[keyName] = test(children.value)
        }else{
            print("children.label 為空")
        }
    }
    return keyValue
}

var kv: [String: Any] = test(Animal()) as! [String : Any]
print(kv)

//打印結果:
//["name": "Cat", "age": 18]

為了方便擴展、通用,我們可以利用封裝的思想,將其抽象為一個協議,然后提供一個默認實現,讓類遵守協議,進而,model就具備了JSON解析的功能。

//1、定義一個JSON解析協議
protocol CustomJSONMap {
    func jsonMap() -> Any
}
//2、提供一個默認實現
extension CustomJSONMap{
    func jsonMap() -> Any{
        let mirror = Mirror(reflecting: self)
        //遞歸終止條件
        guard !mirror.children.isEmpty else {
            return self
        }
        //字典,用于存儲json數據
        var keyValue: [String: Any] = [:]
        //遍歷
        for children in mirror.children {
            if let value = children.value as? CustomJSONMap {
                if let keyName = children.label {
                    //遞歸
                    keyValue[keyName] = value.jsonMap()
                }else{
                    print("key是nil")
                }
            }else{
                print("當前-\(children.value)-沒有遵守協議")
            }
        }
        return keyValue
    }
}

//3、讓類遵守協議(注意:類中屬性的類型也需要遵守協議,否則無法解析)
class Animal: CustomJSONMap {
    var age = 18
    var name = "Cat"
}

//使用
var t = Animal()
print(t.jsonMap())

//打印結果:
//當前-18-沒有遵守協議
//當前-Cat-沒有遵守協議
//[:]

沒有成功,提示,屬性沒有遵守協議。添加代碼:

extension Int: CustomJSONMap{}
extension String: CustomJSONMap{}
extension Double: CustomJSONMap{}

//打印結果:
//["age": 18, "name": "Cat"]

HandyJson

二、Error

為了JSON處理更規范,更好的維護和管理,我們需要對錯誤更規范化的處理。Swift,提供了Error協議來標識當前應用程序發生錯誤的情況。其中Error的定義如下:

//A type representing an error value that can be thrown.
public protocol Error { }

如上,Error是一個空協議,其中沒有任何實現,這也就意味著你可以遵守該協議,然后自定義錯誤類型。所以,structClassenum等,都可以遵循這個Error來表示一個錯誤。
下面,我們結合JSON解析,做一下錯誤處理:

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

//1、定義一個JSON解析協議
protocol CustomJSONMap {
    func jsonMap() -> Any
}
//2、提供一個默認實現
extension CustomJSONMap{
    func jsonMap() -> Any{
        let mirror = Mirror(reflecting: self)
        //遞歸終止條件
        guard !mirror.children.isEmpty else {
            return self
        }
        //字典,用于存儲json數據
        var keyValue: [String: Any] = [:]
        //遍歷
        for children in mirror.children {
            if let value = children.value as? CustomJSONMap {
                if let keyName = children.label {
                    //遞歸
                    keyValue[keyName] = value.jsonMap()
                }else{
                    return JSONMapError.emptyKey
                }
            }else{
                return JSONMapError.notConformProtocol
            }
        }
        return keyValue
    }
}

這里有一個問題,jsonMap方法的返回值是Any,我們無法區分返回的是錯誤還是json數據,那么該如何區分,即如何拋出錯誤呢?在這里可以通過throw關鍵字,將Demo中原本return的錯誤,改成throw拋出

//1、定義一個JSON解析協議
protocol CustomJSONMap {
    func jsonMap() throws-> Any
}
//2、提供一個默認實現
//2、提供一個默認實現
extension CustomJSONMap{
    func jsonMap() throws -> Any{
        let mirror = Mirror(reflecting: self)
        //遞歸終止條件
        guard !mirror.children.isEmpty else {
            return self
        }
        //字典,用于存儲json數據
        var keyValue: [String: Any] = [:]
        //遍歷
        for children in mirror.children {
            if let value = children.value as? CustomJSONMap {
                if let keyName = children.label {
                    //遞歸
                    keyValue[keyName] = try value.jsonMap()
                }else{
                    throw JSONMapError.emptyKey
                }
            }else{
                throw JSONMapError.notConformProtocol
            }
        }
        return keyValue
    }
}

因為我們使用了throw,所以還需要在遞歸調用前增加 try 關鍵字。

//使用
var t = Animal()
print(try t.jsonMap())

三、錯誤處理方式

Swift處理錯誤的方式,主要有兩種,try - throwdo - catch

3.1 try - throw

使用try關鍵字,是最簡便的,將Error向上拋出,拋給上層函數。但是在使用時,需要注意以下兩點:

  1. try?:返回一個可選類型,成功,返回具體的字典值;錯誤,但并不關心是哪種錯誤,統一返回nil
  2. try!:表示你對這段代碼有絕對的自信,這行代碼絕對不會發生錯誤。
//CJLTeacher中定義一個height屬性,并未遵守協議
class Animal: CustomJSONMap {
    var age = 18
    var name = "CJL"
    var height = 1.85
}
let t = Animal()

//1、try?
print(try? t.jsonMap())
//打印結果:nil

//2、try!
print(try! t.jsonMap())
//打印結果:
//SwiftTest/main.swift:256: Fatal error: 'try!' expression unexpectedly raised an error: SwiftTest.JSONMapError.notConformProtocol
//2022-08-29 23:14:16.107880+0800 SwiftTest[10620:17556994] SwiftTest/main.swift:256: Fatal error: 'try!' expression unexpectedly raised an error: SwiftTest.JSONMapError.notConformProtocol

//3、直接使用try,是向上拋出-
try t.jsonMap()
//打印結果:
//Swift/ErrorType.swift:200: Fatal error: Error raised at top level: SwiftTest.JSONMapError.notConformProtocol
//2022-08-29 23:14:47.827688+0800 SwiftTest[10648:17557924] Swift/ErrorType.swift:200: Fatal error: Error raised at top level: SwiftTest.JSONMapError.notConformProtocol

從上面可以知道,try錯誤是向上拋出的,即拋給了上層函數,如果上層函數也不處理,則直接拋給main,main沒有辦法處理,則直接報錯

3.2 do - catch

其中do處理正確結果catch處理errorcatch有個隱藏參數,就是error(Error類型)

do {
    // 處理正常結果
    try t.jsonMap()   // 這里try不會報錯了,因為錯誤都分給了catch
} catch {
    // 處理錯誤類型(其中error為Error類型)
    print(error)
}

//打印結果:notConformProtocol
3.3 LocalizedError

以上代碼,只打印了錯誤類型,如果還想知道錯誤相關的描述或其它信息,則需要使用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 }
}

接下來,我們來使用這個協議,繼續修改上面JSON的解析代碼,新增代碼如下:

//定義更詳細的錯誤信息
extension JSONMapError: LocalizedError{
    var errorDescription: String?{
        switch self {
        case .emptyKey:
            return "key為空"
        case .notConformProtocol:
            return "沒有遵守協議"
        }
    }
}
do {
    // 處理正常結果
    try t.jsonMap()   // 這里try不會報錯了,因為錯誤都分給了catch
} catch {
    // 處理錯誤類型(其中error為Error類型)
    print(error.localizedDescription)
}

//打印結果:沒有遵守協議
3.3 CustomNSError

CustomNSError協議,相當于OC中的NSError,其定義如下,有三個默認屬性:

/// 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 }
}

繼續修改JSON解析中的JSONMapError,讓其遵守CustomNSError協議,如下:

//CustomNSError相當于NSError
extension JSONMapError: CustomNSError{
    var errorCode: Int{
        switch self {
        case .emptyKey:
            return 404
        case .notConformProtocol:
            return 504
        }
    }
}

do {
    // 處理正常結果
    try t.jsonMap()   // 這里try不會報錯了,因為錯誤都分給了catch
} catch {
    //1、 處理錯誤類型(其中error為Error類型)
    print(error.localizedDescription)

    //2、處理錯誤類型(其中error為Error類型
    print((error as? CustomNSError)?.errorCode as Any)
}

//catch1  打印結果:沒有遵守協議
//catch2  打印結果:Optional(504)
rethorws

rethrows是處理這種場景的錯誤:函數1是函數2的入參,其中函數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)
}
defer(延后處理)
func functionDefer()  {
    print("begin")
    defer {
        print("defer1")
    }
    defer {
        print("defer2")
    }
    print("end")
}
functionDefer()

//打印結果: begin  end  defer2 defer1

函數執行完成之前,才會執行defer代碼塊內部的邏輯。如果有多個defer代碼塊,defer代碼塊的執行順序是逆序的。

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

推薦閱讀更多精彩內容