You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

407 lines
16 KiB
Markdown

2 years ago
# 23 | 弹窗:如何设计一个弹窗组件?
你好,我是大圣。
上一讲我们剖析了表单组件的实现模式,相信学完之后,你已经掌握了表单类型组件设计的细节,表单组件的主要功能就是在页面上获取用户的输入。
不过用户在交互完成之后还需要知道交互的结果状态这就需要我们提供专门用来反馈操作状态的组件。这类组件根据反馈的级别不同也分成了很多种类型比如全屏灰色遮罩、居中显示的对话框Dialog在交互按钮侧面显示、用来做简单提示的tooltip以及右上角显示信息的通知组件Notification等这类组件的交互体验你都可以在[Element3官网](https://e3.shengxinjing.cn/#)感受。
今天的代码也会用Element3的Dialog组件和Notification进行举例在动手写代码实现之前我们先从这个弹窗组件的需求开始说起。
## 组件需求分析
我们先来设计一下要做的组件通过这部分内容还可以帮你继续加深一下对单元测试Jest框架的使用熟练度。我建议你在设计一个新的组件的时候也试试采用这种方式先把组件所有的功能都罗列出来分析清楚需求再具体实现这样能够让你后面的工作事半功倍。
首先无论是对话框Dialog还是消息弹窗Notification它们都由一个弹窗的标题以及具体的弹窗的内容组成的。我们希望弹窗有一个关闭的按钮点击之后就可以关闭弹窗弹窗关闭之后还可以设置回调函数。
下面这段代码演示了dialog组件的使用方法通过title显示标题通过slot显示文本内容和交互按钮而通过v-model就能控制显示状态。
```typescript
<el-dialog
title="提示"
:visible.sync="dialogVisible"
width="30%"
v-model:visible="dialogVisible"
>
<span>这是一段信息</span>
<template #footer>
<span class="dialog-footer">
<el-button @click="dialogVisible = false">取 消</el-button>
<el-button type="primary" @click="dialogVisible = false">确 定</el-button>
</span>
</template>
</el-dialog>
```
这类组件实现起来和表单类组件区别不是特别大,我们首先需要做的就是**控制好组件的数据传递**并且使用Teleport渲染到页面顶层的body标签。
像Dialog和Notification类的组件我们只是单纯想显示一个提示或者报错信息过几秒就删除如果在每个组件内部都需要写一个<Dialog v-if>并且使用v-if绑定变量的方式控制显示就会显得很冗余。
所以这里就要用到一种调用Vue组件的新方式我们可以使用JavaScript的API动态地创建和渲染Vue的组件。具体如何实现呢我们以Notification组件为例一起看一下。
下面的代码是Element3的Notification演示代码。组件内部只有两个button我们不需要书写额外的组件标签只需要在<script setup>使Notification.successNotification
```xml
<template>
<el-button plain @click="open1"> 成功 </el-button>
<el-button plain @click="open2"> 警告 </el-button>
</template>
<script setup>
import { Notification } from 'element3'
function open1() {
Notification.success({
title: '成功',
message: '这是一条成功的提示消息',
type: 'success'
})
}
function open2() {
Notification.warning({
title: '警告',
message: '这是一条警告的提示消息',
type: 'warning'
})
}
</script>
```
## 弹窗组件实现
分析完需求之后,我们借助单元测试的方法来实现这个弹窗组件(单元测试的内容如果记不清了,你可以回顾[第20讲](https://time.geekbang.org/column/article/464098))。
我们依次来分析Notification的代码相比于写Demo逻辑的代码这次我们体验一下实际的组件和演示组件的区别。我们来到element3下面的src/components/Notification/notifucation.vue代码中下面的代码构成了组件的主体框架我们不去直接写组件的逻辑而是先从测试代码来梳理组件的功能。
```xml
<template>
<div class="el-nofication">
<slot />
</div>
</template>
<script>
</script>
<style lang="scss">
@import '../styles/mixin';
</style>
```
结合下面的代码可以看到我们进入到了内部文件Notification.spec.js中。下面的测试代码中我们期待Notification组件能够渲染el-notification样式类并且内部能够通过属性title渲染标题message属性用来渲染消息主体position用来渲染组件的位置让我们的弹窗组件可以显示在浏览器四个角。
```xml
import Notification from "./Notification.vue"
import { mount } from "@vue/test-utils"
describe("Notification", () => {
it('渲染标题title', () => {
const title = 'this is a title'
const wrapper = mount(Notification, {
props: {
title
}
})
expect(wrapper.get('.el-notification__title').text()).toContain(title)
})
it('信息message渲染', () => {
const message = 'this is a message'
const wrapper = mount(Notification, {
props: {
message
}
})
expect(wrapper.get('.el-notification__content').text()).toContain(message)
})
it('位置渲染', () => {
const position = 'bottom-right'
const wrapper = mount(Notification, {
props: {
position
}
})
expect(wrapper.find('.el-notification').classes()).toContain('right')
expect(wrapper.vm.verticalProperty).toBe('bottom')
expect(wrapper.find('.el-notification').element.style.bottom).toBe('0px')
})
it('位置偏移', () => {
const verticalOffset = 50
const wrapper = mount(Notification, {
props: {
verticalOffset
}
})
expect(wrapper.vm.verticalProperty).toBe('top')
expect(wrapper.find('.el-notification').element.style.top).toBe(
`${verticalOffset}px`
)
})
})
```
这时候毫无疑问测试窗口会报错。我们需要进入notificatin.vue中实现代码逻辑。
下面的代码中我们在代码中接收title、message和position使用notification\_\_title和notification\_\_message渲染标题和消息。
```xml
<template>
<div class="el-notification" :style="positionStyle" @click="onClickHandler">
<div class="el-notification__title">
{{ title }}
</div>
<div class="el-notification__message">
{{ message }}
</div>
<button
v-if="showClose"
class="el-notification__close-button"
@click="onCloseHandler"
></button>
</div>
</template>
<script setup>
const instance = getCurrentInstance()
const visible = ref(true)
const verticalOffsetVal = ref(props.verticalOffset)
const typeClass = computed(() => {
return props.type ? `el-icon-${props.type}` : ''
})
const horizontalClass = computed(() => {
return props.position.endsWith('right') ? 'right' : 'left'
})
const verticalProperty = computed(() => {
return props.position.startsWith('top') ? 'top' : 'bottom'
})
const positionStyle = computed(() => {
return {
[verticalProperty.value]: `${verticalOffsetVal.value}px`
}
})
</script>
<style lang="scss">
.el-notification {
position: fixed;
right: 10px;
top: 50px;
width: 330px;
padding: 14px 26px 14px 13px;
border-radius: 8px;
border: 1px solid #ebeef5;
background-color: #fff;
box-shadow: 0 2px 12px 0 rgba(0, 0, 0, 0.1);
overflow: hidden;
}
</style>
```
然后我们新增测试代码设置弹窗是否显示关闭按钮以及关闭弹窗之后的回调函数。我们希望点击关闭按钮之后就能够正确执行传入的onClose函数。
```javascript
it('set the showClose ', () => {
const showClose = true
const wrapper = mount(Notification, {
props: {
showClose
}
})
expect(wrapper.find('.el-notification__closeBtn').exists()).toBe(true)
expect(wrapper.find('.el-icon-close').exists()).toBe(true)
})
it('点击关闭按钮', async () => {
const showClose = true
const wrapper = mount(Notification, {
props: {
showClose
}
})
const closeBtn = wrapper.get('.el-notification__closeBtn')
await closeBtn.trigger('click')
expect(wrapper.get('.el-notification').isVisible()).toBe(false)
})
it('持续时间之后自动管理', async () => {
jest.useFakeTimers()
const wrapper = mount(Notification, {
props: {
duration: 1000
}
})
jest.runTimersToTime(1000)
await flushPromises()
expect(wrapper.get('.el-notification').isVisible()).toBe(false)
})
```
到这里Notification组件测试的主体逻辑就实现完毕了我们拥有了一个能够显示在右上角的组件具体效果你可以参考后面这张截图。
![图片](https://static001.geekbang.org/resource/image/aa/04/aa1506d30d0b4d641aa7175c2a4a5004.jpg?wh=1920x972)
进行到这里,距离完成整体设计我们还差两个步骤。
首先弹窗类的组件都需要直接渲染在body标签下面弹窗类组件由于布局都是绝对定位如果在组件内部渲染组件的css属性比如Transform会影响弹窗组件的渲染样式为了避免这种问题重复出现弹窗组件Dialog、Notification都需要渲染在body内部。
Dialog组件可以直接使用Vue3自带的Teleport很方便地渲染到body之上。在下面的代码中, 我们用teleport组件把dialog组件包裹之后通过to属性把dialog渲染到body标签内部。
```javascript
<teleport
:disabled="!appendToBody"
to="body"
>
<div class="el-dialog">
<div class="el-dialog__content">
<slot />
</div>
</div>
</teleport>
```
这时我们使用浏览器调试窗口就可以看到Dialog标签已经从当前组件移动到了body标签内部如下图所示。
![图片](https://static001.geekbang.org/resource/image/d9/61/d9199199590871f811309f4c78963761.jpg?wh=1920x902)
但是Notification组件并不会在当前组件以组件的形式直接调用我们需要像Element3一样能够使用js函数动态创建Notification组件**给Vue的组件提供Javascript的动态渲染方法这是弹窗类组件的特殊需求**。
## 组件渲染优化
我们先把测试代码写好,具体如下。代码中分别测试函数创建组件,以及不同配置和样式的通知组件。
```xml
it('函数会创建组件', () => {
const instanceProxy = Notification('foo')
expect(instanceProxy.close).toBeTruthy()
})
it('默认配置 ', () => {
const instanceProxy = Notification('foo')
expect(instanceProxy.$props.position).toBe('top-right')
expect(instanceProxy.$props.message).toBe('foo')
expect(instanceProxy.$props.duration).toBe(4500)
expect(instanceProxy.$props.verticalOffset).toBe(16)
})
test('字符串信息', () => {
const instanceProxy = Notification.info('foo')
expect(instanceProxy.$props.type).toBe('info')
expect(instanceProxy.$props.message).toBe('foo')
})
test('成功信息', () => {
const instanceProxy = Notification.success('foo')
expect(instanceProxy.$props.type).toBe('success')
expect(instanceProxy.$props.message).toBe('foo')
})
```
现在测试写完后还是会报错因为现在Notification函数还没有定义我们要能通过Notification函数动态地创建Vue的组件而不是在template中使用组件。
在[JSX那一讲](https://time.geekbang.org/column/article/444283)中我们讲过template的本质就是使用h函数创建虚拟Dom如果我们自己想动态创建组件时使用相同的方式即可。
在下面的代码中我们使用Notification函数去执行createComponent函数使用h函数动态创建组件实现了动态组件的创建。
```javascript
function createComponent(Component, props, children) {
const vnode = h(Component, { ...props, ref: MOUNT_COMPONENT_REF }, children)
const container = document.createElement('div')
vnode[COMPONENT_CONTAINER_SYMBOL] = container
render(vnode, container)
return vnode.component
}
export function Notification(options) {
return createNotification(mergeProps(options))
}
function createNotification(options) {
const instance = createNotificationByOpts(options)
setZIndex(instance)
addToBody(instance)
return instance.proxy
}
```
创建组件后由于Notification组件同时可能会出现多个弹窗所以我们需要使用数组来管理通知组件的每一个实例每一个弹窗的实例都存储在数组中进行管理。
下面的代码里我演示了怎样用数组管理弹窗的实例。Notification函数最终会暴露给用户使用在Notification函数内部我们通过createComponent函数创建渲染的容器然后通过createNotification创建弹窗组件的实例并且维护在instanceList中。
```javascript
const instanceList = []
function createNotification(options) {
...
addInstance(instance)
return instance.proxy
}
function addInstance(instance) {
instanceList.push(instance)
}
;['success', 'warning', 'info', 'error'].forEach((type) => {
Notification[type] = (options) => {
if (typeof options === 'string' || isVNode(options)) {
options = {
message: options
}
}
options.type = type
return Notification(options)
}
})
// 有了instanceList 可以很方便的关闭所有信息弹窗
Notification.closeAll = () => {
instanceList.forEach((instance) => {
instance.proxy.close()
removeInstance(instance)
})
}
```
最后我带你简单回顾下我们都做了什么。在正式动手实现弹窗组件前我们分析了弹窗类组件的风格。弹窗类组件主要负责用户交互的反馈。根据显示的级别不同它可以划分成不同的种类既有覆盖全屏的弹窗Dialog也有负责提示消息的Notification。
这些组件除了负责渲染传递的数据和方法之外,还需要能够脱离当前组件进行渲染,**防止当前组件的css样式影响布局**。因此Notification组件需要渲染到body标签内部而Vue提供了Teleport组件来完成这个任务我们通过Teleport组件就能把内部的组件渲染到指定的dom标签。
之后我们需要给组件提供JavaScript调用的方法。我们可以使用Notification()的方式动态创建组件利用createNotification即可动态创建Vue组件的实例。
对于弹窗组件来说可以这样操作首先通过createNotification函数创建弹窗的实例并且给每个弹窗设置好唯一的id属性然后存储在数组中进行管理。接着我们通过对createNotification函数返回值的管理即可实现弹窗动态的渲染、更新和删除功能。
## 总结
正文里已经详细讲解和演示了弹窗组件的设计所以今天的总结我想变个花样再给你说说TDD的事儿。
很多同学会觉得写测试代码要花一定成本有畏难心理觉得自己不太会写测试这些“假想”给我们造成了“TDD很难实施”的错觉。实际上入门TDD并没有这么难。按照我的实践经验来看先学会怎么写测试再学习怎么重构基本上就可以入门写TDD了。
就拿我们这讲的实践来说,我们再次应用了**测试驱动开发**这个方式来实现弹窗组件,把整体需求拆分成一个个子任务,逐个击破。根据设计的需求写好测试代码之后,测试代码就会检查我们的业务逻辑有没有实现,指导我们做相应的修改。
咱们的实践过程抽象出来,一共包括四个步骤:写测试 -> 运行测试(报错) -> 写代码让测试通过 -> 重构的方式。这样的开发模式,今后你在设计组件库时也可以借鉴,不但有助于提高代码的质量和可维护性,还能让代码有比较高的代码测试覆盖率。
## 思考题
最后留一个思考题现在我们设计的Notification组件的message只能支持文本消息如果想支持传入其他组件应该如何实现
欢迎你在评论去分享你的答案,也欢迎你把这一讲的内容分享给你的同事和朋友们,我们下一讲再见。