首页
/ 解决Next.js项目在Storybook中使用next-usequerystate报错问题

解决Next.js项目在Storybook中使用next-usequerystate报错问题

2025-05-30 23:11:34作者:丁柯新Fawn

问题背景

在Next.js项目中使用next-usequerystate库时,如果通过Storybook运行包含该库的组件,可能会遇到"invariant expected app router to be mounted"错误。这个问题主要出现在同时使用Pages Router和Storybook的场景中。

错误原因分析

该问题的根源在于next-usequerystate库为了同时支持App Router和Pages Router,内部使用了next/navigation的导入方式。然而Storybook目前对这种混合使用模式的支持还不完善,特别是在Pages Router项目中尝试使用App Router相关功能时。

技术细节

next-usequerystate库的设计初衷是提供一个统一的API来兼容Next.js的两种路由系统。但在实现上,它依赖于next/navigation模块,这个模块在Pages Router环境下的兼容层并不完全稳定,导致在某些配置组合下会出现问题。

解决方案

目前可行的临时解决方案是在Storybook的配置中添加AppRouterContext的Provider装饰器:

import {
  AppRouterContext,
  type AppRouterInstance,
} from 'next/dist/shared/lib/app-router-context.shared-runtime';

const meta = {
  decorators: [
    (Story) => (
      <AppRouterContext.Provider value={{} as AppRouterInstance}>
        <Story />
      </AppRouterContext.Provider>
    ),
  ],
};

这个方案通过手动提供AppRouterContext来模拟App Router环境,使得next-usequerystate能够正常工作。

长期展望

Storybook团队正在积极解决Next.js路由兼容性问题,预计在未来的v8版本中会提供更完善的解决方案。开发者可以关注相关进展,在官方修复发布后升级依赖版本。

最佳实践建议

  1. 在Pages Router项目中,明确区分App Router和Pages Router的使用场景
  2. 保持next-usequerystate和Storybook等相关依赖的最新版本
  3. 对于关键业务组件,考虑编写独立的测试用例而不完全依赖Storybook
  4. 在团队内部文档中记录此类兼容性问题及解决方案

通过理解问题本质并应用上述解决方案,开发者可以顺利在Storybook中测试使用next-usequerystate的组件,同时为未来的兼容性改进做好准备。

登录后查看全文
热门项目推荐
相关项目推荐