URL schemes 是操作 app 的指令

把 app 視為一個封裝的資源，URL schemes 是用來存取 app 資源的指令。 它就像是遙控器上的按鈕一樣，你只要知道哪一個按鈕會的到什麼結果，不需要知道背後如何執行。

對我來說它像是設計模式(Design Pattern)裡的命令模式一樣，把功能封裝成指令提供外部操作。

以 KKBOX 為例 kkbox://playctrl_pause 這個指令，就是用來暫停現在播放的歌曲。 指令前面這一段 kkbox:// 指的就是 KKBOX 的 URL Scheme(後續以 Scheme 代稱) ，後面 palyctrl_pause 這段則是代表動作。

當然在這我是不會列出所有指令的 XD

為什麼需要重構 URL handler?

在 KKBOX 這樣的大型專案裡有大約 6x 個 schemes，對你沒看錯是 6x 個。 這麼多指令要如何確保每一條都正常運行？ 當然每次出版本前都全部手動測試一次是一個方法，但手動測試不僅慢還有可能會遺漏，身為一個合格的 iOS 工程師當然是要自動化啊。

其實上面這段是比較官方說法，實際情況是幾次出版本前被 QA 測出某些 Scheme 沒有正常運作，來來回回發了好多票。 當問題一再發生的時候一定有哪裡沒做好，需要改善。

Scheme 能夠自動化測試

當我正準備建立測試資料時發現一個問題，那就是我沒有所有 Schemes 的測試案例(沒有人有)，所以我沒辦法一開始就建立所有的 UIAutomaciton 測試。

如果一個問題太大，就拆成多個小問題。

延續前一篇文章簡化邏輯讓 UI 不再出錯的概念， 我打算把 schemes 其實轉換成 Swift enum 。

整體解決方案分成 URL Parser 及 URL Handler 兩個部分：

• Parser: 將 URL Scheme 一對一的轉換成 KKRoute (swift enum) ，並實作 Equatable 介面用單元測試驗證。

• Handler: 著重於這個指令最後執行的結果是否如預期，由於 KKBOX URL Scheme 相當多元，我們必須透過 UIAutomation 來驗證。

也就是先將 Scheme 轉成 KKRoute ，在驗證 KKRoute 的執行結果。

URL Scheme Parser

需求是能夠把已 Scheme 轉成 KKRoute，未定義的 URL Scheme 也要能判斷。 實例如下：

"kkbox://playctrl_pause" => KKRoute.pause
"kkbox://play_music" => KKRoute.unknown

接著就可以快快樂樂的 TDD 完成這項任務

1.建立 KKRoute 的建構子

// KKRoute.swift
enum KKRoute {
    case pause
    case unknown

    init(urlString: String) {       
        self = .unknown
    }
}

2.建立單元測試 KKRoteTest.swift

// KKRouteTests.swift
class KKRouteTests: XCTestCase {    
    func testPause() {
      // [紅燈] 此時因為還未實作正確的建構子，所以會測試失敗 
        XCTAssertEqual(KKRoute(urlString: "kkbox://playctrl_pause"), .pause)
    }
}

3.補上實作

// KKRoute.swift
enum KKRoute {
    case pause
    case unknown

    init(urlString: String) {
      // 補上實作 
        if urlString == "kkbox://playctrl_pause" {
            self = .pause
            return
        }

        self = .unknown
    }
}

extension KKRoute: Equatable {
    public static func ==(lhs: KKRoute, rhs: KKRoute) -> Bool {
        switch (lhs, rhs) {
        case (.pause, .pause):
            return true
        case (.unknown, .unknown):
          return true
      default: 
        return false
        }
    }
}

// KKRouteTests.swift
class KKRouteTests: XCTestCase {    
    func testPause() {
    // [綠燈]
        XCTAssertEqual(KKRoute(urlString: "kkbox://playctrl_pause"), .pause)
    }
}

真正解放 Swift enum 的威力在這個下面這個例子：

// KKRoute.swift
enum KKRoute {
    case pause
    case viewAlbum(albumID: String)
    case unknown

    init(urlString: String) {
        if urlString == "kkbox://playctrl_pause" {
            self = .pause
            return
        }

        if urlString.hasPrefix("kkbox://album/") {
            let albumID = urlString.substring(from: "kkbox://album/".endIndex)
            self = .viewAlbum(albumID: albumID)
            return
        }

        self = .unknown
    }
}

extension KKRoute: Equatable {
    public static func ==(lhs: KKRoute, rhs: KKRoute) -> Bool {
        switch (lhs, rhs) {
        case (let .viewAlbum(albumID1), let .viewAlbum(albumID2)):
            return albumID1 == albumID2
        case (.pause, .pause):
            return true
        case (.unknown, .unknown):
          return true
      default: 
        return false
        }
    }
}

// KKRouteTests.swift
class KKRouteTests: XCTestCase {    
    func testPause() {
        XCTAssertEqual(KKRoute(urlString: "kkbox://playctrl_pause"), .pause)
    }

    func testViewAlbum() {
        XCTAssertEqual(KKRoute(urlString: "kkbox://album/3345678"), .viewAlbum(albumID:"3345678"))
    }
}

接著把所有 schemes 用 TDD 的方式一個一個補上，就能確保 parse 過程中沒有任何錯誤。

URL Handler

這部分也很類似 Parser 的做法，只不過輸入是 KKRoute 而輸出是真正的 UI 畫面。

以 KKRoute.viewAlbum(albumID: "3345678") 來說，我們可以預期當 KKBOX 收到這個指令會把頁面導到 "3345678" 這個 ID 的專輯內頁。

詳細的做法跟 Parser 的驗證方法一樣，在這就不贅述。

後記

其實這一篇字字血淚呀，在執行過程中才發現我們手上沒有所有的測試案例，就連 QA 也沒有。 在這兩週重構的過程中，我把所有 schemes 搞懂是在做什麼的以外，也建立了所有測試案例(昏倒..

Reference

• Server-Side Swift: Routing – Swift talk
• Writing Your UI Swiftly – Sommer Panage