Wagmi项目中useBlockNumber内存泄漏问题分析与解决方案

问题背景

在Wagmi项目中，当开发者使用useBlockNumber({watch: true})钩子函数时，会出现严重的内存泄漏问题。具体表现为：每当新区块产生时，系统都会创建一个新的WebSocket订阅，而旧的订阅却不会被正确关闭。随着时间推移，这将导致内存耗尽，最终使RPC服务对客户端进行速率限制。

问题现象

开发者在使用该钩子时观察到以下异常行为：

1. 每次区块更新都会创建新的WebSocket订阅
2. 订阅数量随时间线性增长
3. 当有多个组件使用该钩子时，问题会成倍恶化
4. 最终导致内存耗尽和RPC服务限制

问题根源

经过深入分析，发现问题出在useWatchBlockNumber内部实现上。该钩子使用了React的useEffect来管理WebSocket订阅，但由于依赖项比较的问题，导致每次区块更新都会触发新的订阅创建，而旧的订阅却没有被正确清理。

具体来说：

1. useEffect依赖项中包含了一个对象，React使用Object.is进行严格相等比较
2. 每次渲染时，依赖对象都会被重新创建，导致React认为依赖项发生了变化
3. 这触发了useEffect的重新执行，创建新的订阅
4. 清理函数虽然存在，但由于订阅管理不当，旧的订阅没有被正确关闭

解决方案

经过社区讨论和代码审查，最终确定了两种解决方案：

方案一：使用引用保持订阅对象

通过使用React的useRef来保持订阅对象的引用，确保useEffect只在组件挂载和卸载时执行一次：

const subscription = useRef<() => void>()

useEffect(() => {
  const unsubscribe = watchBlockNumber(client, {
    onBlockNumber: (blockNumber) => {
      setBlockNumber(blockNumber)
    },
    chainId,
  })
  subscription.current = unsubscribe
  return () => {
    subscription.current?.()
    subscription.current = undefined
  }
}, [])

这种方法确保了：

1. 订阅只创建一次
2. 组件卸载时正确清理订阅
3. 避免了不必要的重复订阅

方案二：利用Viem的observe机制

在底层Viem库中，watchBlockNumber已经内置了订阅管理机制。通过正确使用Viem的observe功能，可以避免重复订阅的问题：

useEffect(() => {
  return observe(client, {
    onBlockNumber: (blockNumber) => {
      setBlockNumber(blockNumber)
    },
    chainId,
  })
}, [])

这种方法更加简洁，且利用了底层库提供的订阅管理能力。

最佳实践建议

对于需要在应用中监听区块更新的开发者，建议：

1. 尽量将区块监听逻辑提升到应用顶层，避免多个组件各自监听
2. 使用Context API共享区块数据，而不是在每个需要的地方单独订阅
3. 确保及时清理订阅，防止内存泄漏
4. 考虑使用防抖或节流技术，避免过于频繁的更新

总结

Wagmi中的useBlockNumber内存泄漏问题是一个典型的React副作用管理不当导致的案例。通过正确管理订阅生命周期和利用底层库提供的功能，可以有效解决这类问题。开发者在使用这类实时数据订阅功能时，应当特别注意资源管理和清理工作，以确保应用的稳定性和性能。

该问题的解决也展示了开源社区协作的力量，通过开发者报告、社区讨论和代码贡献，最终找到了优雅的解决方案。