Kotlin类与对象篇(2)--属性和域(Field)

欢迎关注二师兄Kotlin
转载请注明出处二师兄kotlin

属性声明

使用Kotlin语言，类可以有若干属性，它们可以是可变的（var），可也以是只读的（val）.

class Address {
    var name: String = ...
    var street: String = ...
    var city: String = ...
    var state: String? = ...
    var zip: String = ...
}

要使用一个属性，我们简单地通过名称引用它，就好像它是Java中的一个字段：

fun copyAddress(address: Address): Address {
    val result = Address() // there's no 'new' keyword in Kotlin
    result.name = address.name // accessors are called
    result.street = address.street
    // ...
    return result
}

Getter和Setter

声明一个属性的完整语法是：

var <propertyName>[: <PropertyType>] [= <property_initializer>]
    [<getter>]
    [<setter>]

属性的初始化、getter方法和setter方法都是可选的。如果存在属性的初始化操作，则属性的类型在可以被推断出来（或从getter返回的类型进行推断）的时候也是可以省略的：

var allByDefault: Int? // error: explicit initializer required, default getter and setter implied
var initialized = 1 // has type Int, default getter and setter

只读属性的声明方式和可变属性的声明方式有两点不同：前者以val开头，后者以var开头；前者不允许有setter方法：

val simple: Int? // has type Int, default getter, must be initialized in constructor
val inferredType = 1 // has type Int and a default getter

我们可以在一个属性声明中写出自定义访问器，与普通函数非常类似。以下是一个自定义getter的例子：

val isEmpty: Boolean
    get() = this.size == 0

一个自定义setter的例子如下：

var stringRepresentation: String
    get() = this.toString()
    set(value) {
        setDataFromString(value) // parses the string and assigns values to other properties
    }

按照惯例，setter方法的参数名称是value，但若你喜欢，可以选择其他的名称。
从Kotlin 1.1开始，如果可以通过getter方法推断出属性的类型，则属性的类型也可以省略：

val isEmpty get() = this.size == 0  // has type Boolean

如果需要改变访问器的可见性或注解它，不必改变默认的实现，只需要定义一个无方法体的访问器即可：

var setterVisibility: String = "abc"
    private set // the setter is private and has the default implementation

var setterWithAnnotation: Any? = null
    @Inject set // annotate the setter with Inject

隐藏域（Backing Fields）

域(Fields)在Kotlin中无法直接声明。但是，当属性需要一个隐藏域时，Kotin会自动为你提供。隐藏域可以用field标识符，在访问器中进行引用访问。

var counter = 0 // the initializer value is written directly to the backing field
    set(value) {
        if (value >= 0) field = value
    }

field标识符只能在访问器中进行使用。

如果属性 get/set 方法中的任何一个使用了默认实现, 或者在 get/set 方法的自定义实现中通过 field 标识符访问属性, 那么编译器就会为属性自动生成隐藏域变量.

比如，下面的情况不会存在隐藏域变量：

val isEmpty: Boolean
    get() = this.size == 0

PS:关于隐藏属性想了解更多可以看这里backing field

隐藏属性(Backing Property)

如果你希望实现的功能无法通过这种 “隐含的域变量” 方案来解决, 你可以使用隐藏属性(backing property) 作为替代方案：

private var _table: Map<String, Int>? = null
public val table: Map<String, Int>
    get() {
        if (_table == null) {
            _table = HashMap() // Type parameters are inferred
        }
        return _table ?: throw AssertionError("Set to null by another thread")
    }

不管从哪方面看, 这种方案都与 Java 中完全相同, 因为隐藏私有属性的取值方法与设值方法都使用默认实现, 我们对这个属性的访问将被编译器优化, 变为直接读写隐藏域变量, 因此不会发生不必要的函数调用, 导致性能损失。

编译期常数值

如果属性值在编译期间就能确定, 则可以使用 const 修饰符, 将属性标记为编译期常数值(compile time constants)。这类属性必须满足以下所有条件：

必须是顶级属性, 或者是一个成员对象；
值被初始化为 String 类型, 或基本类型(primitive type)；
不存在自定义的取值方法。
这类属性可以用在注解内：

const val SUBSYSTEM_DEPRECATED: String = "This subsystem is deprecated"

@Deprecated(SUBSYSTEM_DEPRECATED) fun foo() { ... }

延迟初始化属性(Late-Initialized Property)

通常, 如果属性声明为非 null 数据类型, 那么属性值必须在构造器内初始化. 但是, 这种限制很多时候会带来一些不便. 比如, 属性值可以通过依赖注入来进行初始化, 或者在单元测试代码的 setup 方法中初始化. 这种情况下, 你就无法在构造器中为属性编写一段非 null 值的初始化代码, 但你仍然希望在类内参照这个属性时能够避免 null 值检查。

要解决这个问题, 你可以为属性添加一个 lateinit 修饰符：

public class MyTest {
    lateinit var subject: TestSubject

    @SetUp fun setup() {
        subject = TestSubject()
    }

    @Test fun test() {
        subject.method()  // dereference directly
    }
}

这个修饰符只能用于 var 属性，而且只能是声明在类主体部分之内的属性(不可以是主构造器中声明的属性)，而且属性不能有自定义的取值方法和设值方法。而且在Kotlin1.2之后，也可以用于顶级属性和局部变量。但是属性和变量必须是非 null 的,，而且不能是基本类型。

检查lateinit var 是否已初始化

为了检查lateinit var是否已被初始化，请对这个属性使用 . isInitialized：

if (foo::bar.isInitialized) {
    println(foo.bar)
}

属性重写

具体请看Overriding Properties

属性委托（Delegated Properties）

最常见的一种属性是简单的从隐藏域（backing field）中读取（或者写入）。另一方面，自定义getters和setters可以实现属性的任何行为。介于这两者之间，有一种‘中间’方法来让属性工作。一个小例子：延迟赋值（lazy values），根据一个key从map中读取，访问数据库，通知访问的监听器等等。

这些常见的操作可以使用库 delegated properties来实现。