vue3中Hook使用以及Hook结合自定义指令

更新时间：2024年08月16日 15:01:10 作者：白臻

这篇文章主要介绍了vue3中Hook使用以及Hook结合自定义指令方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教

Vue3的自定义的hook

hook是钩子的意思，看到“钩子”是不是就想到了钩子函数？事实上，hooks 还真是函数的一种写法。

vue3 借鉴 reacthooks 开发出了 Composition API ，所以也就意味着 Composition API 也能进行自定义封装 hooks。

vue3 中的 hooks就是函数的一种写法，就是将文件的一些单独功能的js代码进行抽离出来，放到单独的js文件中，或者说是一些可以复用的公共方法/功能。

其实hooks 和 vue2 中的 mixin 有点类似，但是相对 mixins 而言， hooks 更清楚复用功能代码的来源, 更清晰易懂。

Vue3 hook库：hook 官网

手写自定义hook 案例一

1.新建 hooks/iondex.ts 文件

import { onMounted } from "vue"

type Options = {
    el: string
}
export default function (options: Options): Promise<{ baseUrl: string }> {
    return new Promise((resolve) => {
        onMounted(() => {
            let img: HTMLImageElement = document.querySelector(options.el) as HTMLImageElement;
            img.onload = () => {
                resolve({
                    baseUrl: base64(img)
                })
            }
        })
        const base64 = (el: HTMLImageElement) => {
            const canvas = document.createElement('canvas')
            const ctx = canvas.getContext('2d')
            canvas.width = el.width;
            canvas.height = el.height;
            ctx?.drawImage(el, 0, 0, canvas.width, canvas.height)
            return canvas.toDataURL('image/png')
        }
    })

}

2.在文件中使用

<template>
    <div>
        <img
            id="img"
            width="300"
            height="300"
            src="../../assets/vue.svg"
            alt=""
        />
    </div>
</template>
<script setup lang="ts">
import useBase64 from "../hooks/index"
useBase64({
    el: "img",
}).then((res) => {
    console.log(res.baseUrl)
})
</script>
<style scoped lang="scss"></style>

3.展示效果在控制台显示然后复制 base64码到浏览器可显示图片

手写自定义hook 案例二

需求：

实现一个函数同事支持hook 和自定义指令去监听dom宽高的变化 5w3h 八何分析法

1.如何监听dom宽高变化
2.如何用vite打包库
3.如何发布npm

1.新建工程 V-RESIZE-XM

新建src/index.ts文件

- 输入 pnpm init 终端命令生成 package.json 配置文件
- 输入 tsc --init 终端名称生成 tsconfig.json 配置文件
- 新建 vite.config.ts 文件
- 新建 index.d.ts 文件
- 安装两个库 pnpm i vue -D pnpm i vite -D

2.进入 src/index.ts文件中完成hook

ResizeObserver主要侦听元素宽高的变化
MutationObserver主要侦听子集的变化还有属性的变化以及增删改查
interSectionObserver主要侦听元素是否在视口内

import type { App } from 'vue'
function useResize(el: HTMLElement, callback: Function) {
    let resize = new ResizeObserver((entries) => {
        callback(entries[0].contentRect)
    })
    resize.observe(el)
}
// vue 插件
const install = (app: App) => {
    app.directive('resize', {
        mounted(el, binding) {
            useResize(el, binding.value)
        }
    })
}
useResize.install = install
export default useResize

3.打包成为一个库

在vite.config.ts 文件中配置

import { defineConfig } from 'vite'
// umd 支持amd cmd cjs 全局变量模式
export default defineConfig({
    build: {
        lib: {
            entry: 'src/index.ts',
            name: 'userResize',
        },
        rollupOptions: {
            // 确保外部化处理那些你不想打包进库的依赖
            external: ['vue'],
            output: {
                // 在 UMD 构建模式下为这些外部化的依赖提供一个全局变量
                globals: {
                    useResize: 'useResize'
                }
            }
        }
    }
})

4.修改package.json 文件

{
  "name": "v-resize-xm",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "build":"vite build"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "devDependencies": {
    "vite": "^5.2.11",
    "vue": "^3.4.26"
  }
}

5.npm run build 命令后打包

6. 在 index.d.ts 编写声明文件

declare const useResize: {
    (el: HTMLElement, callback: Function): void;
    install: (app: App) => void
};

export default useResize

7.准备就绪发布npm 需要配置 package.json

当使用import 、export的时候它会去找对应的module
当使用require的时候它会去找对应的main
然后配置files是往 npm 上发布的目录
修改版本因为是第一次发布改成0.0.1

{
  "name": "v-resize-xm",
  "version": "0.0.1",
  "description": "",
  "main": "dist/v-resize-xm.umd.js",
  "module": "dist/v-resize-xm.mjs",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "build":"vite"
  },
  "keywords": [],
  "author": "",
  "files": [
    "dist",
    "index.d.ts"
  ],
  "license": "ISC",
  "devDependencies": {
    "vite": "^5.2.11",
    "vue": "^3.4.26"
  }
}

8.上传npm

如果没有npm 账号

npm adduser

有账号的话 npm login

上传插件 npm publish

9.上传成功后

可以去npm 官网搜索package.json 定义的 name 名称进行搜索

链接：npm官网地址

10.使用

在项目中安装库

pnpm i v-resize-smy

在文件中引入

一下代码自定义hook 的实例

<template>
    <div id="resize">
        <a href="http://vitejs.dev" rel="external nofollow"  rel="external nofollow"  target="_blank">
            <img src="/vite.svg" class="logo" alt="Vite logo" />
        </a>
    </div>
</template>
<script setup lang="ts">
import useResize from "v-resize-smy"
import { onMounted } from "vue"
onMounted(() => {
    useResize(document.querySelector("#resize") as HTMLElement, (e: any) => {
        console.log(e)
    })
})
</script>
<style scoped lang="scss">
#resize {
    border: 1px solid #ccc;
    resize: both;
    overflow: hidden;
}
img {
    width: 50px;
    height: 50px;
}
</style>

11.自定义指令+hook 综合使用案例

在main.ts 文件中注册

import useResize from “v-resize-smy”
app.use(useResize)

在文件中使用示例如下

<template>
    <div v-resize="resizeWd" id="resize">
        <a href="http://vitejs.dev" rel="external nofollow"  rel="external nofollow"  target="_blank">
            <img src="/vite.svg" class="logo" alt="Vite logo" />
        </a>
    </div>
</template>
<script setup lang="ts">
const resizeWd = (el: any) => {
    console.log(el)
}
</script>
<style scoped lang="scss">
#resize {
    border: 1px solid #ccc;
    resize: both;
    overflow: hidden;
}
img {
    width: 50px;
    height: 50px;
}
</style>

hooks 优点

1.hooks 作为独立逻辑的组件封装，其内部的属性、函数等和外部组件具有响应式依附的作用。
2.自定义 hook 的作用类似于 vue2 中的 mixin 技术，使用方便，易于上手。
3.使用 Vue3 的组合 API 封装的可复用，高内聚低耦合。

hooks和utils区别

相同点：

通过 hooks 和 utils 函数封装，可以实现组件间共享和复用，提高代码的可重用性和可维护性。

异同点：

表现形式不同：hooks 是在 utils 的基础上再包一层组件级别的东西(钩子函数等)；utils一般用于封装相应的逻辑函数，没有组件的东西；
数据是否具有响应式：hooks 中如果涉及到 ref，reactive，computed 这些 api 的数据，是具有响应式的；而utils 只是单纯提取公共方法就不具备响应式；
作用范围不同：hooks 封装，可以将组件的状态和生命周期方法提取出来，并在多个组件之间共享和重用；utils通常是指一些辅助函数或工具方法，用于实现一些常见的操作或提供特定功能。

总结

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。

您可能感兴趣的文章:

使用VUE实现一键复制内容功能
这篇文章主要介绍了使用VUE实现一键复制内容功能,功能就是当我们点击复制按钮时，会提示“复制成功”，这样复制的内容就可以在其他地方使用了，感兴趣的朋友可以学习一下
2023-04-04
Vue路由配置项和参数使用及说明
文章介绍了Vue路由中query和params参数的传递与接收、命名路由简化跳转、props配置参数、router-link的replace属性、编程式导航、路由组件缓存及activated和deactivated两个生命周期钩子的用法
2025-10-10
Vue.js常用指令的使用小结
这篇文章主要介绍了Vue.js常用指令的使用，非常不错，具有参考借鉴价值,需要的朋友可以参考下
2017-06-06
Vue3中Axios的使用附完整代码
Axios提供了简洁一致的API,使得发送HTTP请求变得非常容易,无论是GET、POST、PUT还是DELETE等请求,都可以通过简洁的语法轻松实现,这篇文章主要介绍了Vue3中Axios的使用附完整代码,需要的朋友可以参考下
2025-06-06
vue.js与element-ui实现菜单树形结构的解决方法
本文通过实例给大家介绍了vue.js与element-ui实现菜单树形结构，非常不错，具有参考借鉴价值,需要的朋友可以参考下
2018-04-04
从Echarts报错中学习Vue3 ref和shallowRef区别及其组件二次封装demo
这篇文章主要介绍了从Echarts报错中学习Vue3 ref和shallowRef区别及其组件二次封装demo,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
2023-11-11
Vue.js设计与实现无限递归学习总结
这篇文章主要为大家介绍了Vue.js设计与实现无限递归学习总结，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2023-05-05
vue组件实现发表评论功能
这篇文章主要为大家详细介绍了vue组件实现发表评论功能，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2022-04-04
Vue-router路由判断页面未登录跳转到登录页面的实例
下面小编就为大家带来一篇Vue-router路由判断页面未登录跳转到登录页面的实例。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2017-10-10
vue 动态表单开发方法案例详解
这篇文章主要介绍了vue 动态表单开发方法,结合具体案例形式详细分析了vue.js动态表单相关原理、开发步骤与实现技巧,需要的朋友可以参考下
2019-12-12