Next.js中使用next-usequerystate时页面导航的渲染问题解析

next-usequerystate是一个用于Next.js项目的状态管理库，它允许开发者将React状态同步到URL查询参数中。然而，在使用过程中，开发者可能会遇到一个特殊的问题：当在页面之间导航时，源页面和目标页面都会被重新渲染。

问题现象

当使用next-usequerystate的useQueryState钩子时，从页面A导航到页面B的过程中，不仅目标页面B会渲染，源页面A也会再次渲染。这与使用Next.js原生useRouter时的行为不同，后者只会渲染目标页面。

具体表现为：

1. 初始访问页面A时，控制台输出页面A的初始状态
2. 点击链接导航到页面B时，控制台会先后输出页面A和页面B的状态
3. 返回页面A时，同样会先后输出页面B和页面A的状态

问题原因

这个问题的根源在于Next.js的路由机制和next-usequerystate的工作方式：

1. Next.js的pages路由器在页面导航时不会立即卸载源页面，而是等到导航完成后才卸载（可能是为了支持过渡效果）
2. next-usequerystate在检测到URL变化时，会将更新广播给所有已挂载的钩子，包括源页面的钩子
3. 这导致源页面在导航过程中也会接收到状态更新，从而触发重新渲染

在app路由器中，行为更加复杂：目标页面会先以无查询参数的状态挂载和渲染，然后才接收正确的URL参数。

解决方案

开发者可以通过创建一个自定义钩子来解决这个问题，该钩子会跟踪当前页面的路径，并只在路径匹配时才更新状态：

export default function useSafeQueryState(key, options?) {
  const [state, setState] = useQueryState(key, options);
  const [safeState, setSafeState] = useState(state);
  const [pathname, setPathname] = useState<string>();
  const router = useRouter();

  useEffect(() => {
    // 初始化时设置当前路径
    setPathname(router.pathname);
  }, []);

  useEffect(() => {
    function onRouteChangeStart(url) {
      // 导航开始时更新路径
      setPathname(url.split('?')[0]);
    }

    router.events.on('routeChangeStart', onRouteChangeStart);

    return () => {
      router.events.off('routeChangeStart', onRouteChangeStart);
    };
  }, [pathname, router.events]);

  useEffect(() => {
    // 只在路径匹配时更新状态
    if (
      pathname !== router.pathname ||
      state === safeState ||
      JSON.stringify(state) === JSON.stringify(safeState)
    ) {
      return;
    }

    setSafeState(state);
  }, [pathname, router.pathname, safeState, state]);

  return [safeState, setState];
}

对于动态路由的情况，需要使用router.asPath而不是router.pathname，因为后者会返回带有方括号的路径模式。

最佳实践

1. 在静态路由中使用router.pathname
2. 在动态路由中使用router.asPath.split('?')[0]获取实际路径
3. 考虑将这种安全查询状态逻辑封装为项目级的自定义钩子
4. 对于性能敏感的场景，可以添加额外的状态比较逻辑来避免不必要的渲染

总结

next-usequerystate在页面导航时的双重渲染问题是由Next.js的路由机制和状态同步策略共同导致的。通过创建自定义钩子来限制状态更新的范围，可以有效解决这个问题。理解这一机制有助于开发者在构建Next.js应用时更好地控制页面渲染行为，提升用户体验。

对于库的维护者来说，未来可以考虑在库内部实现类似的路径检查逻辑，为开发者提供更符合直觉的行为。