spa-custom-hooks 使用教程

2026-01-19 11:27:31作者：咎岭娴Homer

项目介绍

spa-custom-hooks 是一个基于 Vue 架构的自定义 Hook 钩子库，旨在解决页面逻辑依赖全局异步数据的问题。它允许开发者注册全局的异步任务，并自定义钩子的触发条件，当满足条件时自动执行页面相关的钩子。该库支持 Vue 架构（包括 uni-app、wepy、mpvue 等）以及各种小程序。

项目快速启动

安装

首先，通过 npm 安装 spa-custom-hooks：

npm install spa-custom-hooks

注册插件

在项目的入口文件中注册插件：

import Vue from 'vue';
import CustomHook from 'spa-custom-hooks';
import store from './store'; // 假设你有一个 Vuex store

const diyHooks = {
  // 注册属性的监听钩子名称
  'UserInfo': {
    name: 'UserInfo',
    watchKey: 'userinfo',
    deep: true,
    onUpdate(val) {
      return val.nickName;
    }
  }
};

Vue.use(CustomHook, diyHooks, store);

页面中使用

在 Vue 组件中使用自定义钩子：

export default {
  name: 'Home',
  methods: {
    onUserInfo() {
      // 自定义钩子触发时的逻辑
    }
  },
  mounted() {
    this.$store.commit('logs', 'mounted钩子执行(home.vue)');
  },
  created() {
    this.$store.commit('logs', 'onCreatedUserInfo钩子执行(home.vue)');
  }
};

应用案例和最佳实践

案例一：用户信息更新

假设你有一个页面依赖用户的登录信息，当用户信息更新时，页面需要执行特定的逻辑。使用 spa-custom-hooks 可以轻松实现：

const diyHooks = {
  'UserInfo': {
    name: 'UserInfo',
    watchKey: 'userinfo',
    deep: true,
    onUpdate(val) {
      return val.nickName;
    }
  }
};

Vue.use(CustomHook, diyHooks, store);

在组件中：

export default {
  name: 'UserProfile',
  methods: {
    onUserInfo() {
      // 用户信息更新时的逻辑
    }
  },
  mounted() {
    this.$store.commit('logs', 'mounted钩子执行(user-profile.vue)');
  }
};

案例二：异步数据加载

假设你有一个页面依赖异步加载的数据，当数据加载完成时，页面需要执行特定的逻辑。使用 spa-custom-hooks 可以轻松实现：

const diyHooks = {
  'DataLoaded': {
    name: 'DataLoaded',
    watchKey: 'data',
    deep: true,
    onUpdate(val) {
      return val.loaded;
    }
  }
};

Vue.use(CustomHook, diyHooks, store);

在组件中：

export default {
  name: 'DataPage',
  methods: {
    onDataLoaded() {
      // 数据加载完成时的逻辑
    }
  },
  mounted() {
    this.$store.commit('logs', 'mounted钩子执行(data-page.vue)');
  }
};