Kotlin Android Extensions: полное руководство
Если у вас уже есть опыт разработки приложений для Android, вероятно, вы уже устали использовать findViewById, чтобы восстанавливать view. Или, может быть, вы уже сдались и начали использовать известную библиотеку ― ButterKnife. Если это ваш случай, то вы влюбитесь в Kotlin Android Extensions.
Примечание: данная статья была написана в октябре 2018 года, поэтому некоторая информация (например, необходимость указания experimental = true) может быть устаревшей.
Что такое Kotlin Android Extensions?
Kotlin Android Extensions — это плагин для Kotlin, который включён в стандартный пакет. Он позволяет восстанавливать view из Activities, Fragments и Views удивительно бесшовным способом.
Плагин генерирует дополнительный код, который позволяет получить доступ к view в виде XML так же, как если бы вы имели дело с properties с именем id, который вы использовали при определении структуры.
Также он создаёт локальный кэш view. При первом использовании свойства, плагин выполнит стандартный findViewById. В последующем, view будет восстановлен из кэша, поэтому доступ к нему будет быстрее.
Как этим пользоваться
Посмотрим, насколько это просто. В первом примере рассмотрим activity:
Включаем Kotlin Android Extensions в наш код
Хотя плагин уже интегрирован (устанавливать новый не нужно), если вы хотите его использовать, вам нужно подключить плагин в модуль Android:
apply plugin: 'com.android.application' apply plugin: 'kotlin-android' apply plugin: 'kotlin-android-extensions'
И это все, что вам потребуется. Теперь вы можете начать работу с ним.
Восстанавливаем view из XML
С этого момента восстановить view так же просто, как использовать view id, которое вы определили в XML, непосредственно в вашем activity.
Представьте, что у вас есть такой XML:
<?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 есть id welcomeMessage.
Просто напишите следующий код в MainActivity:
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_main)
welcomeMessage.text = "Hello Kotlin!"
}Чтобы это работало, нужен специальный импорт (я написал его ниже), но IDE может автоматически импортировать его. Проще и быть не может!
import kotlinx.android.synthetic.main.activity_main.*
Как я уже упоминал, сгенерированный код включает кэш view, поэтому, если вы повторно обратитесь к view, это не потребует выполнения findViewById снова.
Давайте посмотрим, что происходит под капотом.
Магия Kotlin Android Extensions
Когда начинаешь работать с Kotlin, действительно интересно понять байт-код, который генерируется при использовании той или иной функции. Это поможет вам понять скрытую цену ваших решений.
В меню Tools → Kotlin вы найдёте мощный инструмент Show Kotlin Bytecode. Если кликнуть по нему, вы увидите байт-код, который будет сгенерирован, когда открытый файл класса будет скомпилирован.
Для большинства людей байт-код не особенно полезен, но тут есть ещё одна опция: Decompile.
Эта опция покажет вам Java репрезентацию байт-кода, который был сгенерирован в Kotlin. Так, вы сможете более-менее понять, как будет выглядеть код Java, эквивалентный тому, что вы написали на Kotlin.
Я собираюсь использовать это на примере activity и посмотреть код, сгенерированный Kotlin Android Extensions.
Вот интересная часть:
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, о котором мы говорили.
При запросе view, его поиск начинается в кэше. Если view нет в кэше, то он туда будет добавлен, как только будет найден. Всё просто.
Кроме того, в код добавляется функция для очистки кэша: clearFindViewByIdCache. Её можно использовать, скажем, когда старые view уже не актуальны и вам нужно получить новые.
Тогда эта строка:
welcomeMessage.text = "Hello Kotlin!"
превращается в эту:
((TextView)this._$_findCachedViewById(id.welcomeMessage)).setText((CharSequence)"Hello Kotlin!");
Таким образом, плагин не генерирует свойства для каждого view, это ненастоящие свойства. Плагин просто заменяет код во время компиляции, чтобы получить доступ к кэшу view. Затем он приводит к нужному типу и вызывает метод.
Kotlin Android Extensions ― работа с фрагментами
Этот плагин можно использовать с фрагментами.
Проблема с фрагментами заключается в том, что view может обновиться, а экземпляр фрагмента останется прежним. Что произойдёт? А то, что view находящееся в кэше, перестанет быть валидным.
Давайте посмотрим код, который генерирует плагин, если мы используем его с фрагментом. Я создаю простой фрагмент, который использует тот же XML, который я написал выше:
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!"
}
}В onViewCreated я снова изменяю текст TextView. Что насчёт сгенерированного байт-кода?
Всё то же самое, как и в activity, но с небольшой разницей:
// $FF: synthetic method
public void onDestroyView() {
super.onDestroyView();
this._$_clearFindViewByIdCache();
}Когда view перестанет быть актуальным, этот метод вызовет clearFindViewByIdCache, так что мы в безопасности!
Kotlin Android extensions и Custom View
С custom view плагин работает схожим образом. Скажем, у нас есть такой 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>Я создаю очень простое custom view и генерирую конструкторы с новым намерением, которое использует аннотацию @JvmOverloads:
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!"
}
}В примере выше я изменяю текст в itemTitle. Сгенерированный код должен искать view в кэше. Не имеет смысла снова копировать тот же код полностью. Вы можете наблюдать это в строке, которая изменяет текст:
((TextView)this._$_findCachedViewById(id.itemTitle)).setText((CharSequence)"Hello Kotlin!");
Отлично! В custom views мы тоже вызываем findViewById только первый раз.
Восстанавливаем views из другого view
Последняя альтернатива, которую предлагает Kotlin Android Extensions: использовать свойства напрямую из другого view.
Я использую схему, схожую с той, что была в предыдущем разделе. Представьте, что это было закачано в адаптер для примера.
Вы также можете получить доступ к subviews напрямую, просто используя этот плагин:
val itemView = ... itemView.itemImage.setImageResource(R.mipmap.ic_launcher) itemView.itemTitle.text = "My Text"
Хотя плагин и может помочь заполнить import, здесь есть небольшое отличие:
import kotlinx.android.synthetic.main.view_item.view.*
Несколько вещей, которые вам нужно знать:
- Во время компиляции вы можете ссылаться на любое view из любого другого view. Это значит, вы можете ссылаться на view, которое не является его прямым потомком. Это плохо скажется на времени выполнения при попытке восстановить view, которого не существует.
- В этом случае view не кэшировано, как в случае с Activities и Fragments.
Почему так? В отличие от предыдущих случаев, здесь у плагина нет места, чтобы генерировать необходимый код для кэша.
Если вы снова перечитаете код, который сгенерирован плагином, где вызываются свойства из view, вы увидите это:
((TextView)itemView.findViewById(id.itemTitle)).setText((CharSequence)"My Text");
Как видно, здесь нет запроса к кэшу. Будьте осторожны, если у вас комплексное view и вы используете его в адаптере. Это может повлиять на производительность.
Также у вас есть альтернатива: Kotlin 1.1.4
Kotlin Android Extensions версии 1.1.4
Начиная с этой, новой версии Kotlin, в Android Extensions включили новые интересные функции: кэш в любом классе (включая ViewHolder) и новая аннотация, названная @Parcelize. Также есть способ настраивать сгенерированный кэш.
Мы вернёмся к ним через минуту, но вам следует знать, что эти новые фичи ― не завершены, так чт, вам нужно включить их с помощью build.gradle:
androidExtensions {
experimental = true
}Применяем на ViewHolder (или любом пользовательском классе)
Теперь есть простой способ построить кэш для любого класса. Единственное требование заключается в том, чтобы класс реализовывал интерфейс LayoutContainer. Этот интерфейс предоставит view, которое плагин будет использовать, чтобы искать subviews. Представьте, что у вас есть ViewHolder, который содержит view со структурой, описанной в предыдущем примере. Всё что вам нужно сделать:
class ViewHolder(
override val containerView: View
) : RecyclerView.ViewHolder(containerView), LayoutContainer {
fun bind(title: String) {
itemTitle.text = "Hello Kotlin!"
}
}containerView ― единственное, что мы перезаписываем из интерфейса LayoutContainer. Это все, что вам необходимо.
С этого момента у вас есть доступ к views напрямую. Нет необходимости присоединять itemView, чтобы получить доступ к subviews.
Ещё раз, если вы посмотрите на сгенерированный код, вы увидите, что view берётся из кэша:
((TextView)this._$_findCachedViewById(id.itemTitle)).setText((CharSequence)"Hello Kotlin!");
Здесь я применял его на ViewHolder, но это достаточно универсальный подход и его можно использовать с любым классом.
Kotlin Android Extension. Реализация Parcelable
С новой аннотацией @Parcelize, можно с лёгкостью имплементировать Parcelable c любым классом.
Вам нужно добавить аннотацию, а плагин сделает за вас всю сложную работу:
@Parcelize class Model(val title: String, val amount: Int) : Parcelable
Далее, как вам должно быть известно, можно добавить объект к любому интенту:
val intent = Intent(this, DetailActivity::class.java) intent.putExtra(DetailActivity.EXTRA, model) startActivity(intent)
И восстановить объект из намерения в любой точке (в этом случае из activity):
val model: Model = intent.getParcelableExtra(EXTRA)
Настройка кэша
В этот экспериментальный набор включена новая фича ― аннотация @ContainerOptions. Она даёт возможность настраивать способ построения кэша, или даже предотвращать его создание классом.
По умолчанию, используется Hashmap, как мы видели ранее. Его можно заменить на SparseArray из Android framework, что может быть более эффективно в некоторых ситуациях. Или, если вам не нужен кэш для класса по каким-то причинам, такая возможность тоже есть.
Вот как это использовать:
@ContainerOptions(CacheImplementation.SPARSE_ARRAY)
class MainActivity : AppCompatActivity() {
...
}На момент написания статьи существуют следующие варианты:
public enum class CacheImplementation {
SPARSE_ARRAY,
HASH_MAP,
NO_CACHE;
...
}Заключение
Мы увидели, как легко работать с Android views в Kotlin. Благодаря простому плагину, можно забыть обо всём этом ужасном коде, связанном с восстановлением view. Этот плагин создаёт для нас необходимые свойства с приведением правильного типа, безо всяких проблем.
Кроме того, Kotlin 1.1.4 добавляет интересные фичи, которые будут действительно полезны в некоторых случаях, к которым плагин ранее не имел отношения.