Kotlin学习笔记（8）- 扩展

2017-06-03 本文已影响753人我爱吃栗子啊

系列文章全部为本人的学习笔记，若有任何不妥之处，随时欢迎拍砖指正。如果你觉得我的文章对你有用，欢迎关注我，我们一起学习进步！
Kotlin学习笔记（1）- 环境配置
 Kotlin学习笔记（2）- 空安全
 Kotlin学习笔记（3）- 语法
 Kotlin学习笔记（4）- 流程控制
 Kotlin学习笔记（5）- 类
 Kotlin学习笔记（6）- 属性
 Kotlin学习笔记（7）- 接口
 Kotlin学习笔记（8）- 扩展
 Kotlin学习笔记（8）- 扩展（续）
Kotlin学习笔记（9）- 数据类
 Kotlin学习笔记（10）- 泛型
 Kotlin学习笔记（11）- 内部类和嵌套类
 Kotlin学习笔记（12）- 委托
 Kotlin学习笔记（13）- 函数式编程
 Kotlin学习笔记（14）- lambda

今天要开始学习扩展（Extension）了，扩展是kotlin中非常重要的一个特性，它能让我们对一些已有的类进行功能增加、简化，使他们更好的应对我们的需求。这么说可能有点枯燥，我们先来看一个小栗子。

//  对Context的扩展，增加了toast方法。为了更好的看到效果，我还加了一段log日志
fun Context.toast(msg : String){
    Toast.makeText(this, msg, Toast.LENGTH_SHORT).show()
    Log.d("text", "Toast msg : $msg")
}

// Activity类，由于所有Activity都是Context的子类，所以可以直接使用扩展的toast方法
class MainActivity : AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        ......
        toast("hello, Extension")
    }
}

// 输出
Toast msg : hello, Extension

怎么样，有没有一点小激动，反正我是有的。按照通常的做法，我们会写一个ToastUtils工具类，或者在BaseActivity中实现toast方法，但是现在这些统统不需要了，直接给Context增加扩展，这样不论是Activity或者Service都可以直接调用，更简洁、更优雅。接下来是我的学习进程，希望也能对你有所帮助。

一、扩展方法（Extension Function）

扩展方法，顾名思义，就是对类的方法进行扩展，写法和定义方法类似，但是要声明目标类，也就是对哪个类进行扩展，kotlin中称之为Top Level。就比如上面的栗子。

fun Context.toast(msg : String){
    Toast.makeText(this, msg, Toast.LENGTH_SHORT).show()
    Log.d("text", "Toast msg : $msg")
}

其中，Context就是目标类（Top Level），我们把它放到方法名前，用点.表示从属关系。在方法体中，用关键字this对本体进行调用。和普通方法一样，如果有返回值，在方法后面跟上返回类型，我这里没有返回值，所以直接省略了。

还有一点很神奇的是，我们可以允许目标类接受null。不是说对null进行扩展，而是可以设置目标类为一个可以为空的对象。再举一个栗子，也是我们很常用的功能：

fun Any?.string() : String = if(this == null) "null obj" else toString()

var a = 1
toast("hello, ${a.string()}")
var b : View? = null
toast("hello, ${b.string()}")

// 输出
Toast msg : hello, 1
Toast msg : hello, null obj

在这里我们对Any进行扩展，它在konlin中类似于java中的Object，所有的类都继承与它，我们给它扩展了一个string()方法。还记得吗，类型后面跟问号?表示可为空。在这里当目标为null时，我们返回了一个字符串，看一下调用，再看一下输出，完全和预想的一样。

kotlin中其实已经默认对toString方法进行了处理，如果是空，则会返回字符串null。这其实很多时候不符合我们的需求，我们可以自己扩展一下，将返回值改为空字符串就好。
fun Any?.string() : String = if(this == null) "" else toString()

二、扩展属性（extension property）

扩展属性和扩展方法类似，是对目标类的属性进行扩展。扩展属性也会有set和get方法，并且要求实现这两个方法，不然会提示编译错误。因为扩展并不是在目标类上增加了这个属性，所以目标类其实是不持有这个属性的，我们通过get和set对这个属性进行读写操作的时候也不能使用field指代属性本体。可以使用this，依然表示的目标类。

// 扩展了一个属性paddingH
var View.panddingH : Int
    get() = (paddingLeft + paddingRight) / 2
    set(value) {
        setPadding(value, paddingTop, value, paddingBottom)
    }

// 设置值
text.panddingH = 100

在栗子中，我们首先给View扩展了一个属性paddingH，并给属性增加了set和get方法，然后再activity中通过textview调用。

三、静态扩展

kotlin中的静态用关键字companion表示，而且它不是修饰属性或方法，而是定义一个方法块，在方法块中的所有方法和属性都是静态的，这样就将静态部分统一包装了起来。静态部分的访问和java一致，直接使用类名+静态属性/方法名就可以
```
// 定义静态部分
class Extension {
    companion object part{
        var name = "Extension"
    }
}

// 通过类名+属性名直接调用
toast("hello, ${Extension.name}")

// 输出
Toast msg : hello, Extension
```
上面栗子中，companion object一起是修饰关键字，part是方法块的名称。其中，方法块名称part可以省略，如果省略的话，默认缺省名为Companion

静态的扩展和普通的扩展类似，但是在目标类要加上静态方法块的名称，所以如果我们要对一个静态部分扩展，就要先知道静态方法块的名称才行。

class Extension {
    companion object part{
        var name = "Extension"
    }
}

// part为静态方法块名称
fun Extension.part.upCase() : String{
    return name.toUpperCase()
}

// 调用一下
toast("hello, ${Extension.name}")
toast("hello, ${Extension.upCase()}")

//输出
Toast msg : hello, Extension
Toast msg : hello, EXTENSION

四、引用

在AS中，如果我们使用扩展方法和扩展属性，大部分情况下会自动提示导入import，但有时候如果没有提示，就需要手动import一下了。扩展的import路径为：包名+方法名/属性名，比如我最先创建的扩展方法toast，其实文件全部是这样的

package com.study.jcking.weatherkotlin.exec

import android.content.Context
import android.util.Log
import android.widget.Toast

/**
 * Created by Jcking on 2017/6/3.
 */
fun Context.toast(msg : String){
    Toast.makeText(this, msg, Toast.LENGTH_SHORT).show()
    Log.d("text", "Toast msg : $msg")
}

可见，toast方法没有在类内部，而是与包名同级，当然这不是绝对，只是习惯这样写，那我们引用的时候就这样写import

import com.study.jcking.weatherkotlin.exec.toast

五、最后

以上就是个人学习扩展的一些总结，东西不多，但是感觉是kotlin中很重要的一部分。他让我们的代码更简洁，更优雅，而且功能定位更准确、更清晰。再有，就是感觉一大波util要下岗了~

最后抛出个问题，暂时还没有搞明白，希望小伙伴们帮我解惑：如果我将扩展没有放在包名同级，而是放在一个类的内部，在语法上是完全没有问题的，但是类外部调用却好像不行了。请问是它失去了对外部的可见性，还是我的调用方式有问题？欢迎讨论指教，先行谢过！！

更新：2017年6月4日
问题已经找到资料了，确实是不行的，请看我下一篇笔记： Kotlin学习笔记（8）- 扩展（续）

Extension类，包package com.study.jcking.weatherkotlin.exec

package com.study.jcking.weatherkotlin.exec

class Extension {
    companion object part{
        var name = "Extension"
    }

    fun Context.toast(msg : String){
        Toast.makeText(this, msg, Toast.LENGTH_SHORT).show()
        Log.d("text", "Toast msg : $msg")
    }
}

调用类，包package com.study.jcking.weatherkotlin

package com.study.jcking.weatherkotlin

class MainActivity : AppCompatActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)
        toast("hello, ${Extension.upCase()}")       // 这里toast报错，编译错误，无法调用
    }
}