Kotlin 的 Backing Fields 和 Backing Properties 目录1. 前言2. 正文2.1 属性声明2.2 Getters 和 Setters2.3 Backing Fields2.4 Backing Properties3. 最后参考1. 前言本文先从 Kotlin 属性声明 Getters 和 Setters 方法开始重点会介绍 Backing Fields 的概念为什么 Kotlin 中要有field的概念什么时候才会用到field在开发中的具体应用有哪些之后会介绍 Backing Properties 的概念和用法。2. 正文2.1 属性声明Kotlin 类的属性可以声明为可变的或者是只读的。可变属性要用到var关键字只读属性需要使用到val关键字。来看一下这个简单的Student类classStudent(_name:String,_age:Int){valname:String_namevarage:Int_age}这里声明一个name属性它是不可变的只读的用到了val关键字而age属性它是可变的用到了var关键字。在代码中可以这样使用funmain(args:ArrayString){valstudentStudent(willwaywang6,16)// 打印学生信息println(name${student.name}, age${student.age})}/* 打印结果 namewillwaywang6, age16 */上面说了name是只读的而age是可变的我们通过代码来验证一下尝试将name重新赋值为 “willwaywang7”代码如下student.namewillwaywang7IDE 已经提示出Val cannot be reassignedval 不可以被再赋值。这就证明了name确实是只读的。将age重新赋值为 17代码如下student.age17// 再次打印学生信息println(name${student.name}, age${student.age})/* 打印结果 namewillwaywang6, age17 */这就证明了age是可变的。到这里学过 Java 知识的同学们都会想起 Java Bean 类的声明Student是下面这样的publicclassStudent{privatefinalString name;privateintage;publicStudent(String _name,int_age){name_name;age_age;}publicStringgetName(){returnname;}publicintgetAge(){returnage;}publicvoidsetAge(intage){this.ageage;}}和 Kotlin 中声明的Student相比第一Kotlin 的代码确实少了很多第二在使用方式上Java 必须要通过定义的 getters 和 setters 方法来操作定义的name和age而 Kotlin 却可以直接通过对象.name 和对象.age 来操作这是怎么回事呢难道说它们都是public的带着这个疑问我们进入下一部分2.2 Getters 和 Setters通过 IDE 提供的工具选择Student.kt类通过Tools - Kotlin - Show Kotlin Bytecode点击Decompile查看 对应的Student.decompiled.java文件publicfinalclassStudent{NotNullprivatefinalString name;privateintage;NotNullpublicfinalStringgetName(){returnthis.name;}publicfinalintgetAge(){returnthis.age;}publicfinalvoidsetAge(intvar1){this.agevar1;}publicStudent(NotNullString _name,int_age){Intrinsics.checkParameterIsNotNull(_name,_name);super();this.name_name;this.age_age;}}和Student.java对比一下No difference。这下我们知道了原来Student.kt和Student.java都是通过getter和setter方法来操作name和age的。但是我们在 Student.kt 里面确实没有声明getter和setter方法它们是从哪里来的呢通过查阅官方文档Getters and Setters部分可以知道声明一个属性的完整语法是下面这样的varpropertyName[:PropertyType][property_initializer][getter][setter]valpropertyName[:PropertyType][property_initializer][getter]初始化器getter 和 setter 都是可选的。如果属性类型可以由初始化器或者从 getter 方法返回类型推导出来的话那么它也是可选的。在 Kotlin 中读一个属性例如student.name就会执行name的 getter 访问器改变一个属性例如student.age 17就会执行age的 setter 访问器。可以把Student.kt简化一下classStudent(_name:String,_age:Int){valname_name// 省略了属性类型因为可以从初始化器里推导出来。varage_age}可以给一个属性定义自定义的访问器可以在Student类中声明一个带自定义getter的属性isAdultclassStudent(_name:String,_age:Int){valname_namevarage_agevalisAdult:Booleanget()this.age18}funmain(args:ArrayString){valstudentStudent(willwaywang6,16)// 打印学生信息println(name${student.name}, age${student.age})println(isAdult${student.isAdult})}/* 打印结果 namewillwaywang6, age16 isAdultfalse */每次我们获取isAdult属性都会进行计算它本身并不需要字段来保存它的值。这和在类中定义一个funareAdult()this.age18实现的功能是一模一样的不同的是可读性一个是属性另一个是方法。测试代码如下println(isAdult${student.isAdult})println(areAdult${student.areAdult()})/* 打印结果 isAdultfalse areAdultfalse */好了回归到我们讨论的主题Student.kt声明name和age时确实是有 getter 和 setter 方法的只是被省略了而已。既然是这样不省略的写法应该是怎样的呢按照目前的知识不省略的写法应该是这样的classStudent(_name:String,_age:Int){valname_nameget()this.namevarage_ageget()this.ageset(value){this.agevalue}}但编译器明显告诉我们这样是不对的看一下这张截图更清楚左边的提示是说会造成Recursive call递归调用。我们看一下是怎么回事第一步调用 student.name第二步调用 get() 方法第三步在 get() 方法里调用 this.name第一步调用 student.name第二步调用 get() 方法…这样就形成了递归调用了 get() 方法并且没有终止条件所以是有问题的。如果觉得不是很清晰还可以看一下对应的 Java 代码publicfinalclassStudent{NotNullpublicfinalStringgetName(){returnthis.getName();}publicfinalintgetAge(){returnthis.getAge();}publicfinalvoidsetAge(intvalue){this.setAge(value);}publicStudent(NotNullString _name,int_age){Intrinsics.checkParameterIsNotNull(_name,_name);super();this.name_name;this.age_age;}}很明显可以看到递归调用的。既然这样写法是不对的那么怎么写才是正确的呢我们接着去看另外一条提示Initializer is not allowed here because this property has no backing field这里不能有初始化器因为这个属性没有backing field。这条提示给了我们很重要的信息因为这是唯一的报错信息了。如果解决了这个报错信息就可以编译通过了。这里面有一个新的概念backing field。在 Java 中可是没有见过它的。那么 backing field 到底是什么呢接着往下看2.3 Backing Fields查阅官方文档Backing Fields先学习一下Kotlin 类中不能直接声明 Fields。然而当一个属性需要一个 backing field 时Kotlin 会自动地提供它。在访问器中使用field标识符就可以引用到 backing field。文档给了一个例子varcounter0// Note: the initializer assigns the backing field directlyset(value){if(value0)fieldvalue}把这个例子和我们的Student类的name和age属性对比一下可以发现除了把方法体内的属性名换成了field之外没有区别了。好了我们去尝试替换一把classStudent(_name:String,_age:Int){valname_nameget()fieldvarage_ageget()fieldset(value){fieldvalue}}现在可以编译通过了都正常了。不过我们还是看一下截图里面有一些细节的信息从这里看出IDE 提示我们现在的 getter 和 setter 是Redundant多余的累赘的。这也从另一方面说明了现在的 getter 和 setter 正是省略掉的写法。现在我们一起来学习一下 backing field 的知识吧field用在什么地方field标识符只能用在属性的访问器中。但是却不能用在接口中具有 getter 和 setter 方法的属性这是因为支持字段需要在接口中存储状态而这是接口不允许的。backing field 什么时候会生成呢如果一个属性用到了至少一个访问器的默认实现就会给这个属性生成一个 backing field。这一点在上面的例子中已经看到了。如果一个自定义的访问通过 field 标识符引用了对应的属性就会给这个属性生成一个 backing field。看下面的例子classStudent(_name:String,_age:Int){valname_namevarage_ageset(value){if(value0){// 对设置的年龄进行校验fieldvalue}else{throwIllegalArgumentException(age 0)}}}funmain(args:ArrayString){valstudentStudent(willwaywang6,16)// 打印学生信息println(name${student.name}, age${student.age})student.age0println(name${student.name}, age${student.age})}/* 打印信息 namewillwaywang6, age16 Exception in thread main java.lang.IllegalArgumentException: age 0 at com.kotlin.inaction.reference.classes_and_objects.02_properties_and_fields.Student.setAge(Student.kt:12) at com.kotlin.inaction.reference.classes_and_objects.02_properties_and_fields.StudentKt.main(Student.kt:21) */需要额外说明的是backing field 并不是总会生成的2.2 Getters 和 Setters 部分的isAdult属性就是个例子。从有没有 backing field 的角度可以 Kotlin 的属性分为两类有 backing field 的属性没有 backing field 的属性。有 backing field 的属性会把值以 Java 中字段的形式存储起来。这个字段就把值存储在内存里了。没有 backing field 的属性不能把值以 Java 中字段的形式存储起来。它必须每次调用时都通过计算得到它的值。从这里可以看到Kotlin 中的属性与 Java 中的字段相比较是一个更高层次的概念。2.4 Backing Propertiesbacking property 的出现是为了弥补“隐含的 backing field”的不足。backing property 可以用来实现惰性初始化看下面的例子classStudent(_name:String,_age:Int){valname_namevarage_ageprivatevar_grades:MapString,Int?nullvalgrades:MapString,Intget(){if(_gradesnull){_gradesloadGrades()}return_grades!!}privatefunloadGrades():MutableMapString,Int{println(loadGrades() called)valresultmutableMapOfString,Int()result.put(Chinese,100)result.put(Math,99)result.put(English,100)returnresult}}funmain(args:ArrayString){valstudentStudent(willwaywang6,16)println(grades${student.grades})println(grades${student.grades})}/* 打印结果 loadGrades() called grades{Chinese100, Math99, English100} grades{Chinese100, Math99, English100} */在上面的例子中希望只有在首次访问时才加载成绩信息并只执行一次。从打印结果来看实现了目标。在这里我们使用一个属性_grades可空类型的用来存储这个值而另一个属性grades非空类型的用来提供对属性的读取访问。backing property 可以实现数据的封装比如我们会遇到这种需求希望一个属性对外表现为只读对内表现为可读可写。看下边的例子classScoreViewModel(finalScore:Int):ViewModel(){privateval_scoreMutableLiveDataInt()valscore:LiveDataIntget()_scoreinit{_score.valuefinalScore Timber.i(Final score is$finalScore)}}在ScoreViewModel里面有一个分数的属性希望它对外也就是 UI Controller表现为只读对内也就是ScoreViewModel自己表现为可读可写。使用一个属性_scoreprivate修饰MutableLiveData可变LiveData用于对内的可读可写另一个属性scorepublic修饰LiveData用于对外的只读。其中score就是 backing property。需要注意的是私有的属性是以下划线_开头的而公开的属性是不以下划线开头的。这是一个代码规范。3. 最后从属性声明开始一步一步写到最后并不急于抛出一个新的概念而是自然地引出新的概念。希望这篇文章对同学们有所帮助。另外对于 backing fieldsbacking properties 并没有进行翻译就怕引起误解。实际上在 《Kotlin实战》这本书里backing fields 被翻译成“支持字段”backing properties 被翻译成“支持属性”。这个应该比较权威吧。参考Properties and FieldsKotlin 什么是幕后字段深入理解 Kotlin 类属性What’s Kotlin Backing Field For?Kotlin 的 Getter 和 Setter