【重构】微信小程序倒计时组件
回想在4個月前剛剛進入公司實習時,我封裝了一個應用于小程序的倒計時組件。
鏈接在這里:微信小程序之倒計時組件
以現在的視角再去看之前的實現可以說是一坨看不下去的爛代碼。所以也借此機會,將之前的組件重構一番。
重構舊代碼
在原來的組件中有一個initDuration屬性和3個方法,3個方法分別是countDown,format和runCountDown。
initDuration屬性
首先我們需要三個page屬性來幫助完成接下來的代碼,它們的名字和內容如下:
timer: null, // 存儲setInterval的ID flag: false, // 倒計時是否結束的標志 num: 0 // 過去的秒數 復制代碼在initDuration屬性的新的回調方法中,我們封裝了clearTimer方法,init初始化方法,并且執行倒計時。
initDuration: {type: Number,value: 0,observer: function (newVal) {if (this.timer) {this.clearTimer()}this.init() // 重置num和flagthis.runCountDown(newVal)} }, 復制代碼一定要注意,當傳入的屬性的值為默認值,例如這里是0時,是不會觸發observer回調的。
/*** 初始化函數*/ init: function () {this.flag = falsethis.num = 0 }/*** 清空計時器*/ clearTimer: function () {clearInterval(this.timer)this.timer = null } 復制代碼countDown方法
countDown方法是接受一個參數為倒計時的秒數,返回一個倒計時的字符串。在這個方法中沒有太大改動,只是改動了一些代碼格式。如下:
/*** 計算倒計時* @param {Number} duration - 秒數時間差* @returns {string} 倒計時的字符串*/ countDown: function (duration) {if (duration <= 0) {this.setFlag(true) // 將flag屬性設為truereturn '00:00:00' // 返回默認時間設置}let seconds = this._format(duration % 60)let minutes = Math.floor(duration / 60)minutes = minutes >= 60 ? this._format(minutes % 60) : this._format(minutes)let hours = this._format(Math.floor(duration / 3600))return `${hours}:${minutes}:${seconds}` }, 復制代碼format方法
format方法的作用很簡單,就是處理小于10的數字展示問題。
/*** 格式化小于10的數字* @param {Number} time - 小于10的數字* @returns {string} 格式化后的字符串*/ format: function (time) {return time >= 10 ? time : `0${time}` }, 復制代碼runCountDown方法
runCountDown方法中的改動比較大,在原來的代碼中邏輯比較混亂,穿插了許多無關的代碼,其實應該將它們封裝起來達到解耦的目的。
runCountDown: function (initDuration) {// 第一次給倒計時賦值 this.setData({ countDownStr })this.setCountDownTime(this.countDown(initDuration))// 每一秒更新一次倒計時this.timer = setInterval(() => {if (this.flag == true) { // 倒計時結束clearInterval(this.timer)return undefined}this.addNum() // this.num += 1this.setCountDownTime(this._countDown(initDuration - this.num))}, 1000) }, 復制代碼增加新功能
我們原來的倒計時組件是缺乏一些功能的,例如傳入的時間只能是秒數,倒計時結束后只顯示00:00:00,如果傳入的值是0的話會不進行初始化(這算是Bug了)。所以我們需要加入以下的新功能:
- 支持自定義倒計時結束后現實的字符串。
- 修復傳入值為0的Bug。
- 傳入的時間可以是秒數,也可以是UTC時間的字符串。
自定義結束字符串
在倒計時組件中,展示倒計時字符串的是this.data.countDownTime屬性。所以在結束時將countDownTime屬性的值設為傳入的字符串即可。 首先,封裝一個賦值方法
setEndContent: function (countDownTime) {if (countDownTime) {this.setData({ countDownTime })} } 復制代碼接下來為組件新增加一個屬性為endContent。
endContent: {type: String,value: '00:00:00' } 復制代碼接下來,在倒計時結束的位置,調用我們的賦值方法,也就是runCountDown方法的計時器回調函數中。
this.timer = setInterval(() => {if (this.flag == true) {clearInterval(this.timer)this.setEndContent(this.properties.endContent) // 設置結束字符串return undefined}this.addNum()this.setCountDownTime(this._countDown(initDuration - this.num)) }, 1000) 復制代碼這樣自定義字符串就成功了,在使用組件時傳入默認值即可。
修復傳入值為0的Bug
這個問題的出現是因為當傳入屬性為默認值時,不會調用observer回調函數,所以這時我們需要使用組件的attached生命周期函數。
attached: function () {if (this.properties.initDuration <= 0) {// 如果傳入值為零時不會調用observer回調,則直接從這里展示倒計時結束this.setEndContent(this.properties.endContent)} } 復制代碼可以傳入UTC時間字符串
為了簡潔起見,我們就不為組件增加新的屬性了,依然使用initDuration屬性,所以要將其type從Number改為null(小程序的這點不夠強,不能選擇多類型。)。在修改type后我們需要封裝一個將UTC時間字符串解析成倒計時秒數的方法。
parseDate: function (date) {if (typeof date == 'string') {// 將傳進來的時間減去現在的時間,得到的結果便和直接傳進數字值相同return Math.floor((+new Date(date) / 1000)) - Math.floor((+new Date / 1000))}return date } 復制代碼在observer回調中調用時如下:
initDuration: {type: null,observer: function (newVal) {if (this.timer) {this._clearTimer()}this._init()this._runCountDown(this.parseDate(newVal)) // 在這里調用parseData方法} } 復制代碼總結
在這次重構過程中,我看到了之前代碼耦合太嚴重,僅僅滿足了湊合用的情況。如果想要再此基礎上增加功能的成本很高,所以將內部邏輯拆分。既方便閱讀和理解,也方便日后拓展功能。所以重構后我們便增加了兩個新功能,希望這邊文章可以幫助大家。
倒計時組件代碼:github.com/MeloGuo/wxm…
可將'count-down'文件夾直接copy到項目目錄下使用。
歡迎喜歡、關注、star、fork,當然也歡迎pr、issue.
轉載于:https://juejin.im/post/5b670ccfe51d4516e91fcf32
超強干貨來襲 云風專訪:近40年碼齡,通宵達旦的技術人生總結
以上是生活随笔為你收集整理的【重构】微信小程序倒计时组件的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: python爬虫知识点总结(十九)Scr
- 下一篇: PHP mail()可能导致的问题