layers

使用 layers/ 目录来组织和自动注册应用中的本地层。

layers/ 目录允许您在 Nuxt 应用中组织和共享可复用的代码、组件、组合函数和配置。项目中 layers/ 目录下的任意层都会被自动注册。

layers/ 目录的自动注册功能在 Nuxt v3.12.0 及以上版本可用。
层非常适合通过 领域驱动设计 (DDD) 来组织大型代码库,创建可复用的 UI 库主题,在项目间共享 配置预设,以及分离关注点如 管理面板功能模块

结构

layers/ 目录下的每个子目录都会被视为一个独立的层。一个层的结构可以和标准的 Nuxt 应用相同。

每个层 必须有 一个 nuxt.config.ts 文件才会被识别为有效层,即使该文件为空。
目录结构
-| layers/
---| base/
-----| nuxt.config.ts
-----| app/
-------| components/
---------| BaseButton.vue
-------| composables/
---------| useBase.ts
-----| server/
-------| api/
---------| hello.ts
---| admin/
-----| nuxt.config.ts
-----| app/
-------| pages/
---------| admin.vue
-------| layouts/
---------| admin.vue

自动别名

会自动为每个层的 srcDir 创建命名层别名。你可以用 #layers/[name] 别名访问层:

// 访问 base 层
import something from '#layers/base/path/to/file'

// 访问 admin 层
import { useAdmin } from '#layers/admin/composables/useAdmin'
命名层别名功能于 Nuxt v3.16.0 引入。

层内容

每个层可以包含:

优先级顺序

当多个层定义了相同的资源(组件、组合函数、页面等)时,优先级高的层将生效。层按字母顺序排序,后面的字母优先级更高(Z > A)。

你可以用数字前缀控制顺序:1.base/, 2.features/, 3.admin/

Docs > 4 X > Getting Started > Layers#layer Priority 中查看详情