Kotlin 官方学习教程之属性和字段

x33g5p2x  于2022-03-08 转载在 其他  
字(2.8k)|赞(0)|评价(0)|浏览(430)

属性声明

在 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() // 在 kotlin 中没有 new 关键字
    result.name = address.name // 调用访问器
    result.street = address.street
    // ...
    return result
}

getter 和 setter

声明属性的完整语法是:

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

语法中的初始化语句,getter 和 setter 都是可选的。如果属性类型可以从初始化语句或者类的成员函数中推断出来,那么类型也是忽略的。

例子:

var allByDefault: Int? // 错误: 需要一个初始化语句, 默认实现了 getter 和 setter 方法
var initialized = 1 // 类型为 Int, 默认实现了 getter 和 setter 方法

只读属性声明的完整语法与可变的属性声明有两个不同:它以val而不是var开头,不允许setter:

val simple: Int? // 类型为 Int, 默认实现了 getter 方法,必须在构造函数中初始化
val inferredType = 1 // 类型为 Int, 默认实现了 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  // 类型为 Boolean

如果你需要改变一个访问器的可见性或者给它添加注解,但又不想改变默认的实现,那么你可以定义一个不带函数体的访问器:

var setterVisibility: String = "abc"
    private set // setter 是私有的并且有默认的实现

var setterWithAnnotation: Any? = null
    @Inject set // 使用 Inject 注释 setter

备用字段

Kotlin 中的类不可以有字段。但是,有时候在使用自定义访问器是需要一个备用字段。出于这些原因,Kotlin 使用 field 关键字提供了自动备用字段:

var counter = 0 // 初始化值会直接写入备用字段
    set(value) {
        if (value >= 0) field = value
    }

field 修饰符只能在属性的访问器中使用。

编译器会检查访问器的代码,如果使用了备用字段(或者访问器是默认的实现逻辑),就会自动生成备用字段,否则就不会。

例如,下面的例子中就不会有备用字段:

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

备用属性

如果你想要做一些事情但不适合使用这种 “隐含备用字段” 方案,你可以试着用备用属性的方式:

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 是一样的,因为通过默认的 getter 和 setter 去访问私有属性,因此不会引入函数调用开销。

编译时常量

在编译时已知其值的属性可以使用const修饰符标记为编译时常数。这些属性需要满足以下要求:

  • 在 “top-level” 中声明或者是一个 object 的成员
  • 以 String 或基本类型进行初始化
  • 没有自定义 getter

这些属性可以被当作注解使用:

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

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

延迟初始化属性

通常,声明为非空类型的属性必须在构造函数中进行初始化。然而,这通常不方便。例如在单元测试中,属性应该通过依赖注入进行初始化,或者通过一个 setup 方法进行初始化。在这种条件下,你不能在构造器中提供一个非空的初始化语句,但是你仍然希望在访问这个属性的时候,避免非空检查。

为了解决这种情况,你可以使用 lateinit 修饰符标记属性:

public class MyTest {
    lateinit var subject: TestSubject

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

    @Test fun test() {
        subject.method()  // 直接取消引用
    }
}

这个修饰符只能够被用在类的 var 类型的可变属性定义中,不能用在构造方法中。并且属性不能有自定义的 getter 和 setter访问器。这个属性的类型必须是非空的,同样也不能为一个基本类型。

在一个延迟初始化的属性初始化前访问他,会导致一个特定异常,告诉你访问的时候值还没有初始化。

重写属性

参看重写属性

代理属性

最常见的属性就是从备用属性中读(或者写)。另一方面,自定义的 getter 和 setter 可以实现属性的任何操作。有些像懒值( lazy values ),根据给定的关键字从 map 中读出,读取数据库,通知一个监听者等等,像这些操作介于 getter 和 setter 模式之间。

像这样常用操作可以通过代理属性作为库来实现。

相关文章