vue 中利用 $once 取消 setTimeout 和 setInterval

·  阅读 358
vue 中利用 $once 取消 setTimeout 和 setInterval

这是我参与8月更文挑战的第28天,活动详情查看:8月更文挑战

问题

在开发软件的过程中,经常产生这样的需求:

  • 用户启动了一个进程,比如流量数据的监控,这时候需要实时的查看当前时间的流量分析

  • 或者在一些注册登陆页面,获取手机验证码需要倒计时

  • 或者其他的计时操作,比如抢购等

以上案例没什么共同点,但实现起来都是需要使用间隔调用或者延时调用, 这两个 API 通常用来做 ajax 短连接数据轮询或者 javascript 动画。其中setInterval 是间隔调用,setTimeout是延时调用。

setInterval(functionName, 1000)

// or

function a(){
    ...
    setTimeout(a, 1000)
}
a()
复制代码

由于它们一旦开始运行,就会持续不断的调用,直到页面被关闭。但是有时候我们需要在路由跳转的时候就停止调用,否则容易产生问题。

手动调用clearIntervalclearTimeout可以满足需求

在以前的原生 js 中,我们通常这样写:

window.onload = function(){
	var timer = setInterval(function(){
		getData()
	})
        
        window.onunload = function(){
            clearInterval(timer)
        }
}

function getData(){}


复制代码

那如果用在 vue 中呢?

比如有一个 logs.vue 是用来展示某个正在执行的进程产生的日志:

<template>
	<div>
		<p v-for="item in logList" :key="item.time">
			<span>{{"[" + item.time + "]"}}</span>
			<span>{{ item.log }}</span>
		</p>
	</div>
</template>
<script>
	import { Component, Vue, Watch, Prop, Emit } from 'vue-property-decorator'
	import { getLogList } from './api'
	@Component({})
	export default class extends Vue {
		logList = []
		timer = null
		mounted(){
			this.getData()
		}
		async getData(){
			let r = await getLogList()
			if(r && r.logList){
				this.logList = r.logList
			}
			this.timer = setTimeout(()=>{
				console.log(this.timer);
				this.getData()
			}, 1000)
		}
		beforeDestory(){
			clearTimeout(this.timer)
			this.timer = null;
		}
	}
</script>
复制代码

这段代码看上去没啥问题,但是测试的时候就会发现,有时候路由已经跳转了,获取进程日志的接口依然在不断调用,甚至,有时候接口调用速度非常快,一秒可能有好几个请求。

分析

beforeDestory 是组件销毁前的生命周期的钩子,这个钩子函数一定会调用,但是能不能彻底销毁 setTimeout 呢?答案是不能。

打开控制台就能看到不断打印出来的 id 在这里插入图片描述

这是因为,clearTimeout 是对某次特定的 setTimeout 的引用的清除,每次调用 clearTimeout 清除掉的是上一次的 id, 而不是正要执行的 setTimeout 的返回值,这种情况,对于使用 setInterval 也是一样的。

image.png

解决

那么针对这种边界情况,vue 提供了 程序化的事件侦听器 来处理。

按照文档的说法,我们的代码可以这样来更改

<script>
	import { Component, Vue, Watch, Prop, Emit } from 'vue-property-decorator'
	import { getLogList } from './api'
	@Component({})
	export default class extends Vue {
		logList = []
		// timer = null
		mounted(){
			this.getData()
		}
		async getData(){
			let r = await getLogList()
			if(r && r.logList){
				this.logList = r.logList
			}
			const timer = setTimeout(()=>{
				this.getData()
			}, 1000)
			this.$once('hook:beforeDestroy', function () {
			    clearTimeout(timer)
			})
		}
	}
</script>
复制代码

这样写,还解决了两个潜在问题

  1. 在组件实例中保存这个 timer,最好只有生命周期钩子有访问它的权限。但是实例中的 timer 会视为杂物
  2. 如果建立代码独立于清理代码,会使得我们比较难于程序化地清理所建立的东西

在 ts 中使用

如果你是在项目中引入了 ts,那么可能会导致在组件销毁的时候,定时器不能成功清除,这时候,你需要使用

const timer = window.setTimeout(()=>{
	this.getData()
}, 1000)
this.$once('hook:beforeDestroy', function () {
    window.clearTimeout(timer)
})
复制代码

如果你漏掉了其中一个 window,那么很可能会遇上类似的 ts 报错:Type 'Timer' is not assignable to type 'number',这是因为 node typings

It seems like you are using node typings which override setInterval() as something that returns NodeJS.Timer. If you're running in the browser, it doesn't make a whole lot of sense to use these,

结论

我们可以通过 程序化的事件侦听器 来监听销毁我们创建的任何代码示例 除了 setTimeout 和 setInterval ,通常还有一些第三方库的对象示例,如 timePicker,datePicker,echarts图表等。

mounted: function () {
	// Pikaday 是一个第三方日期选择器的库
  	var picker = new Pikaday({
    	field: this.$refs.input,
    	format: 'YYYY-MM-DD'
  	})
	// 在组件被销毁之前,也销毁这个日期选择器。
  	this.$once('hook:beforeDestroy', function () {
    	picker.destroy()
  	})
}
复制代码
分类:
前端
标签:
分类:
前端
标签: