清理代码；更新注释;优化点击事件处理

AlanCheen · AlanCheen · commit 036d057066ab · 2022-09-08T14:52:50.000+08:00
diff --git a/app/src/main/java/me/yifeiyuan/flapdev/components/TestAllComponent.kt b/app/src/main/java/me/yifeiyuan/flapdev/components/TestAllComponent.kt
@@ -66,11 +66,7 @@ class TestAllComponent(view: View) : Component<TestAllModel>(view) {
 
                 val logService = adapter.getAdapterService(TestService::class.java)
                 logService?.log("LogService Message")
-
-                val logService2 = adapter.getAdapterService<TestService>("LogService")
-
-                val result = logService2?.testResult()
-                messageTextView.text = result
+                messageTextView.text = logService?.testResult()
             }
         }
     }
diff --git a/app/src/main/java/me/yifeiyuan/flapdev/testcases/BaseTestcaseFragment.kt b/app/src/main/java/me/yifeiyuan/flapdev/testcases/BaseTestcaseFragment.kt
@@ -142,7 +142,6 @@ open class BaseTestcaseFragment : Fragment(), Scrollable {
         }
 
         adapter.registerAdapterService(TestService::class.java)
-        adapter.registerAdapterService("LogService", TestService::class.java)
 
         initLayoutManagers()
         initItemDecorations()
diff --git a/app/src/main/java/me/yifeiyuan/flapdev/testcases/DSLTestcase.kt b/app/src/main/java/me/yifeiyuan/flapdev/testcases/DSLTestcase.kt
@@ -6,16 +6,16 @@ import android.widget.ImageView
 import me.yifeiyuan.flap.Component
 import me.yifeiyuan.flap.FlapAdapter
 import me.yifeiyuan.flap.delegate.AdapterDelegate
+import me.yifeiyuan.flap.delegate.LayoutAdapterDelegate
 import me.yifeiyuan.flap.dsl.adapterDelegate
 import me.yifeiyuan.flap.dsl.adapterHook
-import me.yifeiyuan.flap.ext.bindButton
-import me.yifeiyuan.flap.ext.bindTextView
-import me.yifeiyuan.flap.ext.bindView
+import me.yifeiyuan.flap.ext.*
 import me.yifeiyuan.flap.hook.AdapterHook
 import me.yifeiyuan.flapdev.R
 import me.yifeiyuan.flapdev.components.SimpleImageModel
 import me.yifeiyuan.flapdev.components.SimpleTextModel
 import me.yifeiyuan.flapdev.components.TestAllModel
+import me.yifeiyuan.flapdev.components.TestBinderModel
 import me.yifeiyuan.flapdev.mockMultiTypeModels
 
 private const val TAG = "DSLTestcase"
@@ -157,7 +157,9 @@ class DSLTestcase : BaseTestcaseFragment() {
             }
         }
 
-
+//        val layoutDelegate = LayoutAdapterDelegate(TestBinderModel::class.java, R.layout.flap_item_binder) {
+//            model: TestBinderModel, position: Int, payloads: List<Any>, adapter: FlapAdapter ->
+//        }
 
         adapter.registerAdapterDelegates(simpleTextDelegate, simpleImageDelegate, testAllDelegate)
 
diff --git a/flap/src/main/java/me/yifeiyuan/flap/Component.kt b/flap/src/main/java/me/yifeiyuan/flap/Component.kt
@@ -32,7 +32,7 @@ import me.yifeiyuan.flap.delegate.AdapterDelegate
  * @since 2020/9/22
  * @since 3.0.0
  */
-abstract class Component<T>(itemView: View) : RecyclerView.ViewHolder(itemView), LifecycleObserver, ComponentConfig {
+open class Component<T>(itemView: View) : RecyclerView.ViewHolder(itemView), LifecycleObserver, ComponentConfig {
 
     /**
      * 默认情况下 context 是 Activity Context ；
@@ -55,6 +55,7 @@ abstract class Component<T>(itemView: View) : RecyclerView.ViewHolder(itemView),
     }
 
     /**
+     * 执行数据绑定，处理业务逻辑
      *
      * @param model    The model that you need to bind.
      * @param position position
@@ -76,7 +77,7 @@ abstract class Component<T>(itemView: View) : RecyclerView.ViewHolder(itemView),
      *
      * @see onBind
      */
-    abstract fun onBind(model: T)
+    open fun onBind(model: T) {}
 
     protected fun <V : View> findViewById(@IdRes viewId: Int): V {
         return itemView.findViewById<View>(viewId) as V
diff --git a/flap/src/main/java/me/yifeiyuan/flap/Flap.kt b/flap/src/main/java/me/yifeiyuan/flap/Flap.kt
@@ -7,7 +7,6 @@ import me.yifeiyuan.flap.delegate.AdapterDelegate
 import me.yifeiyuan.flap.delegate.AdapterDelegateManager
 import me.yifeiyuan.flap.delegate.FallbackAdapterDelegate
 import me.yifeiyuan.flap.delegate.IAdapterDelegateManager
-import me.yifeiyuan.flap.hook.AdapterHook
 import me.yifeiyuan.flap.hook.AdapterHookManager
 import me.yifeiyuan.flap.hook.IAdapterHookManager
 import me.yifeiyuan.flap.pool.ComponentPool
diff --git a/flap/src/main/java/me/yifeiyuan/flap/FlapAdapter.kt b/flap/src/main/java/me/yifeiyuan/flap/FlapAdapter.kt
@@ -107,7 +107,6 @@ open class FlapAdapter : RecyclerView.Adapter<Component<*>>(), IAdapterHookManag
         adapterHooks.addAll(Flap.adapterHooks)
         adapterDelegates.addAll(Flap.adapterDelegates)
         adapterServices.putAll(Flap.adapterServices)
-        namedAdapterServices.putAll(Flap.namedAdapterServices)
 
         Flap.globalDefaultAdapterDelegate?.let {
             defaultAdapterDelegate = it
diff --git a/flap/src/main/java/me/yifeiyuan/flap/IRegistry.kt b/flap/src/main/java/me/yifeiyuan/flap/IRegistry.kt
diff --git a/flap/src/main/java/me/yifeiyuan/flap/delegate/AdapterDelegate.kt b/flap/src/main/java/me/yifeiyuan/flap/delegate/AdapterDelegate.kt
@@ -9,17 +9,15 @@ import java.lang.reflect.ParameterizedType
 
 /**
  *
- * A delegate class that delegates some methods of FlapAdapter.
+ * AdapterDelegate 是一个代理类，负责代理 Adapter 的部分方法。
  *
- * AdapterDelegate 是 FlapAdapter 的代理类，负责代理 Adapter 的部分方法。
- * 当一个 AdapterDelegate.delegate(model) 返回 true 表示它负责接手这个数据模型。
+ * 每个 model 都应该有一个对应的 AdapterDelegate，当一个 AdapterDelegate.delegate(model) 返回 true 表示它负责代理这个 model。
  * 一般一个 AdapterDelegate 代理一个类型的 Model，是一对一的关系，这样更加解耦。
  * 这样可以解耦 Adapter 对不同类型的 Model 的处理。
  *
  * 如果一个 model 没有任何 AdapterDelegate 代理，那么 FallbackAdapterDelegate 会兜底处理
  * @see FallbackAdapterDelegate
  *
- *
  * Created by 程序亦非猿 on 2021/9/22.
  *
  * Flap Github: <a>https://github.com/AlanCheen/Flap</a>
diff --git a/flap/src/main/java/me/yifeiyuan/flap/delegate/IAdapterDelegateManager.kt b/flap/src/main/java/me/yifeiyuan/flap/delegate/IAdapterDelegateManager.kt
@@ -3,26 +3,41 @@ package me.yifeiyuan.flap.delegate
 import androidx.annotation.NonNull
 
 /**
- * Created by 程序亦非猿 on 2022/9/5.
+ * AdapterDelegate 管理者的抽象
+ *
+ * @see AdapterDelegateManager
  *
+ * Created by 程序亦非猿 on 2022/9/5.
  * @since 3.1.0
  */
 interface IAdapterDelegateManager {
 
     val adapterDelegates: MutableList<AdapterDelegate<*,*>>
 
+    /**
+     * 注册单个 AdapterDelegate
+     */
     fun registerAdapterDelegate(@NonNull adapterDelegate: AdapterDelegate<*,*>){
         this.adapterDelegates.add(adapterDelegate)
     }
 
+    /**
+     * 注册多个 AdapterDelegate
+     */
     fun registerAdapterDelegates(vararg adapterDelegates: AdapterDelegate<*, *>){
         this.adapterDelegates.addAll(adapterDelegates)
     }
 
+    /**
+     * 注销单个 AdapterDelegate
+     */
     fun unregisterAdapterDelegate(@NonNull adapterDelegate: AdapterDelegate<*,*>){
         this.adapterDelegates.remove(adapterDelegate)
     }
 
+    /**
+     * 注销所有 AdapterDelegate
+     */
     fun clearAdapterDelegates(){
         adapterDelegates.clear()
     }
diff --git a/flap/src/main/java/me/yifeiyuan/flap/delegate/LayoutAdapterDelegate.kt b/flap/src/main/java/me/yifeiyuan/flap/delegate/LayoutAdapterDelegate.kt
@@ -12,9 +12,13 @@ import me.yifeiyuan.flap.FlapAdapter
  *
  * LayoutAdapterDelegate 是为了降低创建 Component 和 自定义 AdapterDelegate 带来的使用成本而创建的。
  *
- * 使用 LayoutAdapterDelegate 必须要保证的情况：
- * 1. Model 与 LayoutAdapterDelegate 是一对一的关系
- * 2. layoutId 可以当做 itemViewType 直接用
+ * 使用 LayoutAdapterDelegate 只适用于：
+ * - layoutId 可以当做 itemViewType 直接用
+ * - 只关心 onBind 处理逻辑
+ *
+ * LayoutAdapterDelegate 的使用体验介于 自定义 AdapterDelegate 和 DSL 中间，看情况选择。
+ *
+ * @see me.yifeiyuan.flap.dsl.adapterDelegate
  *
  * Created by 程序亦非猿 on 2021/10/27.
  * @since 3.0.0
@@ -34,7 +38,7 @@ class LayoutAdapterDelegate<T>(
 
     override fun onCreateViewHolder(inflater: LayoutInflater, parent: ViewGroup, viewType: Int): Component<T> {
         val view = inflater.inflate(viewType, parent, false)
-        return LayoutComponent(view)
+        return Component(view)
     }
 
     override fun onBindViewHolder(component: Component<*>, data: Any, position: Int, payloads: List<Any>, adapter: FlapAdapter) {
@@ -48,10 +52,4 @@ class LayoutAdapterDelegate<T>(
     override fun getItemId(model: Any, position: Int): Long {
         return itemId
     }
-}
-
-class LayoutComponent<T>(view: View) : Component<T>(view) {
-
-    override fun onBind(model: T) {
-    }
 }
diff --git a/flap/src/main/java/me/yifeiyuan/flap/dsl/AdapterDelegateDsl.kt b/flap/src/main/java/me/yifeiyuan/flap/dsl/AdapterDelegateDsl.kt
@@ -14,19 +14,29 @@ import me.yifeiyuan.flap.delegate.AdapterDelegate
 /**
  * 支持 AdapterDelegate DSL 功能
  *
+ * @param layoutId 资源 id
+ * @param isDelegateFor 代理关系
+ * @param itemId
+ * @param componentInitializer 初始化 DslComponent 设置
+ *
  * @since 3.0.9
  */
-inline fun <reified T> adapterDelegate(@LayoutRes layoutId: Int, noinline isDelegateFor: ((model: Any) -> Boolean) = { m -> m.javaClass == T::class.java }, noinline componentInitializer: DslComponent<T>.() -> Unit): DslAdapterDelegate<T> {
-    return DslAdapterDelegate(T::class.java, layoutId, isDelegateFor = isDelegateFor, block = componentInitializer)
+inline fun <reified T> adapterDelegate(
+        @LayoutRes layoutId: Int,
+        noinline isDelegateFor: ((model: Any) -> Boolean) = { m -> m.javaClass == T::class.java },
+        itemId: Long = RecyclerView.NO_ID,
+        noinline componentInitializer: DslComponent<T>.() -> Unit): DslAdapterDelegate<T> {
+    return DslAdapterDelegate(T::class.java, layoutId, itemId, isDelegateFor = isDelegateFor, block = componentInitializer)
 }
 
 /**
- * Created by 程序亦非猿 on 2022/9/1.
+ * 支持 DSL 化的 AdapterDelegate
  *
+ * Created by 程序亦非猿 on 2022/9/1.
  * @since 3.0.9
  */
 class DslAdapterDelegate<T>(
-        private var modelClass: Class<T>?,
+        private var modelClass: Class<T>,
         @LayoutRes private var layoutId: Int,
         private var itemId: Long = RecyclerView.NO_ID,
         private var isDelegateFor: ((model: Any) -> Boolean) = { m -> m.javaClass == modelClass },
@@ -103,26 +113,29 @@ class DslComponent<T>(view: View) : Component<T>(view) {
             onBind?.invoke(model)
         }
 
-        if (onClickListener != null && isClickable()) {
+        if (onClickListener != null) {
             itemView.setOnClickListener {
-                onClickListener?.invoke(model, position, adapter)
+                if (isClickable()) {
+                    onClickListener?.invoke(model, position, adapter)
+                }
             }
         } else {
             itemView.setOnClickListener(null)
         }
 
-        if (onLongClickListener != null && isLongClickable()) {
+        if (onLongClickListener != null) {
             itemView.setOnLongClickListener {
-                onLongClickListener!!.invoke(model, position, adapter)
+                if (isLongClickable()) {
+                    onLongClickListener!!.invoke(model, position, adapter)
+                } else {
+                    false
+                }
             }
         } else {
             itemView.setOnLongClickListener(null)
         }
     }
 
-    override fun onBind(model: T) {
-    }
-
     override fun onViewAttachedToWindow(flapAdapter: FlapAdapter) {
         super.onViewAttachedToWindow(flapAdapter)
         onViewAttachedToWindow?.invoke()
diff --git a/flap/src/main/java/me/yifeiyuan/flap/ext/ItemClicksHelper.kt b/flap/src/main/java/me/yifeiyuan/flap/ext/ItemClicksHelper.kt
@@ -34,39 +34,27 @@ internal class ItemClicksHelper : RecyclerView.OnChildAttachStateChangeListener
 
     private val internalOnClickListener = View.OnClickListener { v ->
         val holder: RecyclerView.ViewHolder = recyclerView.getChildViewHolder(v)
-        onItemClickListener?.invoke(recyclerView, v, holder.position)
+        if (holder is ComponentConfig && holder.isClickable()) {
+            onItemClickListener?.invoke(recyclerView, v, holder.position)
+        }
     }
 
     private val internalOnLongClickListener = View.OnLongClickListener { v ->
         val holder: RecyclerView.ViewHolder = recyclerView.getChildViewHolder(v)
-        onItemLongClickListener?.invoke(recyclerView, v, holder.position) ?: false
+        if (holder is ComponentConfig && holder.isLongClickable()) {
+            onItemLongClickListener?.invoke(recyclerView, v, holder.position) ?: false
+        } else {
+            false
+        }
     }
 
     override fun onChildViewAttachedToWindow(view: View) {
-        val holder: RecyclerView.ViewHolder = recyclerView.getChildViewHolder(view)
-
         onItemClickListener?.let {
-            if (holder is ComponentConfig) {
-                if (holder.isClickable()) {
-                    view.setOnClickListener(internalOnClickListener)
-                } else {
-                    view.setOnClickListener(null)
-                }
-            } else {
-                view.setOnClickListener(internalOnClickListener)
-            }
+            view.setOnClickListener(internalOnClickListener)
         }
 
         onItemLongClickListener?.let {
-            if (holder is ComponentConfig) {
-                if (holder.isLongClickable()) {
-                    view.setOnLongClickListener(internalOnLongClickListener)
-                } else {
-                    view.setOnLongClickListener(null)
-                }
-            } else {
-                view.setOnLongClickListener(internalOnLongClickListener)
-            }
+            view.setOnLongClickListener(internalOnLongClickListener)
         }
     }
 
diff --git a/flap/src/main/java/me/yifeiyuan/flap/hook/IAdapterHookManager.kt b/flap/src/main/java/me/yifeiyuan/flap/hook/IAdapterHookManager.kt
@@ -3,6 +3,9 @@ package me.yifeiyuan.flap.hook
 import androidx.annotation.NonNull
 
 /**
+ * AdapterHook 管理者的抽象
+ * @see AdapterHookManager
+ *
  * Created by 程序亦非猿 on 2022/9/5.
  * @since 3.1.0
  */
diff --git a/flap/src/main/java/me/yifeiyuan/flap/service/AdapterServiceManager.kt b/flap/src/main/java/me/yifeiyuan/flap/service/AdapterServiceManager.kt
@@ -14,7 +14,6 @@ package me.yifeiyuan.flap.service
 internal class AdapterServiceManager : IAdapterServiceManager {
 
     override val adapterServices: MutableMap<Class<*>, AdapterService> = mutableMapOf()
-    override val namedAdapterServices: MutableMap<String, AdapterService> = mutableMapOf()
 
     override fun <T : AdapterService> registerAdapterService(serviceClass: Class<T>) {
         try {
@@ -33,20 +32,4 @@ internal class AdapterServiceManager : IAdapterServiceManager {
         return adapterServices[serviceClass] as? T
     }
 
-    override fun <T : AdapterService> registerAdapterService(serviceName: String, serviceClass: Class<T>) {
-        try {
-            val service = serviceClass.getConstructor().newInstance()
-            namedAdapterServices[serviceName] = service
-        } catch (e: Exception) {
-            e.printStackTrace()
-        }
-    }
-
-    override fun <T : AdapterService> registerAdapterService(serviceName: String, service: T) {
-        namedAdapterServices[serviceName] = service
-    }
-
-    override fun <T : AdapterService> getAdapterService(serviceName: String): T? {
-        return namedAdapterServices[serviceName] as? T
-    }
 }
diff --git a/flap/src/main/java/me/yifeiyuan/flap/service/IAdapterServiceManager.kt b/flap/src/main/java/me/yifeiyuan/flap/service/IAdapterServiceManager.kt

Original file line number	Diff line number	Diff line change
`@@ -66,11 +66,7 @@ class TestAllComponent(view: View) : Component<TestAllModel>(view) {`
`66`	`66`
`67`	`67`	`val logService = adapter.getAdapterService(TestService::class.java)`
`68`	`68`	`logService?.log("LogService Message")`
`69`		`-`
`70`		`- val logService2 = adapter.getAdapterService<TestService>("LogService")`
`71`		`-`
`72`		`- val result = logService2?.testResult()`
`73`		`- messageTextView.text = result`
	`69`	`+ messageTextView.text = logService?.testResult()`
`74`	`70`	`}`
`75`	`71`	`}`
`76`	`72`	`}`
Original file line number	Diff line number	Diff line change
`@@ -142,7 +142,6 @@ open class BaseTestcaseFragment : Fragment(), Scrollable {`
`142`	`142`	`}`
`143`	`143`
`144`	`144`	`adapter.registerAdapterService(TestService::class.java)`
`145`		`- adapter.registerAdapterService("LogService", TestService::class.java)`
`146`	`145`
`147`	`146`	`initLayoutManagers()`
`148`	`147`	`initItemDecorations()`
Original file line number	Diff line number	Diff line change
`@@ -9,17 +9,15 @@ import java.lang.reflect.ParameterizedType`
`9`	`9`
`10`	`10`	`/**`
`11`	`11`	`*`
`12`		`- * A delegate class that delegates some methods of FlapAdapter.`
	`12`	`+ * AdapterDelegate 是一个代理类，负责代理 Adapter 的部分方法。`
`13`	`13`	`*`
`14`		`- * AdapterDelegate 是 FlapAdapter 的代理类，负责代理 Adapter 的部分方法。`
`15`		`- * 当一个 AdapterDelegate.delegate(model) 返回 true 表示它负责接手这个数据模型。`
	`14`	`+ * 每个 model 都应该有一个对应的 AdapterDelegate，当一个 AdapterDelegate.delegate(model) 返回 true 表示它负责代理这个 model。`
`16`	`15`	`* 一般一个 AdapterDelegate 代理一个类型的 Model，是一对一的关系，这样更加解耦。`
`17`	`16`	`* 这样可以解耦 Adapter 对不同类型的 Model 的处理。`
`18`	`17`	`*`
`19`	`18`	`* 如果一个 model 没有任何 AdapterDelegate 代理，那么 FallbackAdapterDelegate 会兜底处理`
`20`	`19`	`* @see FallbackAdapterDelegate`
`21`	`20`	`*`
`22`		`- *`
`23`	`21`	`* Created by 程序亦非猿 on 2021/9/22.`
`24`	`22`	`*`
`25`	`23`	`* Flap Github: <a>https://github.com/AlanCheen/Flap</a>`
Original file line number	Diff line number	Diff line change
`@@ -12,9 +12,13 @@ import me.yifeiyuan.flap.FlapAdapter`
`12`	`12`	`*`
`13`	`13`	`* LayoutAdapterDelegate 是为了降低创建 Component 和自定义 AdapterDelegate 带来的使用成本而创建的。`
`14`	`14`	`*`
`15`		`- * 使用 LayoutAdapterDelegate 必须要保证的情况：`
`16`		`- * 1. Model 与 LayoutAdapterDelegate 是一对一的关系`
`17`		`- * 2. layoutId 可以当做 itemViewType 直接用`
	`15`	`+ * 使用 LayoutAdapterDelegate 只适用于：`
	`16`	`+ * - layoutId 可以当做 itemViewType 直接用`
	`17`	`+ * - 只关心 onBind 处理逻辑`
	`18`	`+ *`
	`19`	`+ * LayoutAdapterDelegate 的使用体验介于自定义 AdapterDelegate 和 DSL 中间，看情况选择。`
	`20`	`+ *`
	`21`	`+ * @see me.yifeiyuan.flap.dsl.adapterDelegate`
`18`	`22`	`*`
`19`	`23`	`* Created by 程序亦非猿 on 2021/10/27.`
`20`	`24`	`* @since 3.0.0`
`@@ -34,7 +38,7 @@ class LayoutAdapterDelegate<T>(`
`34`	`38`
`35`	`39`	`override fun onCreateViewHolder(inflater: LayoutInflater, parent: ViewGroup, viewType: Int): Component<T> {`
`36`	`40`	`val view = inflater.inflate(viewType, parent, false)`
`37`		`- return LayoutComponent(view)`
	`41`	`+ return Component(view)`
`38`	`42`	`}`
`39`	`43`
`40`	`44`	`override fun onBindViewHolder(component: Component<*>, data: Any, position: Int, payloads: List<Any>, adapter: FlapAdapter) {`
`@@ -48,10 +52,4 @@ class LayoutAdapterDelegate<T>(`
`48`	`52`	`override fun getItemId(model: Any, position: Int): Long {`
`49`	`53`	`return itemId`
`50`	`54`	`}`
`51`		`-}`
`52`		`-`
`53`		`-class LayoutComponent<T>(view: View) : Component<T>(view) {`
`54`		`-`
`55`		`- override fun onBind(model: T) {`
`56`		`- }`
`57`	`55`	`}`