vue3 directive-自定义指令及模块化

一. 定义
除了核心功能默认内置的指令 (例如 v-model 和 v-show)，Vue 也允许注册自定义指令。注意，在 Vue 中，代码复用和抽象的主要形式是组件。然而，有的情况下，你仍然需要对普通 DOM 元素进行底层操作，这时候就会用到自定义指令。

二. 钩子函数以及生命周期钩子参数详解
● 钩子函数
○ created 元素初始化的时候
○ beforeMount 指令绑定到元素后调用 只调用一次
○ mounted 元素插入父级dom调用
○ beforeUpdate 元素被更新之前调用
○ update 这个周期方法被移除 改用updated
○ beforeUnmount 在元素被移除前调用
○ unmounted 指令被移除后调用 只调用一次

● 生命周期钩子参数详解（每个钩子都有参数）
○ 第一个 el 当前绑定的DOM 元素
○ 第二个 binding
■ instance：使用指令的组件实例。
■ value：传递给指令的值。例如，在 v-my-directive=“1 + 1” 中，该值为 2。
■ oldValue：先前的值，仅在 beforeUpdate 和 updated 中可用。无论值是否有更改都可用。
■ arg：传递给指令的参数(如果有的话)。例如在 v-my-directive:foo 中，arg 为 “foo”。
■ modifiers：包含修饰符(如果有的话) 的对象。例如在 v-my-directive.foo.bar 中，修饰符对象为 {foo: true，bar: true}。
■ dir：一个对象，在注册指令时作为参数传递。例如，在以下指令中
○ 第三个 当前元素的虚拟DOM 也就是Vnode
○ 第四个 prevNode 上一个虚拟节点，仅在 beforeUpdate 和 updated 钩子中可用

注意： 除了 el 之外，你应该将这些参数视为只读，并且永远不要修改它们。

 app.directive('test', {

        created: (el, binding, vnode, prevNode) => {

            console.log("第一个参数:当前绑定的DOM 元素", el);
            console.log("---------------------------------------------");

            console.log("第二个参数:是个对象", binding);
            //使用指令的组件实例
            console.log("binding.instance:第一个参数", binding.instance);
            //传递给指令的值。
            console.log("binding.value:第二个参数", binding.value);
            //先前的值，仅在 beforeUpdate 和 updated 中可用。无论值是否有更改都可用。
            console.log("binding.oldValue:第三个参数", binding.oldValue);
            //传递给指令的参数(如果有的话)。例如在 v-my-directive:foo 中，arg 为 "foo"。
            console.log("binding.arg:第四个参数", binding.arg);
            //包含修饰符(如果有的话) 的对象。
            console.log("binding.modifiers:第五个参数", binding.modifiers);
            //一个对象，在注册指令时作为参数传递。
            console.log("binding.dir:第六个参数", binding.dir);
            console.log("---------------------------------------------");

            console.log("第三个参数:当前元素的虚拟DOM 也就是Vnode", vnode);
            console.log("---------------------------------------------");

            console.log("第四个参数:prevNode 上一个虚拟节点，仅在 beforeUpdate 和 updated 钩子中可用 ", prevNode);
            // console.log("初始化====>");
        },
        beforeMount(...args: Array<any>) {
            // 在元素上做些操作
            // console.log(args);
            // console.log("初始化一次=======>");
        },
        mounted() {
            // console.log("初始化========>");
        },
        beforeUpdate() {
            // console.log("更新q前");
        },
        updated() {
            // console.log("更新结束");
        },
        beforeUnmount() {
            // console.log("======>卸载之前");
        },
        unmounted() {
            // console.log("======>卸载完成");
        },
    });

三. 简写
在前面的例子中，你可能想在 mounted 和 updated 时触发相同行为，而不关心其他的钩子函数。那么你可以通过将这个回调函数传递给指令来实现：

app.directive('pin', (el, binding) => {
		//逻辑代码
})

四. 模块化

1. 在src目录下创建directive文件夹
   
2. directive文件夹创建index.ts，用于暴露每个directiveModules。

import type { App } from 'vue';
import { test } from './test'


/**
 * 导出指令方法：v-xxx
 * @methods test 测试，用法：v-test
 */

export default function directive(app: App) {
    // test
    test(app)
}

3. 在main.ts 应用

//自定义指令引用
//自动会识别index.ts
import Directive from "@/directive"

Directive(app)

五.应用场景
需要对普通 DOM 元素进行底层操作，这时候就会用到自定义指令。
EX：自定义权限按钮、鼠标长按事件、拖拽指令…