基于Promise将Vue组件封装为插件

项目中有些组件在很多场景下都会用到,比如toast、messageBox、alert等,如果作为组件使用,则每个用到的地方都需要引入、注册等操作;如果把组件封装成插件,并作为实例的公共方法,则在整个应用中即可随处调用。

以messageBox为例,封装插件。

步骤如下:

  1. 编写组件
  2. 调用Vue.extend()方法,创建构造器
  3. 创建组件实例
  4. 挂载并插入文档
  5. 往构造器上添加回调,监听用户的操作,取消还是确定
  6. 创建Promise的实例
  7. 添加方法到Vue的原型和实例上
  8. 监听浏览器的前进、后退事件,当离开页面的时候,隐藏组件

具体如下:

  1. 首先编写组件:
<template>
    <div v-show="show">
    <!-- ui-mask为自己封装的组件 -->
        <ui-mask :showMask="show" :opacity="0.2"></ui-mask>
        <div class="message-box">
            <h1 class="message-title" v-show="title">{{title}}</h1>
            <p class="content">{{content}}</p>
            <div class="message-button">
                <p class="fl" @click="cancleMessage" v-show="cancle">{{cancle}}</p>
                <p class="fr" @click="sureMessage">{{sure}}</p>
            </div>
        </div>
    </div>
</template>
  1. 样式使用scss

样式省略...

  1. js部分代码
data() {
    return {
        show: false,
        title: '',
        content: '',
        sure: '确定',
        cancle: ''
    }
},
methods: {
    sureMessage() {
        this.show = false;
        this.callback && this.callback('confirm');
    },
    cancleMessage() {
        this.show = false;
        this.callback && this.callback();
    }
}

封装插件

  • 如果插件是一个对象,则必须提供install方法,Vue.use的时候调用install方法
  • 如果插件是函数,函数将作为install方法执行。

index.js

import messageBox from './messageBox.vue';

export default {
    install(Vue, options = {}) {
        // 创建构造函数
        const MessageBox = Vue.extend(messageBox);

        let instance;
        let currentMsg;

        // 绑定window的history事件
        window.addEventListener('popstate', () => {
            if (instance) {
                insatnce.show = false; 
                instance = null;
                currentMsg = null;
            }
        });

        let messageBoxFunc = (options = {}) => {
            if (!instance) {
                // 创建实例
                instance = new MessageBox({
                    // 需要挂在到某一个元素上
                    el: document.createElement('div')
                });

                // 如果没有传el,则需要调用实例的$mount方法,传入元素
                // instance = new MessageBox().$mount(document.createElement('div'));
              
              // 如果没有传递el选项、$mount()方法也没有传递任何参数,则模板将被渲染为文档之外的元素,亦是可行的。

                // 插入到DOM中
                document.body.appendChild(instance.$el)
            }

            // 合并参数与实例
            Object.assign(instance, options);

            // 在构造器的原型上扩展一个回调,修改promise的状态
            MessageBox.prototype.callback = defaultCallback;

            return new Promise((resolve, reject) => {
                // 保存两个回调,在action改变的时候执行
                currentMsg = {
                    resolve,
                    reject
                }
            })
        };

        function defaultCallback(action) {
            if (action === 'confirm') {
                currentMsg.resolve('confirm');
            }
            currentMsg.reject('cancle');
        }

        // 将方法扩展到Vue的原型和实例上
        Vue.prototype.$messageBox = Vue.messageBox = messageBoxFunc;
    }
}

这样一个messageBox插件就封装好了,在应用的任何地方都可以调用。可以使用Promise的方式then、catch,亦可使用async/await的方式。

Usage

// 方式一 
this.$messageBox()
.then(res => {

})
.catch(err => {

})

// 方式二
// 所在的方法一定是async函数
try {
    await this.$messageBox();

    // do something
}
catch(e) {
    // do... 
}

总结:

用到的知识点Promise、原型链、async/await。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,393评论 5 467
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,790评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,391评论 0 330
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,703评论 1 270
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,613评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,003评论 1 275
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,507评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,158评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,300评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,256评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,274评论 1 328
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,984评论 3 316
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,569评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,662评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,899评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,268评论 2 345
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,840评论 2 339

推荐阅读更多精彩内容