抽象封装——JavaScript高阶函数运用的实例

这是一个对第三方js-sdk进行封装的小例子,希望整个思路过程对JS初学者有所启发。

1. 背景

某系统开发中引用第三方基于websocket的服务,需要对js-sdk进行封装,其最简单的demo如下:

// 触发event
window.doLogin()

// event的回调实现
window.cbLogin = res => {
    if (res.code === 0) {
        //doSomethingSuccess
    }
    else {
        //doSomethingFail
    }
}

先实现某个event的回调函数,然后触发某个event,第三方库会基于websocket发出请求,当有结果返回,会执行event的回调函数。

2. 最初实现

在业务代码 biz.js 中引入封装库 clink.js,然后注册回调函数,并且将业务的上下文传递回去:

//biz.js 业务代码
import clink from './clink'

class Action {
    constructor () {
        super()

        // 注册回调函数
        clink.cbLogin(this)
        clink.cbLogout(this)
    }

    doLogin () {
        window.doLogin()
    }

    // 在window.onload时候执行
    componentDidMount() {
        // 触发login事件
        this.doLogin()
    }
}
//clink.js 对sdk的封装

const clink = {}

clink.cbLogin = ctx => {
    window.cbLogin = res => {
        if (res.code === 0) {
            //doSomethingSuccess
        }
        else {
             //doSomethingFail
        }
    }
}

// 还存在其他event,代码结构类似,此处省略
clink.cbLogout = ...
clink.cbEvent1 = ...
clink.cbEvent2 = ...

biz.js是为了说明怎样来触发event的,我们主要来看clink.js:

// 实现了一个个event的回调
clink.cbLogin = ...
clink.cbLogout = ...
clink.cbEvent1 = ...
clink.cbEvent2 = ...

3. 需求改进

当由于网络不稳定等因素,使得回调函数得到的返回结果是失败,则需要重试,默认重试次数是3次。简单地说需要一个重试机制。

下面我们来实现这个重试,仅做到满足需求:

//clink.js

clink.cbLogin = ctx => {
    const MaxRetryCount = 3
    let retryCount = 0

    window.cbLogin = res => {
        if (res.code === 0) {
            //doSomethingSuccess
        }
        else {
             if (retryCount < MaxRetryCount) {
                 // retry
                 ctx.doLogin()
             }
             else {
                 //doSomethingFail
             }
        }
    }
}

我们应该已经发现,每个回调函数中 MaxRetryCount retryCount if...else...这些是重复的部分,既然是重复的部分,那我们应该做抽象和封装。
而显然,这里的 变量doSomethingSuccessdoSomethingFail,因为JavaScript中的函数是一等公民(First Class Object),可以把Function当成参数传递,所以我们把这两个doSomething当成参数进行封装

4. 开始封装

4.1. 修改 if...else...语句

首先,两层 if...else... 语句不够优雅,做如下修改:

const success = parseInt(res.code, 10) === 0;

// 未成功且没达到重试上限,执行重试
if (!success && (retryCount < maxRetryCount)) {
    // retry
}
// 未成功且达到重试上限,执行失败回调
else if (!success && (retryCount >= maxRetryCount)) {
      // doSomethingFail  
}
// 成功,执行成功回调
else {
    // doSomethingSuccess
}
4.2. 定义高阶函数的参数

如上所述,将 doSomethingSuccessdoSomethingFail 作为两个参数。另外还需要一个参数对象来做一下设置,如重试次数等,具体如下:

/**
 * 高阶辅助函数
 * @param  {Object} args - 参数对象
 * @param  {Object} args.ctx - Action上下文
 * @param  {string} args.name - callback名称
 * @param  {number} args.retry - 重试次数
 * @param  {Function} args.doEvent - 触发event
 * @param  {Function} successCallback - 成功回调函数
 * @param  {Function} failCallback    - 失败回调函数
 *
 */
const cHelper = (args, successCallback, failCallback) => {
}
3.3. 实现高阶函数

实现cHelper,并且用cbLogincbLogout 等来说明:

// clink.js

/**
 * 高阶辅助函数
 */
const cHelper = (args, successCallback, failCallback) => {
    let retryCount = 0
    const maxRetryCount = args.retry || 3

    return root[args.name] = res => {
        const context = args.ctx
        const success = parseInt(res.code, 10) === 0

        if (!success && (retryCount < maxRetryCount)) {
            args.doEvent && (args.doEvent instanceof Function) && args.doEvent()
            retryCount++
        }
        else if (!success && (retryCount >= maxRetryCount)) {
            failCallback(res)
        }
        else {
            successCallback(res)
        }
    }
}

/**
 * 登录回调函数 
 */
clink.cbLogin = function (ctx) {
    let me = this
    let params = {
        ctx: ctx,
        name: 'cbLogin',
        doEvent() {
            me.doLogin()
        }
    }

    cHelper(params, res => {
        // doSomethingSuccess
    }, res => {
        // doSomethingFail
    })
}

/**
 * Event1回调函数(重试5次)
 */
clink.cbEvent1 = function (ctx) {
    let me = this
    let params = {
        ctx: ctx,
        retry: 5,
        name: 'cbEvent1',
        doEvent() {
            me.doEvent1()
        }
    }

    cHelper(params, res => {
        // doSomethingSuccess
    }, res => {
        // doSomethingFail
    })
}

/**
 * Event2回调函数(不重试)
 */
clink.cbEvent2 = function (ctx) {
    let params = {ctx: ctx, name: 'cbEvent2'}

    cHelper(params, res => {
        // doSomethingSuccess
    }, res => {
        // doSomethingFail
    })
}

5. 进一步抽象

我们希望 clink.js 中回调的实现更加抽象,将其中业务逻辑 doSomthingForBiz(比如一些页面元素的操作)抽离出来到biz.js中,而clink.js只包含一些公共逻辑 doSomthingForCommon。所以我们在 biz.js 中写业务代码时,也实现回调函数,因此在clink.js中要做如下修改来实现方法的继承:

//biz.js
import clink from './clink'

class Action {
    constructor () {
        super()

        clink.cbEvent1(this)
        clink.cbEvent2(this)
    }
    
    // 实现Event1回调函数
    cbEvent1 (res) {
        // doSomethingForBiz
    }
    
    // 实现Event2回调函数
    cbEvent2 (res) {
        // doSomethingForBiz
        if (res.code === 0) {
            // doSomethingSuccessForBiz
        }
        else {
            / /doSomethingFailForBiz
        }
    }
}
// clink.js

const cHelper = (args, successCallback, failCallback) => {
    let retryCount = 0
    const maxRetryCount = args.retry || 3

    return root[args.name] = res => {
        const context = args.ctx
        const success = parseInt(res.code, 10) === 0
        // biz中是否有定义callback
        const isOverride = context && (context[args.name] instanceof Function)

        if (!success && (retryCount < maxRetryCount)) {
            args.doEvent && (args.doEvent instanceof Function) && args.doEvent()
            retryCount++
        }
        else if (!success && (retryCount >= maxRetryCount)) {
            failCallback(res)
            // 执行biz中的callback
            isOverride && context[args.name].call(context, res);
        }
        else {
            successCallback(res)
            // 执行biz中的callback
            isOverride && context[args.name].call(context, res)
        }
    }
}

/**
 * Event1回调函数(有公共逻辑)
 */
clink.cbEvent1 = function (ctx) {
    let me = this
    let params = {ctx: ctx, name: 'cbEvent1'}

    cHelper(params, res => {
        // doSomethingSuccessForPauseCommon
    }, res => {
        // doSomethingFailForPauseCommon
    })
}

/**
 * Event2回调函数(无公共逻辑)
 */
clink.cbEvent2 = function (ctx) {
    let me = this
    let params = {ctx: ctx, name: 'cbEvent2'}

    cHelper(params, res => true, res => true)
}

这样一来,执行完 doSomethingForCommon 后会执行 doSomethingForBiz

6. 总结

至此,已经完成了全部的重构封装。clink.js是对sdk的封装,服务于业务biz1, biz2, ...,其中cHelper函数是 clink.js中其他callback的高阶封装。

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

推荐阅读更多精彩内容