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

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

date: 2024/6/25

updated: 2024/6/25

excerpt:

摘要：本文是关于Nuxt3的系列文章之一，主要探讨Nuxt3的生命周期和钩子函数，引导读者深入了解其在前端开发中的应用。文章提供了往期相关文章链接，涉及Nuxt中间件、Composables、状态管理、路由系统、组件开发等多个方面，帮助读者全面掌握Nuxt3框架的特性和实践技巧。

categories:

前端开发

tags:

Nuxt3
生命周期
钩子函数
前端开发
Web框架
Vue.js
应用教程

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

app:created

描述：在初始 Vue 应用实例创建时调用。这个钩子是在 Nuxt 应用启动时，Vue 应用实例被创建之后立即触发的。
服务器端：✅
客户端：✅

用法

app:created 钩子可以在 nuxt.config.ts 文件中的 plugins 或者在页面组件中使用。

示例代码

在 nuxt.config.ts 中的插件中使用：

// nuxt.config.ts
export default defineNuxtConfig({
  plugins: [
    {
      src: '~/plugins/my-plugin',
      mode: 'client', // 或者 'server' 或 'all'
    },
  ],
})

// plugins/my-plugin.ts
export default defineNuxtPlugin((nuxtApp) => {
  nuxtApp.hook('app:created', () => {
    console.log('Vue 应用实例已创建');
    // 这里可以执行一些初始化逻辑
  });
});

在页面组件中使用：

<template>
  <div>页面内容</div>
</template>

<script setup>
import { onBeforeMount } from 'vue'

onBeforeMount(() => {
  // 这个钩子会在 'app:created' 之后调用
  console.log('页面组件即将挂载');
})

const nuxtApp = useNuxtApp()

nuxtApp.hook('app:created', () => {
  console.log('Vue 应用实例已创建 - 页面级别');
});
</script>

在这个示例中，app:created 钩子被用于在 Vue 应用实例创建时输出一条消息。这可以用于执行一些全局的初始化任务，比如设置全局变量或状态，注册全局组件等。需要注意的是，在服务器端渲染 (SSR) 的上下文中，这个钩子会在服务器上为每个请求调用一次。在客户端，这个钩子只在应用初始化时调用一次。

app:error err 服务器端和客户端在发生致命错误时调用。

详细解释

app:error 是 Nuxt 3 的一个全局生命周期钩子，它在服务器端和客户端发生未捕获的致命错误时被调用。这个钩子允许你定义一个自定义的错误处理函数，以便在发生错误时执行特定的逻辑，比如记录错误信息、发送错误报告、显示错误消息或者重定向到错误页面。

用法

在 Nuxt 3 应用中，你可以通过在 defineNuxtPlugin 函数中注册 app:error 钩子来使用它。

export default defineNuxtPlugin((nuxtApp) => {
  nuxtApp.hook('app:error', (err, ctx) => {
    // 自定义错误处理逻辑
  });
});

案例Demo

// plugins/error-handler.js
export default defineNuxtPlugin((nuxtApp) => {
  nuxtApp.hook('app:error', (err, ctx) => {
    console.error('An error occurred:', err.message);
    
    // 如果是客户端错误，可以显示一个错误消息给用户
    if (process.client) {
      alert('An error occurred: ' + err.message);
    }
    
    // 如果是服务器端错误，可以记录到日志文件或发送到错误追踪服务
    if (process.server) {
      // 例如，使用 winston 或其他日志库记录错误
      // logger.error('Server error:', err);
      
      // 或者发送错误到错误追踪服务，如 Sentry
      // Sentry.captureException(err);
    }
    
    // 可以根据错误类型决定是否重定向
    if (err.statusCode === 404) {
      // 重定向到404页面
      ctx.redirect('/404');
    }
  });
});

在这个案例中，我们定义了一个 app:error 钩子，当发生错误时，它会打印错误信息到控制台。如果是客户端错误，它会弹出一个包含错误信息的警告框。如果是服务器端错误，它可以记录错误日志或发送错误到错误追踪服务。此外，如果错误是一个特定的状态码（例如404），我们可以重定向用户到一个特定的页面。

app:error:cleared { redirect? } 服务器端和客户端在致命错误被清除后调用。

详细解释

app:error:cleared 是 Nuxt 3 的一个全局生命周期钩子，它在服务器端和客户端的致命错误被清除后调用。这个钩子允许你在错误被处理后执行后续操作，比如重定向用户到另一个页面。这个钩子接收一个可选的 redirect 参数，它允许你指定一个重定向的路径。

用法

在 Nuxt 3 应用中，你可以通过在 defineNuxtPlugin 函数中注册 app:error:cleared 钩子来使用它。

export default defineNuxtPlugin((nuxtApp) => {
  nuxtApp.hook('app:error:cleared', (redirect, ctx) => {
    // 自定义错误清除后的逻辑
  });
});

案例Demo

// plugins/error-clear-handler.js
export default defineNuxtPlugin((nuxtApp) => {
  nuxtApp.hook('app:error:cleared', (redirect, ctx) => {
    // 如果提供了重定向路径，则进行重定向
    if (redirect) {
      ctx.redirect(redirect);
    }
    
    // 可以在这里执行其他清理工作，例如清除错误状态
    // 或者通知用户错误已经被处理
    if (process.client) {
      // 例如，更新UI来反映错误已经被处理
      // updateErrorState(false);
    }
    
    // 如果是服务器端，可能需要清除服务器状态或发送通知
    if (process.server) {
      // 清理服务器状态或发送通知
      // serverCleanup();
    }
  });
});

在这个案例中，我们定义了一个 app:error:cleared 钩子，当致命错误被清除后，它会检查是否提供了重定向路径，如果提供了，则执行重定向。此外，它还可以执行其他清理工作，例如在客户端更新UI状态以反映错误已经被处理，或者在服务器端清理服务器状态或发送通知。这个钩子是处理错误后恢复应用状态的有用工具。

app:data:refresh keys? 服务器端和客户端 (内部)

详细解释

app:data:refresh 是 Nuxt 3 中的一个内部生命周期钩子，主要用于数据刷新。它在需要重新获取数据时被触发，通常发生在用户刷新页面或者在某些情况下数据更新后。keys 参数是可选的，它是一个数组，包含需要刷新的数据的键名，如果不提供，会刷新所有数据。

用法

在 Nuxt 3 中，你通常不会直接在 defineNuxtPlugin 中使用这个钩子，因为它是内部调用的。然而，如果你需要在插件中影响数据刷新行为，可以通过监听相关事件来间接使用。

export default defineNuxtPlugin((nuxtApp) => {
  nuxtApp.on('dataRefresh', (keys) => {
    // 在这里处理数据刷新操作，例如更新缓存、请求新数据等
    if (keys) {
      // 如果提供了keys，只刷新指定的数据
      keys.forEach((key) => {
        nuxtApp.$store.dispatch('refreshData', key);
      });
    } else {
      // 否则刷新所有数据
      nuxtApp.$store.dispatch('refreshAllData');
    }
  });
});

案例Demo

// plugins/data-refresh.js
export default defineNuxtPlugin((nuxtApp) => {
  nuxtApp.on('dataRefresh', async (keys) => {
    if (keys) {
      const promises = keys.map(async (key) => {
        const freshData = await fetchNewData(key);
        nuxtApp.$store.commit('updateData', { key, data: freshData });
      });
      await Promise.all(promises);
    } else {
      const allData = await fetchAllData();
      nuxtApp.$store.commit('updateAllData', { data: allData });
    }
  });
});

// 在 store 中定义 mutation
export const mutations = {
  updateData(state, { key, data }) {
    state[key] = data;
  },
  updateAllData(state, { data }) {
    state = data;
  },
};

在这个案例中，我们创建了一个插件，监听 dataRefresh 事件。当事件触发时，我们根据提供的 keys 刷新指定的数据，或者刷新所有数据。然后，我们更新 Vuex 存储中的数据。注意，实际的 fetchNewData 和 fetchAllData 需要你根据你的应用逻辑来实现。

vue:setup - 服务器端和客户端 (内部)

详细解释

vue:setup 是 Nuxt 3 中的一个生命周期钩子，它在每个 Vue 组件的 setup 阶段被调用。这个钩子主要用于在组件的初始化阶段进行数据处理、依赖注入、API 设置等操作。由于它是基于 Vue 的，所以它在客户端和服务器端都会执行，但服务器端渲染时，它主要作用于预渲染阶段。

用法

在 Nuxt 3 中，vue:setup 通常用于创建自定义组件，它会接收一个 app 对象，你可以通过这个对象访问 Nuxt 应用实例。例如，你可以注入 $store 或 $router，并定义组件的局部状态和方法。

export default defineComponent({
  setup() {
    const store = inject('store');
    const router = inject('router');

    // 在这里定义组件的局部状态和方法
    const count = ref(0);
    const increment = () => {
      count.value++;
    };

    // 使用store和router
    watch(() => router.currentRoute.value.name, () => {
      // 当路由改变时执行某些操作
    });

    return {
      count,
      increment,
    };
  },
});

案例Demo

// components/MyComponent.vue
export default defineComponent({
  setup() {
    const { $store } = inject();
    const myData = ref($store.state.myData);

    // 在setup中获取并使用store中的数据
    useEffect(() => {
      async function fetchData() {
        const newData = await fetchMyData();
        myData.value = newData;
      }
      fetchData();
    }, []);

    // 示例方法，使用store数据
    const updateData = (newValue) => {
      myData.value = newValue;
      $store.commit('updateMyData', newValue);
    };

    return {
      myData,
      updateData,
    };
  },
});

// 在store/index.js中定义mutation
export const mutations = {
  updateMyData(state, newData) {
    state.myData = newData;
  },
};

在这个案例中，我们在 vue:setup 中注入 $store，获取并使用存储中的数据。当组件挂载时，我们会从服务器获取数据并更新组件状态。同时，我们定义了一个 updateData 方法，用于更新 store 中的数据。在客户端和服务器端，这个组件都会执行这些操作。

vue:error - err, target, info - 服务器端和客户端 - 当 Vue 错误传播到根组件时调用。了解更多。

详细解释

vue:error 是 Nuxt 3 中的一个生命周期钩子，它在 Vue 应用程序的错误处理过程中起作用。当 Vue 错误传播到根组件时，这个钩子会被调用。这个钩子可以用于在服务器端和客户端记录和处理错误。

app:rendered - renderContext - 服务器端 - 在 SSR 渲染完成时调用

app:rendered

钩子：app:redirected

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

往期文章推荐：

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

app:created

用法

示例代码

app:error err 服务器端和客户端 在发生致命错误时调用。

详细解释

用法

案例Demo

app:error:cleared { redirect? } 服务器端和客户端 在致命错误被清除后调用。

详细解释

用法

案例Demo

app:data:refresh keys? 服务器端和客户端 (内部)

详细解释

用法

案例Demo

vue:setup - 服务器端和客户端 (内部)

详细解释

用法

案例Demo

vue:error - err, target, info - 服务器端和客户端 - 当 Vue 错误传播到根组件时调用。了解更多。

详细解释

app:rendered - renderContext - 服务器端 - 在 SSR 渲染完成时调用

app:rendered

钩子：app:redirected

往期文章归档：

app:error err 服务器端和客户端在发生致命错误时调用。

app:error:cleared { redirect? } 服务器端和客户端在致命错误被清除后调用。