|
| 1 | +--- |
| 2 | +sidebar_position: 10 |
| 3 | +--- |
| 4 | +# NuxtJS์ ํจ๊ป ์ฌ์ฉํ๊ธฐ |
| 5 | + |
| 6 | +NuxtJS ํ๋ก์ ํธ์์ FSD๋ฅผ ์ ์ฉํ ์ ์์ง๋ง, NuxtJS์ ๊ธฐ๋ณธ์ ์ธ ํ๋ก์ ํธ ๊ตฌ์กฐ์ FSD ์ํคํ
์ฒ ์์น ๊ฐ์ ์ฐจ์ด๋ก ์ธํด ์ผ๋ถ ์ถฉ๋์ด ๋ฐ์ํ ์ ์์ต๋๋ค: |
| 7 | + |
| 8 | +- NuxtJS๋ ๊ธฐ๋ณธ์ ์ผ๋ก `src` ๋๋ ํฐ๋ฆฌ ์์ด ํ๋ก์ ํธ ๋ฃจํธ์์ ํ์ผ์ ๊ด๋ฆฌํ๋ ๊ตฌ์กฐ๋ฅผ ์ ๊ณตํฉ๋๋ค. |
| 9 | +- ํ์ผ ๊ธฐ๋ฐ ๋ผ์ฐํ
(File-based Routing) ๋ฐฉ์์ผ๋ก `pages` ๋๋ ํฐ๋ฆฌ ๋ด Vue ํ์ผ์ ์๋ ๋งคํํ์ง๋ง, FSD์์๋ ๋๋ ํฐ๋ฆฌ ๊ตฌ์กฐ๋ฅผ slice ๊ด์ ์์ ์ฌ์ฉํ๋ฏ๋ก ์ถฉ๋์ด ๋ฐ์ํ ์ ์์ต๋๋ค. |
| 10 | + |
| 11 | + |
| 12 | +## `src` ํด๋์ ๋ํ ๋ณ์นญ(alias) ์ถ๊ฐํ๊ธฐ |
| 13 | + |
| 14 | +์ค์ ํ์ผ์ `alias` ๊ฐ์ฒด์ src ๋๋ ํฐ๋ฆฌ๋ฅผ ๋งคํํฉ๋๋ค. |
| 15 | + |
| 16 | +```ts title="nuxt.config.ts" |
| 17 | +export default defineNuxtConfig({ |
| 18 | + devtools: { enabled: true }, // ๊ฐ๋ฐ ๋๊ตฌ ํ์ฑํ (FSD์๋ ๋ฌด๊ด) |
| 19 | + alias: { |
| 20 | + "@": '../src' |
| 21 | + }, |
| 22 | +}) |
| 23 | +``` |
| 24 | +## ๋ผ์ฐํฐ ์ค์ ๋ฐฉ๋ฒ ์ ํํ๊ธฐ |
| 25 | + |
| 26 | +NuxtJS์์๋ ๋ผ์ฐํ
์ ์ค์ ํ๋ ๋ ๊ฐ์ง ๋ฐฉ๋ฒ์ ์ ๊ณตํฉ๋๋ค: `ํ์ผ ๊ธฐ๋ฐ ๋ผ์ฐํ
`๊ณผ `์ค์ ๊ธฐ๋ฐ ๋ผ์ฐํ
`์
๋๋ค. |
| 27 | + |
| 28 | +- ํ์ผ ๊ธฐ๋ฐ ๋ผ์ฐํ
: `app/routes` ๋๋ ํฐ๋ฆฌ ๋ด์ `index.vue` ํ์ผ์ ์์ฑํ์ฌ ์๋์ผ๋ก ๋ผ์ฐํธ๋ฅผ ์ ์ํฉ๋๋ค. |
| 29 | +- ์ค์ ๊ธฐ๋ฐ ๋ผ์ฐํ
: `router.options.ts` ํ์ผ์์ ์ง์ ๋ผ์ฐํธ ๊ตฌ์ฑ์ ์ค์ ํฉ๋๋ค. |
| 30 | + |
| 31 | +### ์ค์ ๊ธฐ๋ฐ ๋ผ์ฐํ
|
| 32 | + |
| 33 | +NuxtJS์์ ์ค์ ์ ๊ธฐ๋ฐ์ผ๋ก ๋ผ์ฐํ
์ ๊ตฌ์ฑํ๋ ค๋ฉด, `app` ๋ ์ด์ด์ `router.options.ts` ํ์ผ์ ์์ฑํ๊ณ ๋ผ์ฐํธ ์ค์ ๊ฐ์ฒด๋ฅผ ์ ์ํฉ๋๋ค. |
| 34 | + |
| 35 | +```ts title="app/router.options.ts" |
| 36 | +import type { RouterConfig } from '@nuxt/schema'; |
| 37 | + |
| 38 | +export default <RouterConfig> { |
| 39 | + routes: (_routes) => [], |
| 40 | +}; |
| 41 | + |
| 42 | +``` |
| 43 | +ํ๋ก์ ํธ์ Home page๋ฅผ ์ถ๊ฐํ๋ ค๋ฉด ๋ค์ ๋จ๊ณ๋ฅผ ์ํํฉ๋๋ค: |
| 44 | + |
| 45 | +1. `pages` layer ๋ด์ page slice๋ฅผ ์์ฑํฉ๋๋ค. |
| 46 | +2. `app/router.options.ts` ํ์ผ์ ํด๋น ๋ผ์ฐํธ๋ฅผ ๋ฑ๋กํฉ๋๋ค. |
| 47 | + |
| 48 | +page slice๋ [CLI](https://github.com/feature-sliced/cli)๋ฅผ ์ฌ์ฉํ์ฌ ์์ฑํ ์ ์์ต๋๋ค: |
| 49 | + |
| 50 | +```shell |
| 51 | +fsd pages home |
| 52 | +``` |
| 53 | + |
| 54 | +์ด์ `ui` segment ๋ด์ `home-page.vue` ํ์ผ์ ๋ง๋ค๊ณ , Public API๋ฅผ ํตํด ์ด๋ฅผ ๋
ธ์ถํฉ๋๋ค: |
| 55 | + |
| 56 | +```ts title="src/pages/home/index.ts" |
| 57 | +export { default as HomePage } from './ui/home-page'; |
| 58 | +``` |
| 59 | + |
| 60 | +์ ๊ณผ์ ์ ๋ฐ๋ฅด๋ฉด ํ๋ก์ ํธ ๊ตฌ์กฐ๋ ๋ค์๊ณผ ๊ฐ์ด ๊ตฌ์ฑ๋ฉ๋๋ค: |
| 61 | +```sh |
| 62 | +|โโ src |
| 63 | +โ โโโ app |
| 64 | +โ โ โโโ router.options.ts |
| 65 | +โ โโโ pages |
| 66 | +โ โ โโโ home |
| 67 | +โ โ โ โโโ ui |
| 68 | +โ โ โ โ โโโ home-page.vue |
| 69 | +โ โ โ โโโ index.ts |
| 70 | +``` |
| 71 | + |
| 72 | +๋ง์ง๋ง์ผ๋ก `router.options.ts` ํ์ผ์ ์๋ก์ด page์ ๋ํ ๋ผ์ฐํธ๋ฅผ ์ถ๊ฐํฉ๋๋ค: |
| 73 | + |
| 74 | +```ts title="app/router.options.ts" |
| 75 | +import type { RouterConfig } from '@nuxt/schema' |
| 76 | + |
| 77 | +export default <RouterConfig> { |
| 78 | + routes: (_routes) => [ |
| 79 | + { |
| 80 | + name: 'home', |
| 81 | + path: '/', |
| 82 | + component: () => import('@/pages/home.vue').then(r => r.default || r) |
| 83 | + } |
| 84 | + ], |
| 85 | +} |
| 86 | +``` |
| 87 | + |
| 88 | +### ํ์ผ ๊ธฐ๋ฐ ๋ผ์ฐํ
|
| 89 | + |
| 90 | +#### `src` ๋๋ ํ ๋ฆฌ ์ค์ ๋ฐ ๋ผ์ฐํฐ ๊ตฌ์ฑ |
| 91 | + |
| 92 | +๋จผ์ ํ๋ก์ ํธ ๋ฃจํธ์ `src` ๋๋ ํ ๋ฆฌ๋ฅผ ์์ฑํ๊ณ , ๊ทธ ์์ `app`๊ณผ `pages` ๋ ์ด์ด๋ฅผ ๊ตฌ์ฑํฉ๋๋ค. |
| 93 | +์ดํ `app` ๋ ์ด์ด ๋ด์ `routes` ํด๋๋ฅผ ์ถ๊ฐํ์ฌ NuxtJS์ ๋ผ์ฐํ
์ ์ด๊ณณ์์ ๊ด๋ฆฌํ ์ ์๋๋ก ์ค์ ํฉ๋๋ค. |
| 94 | + |
| 95 | +์ต์ข
์ ์ผ๋ก ํ์ผ ๊ตฌ์กฐ๋ ๋ค์๊ณผ ๊ฐ์์ผ ํฉ๋๋ค: |
| 96 | + |
| 97 | +```sh |
| 98 | +โโโ src |
| 99 | +โ โโโ app |
| 100 | +โ โ โโโ routes |
| 101 | +โ โโโ pages # FSD ๊ตฌ์กฐ์ ๋ง๋ Pages ๋ ์ด์ด |
| 102 | +``` |
| 103 | + |
| 104 | +#### nuxt.config.ts์์ ๋ผ์ฐํธ ๋๋ ํฐ๋ฆฌ ๋ณ๊ฒฝ |
| 105 | + |
| 106 | +NuxtJS๊ฐ `pages` ํด๋ ๋์ `app/routes` ํด๋๋ฅผ ๋ผ์ฐํธ ๋๋ ํฐ๋ฆฌ๋ก ์ฌ์ฉํ๋๋ก ์ค์ ํ๋ ค๋ฉด, `nuxt.config.ts` ํ์ผ์ ์์ ํด์ผ ํฉ๋๋ค: |
| 107 | + |
| 108 | +```ts title="nuxt.config.ts" |
| 109 | +export default defineNuxtConfig({ |
| 110 | + devtools: { enabled: true }, // ๊ฐ๋ฐ ๋๊ตฌ ํ์ฑํ (FSD์ ๋ฌด๊ด) |
| 111 | + alias: { |
| 112 | + "@": '../src' |
| 113 | + }, |
| 114 | + dir: { |
| 115 | + pages: './src/app/routes' |
| 116 | + } |
| 117 | +}) |
| 118 | +``` |
| 119 | + |
| 120 | +์ด์ `app/routes` ๋ด์์ ๋ผ์ฐํธ๋ฅผ ์์ฑํ๊ณ , `pages`์ ์๋ page๋ค๊ณผ ์ฐ๊ฒฐํ ์ ์์ต๋๋ค. |
| 121 | + |
| 122 | +ํ๋ก์ ํธ์ `Home` page๋ฅผ ์ถ๊ฐํ๋ ค๋ฉด ๋ค์ ๋จ๊ณ๋ฅผ ์ํํฉ๋๋ค: |
| 123 | +- `pages` layer ๋ด์ page slice๋ฅผ ์์ฑํฉ๋๋ค. |
| 124 | +- `app/routes` ๋๋ ํฐ๋ฆฌ ๋ด์์ ํด๋น page์ ๋ํ ๋ผ์ฐํธ๋ฅผ ์ถ๊ฐํฉ๋๋ค. |
| 125 | +- page slice์ ์ปดํฌ๋ํธ๋ฅผ ๋ผ์ฐํธ์์ ์ฌ์ฉํ ์ ์๋๋ก ์ฐ๊ฒฐํฉ๋๋ค. |
| 126 | + |
| 127 | + |
| 128 | +#### 1๏ธโฃ page slice ์์ฑ |
| 129 | + |
| 130 | +page slice๋ [CLI](https://github.com/feature-sliced/cli)๋ฅผ ์ฌ์ฉํ์ฌ ๊ฐํธํ๊ฒ ์์ฑํ ์ ์์ต๋๋ค: |
| 131 | + |
| 132 | +```shell |
| 133 | +fsd pages home |
| 134 | +``` |
| 135 | + |
| 136 | +์ด์ `ui` segment ๋ด์ `home-page.vue` ํ์ผ์ ์์ฑํ๊ณ , Public API๋ฅผ ํตํด ์ด๋ฅผ ๋
ธ์ถํฉ๋๋ค: |
| 137 | + |
| 138 | +```ts title="src/pages/home/index.ts" |
| 139 | +export { default as HomePage } from './ui/home-page'; |
| 140 | +``` |
| 141 | + |
| 142 | +#### 2๏ธโฃ `app/routes` ๋ด์ ๋ผ์ฐํธ ์ถ๊ฐ |
| 143 | + |
| 144 | +์์ฑํ page๋ฅผ ๋ผ์ฐํธ์ ์ฐ๊ฒฐํ๋ ค๋ฉด, `app/routes/index.vue` ํ์ผ์ ์์ฑํ๊ณ `HomePage` ์ปดํฌ๋ํธ๋ฅผ ๋ฑ๋กํด์ผ ํฉ๋๋ค. |
| 145 | + |
| 146 | +```sh |
| 147 | + |
| 148 | +โโโ src |
| 149 | +โ โโโ app |
| 150 | +โ โ โโโ routes |
| 151 | +โ โ โ โโโ index.vue |
| 152 | +โ โโโ pages |
| 153 | +โ โ โโโ home |
| 154 | +โ โ โ โโโ ui |
| 155 | +โ โ โ โ โโโ home-page.vue |
| 156 | +โ โ โ โโโ index.ts |
| 157 | +``` |
| 158 | + |
| 159 | +#### 3๏ธโฃ `index.vue`์์ page ์ปดํฌ๋ํธ ๋ฑ๋ก |
| 160 | + |
| 161 | +```html title="src/app/routes/index.vue" |
| 162 | +<script setup> |
| 163 | + import { HomePage } from '@/pages/home'; |
| 164 | +</script> |
| 165 | + |
| 166 | +<template> |
| 167 | + <HomePage/> |
| 168 | +</template> |
| 169 | +``` |
| 170 | + |
| 171 | +์ด์ `HomePage`๊ฐ NuxtJS์ ๋ผ์ฐํ
์์คํ
์ ํตํด ์ ์์ ์ผ๋ก ๋ ๋๋ง๋ฉ๋๋ค. |
| 172 | + |
| 173 | +## `layouts`๋ ์ด๋ป๊ฒ ์ฒ๋ฆฌํ ๊น์? |
| 174 | + |
| 175 | +๋ ์ด์์์ `app` layer ๋ด์์ ๊ด๋ฆฌํ ์ ์์ผ๋ฉฐ, ์ด๋ฅผ ์ํด NuxtJS ์ค์ ์ ์์ ํด์ผ ํฉ๋๋ค. |
| 176 | + |
| 177 | +```ts title="nuxt.config.ts" |
| 178 | +export default defineNuxtConfig({ |
| 179 | + devtools: { enabled: true }, // ๊ฐ๋ฐ ๋๊ตฌ ํ์ฑํ (FSD์ ๋ฌด๊ด) |
| 180 | + alias: { |
| 181 | + "@": '../src' |
| 182 | + }, |
| 183 | + dir: { |
| 184 | + pages: './src/app/routes', |
| 185 | + layouts: './src/app/layouts' |
| 186 | + } |
| 187 | +}) |
| 188 | +``` |
| 189 | + |
| 190 | + |
| 191 | +## ์ฐธ๊ณ ์๋ฃ |
| 192 | + |
| 193 | +- [NuxtJS ํด๋ ์ค์ ๋ณ๊ฒฝ ๋ฌธ์](https://nuxt.com/docs/api/nuxt-config#dir) |
| 194 | +- [NuxtJS ๋ผ์ฐํฐ ์ค์ ๋ณ๊ฒฝ ๋ฌธ์](https://nuxt.com/docs/guide/recipes/custom-routing#router-config) |
| 195 | +- [NuxtJS ๋ณ์นญ(alias) ๋ณ๊ฒฝ ๋ฌธ์](https://nuxt.com/docs/api/nuxt-config#alias) |
| 196 | + |
0 commit comments