面试官：用Vue3.0 写过组件吗？如果想实现一个 Modal你会怎么设计？

偏执的太偏执、 2022-10-26 12:44 205阅读 0赞

![format_png][]

## 一、组件设计 ##

组件就是把图形、非图形的各种逻辑均抽象为一个统一的概念（组件）来实现开发的模式

现在有一个场景，点击新增与编辑都弹框出来进行填写，功能上大同小异，可能只是标题内容或者是显示的主体内容稍微不同

这时候就没必要写两个组件，只需要根据传入的参数不同，组件显示不同内容即可

这样，下次开发相同界面程序时就可以写更少的代码，意味着更高的开发效率，更少的 `Bug`和更少的程序体积

## 二、需求分析 ##

实现一个`Modal`组件，首先确定需要完成的内容：

*  遮罩层
 *  标题内容
 *  主体内容
 *  确定和取消按钮

主体内容需要灵活，所以可以是字符串，也可以是一段 `html` 代码

特点是它们在当前`vue`实例之外独立存在，通常挂载于`body`之上

除了通过引入`import`的形式，我们还可通过`API`的形式进行组件的调用

还可以包括配置全局样式、国际化、与`typeScript`结合

## 三、实现流程 ##

首先看看大致流程：

*  目录结构
 *  组件内容
 *  实现 API 形式
 *  事件处理
 *  其他完善

### 目录结构 ###

`Modal`组件相关的目录结构

├── plugins
    │   └── modal
    │       ├── Content.tsx // 维护 Modal 的内容，用于 h 函数和 jsx 语法
    │       ├── Modal.vue // 基础组件
    │       ├── config.ts // 全局默认配置
    │       ├── index.ts // 入口
    │       ├── locale // 国际化相关
    │       │   ├── index.ts
    │       │   └── lang
    │       │       ├── en-US.ts
    │       │       ├── zh-CN.ts
    │       │       └── zh-TW.ts
    │       └── modal.type.ts // ts类型声明相关

因为 Modal 会被 `app.use(Modal)` 调用作为一个插件，所以都放在`plugins`目录下

### 组件内容 ###

首先实现`modal.vue`的主体显示内容大致如下

<Teleport to="body" :disabled="!isTeleport">
        <div v-if="modelValue" class="modal">
            <div
                 class="mask"
                 :style="style"
                 @click="maskClose && !loading && handleCancel()"
                 ></div>
            <div class="modal__main">
                <div class="modal__title line line--b">
                    <span>{
        { title || t("r.title") }}</span>
                    <span
                          v-if="close"
                          :title="t('r.close')"
                          class="close"
                          @click="!loading && handleCancel()"
                          >✕</span
                        >
                </div>
                <div class="modal__content">
                    <Content v-if="typeof content === 'function'" :render="content" />
                    <slot v-else>
                        {
        { content }}
                    </slot>
                </div>
                <div class="modal__btns line line--t">
                    <button :disabled="loading" @click="handleConfirm">
                        <span class="loading" v-if="loading"> ❍ </span>{
        { t("r.confirm") }}
                    </button>
                    <button @click="!loading && handleCancel()">
                        {
        { t("r.cancel") }}
                    </button>
                </div>
            </div>
        </div>
    </Teleport>

最外层上通过Vue3 `Teleport` 内置组件进行包裹，其相当于传送门，将里面的内容传送至`body`之上

并且从`DOM`结构上来看，把`modal`该有的内容（遮罩层、标题、内容、底部按钮）都实现了

关于主体内容

<div class="modal__content">
        <Content v-if="typeof content==='function'"
                 :render="content" />
        <slot v-else>
            {
        {content}}
        </slot>
    </div>

可以看到根据传入`content`的类型不同，对应显示不同得到内容

最常见的则是通过调用字符串和默认插槽的形式

// 默认插槽
    <Modal v-model="show"
           title="演示 slot">
        <div>hello world~</div>
    </Modal>
    
    // 字符串
    <Modal v-model="show"
           title="演示 content"
           content="hello world~" />

通过 API 形式调用`Modal`组件的时候，`content`可以使用下面两种

*  h 函数

$modal.show({
      title: '演示 h 函数',
      content(h) {
        return h(
          'div',
          {
            style: 'color:red;',
            onClick: ($event: Event) => console.log('clicked', $event.target)
          },
          'hello world ~'
        );
      }
    });

*  JSX

$modal.show({
      title: '演示 jsx 语法',
      content() {
        return (
          <div
            onClick={($event: Event) => console.log('clicked', $event.target)}
          >
            hello world ~
          </div>
        );
      }
    });

### 实现 API 形式 ###

那么组件如何实现`API`形式调用`Modal`组件呢？

在`Vue2`中，我们可以借助`Vue`实例以及`Vue.extend`的方式获得组件实例，然后挂载到`body`上

import Modal from './Modal.vue';
    const ComponentClass = Vue.extend(Modal);
    const instance = new ComponentClass({ el: document.createElement("div") });
    document.body.appendChild(instance.$el);

虽然`Vue3`移除了`Vue.extend`方法，但可以通过`createVNode`实现

import Modal from './Modal.vue';
    const container = document.createElement('div');
    const vnode = createVNode(Modal);
    render(vnode, container);
    const instance = vnode.component;
    document.body.appendChild(container);

在`Vue2`中，可以通过`this`的形式调用全局 API

export default {
        install(vue) {
           vue.prototype.$create = create
        }
    }

而在 Vue3 的 `setup` 中已经没有 `this`概念了，需要调用`app.config.globalProperties`挂载到全局

export default {
        install(app) {
            app.config.globalProperties.$create = create
        }
    }

### 事件处理 ###

下面再看看看`Modal`组件内部是如何处理「确定」「取消」事件的，既然是`Vue3`，我们可以采用`Compositon API` 形式

// Modal.vue
    setup(props, ctx) {
      let instance = getCurrentInstance(); // 获得当前组件实例
      onBeforeMount(() => {
        instance._hub = {
          'on-cancel': () => {},
          'on-confirm': () => {}
        };
      });
    
      const handleConfirm = () => {
        ctx.emit('on-confirm');
        instance._hub['on-confirm']();
      };
      const handleCancel = () => {
        ctx.emit('on-cancel');
        ctx.emit('update:modelValue', false);
        instance._hub['on-cancel']();
      };
    
      return {
        handleConfirm,
        handleCancel
      };
    }

在上面代码中，可以看得到除了使用传统`emit`的形式使父组件监听，还可通过`_hub`属性中添加 `on-cancel`，`on-confirm`方法实现在`API`中进行监听

app.config.globalProperties.$modal = {
       show({}) {
         /* 监听 确定、取消 事件 */
       }
    }

下面再来目睹下`_hub`是如何实现

// index.ts
    app.config.globalProperties.$modal = {
        show({
            /* 其他选项 */
            onConfirm,
            onCancel
        }) {
            /* ... */
    
            const { props, _hub } = instance;
    
            const _closeModal = () => {
                props.modelValue = false;
                container.parentNode!.removeChild(container);
            };
            // 往 _hub 新增事件的具体实现
            Object.assign(_hub, {
                async 'on-confirm'() {
                if (onConfirm) {
                    const fn = onConfirm();
                    // 当方法返回为 Promise
                    if (fn && fn.then) {
                        try {
                            props.loading = true;
                            await fn;
                            props.loading = false;
                            _closeModal();
                        } catch (err) {
                            // 发生错误时，不关闭弹框
                            console.error(err);
                            props.loading = false;
                        }
                    } else {
                        _closeModal();
                    }
                } else {
                    _closeModal();
                }
            },
                'on-cancel'() {
                    onCancel && onCancel();
                    _closeModal();
                }
        });
    }
    };

### 其他完善 ###

关于组件实现国际化、与`typsScript`结合，大家可以根据自身情况在此基础上进行更改

## 参考文献 ##

*  https://segmentfault.com/a/1190000038928664
 *  https://vue3js.cn/docs/zh

面试官VUE3番外篇正在更新：6/6

[面试官：Vue3.0的设计目标是什么？做了哪些优化?][Vue3.0]

[面试官：Vue3.0 性能提升主要是通过哪几方面体现的？][Vue3.0 1]

[面试官：Vue3.0里为什么要用 Proxy API 替代 defineProperty API ？][Vue3.0_ Proxy API _ defineProperty API]

[面试官：Vue3.0 所采用的 Composition Api 与 Vue2.x 使用的 Options Api 有什么不同？][Vue3.0 _ Composition Api _ Vue2.x _ Options Api]

[面试官：说说Vue 3.0中Treeshaking特性？举例说明一下？][Vue 3.0_Treeshaking]

篇副有限，扫下方二维码查看往期

![format_png 1][]

[format_png]: /images/20221024/e046be5df30f437b86257c3e784eac27.png
[Vue3.0]: http://mp.weixin.qq.com/s?__biz=MzU1OTgxNDQ1Nw%3D%3D&chksm=fc10c534cb674c22b3c8d8c00edebfaadfc2c4b053cdc72aada1f85510a7ba2fa6eb17afe931&idx=2&mid=2247485282&scene=21&sn=65fe59726c446b16d9aa1deff9141285#wechat_redirect
[Vue3.0 1]: http://mp.weixin.qq.com/s?__biz=MzU1OTgxNDQ1Nw%3D%3D&chksm=fc10c525cb674c3362db1ba684f9365902177988186009b323cc9398f0c260e58b09d8aaf0b0&idx=1&mid=2247485299&scene=21&sn=92d9cedf388788977179c6dcdb4acf05#wechat_redirect
[Vue3.0_ Proxy API _ defineProperty API]: http://mp.weixin.qq.com/s?__biz=MzU1OTgxNDQ1Nw%3D%3D&chksm=fc10c5f9cb674cef4003894137ead6830b27dd7c22614cb56bdafcc9fb82605f8332e28f61ad&idx=2&mid=2247485359&scene=21&sn=1f3a8633cf6a4e66bc2fd729076e565a#wechat_redirect
[Vue3.0 _ Composition Api _ Vue2.x _ Options Api]: http://mp.weixin.qq.com/s?__biz=MzU1OTgxNDQ1Nw%3D%3D&chksm=fc10c596cb674c80d27d1b4c4961e7376f292296a6835fade27d2c2d6767111ae62a85d7fb39&idx=1&mid=2247485376&scene=21&sn=59271ed8381ddaa99c9d83faaf284bd2#wechat_redirect
[Vue 3.0_Treeshaking]: http://mp.weixin.qq.com/s?__biz=MzU1OTgxNDQ1Nw%3D%3D&chksm=fc10c599cb674c8f04d4b9b28277d4489ec0afb86c39fb98bafe75a5fe86d66d1ada663e6e7b&idx=1&mid=2247485391&scene=21&sn=40c79896193a0b867f9b701d336bc608#wechat_redirect
[format_png 1]: /images/20221024/81c1bae10e2a4ff690ad3b743ea2d893.png