Vue3.0插件执行原理与实战

2023-02-28

app vue 插件

一、编写插件Vue项目能够使用很多插件来丰富自己的功能，例如Vue-Router、Vuex……，这么多插件供我们使用，节省了我们大量的人力和物力，那这些插件是开发出来的呢?是不是我们自己也想拥有一个属于自己的vue插件，下面就展示一下如何写一个自己的Vue插件。1.1包含install()方法的Ob

一、编写插件

Vue项目能够使用很多插件来丰富自己的功能，例如Vue-Router、Vuex……，这么多插件供我们使用，节省了我们大量的人力和物力，那这些插件是开发出来的呢?是不是我们自己也想拥有一个属于自己的vue插件，下面就展示一下如何写一个自己的Vue插件。

1.1 包含install()方法的Object

Vue插件可以是一个包含install方法的Object对象，此时插件被调用时会调用install方法，如下所示：

export default {
    // 接收两个参数
    // app: 应用上下文的实例
    // options：插件输入的选项
    install: (app, options) => {
        console.log('app', app);
        console.log('options', options);
        // 做一些处理
        // ……
    }
}
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.

1.2 通过function的方式

Vue插件也可以是一个function函数，此时插件被调用时会调用function函数本身，如下所示：

export default function TestPlugin(app, options) {
    console.log('app', app);
    console.log('options', options);
}
1.
2.
3.
4.

二、使用插件

上述已经阐述了如何编写自己的插件，插件编写完了之后就需要使用这些插件了，那这些插件应该如何使用呢?其实用起来很简单，应用上下文的实例上提供了对应的use方法。

app.use(plugin, [options]); // 返回一个应用实例，所以其可以链式添加新的插件
1.

三、app.use()是如何执行插件的

为什么app.use()可以使用这些插件呢?本着“知其然而知其所以然”的精神，一起来扒一扒为什么。如下是对应的源码：

function createApp(rootComponent, rootProps = null) {
    // ……
    const installedPlugins = new Set();
    const app = (context.app = {
        // ……
        use(plugin, ...options) {
            if (installedPlugins.has(plugin)) {
                warn(`Plugin has already been applied to target app.`);
            }
            else if (plugin && shared.isFunction(plugin.install)) {
                installedPlugins.add(plugin);
                plugin.install(app, ...options);
            }
            else if (shared.isFunction(plugin)) {
                installedPlugins.add(plugin);
                plugin(app, ...options);
            }
            else {
                warn(`A plugin must either be a function or an object with an "install" ` +
                    `function.`);
            }
            return app;
        },
        // ……
    });
    return app;
};
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.