因?yàn)樵赟wift4.0中flatMap有很多重載, 可能會(huì)引起歧義, 所以在Swift4.1中把flatMap重命名為compactMap
map 簡(jiǎn)介
首先汽抚,咱們說(shuō)說(shuō) map 函數(shù)如何使用。
let numbers = [1,2,3,4]
let result = numbers.map { $0 + 2 }
print(result) // [3,4,5,6]
map 方法接受一個(gè)閉包作為參數(shù)伯病, 然后它會(huì)遍歷整個(gè) numbers 數(shù)組造烁,并對(duì)數(shù)組中每一個(gè)元素執(zhí)行閉包中定義的操作。 相當(dāng)于對(duì)數(shù)組中的所有元素做了一個(gè)映射午笛。 比如咱們這個(gè)例子里面的閉包是講所有元素都加 2 惭蟋。 這樣它產(chǎn)生的結(jié)果數(shù)據(jù)就是 [3,4,5,6]。
初步了解之后季研,我們來(lái)看一下 map 的定義:
public func map<T>(_ transform: (Element) throws -> T) rethrows -> [T]
map 函數(shù)接受一個(gè)閉包敞葛, 這個(gè)閉包的定義是這樣的:
(Element) -> T
它接受 Elementt 類型的參數(shù), 這個(gè)類型代表數(shù)組中當(dāng)前元素的類型与涡。 而這個(gè)閉包的返回值惹谐,是可以和傳遞進(jìn)來(lái)的值不同的。 比如我們可以這樣:
let stringResult = numbers.map { "No. \($0)" }
// ["No. 1", "No. 2", "No. 3", "No. 4"]
這次我們?cè)陂]包裝把傳遞進(jìn)來(lái)的數(shù)字拼接到一個(gè)字符串中驼卖, 然后返回一個(gè)組數(shù)氨肌, 這個(gè)數(shù)組中包含的數(shù)據(jù)類型,就是我們拼接好的字符串酌畜。
這就是關(guān)于 map 的初步了解怎囚, 我們繼續(xù)來(lái)看 flatMap。
flatMap
map 可以對(duì)一個(gè)集合類型的所有元素做一個(gè)映射操作桥胞。 那么 flatMap 呢恳守?
讓我們來(lái)看一個(gè) flatMap 的例子:
result = numbers.flatMap { $0 + 2 }
// [3,4,5,6]
我們對(duì)同樣的數(shù)組使用 flatMap 進(jìn)行處理, 得到了同樣的結(jié)果贩虾。 那 flatMap 和 map 到底有什么區(qū)別呢催烘?
咱們?cè)賮?lái)看另一個(gè)例子:
let numbersCompound = [[1,2,3],[4,5,6]];
var res = numbersCompound.map { $0.map{ $0 + 2 } }
// [[3, 4, 5], [6, 7, 8]]
var flatRes = numbersCompound.flatMap { $0.map{ $0 + 2 } }
// [3, 4, 5, 6, 7, 8]
這里就看出差別了。 對(duì)于二維數(shù)組缎罢, map 和 flatMap 的結(jié)果就不同了伊群。 我們先來(lái)看第一個(gè)調(diào)用:
var res = numbersCompound.map { $0.map{ $0 + 2 } }
// [[3, 4, 5], [6, 7, 8]]
numbersCompound.map { ... } 這個(gè)調(diào)用實(shí)際上是遍歷了這里兩個(gè)數(shù)組元素 [1,2,3] 和 [4,5,6]。 因?yàn)檫@兩個(gè)元素依然是數(shù)組策精,所以我們可以對(duì)他們?cè)俅握{(diào)用 map 函數(shù):$0.map{ $0 + 2 }舰始。 這個(gè)內(nèi)部的調(diào)用最終將數(shù)組中所有的元素加 2。
再來(lái)看看 flatMap 的調(diào)用:
var flatRes = numbersCompound.flatMap { $0.map{ $0 + 2 } }
// [3, 4, 5, 6, 7, 8]
flatMap 依然會(huì)遍歷數(shù)組的元素咽袜,并對(duì)這些元素執(zhí)行閉包中定義的操作丸卷。 但唯一不同的是,它對(duì)最終的結(jié)果進(jìn)行了所謂的 "降維" 操作询刹。 本來(lái)原始數(shù)組是一個(gè)二維的及老, 但經(jīng)過(guò) flatMap 之后抽莱,它變成一維的了范抓。
flatMap 是如何做到的呢骄恶,它的原理是什么,為什么會(huì)存在這樣一個(gè)函數(shù)呢匕垫? 相信此時(shí)你腦海中肯定會(huì)浮現(xiàn)出類似的問(wèn)題僧鲁。
下面咱們?cè)賮?lái)看一下 flatMap 的定義,
public func flatMap<ElementOfResult>(_ transform: (Element) throws -> ElementOfResult? rethrows -> [ElementOfResult]
public func flatMap<SegmentOfResult : Sequence>(_ transform: (Element) throws -> SegmentOfResult) rethrows -> [SegmentOfResult.Element]
和 map 不同, flatMap 有兩個(gè)重載象泵。 參照我們剛才的示例寞秃, 我們調(diào)用的其實(shí)是第二個(gè)重載:
flatMap 的閉包接受的是數(shù)組的元素,但返回的是一個(gè) SequenceType 類型偶惠,也就是另外一個(gè)數(shù)組春寿。 這從我們剛才這個(gè)調(diào)用中不難看出:
numbersCompound.flatMap { $0.map{ $0 + 2 } }
我們傳入給 flatMap 一個(gè)閉包 $0.map{ $0 + 2 } , 這個(gè)閉包中,又對(duì) $0 調(diào)用了 map 方法忽孽, 從 map 方法的定義中我們能夠知道绑改,它返回的還是一個(gè)集合類型,也就是 SequenceType兄一。 所以我們這個(gè) flatMap 的調(diào)用對(duì)應(yīng)的就是第二個(gè)重載形式厘线。
那么為什么 flatMap 調(diào)用后會(huì)對(duì)數(shù)組降維呢? 我們可以從它的源碼中窺探一二出革。
public func flatMap<SegmentOfResult : Sequence>(
_ transform: (Element) throws -> SegmentOfResult
) rethrows -> [SegmentOfResult.Element] {
var result: [SegmentOfResult.Element] = []
for element in self {
result.append(contentsOf: try transform(element))
}
return result
}
這就是 flatMap 的完整源碼了造壮, 它的源碼也很簡(jiǎn)單, 對(duì)遍歷的每一個(gè)元素調(diào)用 try transform(element)骂束。 transform 函數(shù)就是我們傳遞進(jìn)來(lái)的閉包耳璧。
然后將閉包的返回值通過(guò) result.append(contentsOf:) 函數(shù)添加到 result 數(shù)組中。
那我們?cè)賮?lái)看一下 result.append(contentsOf:) 都做了什么展箱, 它的文檔定義是這樣:
Append the elements of newElements to self.
簡(jiǎn)單說(shuō)就是將一個(gè)集合中的所有元素旨枯,添加到另一個(gè)集合。 還以我們剛才這個(gè)二維數(shù)組為例:
let numbersCompound = [[1,2,3],[4,5,6]];
var flatRes = numbersCompound.flatMap { $0.map{ $0 + 2 } }
// [3, 4, 5, 6, 7, 8]
flatMap 首先會(huì)遍歷這個(gè)數(shù)組的兩個(gè)元素 [1,2,3] 和 [4,5,6]析藕, 因?yàn)檫@兩個(gè)元素依然是數(shù)組召廷, 所以我們可以對(duì)他們?cè)龠M(jìn)行 map 操作: $0.map{ $0 + 2 }。
這樣账胧, 內(nèi)部的 $0.map{ $0 + 2 } 調(diào)用返回值類型還是數(shù)組竞慢, 它會(huì)返回 [3,4,5] 和 [6,7,8]。
然后治泥, flatMap 接收到內(nèi)部閉包的這兩個(gè)返回結(jié)果筹煮, 進(jìn)而調(diào)用 result.append(contentsOf:) 將它們的數(shù)組中的內(nèi)容添加到結(jié)果集中,而不是數(shù)組本身居夹。
那么我們最終的調(diào)用結(jié)果理所當(dāng)然就應(yīng)該是 [3, 4, 5, 6, 7, 8] 了败潦。
仔細(xì)想想是不是這樣呢~
flatMap 的另一個(gè)重載
我們剛才分析了半天本冲, 其實(shí)只分析到 flatMap 的一種重載情況, 那么另外一種重載又是怎么回事呢:
public func flatMap<ElementOfResult>(_ transform: (Element) throws -> ElementOfResult? rethrows -> [ElementOfResult]
從定義中我們看出劫扒, 它的閉包接收的是 Element 類型檬洞, 返回的是一個(gè) ElementOfResult? 。 我們都知道沟饥,在 Swift 中類型后面跟隨一個(gè) ?添怔, 代表的是 Optional 值。 也就是說(shuō)這個(gè)重載中接收的閉包返回的是一個(gè) Optional 值贤旷。 更進(jìn)一步來(lái)說(shuō)广料,就是閉包可以返回 nil。
我們來(lái)看一個(gè)例子:
let optionalArray: [String?] = ["AA", nil, "BB", "CC"];
var optionalResult = optionalArray.flatMap{ $0 }
// ["AA", "BB", "CC"]
這樣竟然沒(méi)有報(bào)錯(cuò)幼驶, 并且 flatMap 的返回結(jié)果中艾杏, 成功的將原數(shù)組中的 nil 值過(guò)濾掉了。 再仔細(xì)觀察盅藻,你會(huì)發(fā)現(xiàn)更多购桑。 使用 flatMap 調(diào)用之后, 數(shù)組中的所有元素都被解包了萧求, 如果同樣使用 print 函數(shù)輸出原始數(shù)組的話其兴, 大概會(huì)得到這樣的結(jié)果:
[Optional("AA"), nil, Optional("BB"), Optional("CC")]
而使用 print 函數(shù)輸出 flatMap 的結(jié)果集時(shí),會(huì)得到這樣的輸出:
["AA", "BB", "CC"]
也就是說(shuō)原始數(shù)組的類型是 [String?] 而 flatMap 調(diào)用后變成了 [String]夸政。 這也是 flatMap 和 map 的一個(gè)重大區(qū)別元旬。 如果同樣的數(shù)組,我們使用 map 來(lái)調(diào)用守问, 得到的是這樣的輸出:
[Optional("AA"), nil, Optional("BB"), Optional("CC")]
這就和原始數(shù)組一樣了匀归。 這兩者的區(qū)別就是這樣。 map 函數(shù)值對(duì)元素進(jìn)行變換操作耗帕。 但不會(huì)對(duì)數(shù)組的結(jié)構(gòu)造成影響穆端。 而 flatMap 會(huì)影響數(shù)組的結(jié)構(gòu)。再進(jìn)一步分析之前仿便,我們暫且這樣理解体啰。
flatMap 的這種機(jī)制,而已幫助我們方便的對(duì)數(shù)據(jù)進(jìn)行驗(yàn)證嗽仪,比如我們有一組圖片文件名荒勇, 我們可以使用 flatMap 將無(wú)效的圖片過(guò)濾掉:
var imageNames = ["test.png", "aa.png", "icon.png"];
imageNames.flatMap{ UIImage(named: $0) }
那么 flatMap 是如何實(shí)現(xiàn)過(guò)濾掉 nil 值的呢? 我們還是來(lái)看一下源碼:
源碼地址
@available(swift, deprecated: 4.1, renamed: "compactMap(_:)",
message: "Please use compactMap(_:) for the case where closure returns an optional value")
public func flatMap<ElementOfResult>(
_ transform: (Element) throws -> ElementOfResult?
) rethrows -> [ElementOfResult] {
return try _compactMap(transform)
}
public func _compactMap<ElementOfResult>(
_ transform: (Element) throws -> ElementOfResult?
) rethrows -> [ElementOfResult] {
var result: [ElementOfResult] = []
for element in self {
if let newElement = try transform(element) {
result.append(newElement)
}
}
return result
}
依然是遍歷所有元素闻坚,并應(yīng)用 try transform(element) 閉包的調(diào)用沽翔, 但關(guān)鍵一點(diǎn)是,這里面用到了 if let 語(yǔ)句, 對(duì)那些只有解包成功的元素仅偎,才會(huì)添加到結(jié)果集中:
if let newElement = try transform(element) {
result.append(newElement)
}
這樣跨蟹, 就實(shí)現(xiàn)了我們剛才看到的自動(dòng)去掉 nil 值的效果了。