在漫長的 iOS 開發史中,人們為 API 設計累積了許多通用模式與最佳實踐。我們往往能從 Apple 的 Foundation、Cocoa、Cocoa Touch 等框架中歸納出開發慣例。對於「特定情境下的 API 該如何設計」,向來見仁見智,有相當大的討論空間。而對許多 Objective-C 開發者而言,那些常用模式早已耳熟能詳。
隨著 Swift 問世,API 設計迎來了更多可能。多數情況下,我們只是把現有方法「翻譯」成 Swift 版本,但這對 Swift 並不公平,因為相比 Objective-C,它多了許多新特性。正如 Swift 創始人 Chris Lattner 所說:
Swift 引入了泛型與函數式編程的思想,極大地擴展了設計的空間。
本文將以 Core Image 的 API 封裝為例,探索如何運用這些新工具。Core Image 功能強大,但它的 API 有時略顯笨重——它是弱類型的,透過鍵值對設定濾鏡參數,容易在指定型別與名稱時出錯,導致執行期錯誤。我們希望打造一個更安全、模組化的新 API,用型別取代鍵值對來規避這類問題。
我們的目標是建立一個 API,能簡單安全地組裝自訂濾鏡。理想情況下,最終可以這樣寫:
let myFilter = blur(blurRadius) >|> colorOverlay(overlayColor) let result = myFilter(image)
它構建了一個自訂濾鏡:先模糊圖像,再疊加一層顏色蒙版。為此,我們將充分利用 Swift「函數是一等公民」的特性。
CIFilter 是 Core Image 的核心類,用來建立濾鏡。實例化後,你幾乎總是透過 kCIInputImageKey 輸入圖像,再透過 kCIOutputImageKey 取得結果,並作為下一個濾鏡的輸入。
在新 API 中,我們把這些鍵值對抽離出來,提供一個強型別的介面。我們定義自己的濾鏡型別 Filter,它是一個接收圖片、回傳新圖片的函數:
typealias Filter = CIImage -> CIImage
這裡用 typealias 為 CIImage -> CIImage 型別命名。若你還不熟悉函數式編程,把一個函數型別命名為 Filter 或許有點奇怪,我們通常會用這種命名來定義類。但這裡我們刻意選擇 Filter,因為在函數式編程的核心哲學裡,函數就是值,它與結構體、整數、多元組或類別並無二致。
有了 Filter 型別,接著就能定義構造特定濾鏡的函數,它們接收參數並回傳一個 Filter:
func myFilter(/* parameters */) -> Filter
注意回傳值 Filter 本身就是函數,這有助於我們後續將多個濾鏡組合起來。
為了讓開發更輕鬆,我們擴充了 CIFilter,加入便利初始化方法與取得輸出圖像的計算屬性:
typealias Parameters = Dictionary<String, AnyObject>
extension CIFilter {
convenience init(name: String, parameters: Parameters) {
self.init(name: name)
setDefaults()
for (key, value : AnyObject) in parameters {
setValue(value, forKey: key)
}
}
var outputImage: CIImage {
return self.valueForKey(kCIOutputImageKey) as! CIImage
}
}
便利初始化方法接收濾鏡名稱與参數字典;計算屬性 outputImage 則方便地取出輸出圖像,讓使用者不必手動做型別轉換。
有了這些基礎,我們就能定義簡單的濾鏡。高斯模糊只需一個模糊半徑:
func blur(radius: Double) -> Filter {
return { image in
let parameters : Parameters = [kCIInputRadiusKey: radius, kCIInputImageKey: image]
let filter = CIFilter(name: "CIGaussianBlur", parameters: parameters)
return filter.outputImage
}
}
這個模糊函數回傳一個函數,其輸入與輸出都是圖片,正好符合 Filter 的定義。
接著定義一個顏色濾鏡,在圖片上疊加一層顏色。Core Image 並未直接提供,但我們可以組合既有濾鏡。先定義生成純色面板的濾鏡:
func colorGenerator(color: UIColor) -> Filter {
return { _ in
let filter = CIFilter(name: "CIConstantColorGenerator",
parameters: [kCIInputColorKey: color])
return filter.outputImage
}
}
這裡用匿名參數 _ 表示忽略了傳入的圖片,因為顏色生成濾鏡並不需要輸入圖像。接著定義合成濾鏡:
func compositeSourceOver(overlay: CIImage) -> Filter {
return { image in
let parameters : Parameters = [
kCIInputBackgroundImageKey: image,
kCIInputImageKey: overlay
]
let filter = CIFilter(name: "CISourceOverCompositing", parameters: parameters)
return filter.outputImage.imageByCroppingToRect(image.extent())
}
}
最後把兩者組合起來,形成顏色蒙版濾鏡:
func colorOverlay(color: UIColor) -> Filter {
return { image in
let overlay = colorGenerator(color)(image)
return compositeSourceOver(overlay)(image)
}
}
現在可以將模糊與顏色濾鏡串接使用:
let url = NSURL(string: "https://tinyurl.com/m74sldb") let image = CIImage(contentsOfURL: url) let blurRadius = 5.0 let overlayColor = UIColor.redColor().colorWithAlphaComponent(0.2) let blurredImage = blur(blurRadius)(image) let overlaidImage = colorOverlay(overlayColor)(blurredImage)
我們可以把它壓縮成一行,但可讀性不佳:
let result = colorOverlay(overlayColor)(blur(blurRadius)(image))
更好的做法是定義一個組合函數:
func composeFilters(filter1: Filter, filter2: Filter) -> Filter {
return { img in filter2(filter1(img)) }
}
let myFilter = composeFilters(blur(blurRadius), colorOverlay(overlayColor))
let result = myFilter(image)
我們甚至可以定義一個運算符,讓程式碼更直觀:
infix operator >|> { associativity left }
func >|> (filter1: Filter, filter2: Filter) -> Filter {
return { img in filter2(filter1(img)) }
}
let myFilter = blur(blurRadius) >|> colorOverlay(overlayColor)
let result = myFilter(image)
infix 表示這是個中綴運算符,associativity left 表示左結合。這樣一來,濾鏡的套用順序就與 Unix 管道一致,從左往右閱讀。1 + 2 + 3 + 4 顯然比 add(add(add(1, 2), 3), 4) 更清晰易讀。
仔細想想,我們其實不需要專門為濾鏡定義組合運算符,而可以用泛型來組裝任意函數:
func >|> <A, B, C>(lhs: A -> B, rhs: B -> C) -> A -> C {
return { x in rhs(lhs(x)) }
}
這裡定義了三個泛型 A、B、C:lhs 是 A -> B 的函數,rhs 是 B -> C 的函數,組合後得到 A -> C。原先的濾鏡組合運算符,其實只是把 A、B、C 都替換成 CIImage 的特例而已。
至此,我們成功用函數式 API 封裝了 Core Image。這個例子說明:對 Objective-C 開發者而言,在我們熟悉的 API 設計模式之外,還有一片全新的世界。有了 Swift,我們現在可以動手探索那些嶄新的領域,並將它們充分發揮。