fix: ViewPool 安全性改进

donglua · donglua · commit c51614059dcb · 2026-05-23T05:43:14.000Z
- ViewCleaner: 默认归一化 visibility/isEnabled/isSelected/isActivated/contentDescription
- ViewPool.recycle: 拒绝仍 attached 的 view 入池
- ViewPool.obtain: 有界尝试替代 while+repeat，避免并发活锁
- ViewPool: 新增 opt-in host(Activity) 隔离 + clearForHost
- FastInflater: onActivityDestroyed 委托 clearForHost
- 补充单元测试覆盖以上改动
diff --git a/README.md b/README.md
@@ -111,7 +111,9 @@ val binding = FastDataBinding.inflate<ItemFeedBinding>(
 
 ### 自定义回收策略
 
-默认 `ViewCleaner` 只清理 Android 基础 View 状态，例如文本、图片、listener、alpha、translation、scale、scroll 和动画。业务自定义状态不会被自动识别，例如：
+默认 `ViewCleaner` 只清理 Android 基础 View 状态，例如文本、图片、listener、alpha、translation、scale、scroll 和动画。**此外还会将 `visibility` 归一化为 `VISIBLE`、`isEnabled` 归一化为 `true`、`isSelected`/`isActivated` 归一化为 `false`、`contentDescription` 清空。** 如果布局 XML 中某些子 View 的静态默认值不是这些（例如默认 `GONE` 的占位 View、默认 `disabled` 的按钮、固定的无障碍文案），复用后需要在 bind 阶段或 `ViewRecyclePolicy.onObtain()` 中恢复。
+
+业务自定义状态不会被自动识别，例如：
 
 - 自定义 View 内部的展开/折叠变量、选中缓存、加载状态
 - 运行时替换的特殊背景、前景、Drawable callback
diff --git a/lib/src/main/java/com/github/donglua/fastinflater/FastInflater.kt b/lib/src/main/java/com/github/donglua/fastinflater/FastInflater.kt
@@ -52,7 +52,7 @@ class FastInflater private constructor(context: Context) {
                 override fun onActivityStopped(activity: Activity) = Unit
                 override fun onActivitySaveInstanceState(activity: Activity, outState: Bundle) = Unit
                 override fun onActivityDestroyed(activity: Activity) {
-                    viewPool.clear()
+                    viewPool.clearForHost(activity)
                 }
             }
         )
@@ -234,6 +234,23 @@ class FastInflater private constructor(context: Context) {
         viewPool.setFactoryIsolation(enabled)
     }
 
+    /**
+     * 开启/关闭 host（Activity）隔离。默认关闭。
+     *
+     * 开启后不同 Activity 的 View 不会串池，避免 context/theme 不一致导致的 UI 异常。
+     * 关闭后所有 context 共享同一个桶，适合全局 theme 一致的项目（绝大多数情况）。
+     *
+     * 开启后建议用 Activity context 做 warmUp，以确保预热的 View 进入对应 Activity 的桶。
+     * 切换时会清空池。
+     */
+    fun setHostIsolation(enabled: Boolean) {
+        viewPool.setHostIsolation(enabled)
+    }
+
+    fun isHostIsolationEnabled(): Boolean {
+        return viewPool.isHostIsolationEnabled()
+    }
+
     /**
      * 一键开关诊断埋点（[InflateTracker] + [PoolStats]）。
      *
diff --git a/lib/src/main/java/com/github/donglua/fastinflater/ViewCleaner.kt b/lib/src/main/java/com/github/donglua/fastinflater/ViewCleaner.kt
@@ -43,6 +43,15 @@ object ViewCleaner {
         view.clearAnimation()
         view.clearFocus()
 
+        // ⚠️ 以下属性会被归一化到"可见/可用"默认值。
+        // 如果布局 XML 中某些子 View 的静态默认值不是 VISIBLE / enabled / 无 contentDescription，
+        // 复用后需要在 bind 阶段或 ViewRecyclePolicy.onObtain() 中恢复。
+        view.visibility = View.VISIBLE
+        view.isEnabled = true
+        view.isSelected = false
+        view.isActivated = false
+        view.contentDescription = null
+
         if (view is TextView) {
             view.text = null
             view.setOnEditorActionListener(null)
@@ -55,6 +64,7 @@ object ViewCleaner {
         }
         if (view is CompoundButton) {
             view.setOnCheckedChangeListener(null)
+            view.isChecked = false
         }
     }
 }
diff --git a/lib/src/main/java/com/github/donglua/fastinflater/ViewPool.kt b/lib/src/main/java/com/github/donglua/fastinflater/ViewPool.kt
@@ -1,6 +1,8 @@
 package com.github.donglua.fastinflater
 
+import android.app.Activity
 import android.content.Context
+import android.content.ContextWrapper
 import android.os.Handler
 import android.os.Looper
 import android.util.Xml
@@ -31,10 +33,9 @@ class ViewPool {
     }
 
     /**
-     * Pool key 用 Long 表示。
-     * - 默认（factoryIsolation = false）：key = layoutId（直接放低 32 位），不访问 Context
-     * - 开启 factory 隔离时：高 32 位 layoutId，低 32 位 factory hash
-     * 用 Long 而非 data class 是为了避免每次 obtain/recycle 都分配对象。
+     * Pool key 用 Long 表示，避免每次 obtain/recycle 分配对象。
+     * - 高 32 位：layoutId
+     * - 低 32 位：隔离 hash（hostHash xor factoryHash，两者都关时为 0）
      */
     private val pool = ConcurrentHashMap<Long, ConcurrentLinkedDeque<View>>()
     private val policies = ConcurrentHashMap<Int, ViewRecyclePolicy>()
@@ -59,6 +60,20 @@ class ViewPool {
     @Volatile
     private var factoryIsolation = false
 
+    /**
+     * 开启/关闭 host（Activity）隔离。默认关闭。
+     *
+     * 开启后 pool key 包含 Activity identityHashCode，
+     * 不同 Activity 的 View 不会串池，避免 context/theme 不一致导致的 UI 异常。
+     *
+     * 注意：开启后 Application context 预热的 View 进入独立桶（hostHash=0），
+     * 不会被 Activity context 的 obtain 命中。请改用 Activity context 做 warmUp。
+     *
+     * 关闭时所有 context 共享同一个桶，适合全局 theme 一致的项目（绝大多数情况）。
+     */
+    @Volatile
+    private var hostIsolation = false
+
     private var defaultMaxPoolSize = 4
 
     fun setMaxPoolSize(size: Int) {
@@ -94,6 +109,47 @@ class ViewPool {
 
     fun isFactoryIsolationEnabled(): Boolean = factoryIsolation
 
+    /**
+     * 开启/关闭 host（Activity）隔离。默认关闭。
+     *
+     * 开启后不同 Activity 的 View 不会串池，Application context 预热的 View 进入共享桶。
+     * 关闭后所有 context 共享同一个桶，适合全局 theme 一致的项目（绝大多数情况）。
+     *
+     * 切换时会清空池。
+     */
+    fun setHostIsolation(enabled: Boolean) {
+        if (hostIsolation == enabled) return
+        hostIsolation = enabled
+        clear()
+    }
+
+    fun isHostIsolationEnabled(): Boolean = hostIsolation
+
+    /**
+     * 清除指定 Activity 关联的所有池条目。
+     * 在 Activity.onDestroy 时调用，避免池中 View 持有已销毁 Activity 的 context。
+     *
+     * - hostIsolation 关闭：退化为 [clear]（无法按 host 区分）。
+     * - hostIsolation + factoryIsolation 同时开启：低 32 位是 hostHash xor factoryHash，
+     *   无法仅凭 activityHash 精确匹配，退化为 [clear] 避免泄漏。
+     * - 仅 hostIsolation 开启：精确删除低 32 位等于 activityHash 的条目。
+     */
+    fun clearForHost(activity: Activity) {
+        if (!hostIsolation || factoryIsolation) {
+            clear()
+            return
+        }
+        poolGeneration.incrementAndGet()
+        val activityHash = System.identityHashCode(activity)
+        val mask = 0xFFFFFFFFL
+        pool.keys.removeIf { key ->
+            (key and mask).toInt() == activityHash
+        }
+        warmingCounts.keys.removeIf { key ->
+            (key and mask).toInt() == activityHash
+        }
+    }
+
     /**
      * 控制某个布局是否允许进入 FastInflater 池。
      *
@@ -122,30 +178,51 @@ class ViewPool {
      *
      * 池中的 View 在 [recycle] 时已经被清理过（默认 [ViewCleaner.clean] 或 [ViewRecyclePolicy.onRecycle]），
      * View 处于 detached 状态、不会被外部修改，所以这里不再重复清理整棵 View 树。
+     *
+     * 并发安全：用有界尝试（snapshot size）替代无界 while 循环，避免并发 offer 导致的活锁。
+     * 不兼容的 View 暂存本地列表，最后统一放回队尾，保留给后续兼容的 parent 使用。
      */
     fun obtain(@LayoutRes layoutId: Int, context: Context, parent: ViewGroup? = null): View? {
         if (isPoolingDisabled(layoutId)) return null
         val key = keyFor(layoutId, context)
+        return pollCompatible(key, layoutId, context, parent)
+    }
+
+    /**
+     * 从指定 deque 中 poll 出第一个与 parent 兼容的 View。
+     * 最多尝试 deque 当前 size 次（快照），不兼容的 View 暂存后统一放回队尾。
+     */
+    private fun pollCompatible(
+        key: Long,
+        @LayoutRes layoutId: Int,
+        context: Context,
+        parent: ViewGroup?
+    ): View? {
         val deque = pool[key] ?: return null
-        while (true) {
-            val view = deque.poll() ?: return null
-            if (!ensureAttachableToParent(layoutId, context, parent, view)) {
-                deque.offerLast(view)
-                val remaining = (deque.size - 1).coerceAtLeast(0)
-                repeat(remaining) {
-                    val next = deque.poll() ?: return null
-                    if (ensureAttachableToParent(layoutId, context, parent, next)) {
-                        policies[layoutId]?.onObtain(next)
-                        return next
-                    }
-                    deque.offerLast(next)
-                }
-                return null
+        val maxAttempts = deque.size
+        if (maxAttempts == 0) return null
+
+        val rejected = ArrayList<View>(4)
+        var found: View? = null
+
+        for (i in 0 until maxAttempts) {
+            val view = deque.poll() ?: break
+            if (ensureAttachableToParent(layoutId, context, parent, view)) {
+                found = view
+                break
             }
-            // 只跑用户自定义的 onObtain 钩子；默认情况下 obtain 是纯 poll
-            policies[layoutId]?.onObtain(view)
-            return view
+            rejected.add(view)
+        }
+
+        // 不兼容的 View 放回队尾，保留给后续兼容的 parent 使用
+        for (view in rejected) {
+            deque.offerLast(view)
+        }
+
+        if (found != null) {
+            policies[layoutId]?.onObtain(found)
         }
+        return found
     }
 
     /**
@@ -377,12 +454,14 @@ class ViewPool {
     }
 
     private fun clearLayout(@LayoutRes layoutId: Int) {
-        if (!factoryIsolation) {
-            val key = layoutId.toLong()
+        if (!hostIsolation && !factoryIsolation) {
+            // 无隔离模式：key = layoutId << 32，直接移除
+            val key = layoutId.toLong() shl 32
             pool.remove(key)
             warmingCounts.remove(key)
             return
         }
+        // 有隔离模式：高 32 位匹配 layoutId 的所有 key 都要移除
         pool.keys.removeIf { key ->
             (key ushr 32).toInt() == layoutId
         }
@@ -428,16 +507,47 @@ class ViewPool {
     }
 
     /**
-     * 计算 pool key。默认仅基于 layoutId，零额外开销、不访问 Context。
-     * 开启 factoryIsolation 时，把 LayoutInflater.factory2 的 class hash 编入低 32 位。
+     * 计算 pool key。
+     * - 高 32 位始终为 layoutId
+     * - 低 32 位根据隔离模式组合 hostHash 和 factoryHash
+     *   - hostIsolation=true: 包含 Activity identityHashCode（Application context 为 0）
+     *   - factoryIsolation=true: 包含 LayoutInflater.factory2 的 class hashCode
+     *   - 两者都关: 低 32 位为 0，等价于旧行为
      */
     private fun keyFor(@LayoutRes layoutId: Int, context: Context): Long {
-        if (!factoryIsolation) {
-            return layoutId.toLong()
+        val high = layoutId.toLong() shl 32
+        if (!hostIsolation && !factoryIsolation) {
+            return high
+        }
+        var low = 0
+        if (hostIsolation) {
+            low = hostHash(context)
+        }
+        if (factoryIsolation) {
+            low = low xor factoryHash(context)
+        }
+        return high or (low.toLong() and 0xFFFFFFFFL)
+    }
+
+    /**
+     * 返回 context 所属 Activity 的 identityHashCode，用于 host 隔离。
+     * 非 Activity context（Application / Service）返回 0，进入共享桶。
+     */
+    private fun hostHash(context: Context): Int {
+        val activity = unwrapActivity(context) ?: return 0
+        return System.identityHashCode(activity)
+    }
+
+    /**
+     * 沿 ContextWrapper 链向上查找 Activity。
+     */
+    private fun unwrapActivity(context: Context): Activity? {
+        var ctx: Context? = context
+        while (ctx != null) {
+            if (ctx is Activity) return ctx
+            ctx = if (ctx is ContextWrapper) ctx.baseContext else null
         }
-        // 高 32 位 layoutId，低 32 位 factory hash
-        val hash = factoryHash(context)
-        return (layoutId.toLong() shl 32) or (hash.toLong() and 0xFFFFFFFFL)
+        return null
     }
 
     private fun factoryHash(context: Context): Int {
@@ -489,6 +599,12 @@ class ViewPool {
     }
 
     private fun canEnterPool(@LayoutRes layoutId: Int, view: View): Boolean {
+        // 仍 attached 的 view 不能入池：下一次 obtain + parent.addView 会抛 IllegalStateException
+        // 如果业务确认安全（已经 detach 或者 parent 即将丢弃），可以注册 ViewRecyclePolicy 覆盖默认行为
+        if (view.parent != null) {
+            val policy = policies[layoutId] ?: return false
+            return policy.canRecycle(view)
+        }
         return policies[layoutId]?.canRecycle(view) ?: true
     }
 
diff --git a/lib/src/test/java/com/github/donglua/fastinflater/ViewCleanerTest.kt b/lib/src/test/java/com/github/donglua/fastinflater/ViewCleanerTest.kt
@@ -320,4 +320,60 @@ class ViewCleanerTest {
         assertThat(parent.scaleX).isEqualTo(1f)
         assertThat(parent.rotation).isEqualTo(0f)
     }
+
+    // ── Visibility / Enabled / Selected / Activated / ContentDescription ──
+
+    @Test
+    fun `clean resets visibility to VISIBLE`() {
+        val view = View(context).apply { visibility = View.GONE }
+
+        ViewCleaner.clean(view)
+
+        assertThat(view.visibility).isEqualTo(View.VISIBLE)
+    }
+
+    @Test
+    fun `clean resets isEnabled to true`() {
+        val view = View(context).apply { isEnabled = false }
+
+        ViewCleaner.clean(view)
+
+        assertThat(view.isEnabled).isTrue()
+    }
+
+    @Test
+    fun `clean resets isSelected to false`() {
+        val view = View(context).apply { isSelected = true }
+
+        ViewCleaner.clean(view)
+
+        assertThat(view.isSelected).isFalse()
+    }
+
+    @Test
+    fun `clean resets isActivated to false`() {
+        val view = View(context).apply { isActivated = true }
+
+        ViewCleaner.clean(view)
+
+        assertThat(view.isActivated).isFalse()
+    }
+
+    @Test
+    fun `clean clears contentDescription`() {
+        val view = View(context).apply { contentDescription = "test desc" }
+
+        ViewCleaner.clean(view)
+
+        assertThat(view.contentDescription).isNull()
+    }
+
+    @Test
+    fun `clean resets CompoundButton isChecked to false`() {
+        val checkBox = CheckBox(context).apply { isChecked = true }
+
+        ViewCleaner.clean(checkBox)
+
+        assertThat(checkBox.isChecked).isFalse()
+    }
 }
diff --git a/lib/src/test/java/com/github/donglua/fastinflater/ViewPoolTest.kt b/lib/src/test/java/com/github/donglua/fastinflater/ViewPoolTest.kt

Original file line number	Diff line number	Diff line change
`@@ -43,6 +43,15 @@ object ViewCleaner {`
`43`	`43`	`view.clearAnimation()`
`44`	`44`	`view.clearFocus()`
`45`	`45`
	`46`	`+ // ⚠️ 以下属性会被归一化到"可见/可用"默认值。`
	`47`	`+ // 如果布局 XML 中某些子 View 的静态默认值不是 VISIBLE / enabled / 无 contentDescription，`
	`48`	`+ // 复用后需要在 bind 阶段或 ViewRecyclePolicy.onObtain() 中恢复。`
	`49`	`+ view.visibility = View.VISIBLE`
	`50`	`+ view.isEnabled = true`
	`51`	`+ view.isSelected = false`
	`52`	`+ view.isActivated = false`
	`53`	`+ view.contentDescription = null`
	`54`	`+`
`46`	`55`	`if (view is TextView) {`
`47`	`56`	`view.text = null`
`48`	`57`	`view.setOnEditorActionListener(null)`
`@@ -55,6 +64,7 @@ object ViewCleaner {`
`55`	`64`	`}`
`56`	`65`	`if (view is CompoundButton) {`
`57`	`66`	`view.setOnCheckedChangeListener(null)`
	`67`	`+ view.isChecked = false`
`58`	`68`	`}`
`59`	`69`	`}`
`60`	`70`	`}`