Replace findViewById and Kotlin synthetics with ViewBinding

adasiewiczr · adasiewiczr · commit 72b77aa7b5ab · 2020-10-30T12:43:33.000+01:00
ViewBinding is a common tool and it's an official best practice recommended by Google.
diff --git a/samplekotlin/build.gradle b/samplekotlin/build.gradle
@@ -1,10 +1,8 @@
-
 apply plugin: 'com.android.application'
 apply plugin: 'kotlin-android'
-apply plugin: 'kotlin-android-extensions'
 
 android {
-    compileSdkVersion 29
+    compileSdkVersion 30
     defaultConfig {
         applicationId "com.example.chattutorial"
         minSdkVersion 21
@@ -23,13 +21,18 @@ android {
     }
 
     compileOptions {
+        sourceCompatibility JavaVersion.VERSION_1_8
         targetCompatibility JavaVersion.VERSION_1_8
     }
 
     kotlinOptions {
         jvmTarget = JavaVersion.VERSION_1_8.toString()
     }
 
+    buildFeatures {
+        viewBinding true
+    }
+
     packagingOptions {
         exclude 'META-INF/*.kotlin_module'
     }
@@ -42,6 +45,6 @@ dependencies {
 
     implementation "androidx.lifecycle:lifecycle-viewmodel:2.3.0-beta1"
     implementation "androidx.appcompat:appcompat:1.2.0"
-    implementation "androidx.constraintlayout:constraintlayout:2.0.3"
+    implementation "androidx.constraintlayout:constraintlayout:2.0.4"
     implementation 'androidx.activity:activity-ktx:1.1.0'
 }
diff --git a/samplekotlin/src/main/java/com/example/chattutorial/AttachmentViewHolderImgur.kt b/samplekotlin/src/main/java/com/example/chattutorial/AttachmentViewHolderImgur.kt
@@ -3,23 +3,20 @@ package com.example.chattutorial
 import android.view.LayoutInflater
 import android.view.ViewGroup
 import coil.load
+import com.example.chattutorial.databinding.ListItemAttachImgurBinding
 import com.getstream.sdk.chat.adapter.AttachmentListItem
 import com.getstream.sdk.chat.adapter.MessageListItem
 import com.getstream.sdk.chat.adapter.viewholder.attachment.BaseAttachmentViewHolder
-import com.getstream.sdk.chat.utils.roundedImageView.PorterShapeImageView
 import com.getstream.sdk.chat.view.MessageListView
-import kotlinx.android.synthetic.main.list_item_attach_imgur.view.*
 
 class AttachmentViewHolderImgur(
     parent: ViewGroup,
     private val bubbleHelper: MessageListView.BubbleHelper,
-    private val messageItem: MessageListItem.MessageItem
-) : BaseAttachmentViewHolder(
-    LayoutInflater.from(parent.context)
-        .inflate(R.layout.list_item_attach_imgur, parent, false)
-) {
-
-    private val ivMediaThumb: PorterShapeImageView = itemView.iv_media_thumb
+    private val messageItem: MessageListItem.MessageItem,
+    private val binding: ListItemAttachImgurBinding = ListItemAttachImgurBinding.inflate(
+        LayoutInflater.from(parent.context), parent, false
+    )
+) : BaseAttachmentViewHolder(binding.root) {
 
     override fun bind(attachmentListItem: AttachmentListItem) {
         val background = bubbleHelper.getDrawableForAttachment(
@@ -28,9 +25,9 @@ class AttachmentViewHolderImgur(
             messageItem.positions,
             attachmentListItem.attachment
         )
-        ivMediaThumb.setShape(context, background)
+        binding.ivMediaThumb.setShape(context, background)
 
-        ivMediaThumb.load(attachmentListItem.attachment.thumbUrl) {
+        binding.ivMediaThumb.load(attachmentListItem.attachment.thumbUrl) {
             allowHardware(false)
         }
     }
diff --git a/samplekotlin/src/main/java/com/example/chattutorial/ChannelActivity.kt b/samplekotlin/src/main/java/com/example/chattutorial/ChannelActivity.kt
@@ -6,8 +6,7 @@ import android.os.Bundle
 import androidx.activity.addCallback
 import androidx.activity.viewModels
 import androidx.appcompat.app.AppCompatActivity
-import com.getstream.sdk.chat.view.ChannelHeaderView
-import com.getstream.sdk.chat.view.MessageListView
+import com.example.chattutorial.databinding.ActivityChannelBinding
 import com.getstream.sdk.chat.viewmodel.ChannelHeaderViewModel
 import com.getstream.sdk.chat.viewmodel.MessageInputViewModel
 import com.getstream.sdk.chat.viewmodel.bindView
@@ -19,11 +18,16 @@ import com.getstream.sdk.chat.viewmodel.messages.MessageListViewModel.State.Navi
 import com.getstream.sdk.chat.viewmodel.messages.bindView
 import io.getstream.chat.android.client.models.Channel
 
+class ChannelActivity : AppCompatActivity() {
 
-class ChannelActivity : AppCompatActivity(R.layout.activity_channel) {
+    private lateinit var binding: ActivityChannelBinding
 
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
+
+        binding = ActivityChannelBinding.inflate(layoutInflater)
+        setContentView(binding.root)
+
         val cid = checkNotNull(intent.getStringExtra(CID_KEY)) {
             "Specifying a channel id is required when starting ChannelActivity"
         }
@@ -37,11 +41,9 @@ class ChannelActivity : AppCompatActivity(R.layout.activity_channel) {
         // TODO set custom AttachmentViewHolderFactory
 
         // Step 2 - Bind the view and ViewModels, they are loosely coupled so it's easy to customize
-        val channelHeaderView: ChannelHeaderView = findViewById(R.id.channelHeaderView)
-        val messageListView: MessageListView = findViewById(R.id.messageListView)
-        channelHeaderViewModel.bindView(channelHeaderView, this)
-        messageListViewModel.bindView(messageListView, this)
-        messageInputViewModel.bindView(findViewById(R.id.messageInputView), this)
+        channelHeaderViewModel.bindView(binding.channelHeaderView, this)
+        messageListViewModel.bindView(binding.messageListView, this)
+        messageInputViewModel.bindView(binding.messageInputView, this)
 
         // Step 3 - Let the message input know when we open a thread
         messageListViewModel.mode.observe(this) { mode ->
@@ -52,7 +54,7 @@ class ChannelActivity : AppCompatActivity(R.layout.activity_channel) {
         }
 
         // Step 4 - Let the message input know when we are editing a message
-        messageListView.setOnMessageEditHandler {
+        binding.messageListView.setOnMessageEditHandler {
             messageInputViewModel.editMessage.postValue(it)
         }
 
@@ -64,11 +66,11 @@ class ChannelActivity : AppCompatActivity(R.layout.activity_channel) {
         }
 
         // Step 6 - Handle back button behaviour correctly when you're in a thread
-        channelHeaderView.onBackClick = {
+        binding.channelHeaderView.onBackClick = {
             messageListViewModel.onEvent(MessageListViewModel.Event.BackButtonPressed)
         }
         onBackPressedDispatcher.addCallback(this) {
-            channelHeaderView.onBackClick()
+            binding.channelHeaderView.onBackClick()
         }
     }
 
diff --git a/samplekotlin/src/main/java/com/example/chattutorial/ChannelActivity2.kt b/samplekotlin/src/main/java/com/example/chattutorial/ChannelActivity2.kt
@@ -6,6 +6,7 @@ import android.os.Bundle
 import androidx.activity.addCallback
 import androidx.activity.viewModels
 import androidx.appcompat.app.AppCompatActivity
+import com.example.chattutorial.databinding.ActivityChannel2Binding
 import com.getstream.sdk.chat.viewmodel.ChannelHeaderViewModel
 import com.getstream.sdk.chat.viewmodel.MessageInputViewModel
 import com.getstream.sdk.chat.viewmodel.bindView
@@ -16,14 +17,17 @@ import com.getstream.sdk.chat.viewmodel.messages.MessageListViewModel.Mode.Threa
 import com.getstream.sdk.chat.viewmodel.messages.MessageListViewModel.State.NavigateUp
 import com.getstream.sdk.chat.viewmodel.messages.bindView
 import io.getstream.chat.android.client.models.Channel
-import kotlinx.android.synthetic.main.activity_channel.channelHeaderView
-import kotlinx.android.synthetic.main.activity_channel.messageInputView
-import kotlinx.android.synthetic.main.activity_channel.messageListView
 
-class ChannelActivity2 : AppCompatActivity(R.layout.activity_channel_2) {
+class ChannelActivity2 : AppCompatActivity() {
+
+    private lateinit var binding: ActivityChannel2Binding
 
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
+
+        binding = ActivityChannel2Binding.inflate(layoutInflater)
+        setContentView(binding.root)
+
         val cid = checkNotNull(intent.getStringExtra(CID_KEY)) {
             "Specifying a channel id is required when starting ChannelActivity2"
         }
@@ -35,12 +39,12 @@ class ChannelActivity2 : AppCompatActivity(R.layout.activity_channel_2) {
         val messageInputViewModel: MessageInputViewModel by viewModels { factory }
 
         // Set custom AttachmentViewHolderFactory
-        messageListView.setAttachmentViewHolderFactory(MyAttachmentViewHolderFactory())
+        binding.messageListView.setAttachmentViewHolderFactory(MyAttachmentViewHolderFactory())
 
         // Step 2 - Bind the view and ViewModels, they are loosely coupled so it's easy to customize
-        channelHeaderViewModel.bindView(channelHeaderView, this)
-        messageListViewModel.bindView(messageListView, this)
-        messageInputViewModel.bindView(messageInputView, this)
+        channelHeaderViewModel.bindView(binding.channelHeaderView, this)
+        messageListViewModel.bindView(binding.messageListView, this)
+        messageInputViewModel.bindView(binding.messageInputView, this)
 
         // Step 3 - Let the message input know when we open a thread
         messageListViewModel.mode.observe(this) { mode ->
@@ -58,16 +62,16 @@ class ChannelActivity2 : AppCompatActivity(R.layout.activity_channel_2) {
         }
 
         // Step 5 - Let the message input know when we are editing a message
-        messageListView.setOnMessageEditHandler {
+        binding.messageListView.setOnMessageEditHandler {
             messageInputViewModel.editMessage.postValue(it)
         }
 
         // Step 6 - Handle back button behaviour correctly when you're in a thread
-        channelHeaderView.onBackClick = {
+        binding.channelHeaderView.onBackClick = {
             messageListViewModel.onEvent(MessageListViewModel.Event.BackButtonPressed)
         }
         onBackPressedDispatcher.addCallback(this) {
-            channelHeaderView.onBackClick()
+            binding.channelHeaderView.onBackClick()
         }
     }
 
diff --git a/samplekotlin/src/main/java/com/example/chattutorial/ChannelActivity3.kt b/samplekotlin/src/main/java/com/example/chattutorial/ChannelActivity3.kt
@@ -6,6 +6,7 @@ import android.os.Bundle
 import androidx.activity.addCallback
 import androidx.activity.viewModels
 import androidx.appcompat.app.AppCompatActivity
+import com.example.chattutorial.databinding.ActivityChannel3Binding
 import com.getstream.sdk.chat.viewmodel.ChannelHeaderViewModel
 import com.getstream.sdk.chat.viewmodel.MessageInputViewModel
 import com.getstream.sdk.chat.viewmodel.bindView
@@ -18,16 +19,17 @@ import com.getstream.sdk.chat.viewmodel.messages.bindView
 import io.getstream.chat.android.client.models.Channel
 import io.getstream.chat.android.client.models.name
 import io.getstream.chat.android.livedata.ChatDomain
-import io.getstream.chat.android.livedata.controller.ChannelController
-import kotlinx.android.synthetic.main.activity_channel.channelHeaderView
-import kotlinx.android.synthetic.main.activity_channel.messageInputView
-import kotlinx.android.synthetic.main.activity_channel.messageListView
-import kotlinx.android.synthetic.main.activity_channel_3.typingHeader
 
-class ChannelActivity3 : AppCompatActivity(R.layout.activity_channel_3) {
+class ChannelActivity3 : AppCompatActivity() {
+
+    private lateinit var binding: ActivityChannel3Binding
 
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
+
+        binding = ActivityChannel3Binding.inflate(layoutInflater)
+        setContentView(binding.root)
+
         val cid = checkNotNull(intent.getStringExtra(CID_KEY)) {
             "Specifying a channel id is required when starting ChannelActivity3"
         }
@@ -39,12 +41,12 @@ class ChannelActivity3 : AppCompatActivity(R.layout.activity_channel_3) {
         val messageInputViewModel: MessageInputViewModel by viewModels { factory }
 
         // Set custom AttachmentViewHolderFactory
-        messageListView.setAttachmentViewHolderFactory(MyAttachmentViewHolderFactory())
+        binding.messageListView.setAttachmentViewHolderFactory(MyAttachmentViewHolderFactory())
 
         // Step 2 - Bind the view and ViewModels, they are loosely coupled so it's easy to customize
-        channelHeaderViewModel.bindView(channelHeaderView, this)
-        messageListViewModel.bindView(messageListView, this)
-        messageInputViewModel.bindView(messageInputView, this)
+        channelHeaderViewModel.bindView(binding.channelHeaderView, this)
+        messageListViewModel.bindView(binding.messageListView, this)
+        messageInputViewModel.bindView(binding.messageInputView, this)
 
         // Step 3 - Let the message input know when we open a thread
         messageListViewModel.mode.observe(this) { mode ->
@@ -62,28 +64,29 @@ class ChannelActivity3 : AppCompatActivity(R.layout.activity_channel_3) {
         }
 
         // Step 5 - Let the message input know when we are editing a message
-        messageListView.setOnMessageEditHandler {
+        binding.messageListView.setOnMessageEditHandler {
             messageInputViewModel.editMessage.postValue(it)
         }
 
         // Step 6 - Handle back button behaviour correctly when you're in a thread
-        channelHeaderView.onBackClick = {
+        binding.channelHeaderView.onBackClick = {
             messageListViewModel.onEvent(MessageListViewModel.Event.BackButtonPressed)
         }
         onBackPressedDispatcher.addCallback(this) {
-            channelHeaderView.onBackClick()
+            binding.channelHeaderView.onBackClick()
         }
 
         // Custom typing info header bar
         val nobodyTyping = "nobody is typing"
-        typingHeader.text = nobodyTyping
+        binding.typingHeader.text = nobodyTyping
 
         // Obtain a ChannelController
-        val channelController = ChatDomain.instance().useCases.getChannelController(cid).execute().data()
+        val channelController =
+            ChatDomain.instance().useCases.getChannelController(cid).execute().data()
 
         // Observe typing users
         channelController.typing.observe(this) { users ->
-            typingHeader.text = when {
+            binding.typingHeader.text = when {
                 users.isNotEmpty() -> users.joinToString(prefix = "typing: ") { user -> user.name }
                 else -> nobodyTyping
             }
diff --git a/samplekotlin/src/main/java/com/example/chattutorial/ChannelActivity4.kt b/samplekotlin/src/main/java/com/example/chattutorial/ChannelActivity4.kt
@@ -6,6 +6,7 @@ import android.os.Bundle
 import androidx.activity.addCallback
 import androidx.activity.viewModels
 import androidx.appcompat.app.AppCompatActivity
+import com.example.chattutorial.databinding.ActivityChannel4Binding
 import com.getstream.sdk.chat.viewmodel.ChannelHeaderViewModel
 import com.getstream.sdk.chat.viewmodel.MessageInputViewModel
 import com.getstream.sdk.chat.viewmodel.bindView
@@ -16,15 +17,17 @@ import com.getstream.sdk.chat.viewmodel.messages.MessageListViewModel.Mode.Threa
 import com.getstream.sdk.chat.viewmodel.messages.MessageListViewModel.State.NavigateUp
 import com.getstream.sdk.chat.viewmodel.messages.bindView
 import io.getstream.chat.android.client.models.Channel
-import kotlinx.android.synthetic.main.activity_channel.channelHeaderView
-import kotlinx.android.synthetic.main.activity_channel.messageInputView
-import kotlinx.android.synthetic.main.activity_channel.messageListView
-import kotlinx.android.synthetic.main.activity_channel_3.typingHeader
 
-class ChannelActivity4 : AppCompatActivity(R.layout.activity_channel_4) {
+class ChannelActivity4 : AppCompatActivity() {
+
+    private lateinit var binding: ActivityChannel4Binding
 
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
+
+        binding = ActivityChannel4Binding.inflate(layoutInflater)
+        setContentView(binding.root)
+
         val cid = checkNotNull(intent.getStringExtra(CID_KEY)) {
             "Specifying a channel id is required when starting ChannelActivity"
         }
@@ -36,12 +39,12 @@ class ChannelActivity4 : AppCompatActivity(R.layout.activity_channel_4) {
         val messageInputViewModel: MessageInputViewModel by viewModels { factory }
 
         // Set custom AttachmentViewHolderFactory
-        messageListView.setAttachmentViewHolderFactory(MyAttachmentViewHolderFactory())
+        binding.messageListView.setAttachmentViewHolderFactory(MyAttachmentViewHolderFactory())
 
         // Step 2 - Bind the view and ViewModels, they are loosely coupled so it's easy to customize
-        channelHeaderViewModel.bindView(channelHeaderView, this)
-        messageListViewModel.bindView(messageListView, this)
-        messageInputViewModel.bindView(messageInputView, this)
+        channelHeaderViewModel.bindView(binding.channelHeaderView, this)
+        messageListViewModel.bindView(binding.messageListView, this)
+        messageInputViewModel.bindView(binding.messageInputView, this)
 
         // Step 3 - Let the message input know when we open a thread
         messageListViewModel.mode.observe(this) { mode ->
@@ -59,21 +62,21 @@ class ChannelActivity4 : AppCompatActivity(R.layout.activity_channel_4) {
         }
 
         // Step 5 - Let the message input know when we are editing a message
-        messageListView.setOnMessageEditHandler {
+        binding.messageListView.setOnMessageEditHandler {
             messageInputViewModel.editMessage.postValue(it)
         }
 
         // Step 6 - Handle back button behaviour correctly when you're in a thread
-        channelHeaderView.onBackClick = {
+        binding.channelHeaderView.onBackClick = {
             messageListViewModel.onEvent(MessageListViewModel.Event.BackButtonPressed)
         }
         onBackPressedDispatcher.addCallback(this) {
-            channelHeaderView.onBackClick()
+            binding.channelHeaderView.onBackClick()
         }
 
         // Custom typing info header bar
         val nobodyTyping = "nobody is typing"
-        typingHeader.text = nobodyTyping
+        binding.typingHeader.text = nobodyTyping
 
         val currentlyTyping = mutableSetOf<String>()
         // TODO update when new SDK version is out
@@ -90,7 +93,7 @@ class ChannelActivity4 : AppCompatActivity(R.layout.activity_channel_4) {
                     is TypingStopEvent -> currentlyTyping.remove(event.user.name)
                 }
 
-                typingHeader.text = when {
+                binding.typingHeader.text = when {
                     currentlyTyping.isNotEmpty() -> currentlyTyping.joinToString(prefix = "typing: ")
                     else -> nobodyTyping
                 }
diff --git a/samplekotlin/src/main/java/com/example/chattutorial/MainActivity.kt b/samplekotlin/src/main/java/com/example/chattutorial/MainActivity.kt
