mirror of
https://github.com/nuxt/nuxt.git
synced 2025-02-11 11:18:06 +00:00
docs: add nuxt lifecycle (#30726)
Co-authored-by: Sébastien Chopin <atinux@gmail.com>
This commit is contained in:
parent
ebd5b5659b
commit
eacdfaa20d
141
docs/2.guide/1.concepts/10.nuxt-lifecycle.md
Normal file
141
docs/2.guide/1.concepts/10.nuxt-lifecycle.md
Normal file
@ -0,0 +1,141 @@
|
|||||||
|
---
|
||||||
|
title: 'Nuxt Lifecycle'
|
||||||
|
description: "Understanding the lifecycle of Nuxt applications can help you gain deeper insights into how the framework operates, especially for both server-side and client-side rendering."
|
||||||
|
---
|
||||||
|
|
||||||
|
The goal of this chapter is to provide a high-level overview of the different parts of the framework, their execution order, and how they work together.
|
||||||
|
|
||||||
|
## Server
|
||||||
|
|
||||||
|
On the server, the following steps are executed for every initial request to your application:
|
||||||
|
|
||||||
|
### Step 1: Setup Nitro Server and Nitro Plugins (Once)
|
||||||
|
|
||||||
|
Nuxt is powered by [Nitro](https://nitro.build/), a modern server engine.
|
||||||
|
|
||||||
|
When Nitro starts, it initializes and executes the plugins under the `/server/plugins` directory. These plugins can:
|
||||||
|
- Capture and handle application-wide errors.
|
||||||
|
- Register hooks that execute when Nitro shuts down.
|
||||||
|
- Register hooks for request lifecycle events, such as modifying responses.
|
||||||
|
|
||||||
|
::callout{icon="i-ph-lightbulb"}
|
||||||
|
Nitro plugins are executed only once when the server starts. In a serverless environment, the server boots on each incoming request, and so do the Nitro plugins. However, they are not awaited.
|
||||||
|
::
|
||||||
|
|
||||||
|
:read-more{to="/docs/guide/directory-structure/server#server-plugins"}
|
||||||
|
|
||||||
|
### Step 2: Nitro Server Middleware
|
||||||
|
|
||||||
|
After initializing the Nitro server, middleware under `server/middleware/` is executed for every request. Middleware can be used for tasks such as authentication, logging, or request transformation.
|
||||||
|
|
||||||
|
::warning
|
||||||
|
Returning a value from middleware will terminate the request and send the returned value as the response. This behavior should generally be avoided to ensure proper request handling!
|
||||||
|
::
|
||||||
|
|
||||||
|
:read-more{to="/docs/guide/directory-structure/server#server-middleware"}
|
||||||
|
|
||||||
|
### Step 3: Initialize Nuxt and Execute Nuxt App Plugins
|
||||||
|
|
||||||
|
The Vue and Nuxt instances are created first. Afterward, Nuxt executes its server plugins. This includes:
|
||||||
|
- Built-in plugins, such as Vue Router and `unhead`.
|
||||||
|
- Custom plugins located in the `plugins/` directory, including those without a suffix (e.g., `myPlugin.ts`) and those with the `.server` suffix (e.g., `myServerPlugin.server.ts`).
|
||||||
|
|
||||||
|
Plugins execute in a specific order and may have dependencies on one another. For more details, including execution order and parallelism, refer to the [Plugins documentation](/docs/guide/directory-structure/plugins).
|
||||||
|
|
||||||
|
::callout{icon="i-ph-lightbulb"}
|
||||||
|
After this step, Nuxt calls the [`app:created`](/docs/api/advanced/hooks#app-hooks-runtime) hook, which can be used to execute additional logic.
|
||||||
|
::
|
||||||
|
|
||||||
|
:read-more{to="/docs/guide/directory-structure/plugins"}
|
||||||
|
|
||||||
|
### Step 4: Route Validation
|
||||||
|
|
||||||
|
After initializing plugins and before executing middleware, Nuxt calls the `validate` method if it is defined in the `definePageMeta` function. The `validate` method, which can be synchronous or asynchronous, is often used to validate dynamic route parameters.
|
||||||
|
|
||||||
|
- The `validate` function should return `true` if the parameters are valid.
|
||||||
|
- If validation fails, it should return `false` or an object containing a `statusCode` and/or `statusMessage` to terminate the request.
|
||||||
|
|
||||||
|
For more information, see the [Route Validation documentation](/docs/getting-started/routing#route-validation).
|
||||||
|
|
||||||
|
:read-more{to="/docs/getting-started/routing#route-validation"}
|
||||||
|
|
||||||
|
### Step 5: Execute Nuxt App Middleware
|
||||||
|
|
||||||
|
Middleware allows you to run code before navigating to a particular route. It is often used for tasks such as authentication, redirection, or logging.
|
||||||
|
|
||||||
|
In Nuxt, there are three types of middleware:
|
||||||
|
- **Global route middleware**
|
||||||
|
- **Named route middleware**
|
||||||
|
- **Anonymous (or inline) route middleware**
|
||||||
|
|
||||||
|
Nuxt automatically executes global middleware for first time enter to the application and every time before route navigation. Named and anonymous middleware are executed only on the routes specified in the middleware property of the page(route) meta defined in the corresponding page components.
|
||||||
|
|
||||||
|
For details about each type and examples, see the [Middleware documentation](/docs/guide/directory-structure/middleware).
|
||||||
|
|
||||||
|
Any redirection on the server will result in a `Location:` header being sent to the browser; the browser then makes a fresh request to this new location. All application state will be reset when this happens, unless persisted in a cookie.
|
||||||
|
|
||||||
|
:read-more{to="/docs/guide/directory-structure/middleware"}
|
||||||
|
|
||||||
|
### Step 6: Setup Page and Components
|
||||||
|
|
||||||
|
Nuxt initializes the page and its components during this step and fetches any required data with `useFetch` and `useAsyncData`. Since there are no dynamic updates and no DOM operations occur on the server, Vue lifecycle hooks such as `onBeforeMount`, `onMounted`, and subsequent hooks are **NOT** executed during SSR.
|
||||||
|
|
||||||
|
::important
|
||||||
|
You should avoid code that produces side effects that need cleanup in root scope of `<script setup>`. An example of such side effects is setting up timers with `setInterval`. In client-side only code we may setup a timer and then tear it down in `onBeforeUnmount` or `onUnmounted`. However, because the unmount hooks will never be called during SSR, the timers will stay around forever. To avoid this, move your side-effect code into `onMounted` instead.
|
||||||
|
::
|
||||||
|
|
||||||
|
### Step 7: Render and Generate HTML Output
|
||||||
|
|
||||||
|
After all components are initialized and data is fetched, Nuxt combines the components with settings from `unhead` to generate a complete HTML document. This HTML, along with the associated data, is sent back to the client to complete the SSR process.
|
||||||
|
|
||||||
|
::callout{icon="i-ph-lightbulb"}
|
||||||
|
After rendering the Vue application to HTML, Nuxt calls the [`app:rendered`](/docs/api/advanced/hooks#app-hooks-runtime) hook.
|
||||||
|
::
|
||||||
|
|
||||||
|
::callout{icon="i-ph-lightbulb"}
|
||||||
|
Before finalizing and sending the HTML, Nitro will call the [`render:html`](/docs/api/advanced/hooks#nitro-app-hooks-runtime-server-side) hook. This hook allows you to manipulate the generated HTML, such as injecting additional scripts or modifying meta tags.
|
||||||
|
::
|
||||||
|
|
||||||
|
## Client (browser)
|
||||||
|
|
||||||
|
This part of the lifecycle is fully executed in the browser, no matter which Nuxt mode you've chosen.
|
||||||
|
|
||||||
|
### Step 1: Initialize Nuxt and Execute Nuxt App Plugins
|
||||||
|
|
||||||
|
This step is similar to the server-side execution and includes both built-in and custom plugins.
|
||||||
|
|
||||||
|
Custom plugins in the `plugins/` directory, such as those without a suffix (e.g., `myPlugin.ts`) and with the `.client` suffix (e.g., `myClientPlugin.client.ts`), are executed on the client side.
|
||||||
|
|
||||||
|
::callout{icon="i-ph-lightbulb"}
|
||||||
|
After this step, Nuxt calls the [`app:created`](/docs/api/advanced/hooks#app-hooks-runtime) hook, which can be used to execute additional logic.
|
||||||
|
::
|
||||||
|
|
||||||
|
:read-more{to="/docs/guide/directory-structure/plugins"}
|
||||||
|
|
||||||
|
### Step 2: Route Validation
|
||||||
|
|
||||||
|
This step is the same as the server-side execution and includes the `validate` method if defined in the `definePageMeta` function.
|
||||||
|
|
||||||
|
### Step 3: Execute Nuxt App Middleware
|
||||||
|
|
||||||
|
Nuxt middleware runs on both the server and the client. If you want certain code to run in specific environments, consider splitting it by using `import.meta.client` for the client and `import.meta.server` for the server.
|
||||||
|
|
||||||
|
:read-more{to="/docs/guide/directory-structure/middleware#when-middleware-runs"}
|
||||||
|
|
||||||
|
### Step 4: Mount Vue Application and Hydration
|
||||||
|
|
||||||
|
Calling `app.mount('#__nuxt')` mounts the Vue application to the DOM. If the application uses SSR or SSG mode, Vue performs a hydration step to make the client-side application interactive. During hydration, Vue recreates the application (excluding [Server Components](/docs/guide/directory-structure/components#server-components)), matches each component to its corresponding DOM nodes, and attaches DOM event listeners.
|
||||||
|
|
||||||
|
To ensure proper hydration, it's important to maintain consistency between the data on the server and the client. For API requests, it is recommended to use `useAsyncData`, `useFetch`, or other SSR-friendly composables. These methods ensure that the data fetched on the server side is reused during hydration, avoiding repeated requests. Any new requests should only be triggered after hydration, preventing hydration errors.
|
||||||
|
|
||||||
|
::callout{icon="i-ph-lightbulb"}
|
||||||
|
Before mounting the Vue application, Nuxt calls the [`app:beforeMount`](/docs/api/advanced/hooks#app-hooks-runtime) hook.
|
||||||
|
::
|
||||||
|
|
||||||
|
::callout{icon="i-ph-lightbulb"}
|
||||||
|
After mounting the Vue application, Nuxt calls the [`app:mounted`](/docs/api/advanced/hooks#app-hooks-runtime) hook.
|
||||||
|
::
|
||||||
|
|
||||||
|
### Step 6: Vue Lifecycle
|
||||||
|
|
||||||
|
Unlike on the server, the browser executes the full [Vue lifecycle](https://vuejs.org/guide/essentials/lifecycle).
|
Loading…
Reference in New Issue
Block a user