淺談Kotlin中集合和函式式API完全解析-上篇(八)

簡述: 今天帶來的是Kotlin淺談系列的第八講，這講我們一起來聊聊Kotlin這門語言對函數語言程式設計的支援。我們都知道在kotlin這門語言中函式榮升成為了一等公民，所以在支援函數語言程式設計的方面，Kotlin這門語言也是非常給力的，並且在Kotlin中語法也儘量推薦接近函數語言程式設計的風格。學過以及瞭解過函數語言程式設計的小夥伴都知道函數語言程式設計最吸引人的地方，莫過於它擁有豐富的函式式操作符，可以使用一種全新的程式設計方式去操作集合資料。其中操作符最流行莫過於函式式中“三板斧”(過濾filter、對映map、摺疊foldLeft/化約reduce)。那麼小夥伴會提問了:

• 1、那Kotlin語言中有這些操作符嗎？

答: 當然有，不僅有這些而且還有很多很豐富的函式式操作符，僅從這方面來說Kotlin這門語言是函數語言程式設計語言一點也不為過。

• 2、那今天是講函式式API嗎？

答: 沒錯，今天會對Kotlin中所有函式式操作符API做詳細的講解，包括基本使用、基本定義、實質原理三個方面來做介紹，力求做到完全解析

• 3、有什麼小建議？

最後，一個小建議，由於Kotlin中的函式式API有很多，有些也不是經常使用的，建議先將經常使用的操作符(我會做好標記)理解、掌握。其他不常用的後續可以返回來查詢即可

今天闡述的內容點很簡單，主要有以下三點：

• 1、Kotlin中集合的詳細介紹和完全解析
• 2、Kotlin中函式式API操作符的分類
• 3、Kotlin中函式式API操作符的詳解

一、Kotlin中集合的詳細介紹和完全解析

在介紹函式式API操作符之前，有必要去了解一下這些操作符操作的物件集合。實際上，Kotlin語言中的集合和Java還是有一定區別的。在Kotlin中集合主要分為了兩個大類，一類是可變集合(具有訪問和修改許可權)，另一類是只讀集合(只具有訪問許可權)(注意: 這裡不能說不可變集合，只能說是具有可讀許可權，關於這個不可變和可讀討論之前部落格有相關闡述)。Kotlin的集合設計與Java集合設計有一個很重要區別就是Kotlin把集合訪問介面和集合修改介面分開了。

• 1、Kotlin為什麼把集合設計為可變和只讀兩種？

關於這個問題，實際上之前的var和val的分離設計已經回答了一部分。Kotlin這門考慮到實際開發中方便和程式中資料發生的事情更容易讓人理解，所以才有此設計。我們設想一下這樣的場景，kotlin中定義一個函式，函式的引數是一個可變集合，以kotlin開發規則而言，傳遞一個可變集合作為引數，實際上也在表明在該函式體內部涉及到修改集合操作。如果傳遞的是一個只讀集合作為引數，那麼表明在該函式體內是不會涉及到修改集合操作，只允許訪問集合。看到如此的設計你是否已經愛上了這門語言，也就是這門語言在各個方面和開發細節上都是花了很多功夫的，力求做到任何一步都是讓開發者開發更簡單和更容易理解。

• 2、集合的分類

在kotlin.collections包中包含相應集合。主要包含Iterable(只讀迭代器)和MutableIterable(可變迭代器)、Collection和MutableCollection、List和MutableList、Set和MutableSet、Map和MutableMap

• 3、可變集合與只讀集合之間的區別和聯絡（以Collection集合為例）

Collection只讀集合與MutableCollectio可變集合區別:

在Collection只具有訪問元素的方法，不具有類似add、remove、clear之類的方法，而在MutableCollection中則相比Collection多出了修改元素的方法。

Collection只讀集合與MutableCollectio可變集合聯絡:

MutableCollection實際上是Collection集合介面的子介面，他們之間是繼承關係。

• 4、集合之間類的關係

通過Collection.kt檔案中可以瞭解到有這些集合Iterable(只讀迭代器)和MutableIterable(可變迭代器)、Collection和MutableCollection、List和MutableList、Set和MutableSet、Map和MutableMap。那麼它們之間的類關係圖是怎樣的。

Iterable和MutableIterable介面分別是隻讀和可變集合的父介面，Collection繼承Iterable然後List、Set介面繼承自Collection，Map介面比較特殊它是單獨的介面，然後MutableMap介面是繼承自Map.

• 5、Java中的集合與Kotlin中集合對應關係

我們剛剛說到在Kotlin中集合的設計與Java不一樣，但是每一個Kotlin的介面都是其對應的Java集合介面的一個例項，也就是在Kotlin中集合與Kotlin中的集合存在一定的對應關係。Java中的ArrayList類和HashSet類實際上Kotlin中的MutableList和MutableSet集合介面的實現類。把這種關係加上，上面的類關係圖可以進一步完善。

• 6、集合的初始化

由於在Kotlin中集合主要分為了只讀集合和可變集合，那麼初始化只讀集合和可變集合的函式也不一樣。以List集合為例，對於只讀集合初始化一般採用listOf()方法，對於可變集合初始化一般採用mutableListOf()或者直接建立ArrayList<E>，因為mutableListOf()內部實現也是也還是採用建立ArrayList,這個ArrayList實際上是Java中的java.util.ArrayList<E>，只不過在Kotlin中使用typealias(關於typealias的使用之前部落格有過詳細介紹)取了別名而已。關於具體內容請參考這個類kotlin.collections.TypeAliasesKt實現

• 7、集合使用的注意事項

注意點一: 在程式碼的任何地方都優先使用只讀集合，只在需要修改集合的情況下才去使用可變集合

注意點二: 只讀集合不一定是不可變的，關於這個只讀和不可變類似於val的只讀和不可變原理。

注意點三: 不能把一個只讀型別的集合作為引數傳遞給一個帶可變型別集合的函式。

二、Kotlin中函式式API操作符的分類

Kotlin中函式式API操作符有很多，函式式中“三板斧”必須有的，定義和用法也是不盡相同。與其雜亂的死記硬背，不如先從大體上給這些API操作符分類，然後針對每一類去分析、理解、掌握，分類的規則也是按照各個操作符的功能來分。Kotlin中函式式API操作符主要有以下幾大類。

• 1、篩選類操作符(Filtering operations):主要有以下操作符

  slice

  filter系列

  

  drop系列

  

  take系列

  

• 2、並集類操作符(Aggregate operations):主要有以下操作符

  any、all、count、none

  fold系列

  

  forEach系列

  

  max系列

  

  min系列

  

  reduce系列

  

  sum系列

  

• 3、對映類操作符(Mapping operations):主要有以下操作符

  flatMap系列

  

  groupBy系列

  

  map系列

  

• 4、元素類操作符(Element operations):主要有以下操作符

  elementAt系列

  

  first系列

  

  find系列

  

  indexOf系列

  

  last系列

  

  single系列

  

• 5、排序類操作符(Ordering operations):主要有以下操作符

  reverse

  sort系列

  

• 6、生成類操作符(Generation operations):主要有以下操作符

  partition

  plus系列

  

  zip系列

  

三、篩選類函式式API的詳解(Filtering operations)

slice操作符

• 1、基本定義

slice操作符顧名思義是"切片"的意思，也就是它可以取集合中一部分元素或者某個元素，最後也是組合成一個新的集合。它有兩個過載函式，一個傳入IntRange物件指定切片起始位置和終止位置，最後切出的是一個範圍的元素加入到新集合中。另一個是傳入一個Iterable下標集合，也就會從指定下標分別切出對應的元素，最後放入到新集合中。

• 2、原始碼定義

public fun <T> List<T>.slice(indices: IntRange): List<T> {
    if (indices.isEmpty()) return listOf()
    return this.subList(indices.start, indices.endInclusive + 1).toList()
}

public fun <T> List<T>.slice(indices: Iterable<Int>): List<T> {
    val size = indices.collectionSizeOrDefault(10)
    if (size == 0) return emptyList()
    val list = ArrayList<T>(size)
    for (index in indices) {
        list.add(get(index))
    }
    return list
}
複製程式碼

• 3、原始碼解析

首先，slice函式是List<T>的一個擴充套件函式，它有兩個過載函式，一個是接收IntRange物件，另一個是接收元素下標的集合物件，最終函式是返回一個List<T>集合。接收IntRange物件的函式實現很簡單，主要是通過IntRange物件拿到對應的start,end位置，然後利用subList拿到子集合，最後返回這個子集合。接收元素下標的集合的函式，是內部建立一個新的集合物件，然後遍歷整個原集合把元素下標集合中的元素加入到新建立的集合中，最後返回這個新的集合物件。

• 4、原理圖解

• 5、使用場景

slice by IntRange一般使用場景: 用於切取一段下標範圍的子集合

slice by itertar index一般使用場景: 用於切取某個或者某些下標元素組成的集合

fun main(args: Array<String>) {
    val numberList = listOf(1, 2, 3, 4, 5, 6, 7, 8, 9)

    val newNumberList1 = numberList.slice(IntRange(3, 6))
    print("slice by IntRange: ")
    newNumberList1.forEach {
        print("$it ")
    }

    println()

    val newNumberList2 = numberList.slice(listOf(1, 3, 7))
    print("slice by iterator index: ")
    newNumberList2.forEach {
        print("$it ")
    }
}
複製程式碼

filter和filterTo操作符

• 1、基本定義:

根據使用者定義的條件篩選集合中的資料，並且由此產生一個新的集合。這個新的集合是原集合的子集。

• 2、原始碼定義:

public inline fun <T> Iterable<T>.filter(predicate: (T) -> Boolean): List<T> {
    return filterTo(ArrayList<T>(), predicate)
}

public inline fun <T, C : MutableCollection<in T>> Iterable<T>.filterTo(destination: C, predicate: (T) -> Boolean): C {
    for (element in this) if (predicate(element)) destination.add(element)
    return destination
}
複製程式碼

• 3、原始碼解析:

首先，從整體上可以看出filter是一個Iterable<T>的擴充套件函式並且是一個行內函數，該函式接收一個以接收T型別返回一個Boolean型別的lambda表示式predicate作為引數，所以它還是一個高階函式，返回一個List<T>集合

然後，看具體的內部實現是呼叫了另一個函式filterTo，並傳入新建立的ArrayList<T>()可變集合物件，然後繼續把lambda表示式作為引數傳遞到filterTo函式中，在filterTo函式去實現真正的過濾操作。傳入的lambda表示式predicate實際上就是外部呼叫者傳入的過濾條件，可以看到在filterTo內部是利用一個for迴圈進行篩選判斷符合lambda表示式條件的，就新增到filter呼叫filterTo函式傳遞的引數ArrayList<T>新集合物件中，最後就是返回這個ArrayList<T>新集合物件。所以filter最後篩選出來的還是一個集合。

• 4、原理圖解:

• 5、使用場景:

filter的操作符使用場景: 從一個集合篩選出符合條件的元素，並以一個新集合返回。

fun main(args: Array<String>) {
    val numberList = listOf(0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10)
    val newNumberList = numberList.filter { number ->
        number % 2 == 0//篩選出偶數
    }

    newNumberList.forEach { print("$it   ")}
}

複製程式碼

filterTo的操作符使用場景: 從多個集合篩選出符合條件的元素，並最終用一個集合進行收集從每個集合篩選出的元素。

fun main(args: Array<String>) {
    val numberList1 = listOf(23, 65, 14, 57, 99, 123, 26, 15, 88, 37, 56)
    val numberList2 = listOf(13, 55, 24, 67, 93, 137, 216, 115, 828, 317, 16)
    val numberList3 = listOf(20, 45, 19, 7, 9, 3, 26, 5, 38, 75, 46)
    
    //需要注意一點的是，我們從原始碼看到filterTo第一個引數destination是一個可變集合型別，所以這裡使用的mutableListOf初始化
    val newNumberList = mutableListOf<Int>().apply {
        numberList1.filterTo(this) {
            it % 2 == 0
        }
        numberList2.filterTo(this) {
            it % 2 == 0
        }
        numberList3.filterTo(this) {
            it % 2 == 0
        }
    }

    print("從三個集合篩選出的偶數集合: ")
    newNumberList.forEach {
        print("$it   ")
    }
}
複製程式碼

filterIndexed和filterIndexedTo操作符

• 1、基本定義:

filterIndexed操作符定義和filter幾乎是一樣的。他們之前唯一的區別是filterIndexed篩選條件的lambda表示式多暴露一個引數那就是元素在集合中的index.也就是外部可以拿到這個元素以及這個元素的index. 特別適合需要集合元素index參與篩選條件的case。

• 2、原始碼定義:

public inline fun <T> Iterable<T>.filterIndexed(predicate: (index: Int, T) -> Boolean): List<T> {
    return filterIndexedTo(ArrayList<T>(), predicate)
}

public inline fun <T, C : MutableCollection<in T>> Iterable<T>.filterIndexedTo(destination: C, predicate: (index: Int, T) -> Boolean): C {
    forEachIndexed { index, element ->
        if (predicate(index, element)) destination.add(element)
    }
    return destination
}

public inline fun <T> Iterable<T>.forEachIndexed(action: (index: Int, T) -> Unit): Unit {
    var index = 0
    for (item in this) action(index++, item)
}

複製程式碼

• 3、原始碼解析:

首先，要了解filterIndexed實現原理還需要涉及兩個操作符: filterIndexedTo、forEachIndexed。從整體上可以看出filterIndexed是一個Iterable<T>的擴充套件函式並且是一個行內函數，該函式接收一個以接收Int型別和接收T型別兩個引數返回一個Boolean型別的lambda表示式predicate作為引數，所以它還是一個高階函式，返回一個List<T>集合。

然後，大部分實現的原理和filter類似，filterIndexedTo和filterIndexed類似，唯一可以說下的就是index，index實際上是forEachIndexed內部的一個迭代自增計數器，可以在內部每次迭代，就會計數器就會自增一次,並且把這個index回撥到外部。

• 4、使用場景:

fun main(args: Array<String>) {
    val numberList = listOf(0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10)

    val newNumberList = numberList.filterIndexed { index, number ->
        index < 5 && number % 2 == 0 //篩選出集合中前五個元素中是偶數的數
    }

    newNumberList.forEach {
        print("$it  ")
    }
}
複製程式碼

filterIsInstance和filterIsInstanceTo操作符

• 1、基本定義

filterIsInstance操作符是filter操作符一個特定應用，從集合中篩選出instance某個特定型別元素並把該元素強轉成該型別，最後返回這些元素集合。

• 2、原始碼定義

public inline fun <reified R> Iterable<*>.filterIsInstance(): List<@kotlin.internal.NoInfer R> {
    return filterIsInstanceTo(ArrayList<R>())
}

public inline fun <reified R, C : MutableCollection<in R>> Iterable<*>.filterIsInstanceTo(destination: C): C {
    for (element in this) if (element is R) destination.add(element)
    return destination
}
複製程式碼

• 3、原始碼解析

首先，filterIsInstance是一個擴充套件函式，它的主要實現是藉助於filterIsInstanceTo，通過外部傳入的R泛型，建立一個R泛型的ArrayList可變集合，用於收集原集合中instance R型別的元素.可以看出在filterIsInstanceTo內部是遍歷集合然後利用is判斷屬於R型別的元素就加入到集合中，最後返回該集合。

• 4、使用場景

filterInstance使用場景: 適用於一個抽象類集合中還有多種子型別的元素，可以很方便篩選對應子型別的元素，並組成一個集合返回。

filterInstanceTo使用場景: 基本作用和filterInstance一致，不過唯一的區別就是這個可變集合ArrayList<R>不是在內部建立，而是由外部建立，非常適合篩選多個集合的情況。

下面看個例子，我們來看下不使用filterInstance和使用filterInstance情況對比。

沒有使用filterInstance，而是使用filter和map集合相結合。(當你不知道有filterInstance操作符，估計很多都是這種實現的)

abstract class Animal(var name: String, var age: Int){
    abstract fun eatFood(): String
}
class Bird(name: String, age: Int): Animal(name, age){
    override fun eatFood() = "bird eat worm"
}
class Cat(name: String, age: Int) : Animal(name, age) {
    override fun eatFood() = "Cat eat Fish"
}
class Dog(name: String, age: Int) : Animal(name, age) {
    override fun eatFood() = "dog eat bone"
}

fun main(args: Array<String>) {
    val animalList: List<Animal> = listOf(Bird(name = "Bird1", age = 12),
            Cat(name = "Cat1", age = 18),
            Cat(name = "Cat3", age = 20),
            Dog(name = "Dog2", age = 8),
            Cat(name = "Cat2", age = 8),
            Bird(name = "Bird2", age = 14),
            Bird(name = "Bird3", age = 16),
            Dog(name = "Dog1", age = 18)
    )

    //篩選出個所有Dog的資訊，藉助filter和map操作符
    animalList.filter {
        it is Dog
    }.map {
        it as Dog
    }.forEach {
        println("${it.name} is ${it.age} years old, and ${it.eatFood()}")
    }
}
複製程式碼

使用filterInstance操作符實現

fun main(args: Array<String>) {
    val animalList: List<Animal> = listOf(Bird(name = "Bird1", age = 12),
            Cat(name = "Cat1", age = 18),
            Cat(name = "Cat3", age = 20),
            Dog(name = "Dog2", age = 8),
            Cat(name = "Cat2", age = 8),
            Bird(name = "Bird2", age = 14),
            Bird(name = "Bird3", age = 16),
            Dog(name = "Dog1", age = 18)
    )

    //篩選出個所有Dog的資訊，藉助filterIsInstance操作符
    animalList.filterIsInstance<Dog>().forEach { println("${it.name} is ${it.age} years old, and ${it.eatFood()}") }
}
複製程式碼

filterNot和filterNotTo操作符

• 1、基本定義

從一個集合篩選出符合條件之外的元素，並以一個新集合返回，它是filter操作符取反操作。

• 2、原始碼定義

public inline fun <T> Iterable<T>.filterNot(predicate: (T) -> Boolean): List<T> {
    return filterNotTo(ArrayList<T>(), predicate)
}
public inline fun <T, C : MutableCollection<in T>> Iterable<T>.filterNotTo(destination: C, predicate: (T) -> Boolean): C {
    for (element in this) if (!predicate(element)) destination.add(element)
    return destination
}
複製程式碼

• 3、原始碼解析

實際上filterNot沒什麼可說的，它也是藉助於filterNotTo操作具體，和filterTo唯一區別就是判斷條件取反

• 4、原理圖解

• 5、使用場景

使用場景就是filter使用的取反條件使用，當然你也可以繼續使用filter操作符，並且篩選條件為取反條件。

filterNotNull和filterNotNullTo操作符

• 1、基本定義

filterNotNull操作符可以過濾集合中為null的元素,那麼同理filterNotNullTo才是真正過濾操作，但是需要從外部傳入一個可變集合。

• 2、原始碼定義

public fun <T : Any> Iterable<T?>.filterNotNull(): List<T> {
    return filterNotNullTo(ArrayList<T>())
}

public fun <C : MutableCollection<in T>, T : Any> Iterable<T?>.filterNotNullTo(destination: C): C {
    for (element in this) if (element != null) destination.add(element)
    return destination
}
複製程式碼

• 3、原始碼解析

filterNotNull是集合的擴充套件函式，該集合中的元素是可null的T泛型，那麼這個篩選條件也就是判斷是否為null,篩選條件內部確定好的。filterNotNull還是繼續傳入一個可變集合，然後在filterNotNullTo內部判斷把null的元素直接過濾，其他元素就會被加入傳入的可變集合中。

• 4、使用場景

filterNotNull操作符使用場景: 一般用於過濾掉集合中為null的元素，最後返回一個不含null的元素集合。

filterNotNullTo操作符使用場景: 一般在外部傳入一個可變的集合，然後過濾多個集合中為null的元素，最後將這些元素放入可變集合中，並返回這個集合。

fun main(args: Array<String>) {
    val animalList: List<Animal?> = listOf(Bird(name = "Bird1", age = 12),
            Cat(name = "Cat1", age = 18),
            Cat(name = "Cat3", age = 20),
            Dog(name = "Dog2", age = 8),
            null,
            Bird(name = "Bird2", age = 14),
           null,
            Dog(name = "Dog1", age = 18)
    )

    animalList.filterNotNull().forEach { println("${it.name} is ${it.age} years old and it ${it.eatFood()}") }
}
複製程式碼

drop操作符

• 1、基本定義

根據傳入數值n，表示從左到右順序地刪除n個集合中的元素，並返回集合中剩餘的元素。

• 2、原始碼定義

public fun <T> Iterable<T>.drop(n: Int): List<T> {
    require(n >= 0) { "Requested element count $n is less than zero." }
    if (n == 0) return toList()//要刪除元素為0，說明剩餘元素集合正好取整個集合
    val list: ArrayList<T>//宣告一個可變集合
    if (this is Collection<*>) {//如果原集合是一個只讀的Collection或者其子類，那麼原集合的size是可確定的，那麼建立新集合size是可以做差計算得到的
        val resultSize = size - n//拿原集合的size與起始下標做差值確定最終返回的集合的大小resultSize
        if (resultSize <= 0)//集合的size小於或等於0直接返回空集合
            return emptyList()
        if (resultSize == 1)//resultSize等於1說明就直接返回原集合的最後一個元素
            return listOf(last())
        list = ArrayList<T>(resultSize)//建立resultSize大小的可變集合
        if (this is List<T>) {
            if (this is RandomAccess) {//RandomAccess是一個集合標記介面,如果集合類是RandomAccess的實現，則儘量用index下標 來遍歷而不要用Iterator迭代器來遍歷，在效率上要差一些。反過來，如果List是Sequence List，則最好用迭代器來進行迭代。
                for (index in n until size)//採用下標遍歷
                    list.add(this[index])
            } else {
                for (item in listIterator(n))//採用迭代器遍歷
                    list.add(item)
            }
            return list
        }
    }
    else {//如果原集合是一個可變的集合，那麼就無法通過計算確切的新集合的size。
        list = ArrayList<T>()
    }
    var count = 0
    for (item in this) {
        if (count++ >= n) list.add(item)//對於可變集合通過遍歷，計數累加的方式，當計數器超過起始下標就開始往集合中新增元素。
    }
    return list.optimizeReadOnlyList()
}
複製程式碼

• 3、原理圖解

• 4、使用場景 drop操作符一般是適用於把集合元素去除一部分，drop是順序的刪除，n則表示順序刪除幾個元素，最後返回剩餘元素集合

fun main(args: Array<String>) {
    val numberList = listOf(1, 2, 3, 4, 5, 6, 7, 8, 9)
    numberList.drop(5).forEach { print("$it   ") }
}
複製程式碼

dropLast操作符

• 1、基本定義

根據傳入數值n，表示從右到左倒序地刪除n個集合中的元素，並返回集合中剩餘的元素。

• 2、原始碼定義

public fun <T> List<T>.dropLast(n: Int): List<T> {
    require(n >= 0) { "Requested element count $n is less than zero." }
    return take((size - n).coerceAtLeast(0))//這裡應該是this.take(),this指代List,然後傳入(size - n)必須滿足大於或等於0
}

//這是一個Int型別的擴充套件函式，用於判斷某個值是否大於傳入預設最小值，如果大於就直接返回這個值，否則返回這個預設最小值
public fun Int.coerceAtLeast(minimumValue: Int): Int {
    return if (this < minimumValue) minimumValue else this
}

//take也是一種操作符
public fun <T> Iterable<T>.take(n: Int): List<T> {
    require(n >= 0) { "Requested element count $n is less than zero." }
    if (n == 0) return emptyList()//這裡n 實際上是size - dropLast傳入n的差值，n為0表示dropLast傳入n為原集合size,相當於刪除原集合size個數元素，那麼剩下就是空集合了
    if (this is Collection<T>) {//如果是一個只讀型別集合，就可以確定該集合的size
        if (n >= size) return toList()//如果這裡n等於size表示dropLast傳入n為0，那麼表示刪除集合元素個數為0,那麼剩下來就是整個原集合了
        if (n == 1) return listOf(first())//如果n等於1，表示dropLasr傳入n為size-1,那麼表示刪除集合個數size-1個，由於刪除順序是倒序的，自然原集合剩下的元素就是第一個元素了。
    }
    //以下是針對this是一個可變集合，由於可變集合的size不太好確定，所以採用另一方式實現dropLast功能。
    var count = 0
    val list = ArrayList<T>(n)//建立剩餘集合元素size大小n的可變集合
    for (item in this) {//由於是從右到左遞增刪除的，取剩餘，現在是採用逆向方式，從左到右加入新的集合中，一直等待count計數器自增到n為止。
        if (count++ == n)
            break
        list.add(item)
    }
    return list.optimizeReadOnlyList()
}

複製程式碼

• 3、原理圖解

• 4、使用場景

使用的場景和drop相反，但是整體作用和drop類似。

fun main(args: Array<String>) {
    val strList = listOf("kotlin", "java", "javaScript", "C", "C++", "python", "Swift", "Go", "Scala")
    strList.dropLast(3).forEach { print("$it   ") }
}
複製程式碼

dropWhile操作符

• 1、基本定義

從集合的第一項開始去掉滿足條件元素，這樣操作一直持續到出現第一個不滿足條件元素出現為止，返回剩餘元素(可能剩餘元素有滿足條件的元素)

• 2、原始碼定義

public inline fun <T> Iterable<T>.dropWhile(predicate: (T) -> Boolean): List<T> {
    var yielding = false//初始化標誌位false
    val list = ArrayList<T>()//建立一個新的可變集合
    for (item in this)//遍歷原集合
        if (yielding)//該標誌一直為false直到，不符合lambda表示式外部傳入條件時，該標記為置為true,才開始往新集合新增元素
            list.add(item)
        else if (!predicate(item)) {//判斷不符合外部傳入的條件，才開始往新集合新增元素，標記置為true，
        //這樣就滿足了需求，一開始符合條件元素不會被新增到新集合中，不符合條件才開始加入新集合，這樣產生新集合相對於原集合而言也就是刪除符合條件元素直到出現不符合條件的為止
            list.add(item)
            yielding = true
        }
    return list
}
複製程式碼

• 3、原理圖解

• 4、使用場景

適用於去掉集合中前半部分具有相同特徵的元素場景。

fun main(args: Array<String>) {
    val strList = listOf("java", "javaScript", "kotlin", "C", "C++", "javaFx","python", "Swift", "Go", "Scala")
    strList.dropWhile { it.startsWith("java") }.forEach { print("$it  ") }
}
複製程式碼

dropLastWhile操作符

• 1、基本定義

從集合的最後一項開始去掉滿足條件元素，這樣操作一直持續到出現第一個不滿足條件元素出現為止，返回剩餘元素(可能剩餘元素有滿足條件的元素)

• 2、原始碼定義

public inline fun <T> List<T>.dropLastWhile(predicate: (T) -> Boolean): List<T> {
    if (!isEmpty()) {
        val iterator = listIterator(size)//表示從原集合尾部開始向頭部迭代
        while (iterator.hasPrevious()) {//當前元素存在上一個元素進入迭代
            if (!predicate(iterator.previous())) {//直到出現上一個元素不符合條件，才開始取相應後續元素，加入到新集合中
                return take(iterator.nextIndex() + 1)
            }
        }
    }
    return emptyList()
}
複製程式碼

• 3、原理圖解

• 4、使用場景

使用的場景和dropWhile類似，不過刪除元素順序不一樣

fun main(args: Array<String>) {
    val strList = listOf("java", "javaScript", "kotlin", "C", "C++", "javaFx", "python","Go", "Swift", "Scala")
    strList.dropLastWhile { it.startsWith("S") }.forEach { print("$it  ") }
}
複製程式碼

take操作符

• 1、基本定義

從原集合的第一項開始順序取集合的元素，取n個元素，最後返回取出這些元素的集合。換句話說就是取集合前n個元素組成新的集合返回。

• 2、原始碼定義

public fun <T> Iterable<T>.take(n: Int): List<T> {
    require(n >= 0) { "Requested element count $n is less than zero." }
    if (n == 0) return emptyList()//n為0表示取0個元素的集合，返回空集合
    if (this is Collection<T>) {//如果是隻讀集合，可確定集合的size
        if (n >= size) return toList()//如果要取元素集合大小大於或等於原集合大小那麼就直接返回原集合
        if (n == 1) return listOf(first())//從第一項開始取1個元素，所以就是集合的first()
    }
    var count = 0
    val list = ArrayList<T>(n)//建立一個n大小可變集合
    for (item in this) {//遍歷原集合
        if (count++ == n)//自增計數器count大小超過要取元素個數，就跳出迴圈
            break
        list.add(item)
    }
    return list.optimizeReadOnlyList()
}
複製程式碼

• 3、原理圖解

• 4、使用場景

適用於順序從第一項開始取集合中子集合

fun main(args: Array<String>) {
    val strList = listOf("java", "javaScript", "kotlin", "C", "C++", "javaFx", "python","Go", "Swift", "Scala")
    strList.take(2).forEach { print("$it ") }
}
複製程式碼

takeLast操作符

• 1、基本定義

從原集合的最後一項開始倒序取集合的元素，取n個元素，最後返回取出這些元素的集合。

• 2、原始碼定義

public fun <T> List<T>.takeLast(n: Int): List<T> {
    require(n >= 0) { "Requested element count $n is less than zero." }
    if (n == 0) return emptyList()//n為0表示取0個元素的集合，返回空集合
    val size = size
    if (n >= size) return toList()//如果取的元素集合大小大於size直接返回整個集合
    if (n == 1) return listOf(last())//從最後一項開始取1個元素，自然就是返回last()
    val list = ArrayList<T>(n)//建立一個n大小的可變集合
    if (this is RandomAccess) {//RandomAccess是一個集合標記介面,如果集合類是RandomAccess的實現，則儘量用index下標 來遍歷而不要用Iterator迭代器來遍歷，在效率上要差一些。反過來，如果List是Sequence List，則最好用迭代器來進行迭代。
        for (index in size - n until size)//採用下邊遍歷
            list.add(this[index])
    } else {
        for (item in listIterator(size - n))//採用迭代器遍歷
            list.add(item)
    }
    return list
}
複製程式碼

• 3、原理圖解

• 4、使用場景

適用於倒序從最後一項開始取集合中子集合

fun main(args: Array<String>) {
    val strList = listOf("java", "javaScript", "kotlin", "C", "C++", "javaFx", "python","Go", "Swift", "Scala")
    strList.takeLast(2).forEach { print("$it ") }
}
複製程式碼

takeLastWhile操作符

• 1、基本定義

從集合的最後一項開始取出滿足條件元素，這樣操作一直持續到出現第一個不滿足條件元素出現為止，暫停取元素，返回取出元素的集合。

• 2、原始碼定義

public inline fun <T> List<T>.takeLastWhile(predicate: (T) -> Boolean): List<T> {
    if (isEmpty())//如果當前集合是一個空的，那麼直接返回空集合
        return emptyList()
    val iterator = listIterator(size)//表示從集合index = size開始迭代,那麼size - 1也是最後一個元素，也即是迭代器的previous,也就是從集合尾部開始向頭部迭代
    while (iterator.hasPrevious()) {//含有上一個元素的元素繼續進入迭代
        if (!predicate(iterator.previous())) {//直到某個元素的前一個元素不符合條件，也是從最後一項開始遇到第一個不符合條件的元素，不進入以下操作
            iterator.next()
            val expectedSize = size - iterator.nextIndex()//由於從尾部開始迭代，那麼符合條件元素集合的expectedSize等於原集合size與當前下一個元素的index的差值
            if (expectedSize == 0) return emptyList()//差值為0的話說明，在原集合尾部開始迭代就不符合條件被終止，所以返回空集合
            return ArrayList<T>(expectedSize).apply {//拿到符合條件元素集合size，建立expectedSize大小新集合，並把迭代器中的元素遍歷加入到新集合中
                while (iterator.hasNext())
                    add(iterator.next())
            }
        }
    }
    return toList()
}
複製程式碼

• 3、原始碼解析

takeLastWhile操作符是一個集合的擴充套件行內函數，也是一個高階函式，它接收一個以接收T泛型引數返回一個Boolean型別的Lambda表示式，也是即是takeLastWhile取元素的條件的實現。

• 4、原理圖解

• 5、使用場景

適用於取出集合中後半部分具有相同特徵的元素場景。

fun main(args: Array<String>) {
    val strList = listOf("java", "javaScript", "kotlin", "C", "C++", "javaFx", "python","Go", "Swift", "Scala")
    strList.takeLastWhile { it.startsWith("S") }.forEach { print("$it ") }
}
複製程式碼

takeWhile操作符

• 1、基本定義

從集合的第一項開始取出滿足條件元素，這樣操作一直持續到出現第一個不滿足條件元素出現為止，暫停取元素，返回取出元素的集合。

• 2、原始碼定義

public inline fun <T> Iterable<T>.takeWhile(predicate: (T) -> Boolean): List<T> {
    val list = ArrayList<T>()//建立一個可變集合
    for (item in this) {//遍歷原集合
        if (!predicate(item))//不符合傳入條件就直接跳出訓練
            break
        list.add(item)//符合條件的直接加入到新集合
    }
    return list//最後返回新集合
}
複製程式碼

• 3、原始碼解析

takeWhile操作符是一個集合的擴充套件行內函數，也是一個高階函式，它接收一個以接收T泛型引數返回一個Boolean型別的Lambda表示式，也是即是takeWhile取元素的條件的實現。遍歷整個原集合，符合條件的加入到新集合中，一旦遇到不符合條件元素直接跳出迴圈，也就是遇到第一個不符合條件的就終止取元素的操作，最後返回這個新集合。

• 4、原理圖解

• 5、使用場景

適用於取出集合中前半部分具有相同特徵的元素場景。

fun main(args: Array<String>) {
    val strList = listOf("java", "javaScript", "kotlin", "C", "C++", "javaFx", "python","Go", "Swift", "Scala")
    strList.takeWhile { it.startsWith("java") }.forEach { print("$it ") }
}
複製程式碼

最後，由於文章篇幅有限，上篇只詳細解析了過濾類的函式式API操作符，在下篇會繼續接著解析其他幾類操作符，歡迎持續關注~~~

歡迎關注Kotlin開發者聯盟，這裡有最新Kotlin技術文章，每週會不定期翻譯一篇Kotlin國外技術文章。如果你也喜歡Kotlin，歡迎加入我們~~~