給 String 實現一個安全的 subscript 方法

四娘發表於2017-10-09

完整的實現：Gist

最近剛好接觸了字串的切片，原生的 API 各種麻煩，我就試著實現了幾個語法糖，目標是：

let str = "Swift-Evolution"
str[3...]   // "ft-Evolution"
str[...3]   // "Swif"
str[..<3]   // "Swi"
str[3...11] // "ft-Evolut"複製程式碼

Swift 4 的字串原生也是帶 subscript 方法的，接收 Range<String.Index> 之類的範圍型別作為引數，而我們需要的是使用 Range<Int> 進行呼叫，那我們只要構造一個過程，讓 Range<Int> map 到 Range<String.Index> 就行了。

subscript(_ range: Range<Int>) -> String {
    let newStartIndex = index(startIndex, offsetBy: range.lowerBound)
    let newEndIndex   = index(startIndex, offsetBy: range.upperBound)
    let newRange      = [newStartIndex..<newEndIndex] // Range<String.Index>
    return String(self[newRange])
}複製程式碼

但這種方式其實是不安全的，可能會出現越界導致的崩潰：

str[(-22)...(-11)] // fatalError複製程式碼

我採取的是這樣的檢驗方式，先檢驗索引值是否在合理的範圍內，如果不合理的話，就拉回到最近的邊界上，然後再檢查它作為一個起始點和終止點是否合理，如果不合理就返回 nil：

private func validIndex(original: Int) -> String.Index {
    switch original {
    case ...startIndex.encodedOffset : return startIndex
    case endIndex.encodedOffset...   : return endIndex
    default                          : return index(startIndex, offsetBy: original)
    }
}

private func validStartIndex(original: Int) -> String.Index? {
    guard original <= endIndex.encodedOffset else { return nil }
    return validIndex(original:original)
}

private func validEndIndex(original: Int) -> String.Index? {
    guard original >= startIndex.encodedOffset else { return nil }
    return validIndex(original:original)
}複製程式碼

然後前面的那段程式碼就可以改寫成這樣：

subscript(_ range: CountableRange<Int>) -> String {
    guard
        let startIndex = validStartIndex(original: range.lowerBound),
        let endIndex   = validEndIndex(original: range.upperBound),
        startIndex < endIndex
    else {
        return ""
    }

    return String(self[startIndex..<endIndex])
}複製程式碼

這裡的抽象，可以這麼理解，字串是無限長的，平躺在座標軸上，它只有一小段是有意義的，我們有字串從開頭到結尾的一個範圍 A，有要取值的範圍 B，兩個範圍取交集就是我們取值的結果。如果沒有交集，那麼獲取到的就是一個空集：

索引             0
------------------------------------
字串           Swfit-Evolution
字串範圍       |--------------|
取值範圍    |------------|
交集            |=======|複製程式碼

而實際實現的時候，我們其實需要實現 8 個範圍型別 Range / ClosedRange / CountableRange / CountableClosedRange / PartialRangeFrom/PartialRangeThrough / PartialRangeUpTo / CountablePartialRangeFrom。

原因是 Swift 的泛型系統還有沒完善，需要實現 Condition Conformance 才可以更好地把範圍抽象出來，類似於 Countable 的特性是可以通過泛型抽象出來的，而沒必要使用那麼多的型別，更具體的解釋可以看 Ole Begemann 大神對於 Range 型別的解釋。

如果實現了 Condition Comformance 的話，只要像文章開頭說的那樣，一個 map 就能解決了，而不需要像現在這樣每個型別寫一套。

到現在其實還是沒有很懂為什麼 Swift 要封裝出一個 String.Index 的概念？編碼嗎？

最後獻上一段有趣的程式碼：

extension Collection {
    // could choose to handle or fail on gaps, out-of-order ranges, overlapping ranges etc
    func fields<P: Collection>(at positions: P) -> [String: SubSequence]? 
        where P.Element == (key: String, value: CountableRange<IndexDistance>)
    { }
}

let barcodeSchema: DictionaryLiteral = [
    "name": 2..<22,
    "pnrCode": 23..<30,
    "fromCity": 30..<33,
    "toCity": 33..<36,
    "carrier": 36..<39,
    "flightNumber": 39..<44,
    "day": 45..<47,
    "seatNo": 47..<51,
]

let fields = barcode.fields(at: barcodeSchema)!複製程式碼

覺得文章還不錯的話可以關注一下我的部落格

相關文章