跳到正文

我所理解的 Nuxt 最佳实践(1):沿着路由组织页面和自动导入

我所理解的 Nuxt 最佳实践

  1. 沿着路由组织页面和自动导入(当前)
  2. 按请求隔离状态,让客户端接得住首屏
  3. 用插件依赖声明启动顺序
  4. 部署前检查资源与服务端产物

个人主页要加一张资料卡。我希望从 /me 找到路由文件,再从模板里的组件名找到资料卡。卡片怎样排版、路由用户怎样加载,也应该有各自的修改位置。

路由文件负责组装页面

app/
  pages/
    me/
      index.vue
  components/
    me/
      profile-card.vue
    common/
      search-box.vue
  composables/
    useMePage.ts

app/pages/me/index.vue 是路由入口,负责读取路由参数、声明页面 meta 和组装页面。资料卡的展示放进 app/components/me/profile-card.vue。当请求、派生数据和页面动作需要一起维护,可以把这一组逻辑放在页面域的 useMePage.ts。只服务资料卡的交互留在卡片附近,等出现独立调用方,再判断它是否应归到更广的业务域。

app/pages 参与路由扫描。把私有组件放进这个目录时,要额外处理路由识别。默认顺着 pages、components 和 composables 的职责摆放,读目录时就能看出哪些文件会成为路由。见 Nuxt 页面目录。

目录提供命名空间,声明确认结果

按默认组件扫描约定,me/profile-card.vue 在模板里叫 <MeProfileCard>。目录已经提供 Me,文件名只写 profile-card 就够了。通用搜索框可以放在 common/search-box.vue,跨页面使用但仍包含账号规则的组件则适合放到账号业务域。项目如果调整了 pathPrefix、prefix 或扫描目录,从 Nuxt 生成的组件声明看实际注册名。见 Nuxt 组件目录。

Nuxt 默认只扫描 app/composables 的顶层文件,所以能直接发现示例中的 useMePage.ts。需要分子目录时,可以从顶层入口重导出,或显式配置扫描范围。目录里的辅助函数是否公开,仍由模块的调用方决定。

自动导入只在对应的应用上下文里使用

在 Nuxt 转换覆盖的页面里,可以按约定使用 <MeProfileCard>、ref 和 computed。名字有冲突、需要把组件作为值传递,或调用处需要标明来源时,可以从 #components 或 #imports 显式导入。import type { Ref } from 'vue' 交代的是类型来源。共享包、独立 Node.js 脚本和脱离 Nuxt 环境运行的测试,按各自的模块解析方式声明依赖。见 Nuxt 自动导入。

移动组件或调整扫描配置后,先生成声明,核对组件注册名、文件路径和 composable 入口。再打开真实路由,看组件是否渲染、首次请求和客户端导航是否正常。Lint 可以提示项目约定下的显式 value import,命中之后仍要核对建议名和实际的生成结果。见《Nuxt 自动导入的 ESLint 护栏》和《ESLint 怎样判断 Vue 组件的根 Block》。