摘要：項(xiàng)目實(shí)戰(zhàn)教程第章擴(kuò)展函數(shù)與屬性在使用的時(shí)候，我們經(jīng)常使用諸如等等一堆工具類，代碼寫起來也比較冗長。本章我們介紹的擴(kuò)展函數(shù)和屬性。擴(kuò)展函數(shù)中提供了非常簡(jiǎn)單使用的擴(kuò)展函數(shù)功能。

《Kotlin 項(xiàng)目實(shí)戰(zhàn)教程》

第6章 擴(kuò)展函數(shù)與屬性

在使用Java的時(shí)候，我們經(jīng)常使用諸如StringUtil, DateUtil等等一堆工具類，代碼寫起來也比較冗長。舉個(gè)例子，獲取一個(gè)字符串的第一個(gè)字符值、最后一個(gè)字符值。如果我們用Java代碼來寫，通常是要先聲明一個(gè)StringUtil類，然后在里面寫相應(yīng)的工具方法，代碼可以是下面的這個(gè)樣子

package com.easy.kotlin;

import static java.lang.System.out;

public class StringUtil {

    /**
     * 獲取str的第一個(gè)字符值
     *
     * @param str
     * @return
     */
    public static String firstChar(String str) {
        if (str != null && str.length() > 0) {
            return str.charAt(0) + "";
        }
        return "";
    }

    /**
     * 獲取str的最后一個(gè)字符值
     *
     * @param str
     * @return
     */
    public static String lastChar(String str) {
        if (str != null && str.length() > 0) {
            return str.charAt(str.length() - 1) + "";
        }
        return "";
    }

    public static void main(String[] args) {
        String str = "abc";
        out.println(StringUtil.firstChar(str)); // a
        out.println(StringUtil.lastChar(str)); // c
    }
}

我們可以看到 StringUtil.firstChar(str) 這樣的調(diào)用方式不夠簡(jiǎn)單直接。能不能直接這樣調(diào)用

"abc".firstChar()
"abc".lastChar()

非常遺憾的是，在Java中我們無法給String類添加一個(gè)自定義方法。因?yàn)镾tring類是JDK中內(nèi)置的基礎(chǔ)類，而且為final，不能修改。所以，Java程序員通常使用這樣的一個(gè)變通的方法：開發(fā)一個(gè)StringUtil類，在里面封裝所需要的String操作的方法。而不是修改或繼承String類。

而情況到了Kotlin里面，就完全不一樣了——我們完全可以自由擴(kuò)展任何類的方法和屬性。在不修改原類的情況下, Kotlin能給一個(gè)類擴(kuò)展新功能而無需繼承該類。

本章我們介紹Kotlin的擴(kuò)展函數(shù)和屬性。

Kotlin中提供了非常簡(jiǎn)單使用的擴(kuò)展函數(shù)功能。我們可以為現(xiàn)有的類自由添加自定義的函數(shù) 。

例如，我們現(xiàn)在給String類擴(kuò)展兩個(gè)函數(shù)：lastChar() 和 firstChar() ， 實(shí)現(xiàn)代碼如下

package com.easy.kotlin

fun String.lastChar(): String {
    if (this.length == 0) {
        return ""
    }
    return this[this.length - 1].toString()
}

fun String.firstChar(): String {
    if (this.length == 0) {
        return ""
    }
    return this[0].toString()
}

擴(kuò)展函數(shù)的語法，我們用下圖來簡(jiǎn)單說明

然后，我們就可以在代碼中直接調(diào)用了

fun main(args: Array) {
    val str = "abc"
    println(str.firstChar()) // a
    println(str.lastChar()) // c
}

如果在其他package路徑下面，需要 import 導(dǎo)入擴(kuò)展函數(shù)

package com.easy.kotlin.tutorial // 跟擴(kuò)展函數(shù)不在同一個(gè)包路徑下面

import com.easy.kotlin.firstChar // 導(dǎo)入擴(kuò)展函數(shù) firstChar
import com.easy.kotlin.lastChar// 導(dǎo)入擴(kuò)展函數(shù) lastChar

fun main(args: Array) {
    val str = "abc"
    str.firstChar() // 這樣的調(diào)用方式要比 StringUtil.firstChar(str) 簡(jiǎn)單優(yōu)雅許多
    str.lastChar() 
}

在上一章中我們介紹過List的filter函數(shù)。那么這個(gè) filter 函數(shù)是怎樣實(shí)現(xiàn)的呢？ 如果我們自己來給List類擴(kuò)展一個(gè)過濾函數(shù)，應(yīng)該怎樣去做呢？下面我們就來介紹。

為了更加深刻體會(huì)到 Kotlin 擴(kuò)展功能的簡(jiǎn)單優(yōu)雅性，我們先來看看在Java中是怎樣實(shí)現(xiàn)的吧！首先，我們會(huì)去聲明一個(gè)ListUtil 類，里面實(shí)現(xiàn)一個(gè) List filter(List list, Predicate p) 方法，代碼如下

public class ListUtil {
  /**
   * 根據(jù)謂詞p 過濾 list 中的元素
   *
   * @param list
   * @param p
   * @return
   */
  public List filter(List list, Predicate p) {
      List result = new ArrayList<>();
      for (T t : list) {
          if (p.predicate(t)) {
              result.add(t);
          }
      }
      return result;
  }
}

其中，Predicate 接口聲明如下

interface Predicate {
    Boolean predicate(T t);
}

然后，我們?cè)诖a中這樣使用這個(gè) filter 方法

    public static void main(String[] args) {
        List list = Arrays.asList(new Integer[] {1, 2, 3, 4, 5, 6, 7});
        ListUtil listUtil = new ListUtil(); // 聲明ListUtil對(duì)象
        List result = listUtil.filter(list, (it) -> it % 2 == 1); // lambda 表達(dá)式
        out.println(result); // [1, 3, 5, 7]
    }

為了調(diào)用 filter 方法，我們還要聲明一個(gè)ListUtil對(duì)象，費(fèi)事。能不能直接像下面這樣調(diào)用?

list.filter { it % 2 == 1 }

答案是肯定的，只不過是在Kotlin中，而不是在Java中。

我們就來使用Kotlin的擴(kuò)展函數(shù)為List擴(kuò)展一個(gè)filter函數(shù)，代碼如下

fun  List.filter(predicate: (T) -> Boolean): MutableList {
    val result = ArrayList()
    this.forEach {
        if (predicate(it)) {
            result.add(it)
        }
    }
    return result
}

這個(gè)函數(shù)的簽名稍微有點(diǎn)復(fù)雜，我們用下圖來形象化地簡(jiǎn)單說明

然后，我們?cè)诖a中只需要這樣調(diào)用即可

    val list = mutableListOf(1, 2, 3, 4, 5, 6, 7)
    val result = list.filter {
        it % 2 == 1
    }
    println(result) // [1, 3, 5, 7]

Kotlin的標(biāo)準(zhǔn)庫API中使用擴(kuò)展的功能，通過擴(kuò)展Java的API，提供了大量的實(shí)用簡(jiǎn)單的函數(shù)。我們將在后面的關(guān)于文件IO、正則表達(dá)式、多線程等相關(guān)主題中介紹。

除了擴(kuò)展一個(gè)類的函數(shù)，我們還可以擴(kuò)展類屬性。例如，我們給 MutableList 擴(kuò)展兩個(gè)屬性：firstElement 和 lastElement ， 實(shí)現(xiàn)代碼如下

var  MutableList.firstElement: T
    get() {
        return this[0]
    }
    set(value) {
        this[0] = value
    }

var  MutableList.lastElement: T
    get() {
        return this[this.size - 1]
    }
    set(value) {
        this[this.size - 1] = value
    }

上面的代碼中的擴(kuò)展屬性的語法說明如下圖所示

然后，我們就可以在代碼中直接使用擴(kuò)展的屬性了

    val list = mutableListOf(1, 2, 3, 4, 5, 6, 7)

    println("list = ${list}") // list = [1, 2, 3, 4, 5, 6, 7]
    println(list.firstElement) // 調(diào)用getter 函數(shù) ， 值是 1
    println(list.lastElement) // 7

    list.firstElement = -1 // 調(diào)用 setter 函數(shù)
    list.lastElement = -7

    println("list = ${list}") // list = [-1, 2, 3, 4, 5, 6, -7]
    println(list.firstElement) // -1
    println(list.lastElement) // -7

擴(kuò)展屬性允許定義在類或者kotlin文件中，不允許定義在函數(shù)中。

我們有注意到，在上面的List的擴(kuò)展函數(shù)filter的實(shí)現(xiàn)中，我們有用到一個(gè)this關(guān)鍵字

    this.forEach {
        if (predicate(it)) {
            result.add(it)
        }
    }

這里的 this 指的是 接收者對(duì)象(receiver object)， 也就是調(diào)用擴(kuò)展函數(shù)時(shí), 在點(diǎn)號(hào)（ . ）之前指定的對(duì)象實(shí)例。