原文地址：https://proandroiddev.com/kotlin-android-extensions-the-definitive-guide-786d190b30e7
Kotlin Android Extensions是一个Kotlin插件，将会生成一些额外的代码然你跟可以访问布局文件中的views。他会构建一个本地的view缓存，如果首次使用一个属性，他将会执行findViewById，但是下次执行时，view将会被替换为缓存中，访问速度也会更快。
在项目中集成Kotlin Android Extensions
在项目的app/build.gradle文件中添加如下：
apply plugin: 'com.android.application'
apply plugin: 'kotlin-android'
apply plugin: 'kotlin-android-extensions'
直接在activity中使用布局中定义的id
<?xml version="1.0" encoding="utf-8"?>
<FrameLayout
xmlns:android="http://schemas.android.com/apk/res/android"
android:layout_width="match_parent"
android:layout_height="match_parent">
<TextView
android:id="@+id/welcomeMessage"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_gravity="center"
android:text="Hello World!"/>
</FrameLayout>
TextView有一个welcomeMessage id。
然后在MainActivity中使用它：
override fun onCreate(savedInstanceState: Bundle?){
super.onCreate(savedInstance)
setContentView(R.layout.activity_main)
welcomeMessage.text = "Hello Kotlin!"
}
IDE会自动导入一个特殊的包
import kotlinx.android.synthetic.main.activity_main.*
实现原理
在kotlin -> Tools下面点击show kotlin bytecode可以查看生成的字节码。
字节码有时候不容易理解，所以可以点击Decompile。
看一下activity生成的代码：
private HashMap _$_findViewCache;
...
public View _$_findCachedViewById(int var1) {
if(this._$_findViewCache == null) {
this._$_findViewCache = new HashMap();
}
View var2 = (View)this._$_findViewCache.get(Integer.valueOf(var1));
if(var2 == null) {
var2 = this.findViewById(var1);
this._$_findViewCache.put(Integer.valueOf(var1), var2);
}
return var2;
}
public void _$_clearFindViewByIdCache() {
if(this._$_findViewCache != null) {
this._$_findViewCache.clear();
}
}
当我们需要一个view的时候，首先会去缓存中查找，如果没有，将会通过findViewById查找他并且添加到缓存中。
他还额外的生成了一个清除缓存的方法：clearFindViewByIdCache，如果必须重建视图，可以使用该方法，因为旧视图将失效。
下面这行代码：
welcomeMessage.text = "Hello Kotlin!"
将会被替换为：
((TextView)this._$_findCachedViewById(id.welcomeMessage)).setText((CharSequence)"Hello Kotlin!");
所以这个属性不是真实的，插件不会为每个view生成一个属性。只是会在编译期间替换代码以访问视图缓存，将其转换为正确的类型并调用该方法。
在fragment中的使用方法
问题是fragment中的视图可以重建，但是fragment实例将保持活动状态。这意味着缓存中的视图将不再有效。
将上面的代码移动到fragment中看看会发生什么：
class Fragment : Fragment() {
override fun onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View? {
return inflater.inflate(R.layout.fragment, container, false)
}
override fun onViewCreated(view: View?, savedInstanceState: Bundle?) {
super.onViewCreated(view, savedInstanceState)
welcomeMessage.text = "Hello Kotlin!"
}
}
接下来看一下生成的字节码，除了下面的一部分其余的都与activity中的一样：
// $FF: synthetic method
public void onDestroyView() {
super.onDestroyView();
this._$_clearFindViewByIdCache();
}
当view被销毁的时候，onDestroyView方法将会调用clearFindViewByIdCache.
自定义view中使用方法
比如说，我们有如下布局文件：
<merge xmlns:android="http://schemas.android.com/apk/res/android"
android:orientation="vertical"
android:layout_width="match_parent"
android:layout_height="match_parent">
<ImageView
android:id="@+id/itemImage"
android:layout_width="match_parent"
android:layout_height="200dp"/>
<TextView
android:id="@+id/itemTitle"
android:layout_width="match_parent"
android:layout_height="wrap_content"/>
</merge>
创建一个简单的自定义布局，使用@JvmOverloads生成构造函数：
image.png
class CustomView @JvmOverloads constructor(
context: Context, attrs: AttributeSet? = null, defStyleAttr: Int = 0
) : LinearLayout(context, attrs, defStyleAttr) {
init {
LayoutInflater.from(context).inflate(R.layout.view_custom, this, true)
itemTitle.text = "Hello Kotlin!"
}
}
接下来看一下生成的字节码：
((TextView)this._$_findCachedViewById(id.itemTitle)).setText((CharSequence)"Hello Kotlin!");
从另一个视图访问属性
比如说adapter中：
val itemView = ...
itemView.itemImage.setImageResource(R.mipmap.ic_launcher)
itemView.itemTitle.text = "My Text"
插件会帮助你导入如下的包：
import kotlinx.android.synthetic.main.view_item.view.*
- 这种情况下视图不会像activity或fragment那样进行缓存
- 你可以在任意视图引用任意布局的view
然后看一下生成的字节码:
((TextView)itemView.findViewById(id.itemTitle)).setText((CharSequence)"My Text");
并没有任何缓存的操作。如果布局比较复杂的情况下可能会影响性能。
Kotlin Android Extensions in 1.1.4
在1.1.4中任何类中的view属性都会被缓存包括ViewHolder。还提供了一个新注解@Parcelize，还有一种方法可以自定义生成的缓存。
需要在build.gradle文件中启用这些功能：
androidExtensions {
experimental = true
}
在ViewHolder中使用(或任意自定义类)
你可以使用简单的方法为任意类构建一个缓存，唯一需要做的就是让你的类实现LayoutContainer接口，比如说上面的示例就可以改成如下这样：
class ViewHolder(override val containerView: View) : RecyclerView.ViewHolder(containerView),
LayoutContainer {
fun bind(title: String) {
itemTitle.text = "Hello Kotlin!"
}
}
containerView是从LayoutContainer接口覆盖的那个。
接下来看一下生成的字节码：
((TextView)this._$_findCachedViewById(id.itemTitle)).setText((CharSequence)"Hello Kotlin!");
可以发现已经出现了cache。
Kotlin Android Extension实现Parcelable
使用@Parcelize注解，可以让任何类以一种简单的方式实现Parcelable。
你只需要在类上添加注解，然后插件就会将你做其余的工作：
@ Parcelize
class Model(val title: String, val amount: Int): Parcelable
接着你就可以在任意的Intent中使用如下代码：
val intent = Intent(this, DetailActivity::class.java)
intent.putExtra(DetailActivity.EXTRA, model)
从intent中获取数据：
val model: Model = intent.getParcelableExtra(EXTRA)
定制缓存
@ContainerOptions注解可以允许你自定义缓存的构建方式，甚至可以阻止类创建缓存。
默认情况下会使用Hashmap，就像我们上面看到的那样，可以改为使用Android框架中的SparseArray，在某些情况下可能更有效，如果你不需要为类添加缓存，也可以使用该注解。
@ContainerOptions(CacheImplementation.SPARSE_ARRAY)
class MainActivity : AppCompatActivity() {
...
}
public enum class CacheImplementation {
SPARSE_ARRAY,
HASH_MAP,
NO_CACHE;
...
}
网友评论