Nuxt3 的生命周期和钩子函数（五）

title: Nuxt3 的生命周期和钩子函数（五）

date: 2024/6/29

updated: 2024/6/29

author: cmdragon

excerpt:

摘要：本文详细介绍了Nuxt3中的六个核心生命周期钩子及其用法，包括build:done、build:manifest、builder:generateApp、builder:watch、pages:extend和server:devHandler:handler。内容涵盖各钩子的调用时机、参数、环境、功能描述及具体示例代码，帮助开发者深入理解如何在Nuxt应用的构建、运行、开发及部署等阶段自定义行为和逻辑。

categories:

前端开发

tags:

Nuxt3
生命周期
钩子函数
Web开发
前端框架
自定义构建
服务器渲染

扫码关注或者微信搜一搜：编程智域前端至全栈交流与成长

钩子：build:done

参数：nuxtApp

环境：Nuxt.js

描述：build:done是 Nuxt.js 的一个生命周期钩子，它在应用的打包构建过程完成后被调用。这个钩子允许开发者在构建过程结束后执行一些后续操作，比如清理临时文件、生成额外的资源或者通知外部服务构建完成。

详细解释与用法：

参数说明：nuxtApp参数是 Nuxt 应用实例的引用，它提供了对 Nuxt 应用的配置和内部状态的访问。
使用场景：通常用于执行构建后的清理工作，或者对构建结果进行最后的修改。
调用时机：在 Nuxt 的构建过程完全结束后，即所有文件都被编译和优化之后。

案例Demo：

export default defineNuxtPlugin((nuxtApp) => {

  nuxtApp.hook('build:done', async (builder) => {

    // 示例：构建完成后，打印构建信息

    console.log('构建完成！构建信息如下：');

    console.log(builder.stats);

    // 示例：清理构建目录中的临时文件

    await cleanUpTemporaryFiles();

    // 示例：发送构建完成的通知

    await notifyBuildCompletion();

  });

  async function cleanUpTemporaryFiles() {

    // 这里是清理临时文件的逻辑

    // 例如使用 Node.js 的 fs 模块来删除文件

    const fs = require('fs');

    const path = require('path');

    const tempFilePath = path.join(__dirname, 'temp-file.txt');

    if (fs.existsSync(tempFilePath)) {

      fs.unlinkSync(tempFilePath);

      console.log('临时文件已清理');

    }

  }

  async function notifyBuildCompletion() {

    // 这里是通知构建完成的逻辑

    // 例如发送 HTTP 请求到某个服务

    const axios = require('axios');

    await axios.post('https://example.com/build-completed', {

      message: '构建完成'

    });

    console.log('构建完成通知已发送');

  }

});

在这个案例中，build:done钩子被用来打印构建信息、清理临时文件，以及向外部服务发送构建完成的通知。这些操作有助于确保构建过程的完整性和后续的自动化流程。

钩子：build:manifest

参数：manifest

环境：Vite 或 Webpack (用于服务端渲染的框架)

描述：build:manifest是 Vite 或 Webpack 在构建过程中生成清单（manifest.json）时调用的钩子。清单文件通常包含了应用中所有静态资源的哈希值，以便浏览器缓存管理和服务器预加载。在

Nuxt.js 中，通过这个钩子，开发者可以自定义 Nitro（Vite 的预渲染服务）在 HTML 中渲染的<link>标签，以及影响资源的缓存策略。

详细解释与用法：

参数说明：manifest是一个对象，包含了当前构建的清单内容，包括文件名、哈希值、版本等信息。
使用场景：可以根据需要修改清单，比如添加或删除特定资源，或者更改资源的缓存策略。
示例用法：

export default defineNuxtPlugin((nuxtApp) => {

  nuxtApp.hook('build:manifest', async (manifest) => {

    // 示例：修改清单中的资源哈希值

    manifest['assets/images/my-image.png'].hash = 'new-hash-for-image';

    // 示例：添加自定义的清单项

    manifest['custom-manifest'] = {

      url: '/custom-manifest.json',

      revision: manifest.revision,

      hash: 'custom-manifest-hash'

    };

    // 示例：处理 Nitro 预渲染的 `<link>` 标签

    if (nuxtApp.isServer) {

      const html = nuxtApp.renderToString();

      const modifiedHtml = html.replace(

        '<link rel="preload" href="/manifest.json">',

        '<link rel="preload" href="/custom-manifest.json">'

      );

      nuxtApp.render(modifiedHtml);

    }

  });

});

在这个案例中，build:manifest钩子被用来：

修改my-image.png的哈希值，这可能会影响浏览器缓存。
添加一个自定义的清单项，如custom-manifest.json。
如果是在服务器端渲染（SSR）环境中，替换 Nitro 预渲染时使用的清单文件路径。

请注意，Vite 和 Webpack 的具体用法可能略有不同，但基本原理相似，都是在构建阶段对清单进行定制。

钩子：builder:generateApp

参数：options

环境：Nuxt.js 用于生成静态站点或预构建应用

描述：builder:generateApp是 Nuxt.js 在执行nuxt generate或nuxt build --generate

命令，即生成应用程序（如静态站点）之前调用的钩子。这个钩子允许开发者在生成过程开始时对生成的文件结构、内容或配置进行定制。

详细解释与用法：

参数说明：options是一个对象，包含了生成应用时的配置和环境信息，如输出目录、模式（spa、ssr）、路由等。
应用场景：
- 可以修改输出目录或文件名，如重命名文件、创建子目录结构。
- 可以根据生成环境（如开发、生产）动态调整内容或配置。
- 可能会用到options.context，它提供了生成过程中的上下文信息，如当前路由、页面数据等。

示例用法：

export default defineNuxtPlugin((nuxtApp) => {

  nuxtApp.hook('builder:generateApp', async (options) => {

    // 示例：修改输出目录

    options.outputDir = 'custom-output';

    // 示例：根据环境添加不同的内容

    if (options.mode === 'spa') {

      options.content.push({

        path: 'custom-spa-page.html',

        template: '<h1>Custom SPA Page</h1>'

      });

    } else {

      options.pages['/custom-server-page.vue'] = {

        template: '<h1>Custom Server Page</h1>'

      };

    }

    // 示例：使用 context 获取当前路由信息

    const currentRoute = options.context.route;

    if (currentRoute.name === 'my-custom-route') {

      // 添加或修改特定路由的页面内容

    }

  });

});

在这个案例中，builder:generateApp钩子被用来：

修改生成的输出目录。
根据应用模式（SPA 或 SSR）动态添加或修改生成的内容。
利用context获取当前路由信息，可能用于根据路由条件调整生成的页面。

请确保在实际使用时，遵循 Nuxt.js 的最佳实践和API规范。

钩子：builder:watch

参数：event, path

环境：Nuxt.js 开发环境

描述：builder:watch是 Nuxt.js

在开发环境中使用的钩子，当文件系统监视器检测到项目中的文件或目录发生变化时，此钩子会被调用。这个钩子允许开发者在文件变化时执行自定义逻辑，例如清除缓存、触发自定义构建步骤等。

详细解释与用法：

参数说明：
- event：一个字符串，表示文件变化的类型，通常是add,change, 或unlink（删除）。
- path：一个字符串，表示发生变化文件的路径。
应用场景：
- 当文件被修改时，清除某些缓存或临时文件。
- 当文件被添加或删除时，触发某些自定义的构建或编译过程。

钩子：pages:extend

钩子：server:devHandler:handler

余下文章内容请点击跳转至个人博客页面或者扫码关注或者微信搜一搜：编程智域前端至全栈交流与成长，阅读完整的文章：Nuxt3 的生命周期和钩子函数（五） | cmdragon's Blog

往期文章归档：