Optimize code

DylanCaiCoding · DylanCaiCoding · commit 1335df4ff5d5 · 2022-04-22T18:23:34.000+08:00
diff --git a/docs/kotlin/delegate.md b/docs/kotlin/delegate.md
@@ -0,0 +1,61 @@
+## Kotlin 委托用法
+
+先康康最终效果，
+
+### 准备工作
+
+#### 修改基类
+
+只需简单的几步就可以把本库的功能集成到基类，并且不会影响到已有的代码，只是给基类增加了新的方法。
+
+修改步骤如下：
+
+1. 增加 `LoadingState by LoadingStateImpl(), OnReloadListener` 代码，这是给基类实现 `LoadingState` 和 `OnReloadListener` 接口，并且把 `LoadingState` 接口委托给 `LoadingStateImpl`。
+2. 在基类中添加 `open val isDecorated = true` 属性，提供一个可重写的配置变量。
+3. 在 Activity 的 `setContentView()` 方法后执行 `decorateContentView(this, isDecorated)`。在 Fragment 的 `onCreateView()` 返回值执行 `view.decorate(this, isDecorated)`。
+
+Activity 基类的修改示例：
+
+```kotlin
+abstract class BaseActivity(private val layoutRes: Int) : AppCompatActivity(),
+  LoadingState by LoadingStateImpl(), OnReloadListener {
+
+  open val isDecorated = true
+
+  override fun onCreate(savedInstanceState: Bundle?) {
+    super.onCreate(savedInstanceState)
+    setContentView(layoutRes)
+    decorateContentView(this, isDecorated)
+  }
+}
+```
+
+Fragment 基类的修改示例：
+
+```kotlin
+abstract class BaseFragment(private val layoutRes: Int) : Fragment(),
+  LoadingState by LoadingStateImpl(), OnReloadListener {
+
+  open val isDecorated = true
+
+  override fun onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View? {
+    val root = inflater.inflate(layoutRes, container, false)
+    return root.decorate(this, isDecorated)
+  }
+}
+```
+
+这样改造基类后会得到以下的增强：
+
+- 在不影响已有代码的情况下，增加了 [LoadingState](https://github.com/DylanCaiCoding/LoadingStateView/blob/master/loadingstateview-ktx/src/main/java/com/dylanc/loadingstateview/LoadingState.kt) 和 `OnReloadListener` 提供的常用方法。
+- 如果担心万一会遇到什么兼容问题，那么在页面重写 `override val isDecorated = false` 属性就会把新增的功能禁用，即使调用了方法也不会生效。
+
+#### 注册默认的标题栏和缺省页
+
+通常项目都有各自的标题栏封装，比如 `<include/>` 的标题栏布局或者自定义的标题栏控件，我们能基于此实现 `ToolbarViewDelegate`。
+
+```kotlin
+LoadingStateView.setViewDelegatePool {
+  register(ToolbarViewDelegate(), LoadingViewDelegate(), ErrorViewDelegate())
+}
+```
diff --git a/docs/kotlin/toolbar.md b/docs/kotlin/toolbar.md
diff --git a/loadingstateview-ktx/src/main/java/com/dylanc/loadingstateview/BaseToolbarViewDelegate.kt b/loadingstateview-ktx/src/main/java/com/dylanc/loadingstateview/BaseToolbarViewDelegate.kt
@@ -20,7 +20,7 @@ import android.view.LayoutInflater
 import android.view.View
 import android.view.ViewGroup
 
-abstract class ToolbarViewDelegate : LoadingStateView.ViewDelegate(ViewType.TITLE) {
+abstract class BaseToolbarViewDelegate : LoadingStateView.ViewDelegate(ViewType.TITLE) {
   internal lateinit var config: ToolbarConfig
 
   override fun onCreateView(inflater: LayoutInflater, parent: ViewGroup) =
diff --git a/loadingstateview-ktx/src/main/java/com/dylanc/loadingstateview/LoadingState.kt b/loadingstateview-ktx/src/main/java/com/dylanc/loadingstateview/LoadingState.kt
@@ -18,7 +18,6 @@ package com.dylanc.loadingstateview
 
 import android.app.Activity
 import android.view.View
-import android.view.ViewGroup
 import androidx.annotation.StringRes
 import androidx.fragment.app.Fragment
 
@@ -62,5 +61,5 @@ interface LoadingState {
 
   fun ToolbarViewDelegate(
     title: String? = null, navBtnType: NavBtnType = NavBtnType.ICON, block: (ToolbarConfig.() -> Unit)? = null
-  ): ToolbarViewDelegate
+  ): BaseToolbarViewDelegate
 }
diff --git a/loadingstateview-ktx/src/main/java/com/dylanc/loadingstateview/LoadingStateImpl.kt b/loadingstateview-ktx/src/main/java/com/dylanc/loadingstateview/LoadingStateImpl.kt
@@ -93,15 +93,15 @@ class LoadingStateImpl : LoadingState {
   }
 
   override fun updateToolbar(block: ToolbarConfig.() -> Unit) {
-    updateView<ToolbarViewDelegate>(ViewType.TITLE) { bind(config.apply(block)) }
+    updateView<BaseToolbarViewDelegate>(ViewType.TITLE) { bind(config.apply(block)) }
   }
 
   override fun <T : LoadingStateView.ViewDelegate> updateView(viewType: Any, block: T.() -> Unit) {
     loadingStateView?.getViewDelegate<T>(viewType)?.apply(block)
   }
 
   override fun ToolbarViewDelegate(title: String?, navBtnType: NavBtnType, block: (ToolbarConfig.() -> Unit)?) =
-    requireNotNull(loadingStateView?.getViewDelegate<ToolbarViewDelegate>(ViewType.TITLE)) {
+    requireNotNull(loadingStateView?.getViewDelegate<BaseToolbarViewDelegate>(ViewType.TITLE)) {
       "ToolbarViewDelegate must be registered before."
     }.apply {
       config = ToolbarConfig(title, navBtnType).apply { block?.invoke(this) }
diff --git a/loadingstateview-ktx/src/main/java/com/dylanc/loadingstateview/ToolbarConfig.kt b/loadingstateview-ktx/src/main/java/com/dylanc/loadingstateview/ToolbarConfig.kt
@@ -31,36 +31,47 @@ enum class NavBtnType {
 class ToolbarConfig(
   var title: String? = null,
   var navBtnType: NavBtnType = NavBtnType.ICON,
-  @DrawableRes var navIcon: Int? = null,
-  var navText: String? = null,
-  var onNavClickListener: View.OnClickListener = View.OnClickListener {
-    val context = it.context
-    if (context is Activity) context.finish()
-  },
-  @DrawableRes var rightIcon: Int? = null,
-  var rightText: String? = null,
-  var onRightClickListener: View.OnClickListener? = null,
-  val extras: HashMap<String, Any?> = HashMap()
-)
+  val extras: HashMap<String, Any?> = HashMap(),
+) {
+  @DrawableRes
+  var navIcon: Int? = null
+    private set
+  var navText: String? = null
+    private set
+  var onNavClickListener = View.OnClickListener {
+    if (it.context is Activity) {
+      (it.context as Activity).finish()
+    }
+  }
+    private set
 
-fun ToolbarConfig.navIcon(@DrawableRes icon: Int, listener: View.OnClickListener) {
-  navIcon = icon
-  onNavClickListener = listener
-}
+  @DrawableRes
+  var rightIcon: Int? = null
+    private set
+  var rightText: String? = null
+    private set
+  var onRightClickListener: View.OnClickListener? = null
+    private set
 
-fun ToolbarConfig.navText(text: String, listener: View.OnClickListener) {
-  navText = text
-  onNavClickListener = listener
-}
+  fun navIcon(@DrawableRes icon: Int, listener: View.OnClickListener) {
+    navIcon = icon
+    onNavClickListener = listener
+  }
 
-fun ToolbarConfig.rightIcon(@DrawableRes icon: Int, listener: View.OnClickListener) {
-  rightIcon = icon
-  onRightClickListener = listener
-}
+  fun navText(text: String, listener: View.OnClickListener) {
+    navText = text
+    onNavClickListener = listener
+  }
+
+  fun rightIcon(@DrawableRes icon: Int, listener: View.OnClickListener) {
+    rightIcon = icon
+    onRightClickListener = listener
+  }
 
-fun ToolbarConfig.rightText(text: String, listener: View.OnClickListener) {
-  rightText = text
-  onRightClickListener = listener
+  fun rightText(text: String, listener: View.OnClickListener) {
+    rightText = text
+    onRightClickListener = listener
+  }
 }
 
 fun <T> toolbarExtras() = object : ReadWriteProperty<ToolbarConfig, T?> {
diff --git a/loadingstateview/src/main/java/com/dylanc/loadingstateview/LoadingStateView.kt b/loadingstateview/src/main/java/com/dylanc/loadingstateview/LoadingStateView.kt
@@ -17,6 +17,7 @@
 package com.dylanc.loadingstateview
 
 import android.app.Activity
+import android.content.Context
 import android.view.LayoutInflater
 import android.view.View
 import android.view.ViewGroup
@@ -109,7 +110,7 @@ class LoadingStateView @JvmOverloads constructor(
   }
 
   private fun DecorViewDelegate.createDecorView() =
-    onCreateDecorView(LayoutInflater.from(contentView.context)).also { decorView ->
+    onCreateDecorView(contentView.context, LayoutInflater.from(contentView.context)).also { decorView ->
       contentView.layoutParams?.let {
         decorView.layoutParams = if (it is ConstraintLayout.LayoutParams) ConstraintLayout.LayoutParams(it) else it
       }
@@ -201,7 +202,7 @@ class LoadingStateView @JvmOverloads constructor(
   }
 
   abstract class DecorViewDelegate {
-    abstract fun onCreateDecorView(inflater: LayoutInflater): View
+    abstract fun onCreateDecorView(context: Context, inflater: LayoutInflater): View
     abstract fun getContentParent(decorView: View): ViewGroup
   }
 
@@ -213,7 +214,7 @@ class LoadingStateView @JvmOverloads constructor(
       getView(it.viewType)
     })
 
-    override fun onCreateDecorView(inflater: LayoutInflater) =
+    override fun onCreateDecorView(context: Context, inflater: LayoutInflater) =
       LinearLayout(inflater.context).apply {
         orientation = LinearLayout.VERTICAL
         contentParent = FrameLayout(context)
diff --git a/sample-kotlin/src/main/java/com/dylanc/loadingstateview/sample/kotlin/App.kt b/sample-kotlin/src/main/java/com/dylanc/loadingstateview/sample/kotlin/App.kt
@@ -4,14 +4,14 @@ import android.app.Application
 import com.dylanc.loadingstateview.LoadingStateView
 import com.dylanc.loadingstateview.sample.kotlin.delegate.ErrorViewDelegate
 import com.dylanc.loadingstateview.sample.kotlin.delegate.LoadingViewDelegate
-import com.dylanc.loadingstateview.sample.kotlin.delegate.DefaultToolbarViewDelegate
+import com.dylanc.loadingstateview.sample.kotlin.delegate.ToolbarViewDelegate
 
 class App : Application() {
 
   override fun onCreate() {
     super.onCreate()
     LoadingStateView.setViewDelegatePool {
-      register(DefaultToolbarViewDelegate(), LoadingViewDelegate(), ErrorViewDelegate())
+      register(ToolbarViewDelegate(), LoadingViewDelegate(), ErrorViewDelegate())
     }
   }
 }
diff --git a/sample-kotlin/src/main/java/com/dylanc/loadingstateview/sample/kotlin/delegate/LoadingViewDelegate.kt b/sample-kotlin/src/main/java/com/dylanc/loadingstateview/sample/kotlin/delegate/LoadingViewDelegate.kt
@@ -16,18 +16,17 @@
 
 package com.dylanc.loadingstateview.sample.kotlin.delegate
 
-import com.dylanc.loadingstateview.LoadingStateView.ViewDelegate
-import android.view.ViewGroup
 import android.view.LayoutInflater
 import android.view.View
+import android.view.ViewGroup
 import com.dylanc.loadingstateview.LoadingStateView
 import com.dylanc.loadingstateview.ViewType
 import com.dylanc.loadingstateview.sample.kotlin.R
 
 /**
  * @author Dylan Cai
  */
-class LoadingViewDelegate : ViewDelegate(ViewType.LOADING) {
+class LoadingViewDelegate : LoadingStateView.ViewDelegate(ViewType.LOADING) {
 
   override fun onCreateView(inflater: LayoutInflater, parent: ViewGroup): View =
     inflater.inflate(R.layout.layout_loading, parent, false)
diff --git a/sample-kotlin/src/main/java/com/dylanc/loadingstateview/sample/kotlin/delegate/ScrollingDecorViewDelegate.kt b/sample-kotlin/src/main/java/com/dylanc/loadingstateview/sample/kotlin/delegate/ScrollingDecorViewDelegate.kt
@@ -0,0 +1,45 @@
+/*
+ * Copyright (c) 2019. Dylan Cai
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.dylanc.loadingstateview.sample.kotlin.delegate
+
+import android.app.Activity
+import android.content.Context
+import android.view.LayoutInflater
+import android.view.View
+import android.view.ViewGroup
+import androidx.appcompat.widget.Toolbar
+import com.dylanc.loadingstateview.LoadingStateView
+import com.dylanc.loadingstateview.sample.kotlin.R
+
+/**
+ * @author Dylan Cai
+ */
+class ScrollingDecorViewDelegate(private val title: String) : LoadingStateView.DecorViewDelegate() {
+
+  override fun onCreateDecorView(context: Context, inflater: LayoutInflater): View {
+    val view = inflater.inflate(R.layout.layout_scrolling_toolbar, null)
+    val toolbar: Toolbar = view.findViewById(R.id.toolbar)
+    toolbar.title = title
+    toolbar.setNavigationOnClickListener {
+      if (context is Activity) context.finish()
+    }
+    return view
+  }
+
+  override fun getContentParent(decorView: View): ViewGroup {
+    return decorView.findViewById(R.id.content_parent)
+  }
+}
diff --git a/sample-kotlin/src/main/java/com/dylanc/loadingstateview/sample/kotlin/delegate/ToolbarViewDelegate.kt b/sample-kotlin/src/main/java/com/dylanc/loadingstateview/sample/kotlin/delegate/ToolbarViewDelegate.kt
@@ -21,13 +21,13 @@ import android.view.View
 import android.view.ViewGroup
 import com.dylanc.loadingstateview.NavBtnType
 import com.dylanc.loadingstateview.ToolbarConfig
-import com.dylanc.loadingstateview.ToolbarViewDelegate
+import com.dylanc.loadingstateview.BaseToolbarViewDelegate
 import com.dylanc.loadingstateview.sample.kotlin.databinding.LayoutToolbarBinding
 import com.dylanc.loadingstateview.toolbarExtras
 
 var ToolbarConfig.rightTextColor: Int? by toolbarExtras()
 
-class DefaultToolbarViewDelegate : ToolbarViewDelegate() {
+class ToolbarViewDelegate : BaseToolbarViewDelegate() {
   private lateinit var binding: LayoutToolbarBinding
 
   override fun onCreateToolbar(inflater: LayoutInflater, parent: ViewGroup): View {
diff --git a/sample-kotlin/src/main/res/layout/layout_scrolling_toolbar.xml b/sample-kotlin/src/main/res/layout/layout_scrolling_toolbar.xml
@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="utf-8"?>
+<androidx.coordinatorlayout.widget.CoordinatorLayout xmlns:android="http://schemas.android.com/apk/res/android"
+  xmlns:app="http://schemas.android.com/apk/res-auto"
+  android:layout_width="match_parent"
+  android:layout_height="match_parent">
+
+  <com.google.android.material.appbar.AppBarLayout
+    android:id="@+id/app_bar"
+    android:layout_width="match_parent"
+    android:layout_height="wrap_content"
+    android:elevation="2dp">
+
+    <androidx.appcompat.widget.Toolbar
+      android:id="@+id/toolbar"
+      android:layout_width="match_parent"
+      android:layout_height="?attr/actionBarSize"
+      app:layout_collapseMode="pin"
+      app:layout_scrollFlags="scroll|enterAlways"
+      app:navigationIcon="@drawable/ic_arrow_back_ios"
+      android:background="@color/white"
+      app:titleTextAppearance="@style/ToolbarTextAppearance" />
+
+  </com.google.android.material.appbar.AppBarLayout>
+
+  <FrameLayout
+    android:id="@+id/content_parent"
+    android:layout_width="match_parent"
+    android:layout_height="match_parent"
+    app:layout_behavior="@string/appbar_scrolling_view_behavior"/>
+
+</androidx.coordinatorlayout.widget.CoordinatorLayout>

Original file line number	Diff line number	Diff line change
`@@ -93,15 +93,15 @@ class LoadingStateImpl : LoadingState {`
`93`	`93`	`}`
`94`	`94`
`95`	`95`	`override fun updateToolbar(block: ToolbarConfig.() -> Unit) {`
`96`		`- updateView<ToolbarViewDelegate>(ViewType.TITLE) { bind(config.apply(block)) }`
	`96`	`+ updateView<BaseToolbarViewDelegate>(ViewType.TITLE) { bind(config.apply(block)) }`
`97`	`97`	`}`
`98`	`98`
`99`	`99`	`override fun <T : LoadingStateView.ViewDelegate> updateView(viewType: Any, block: T.() -> Unit) {`
`100`	`100`	`loadingStateView?.getViewDelegate<T>(viewType)?.apply(block)`
`101`	`101`	`}`
`102`	`102`
`103`	`103`	`override fun ToolbarViewDelegate(title: String?, navBtnType: NavBtnType, block: (ToolbarConfig.() -> Unit)?) =`
`104`		`- requireNotNull(loadingStateView?.getViewDelegate<ToolbarViewDelegate>(ViewType.TITLE)) {`
	`104`	`+ requireNotNull(loadingStateView?.getViewDelegate<BaseToolbarViewDelegate>(ViewType.TITLE)) {`
`105`	`105`	`"ToolbarViewDelegate must be registered before."`
`106`	`106`	`}.apply {`
`107`	`107`	`config = ToolbarConfig(title, navBtnType).apply { block?.invoke(this) }`
Original file line number	Diff line number	Diff line change
`@@ -4,14 +4,14 @@ import android.app.Application`
`4`	`4`	`import com.dylanc.loadingstateview.LoadingStateView`
`5`	`5`	`import com.dylanc.loadingstateview.sample.kotlin.delegate.ErrorViewDelegate`
`6`	`6`	`import com.dylanc.loadingstateview.sample.kotlin.delegate.LoadingViewDelegate`
`7`		`-import com.dylanc.loadingstateview.sample.kotlin.delegate.DefaultToolbarViewDelegate`
	`7`	`+import com.dylanc.loadingstateview.sample.kotlin.delegate.ToolbarViewDelegate`
`8`	`8`
`9`	`9`	`class App : Application() {`
`10`	`10`
`11`	`11`	`override fun onCreate() {`
`12`	`12`	`super.onCreate()`
`13`	`13`	`LoadingStateView.setViewDelegatePool {`
`14`		`- register(DefaultToolbarViewDelegate(), LoadingViewDelegate(), ErrorViewDelegate())`
	`14`	`+ register(ToolbarViewDelegate(), LoadingViewDelegate(), ErrorViewDelegate())`
`15`	`15`	`}`
`16`	`16`	`}`
`17`	`17`	`}`