左右分离模型之封装

Ajax 和异步处理

调用 API 访问数据应用的 Ajax
格局,那是一个异步进度,异步进度最大旨的处理方式是事件或回调,其实这二种处理格局完毕原理大致,都亟待在调用异步过程的时候传出一个在异步进度为止的时候调用的接口。比如
jQuery Ajax 的 success 就是独占鳌头的回调参数。然而使用 jQuery
处理异步推荐使用 Promise 处理格局。

Promise 处理情势也是经过挂号回调函数来形成的。jQuery 的 Promise 和 ES6
的正统 Promise 有点不一样,但在 then 上可以协作,日常称为
thenable。jQuery 的 Promise 没有提供 .catch() 接口,但它本人定义的
.done()、.fail() 和 .always()
多个注册回调的措施也很有特色,用起来很便利,它是在事件的艺术来注册的(即,可以登记多少个同连串的处理函数,在该触发的时候都会接触)。

自然更直观的一些的处理形式是行使 ES2017 带来的 async/await
格局,可以用一块代码的花样来写异步代码,当然也有一对坑在中间。对于前端工程师来说,最大的坑就是有些浏览器不帮助,须要展开转译,所以只要前端代码没有打造进度,一般仍旧就用
ES5 的语法包容性好一些(jQuery 的 Promise 是永葆 ES5 的,可是正式
Promise 要 ES6 现在才方可选择)。

有关 JavaScript 异步处理相关的始末可以参考

团结包裹工具函数

在处理 Ajax 的历程中,即使有现成的库(比如 jQuery.ajax,axios
等),它说到底是为着通用指标设计的,在运用的时候依然免不了繁琐。而在项目中,对
Api
举行调用的经过大致都大概。如果规划适合,就连错误处理的方法都会是一模一样的。因而,在类型内的
Ajax
调用实际可以开展进一步的包裹,使之在品种内采取起来更便民。假如接口方式发生变化,修改起来也更便于。

譬如说,当前接口须求运用 POST 方法调用(暂不考虑 RESTful),参数必须概括
action,重回的多寡以 JSON
格局提供,如果出错,只要不是服务器很是都会重回特定的 JSON
数据,包涵一个不等于 0 的 code 和可选的 message 属性。

那么用 jQuery 写这么一个 Ajax 调用,大概是这么

const apiUrl = "http://api.some.com/";

jQuery
    .ajax(url, {
        type: "post",
        dataType: "json",
        data: {
            action: "login",
            username: "uname",
            password: "passwd"
        }
    })
    .done(function(data) {
        if (data.code) {
            alert(data.message || "登录失败!");
        } else {
            window.location.assign("home");
        }
    })
    .fail(function() {
        alert("服务器错误");
    });

起来封装

相同品种中,这样的 Ajax 调用,基本上惟有 data 部分和 .done 回调中的 else
部分分化,所以进行两回封装会大大减弱代码量,可以如此封装

function appAjax(action, params) {
    var deffered = $.Deferred();

    jQuery
        .ajax(apiUrl, {
            type: "post",
            dataType: "json",
            data: $.extend({
                action: action
            }, params)
        })
        .done(function(data) {
            // 当 code 为 0 或省略时,表示没有错误,
            // 其它值表示错误代码
            if (data.code) {
                if (data.message) {
                    // 如果服务器返回了消息,那么向用户呈现消息
                    // resolve(null),表示不需要后续进行业务处理
                    alert(data.message);
                    deffered.resolve();
                } else {
                    // 如果服务器没返回消息,那么把 data 丢给外面的业务处理
                    deferred.reject(data);
                }
            } else {
                // 正常返回数据的情况
                deffered.resolve(data);
            }
        })
        .fail(function() {
            // Ajax 调用失败,向用户呈现消息,同时不需要进行后续的业务处理
            alert("服务器错误");
            deffered.resolve();
        });

    return deferred.promise();
}

而业务层的调用就很粗略了

appAjax("login", {
    username: "uname",
    password: "passwd"
}).done(function(data) {
    if (data) {
        window.location.assign("home");
    }
}).fail(function() {
    alert("登录失败");
});

更换 API 调用接口

上边的包装对调用接口和重回数据开展了联合处理,把大多数品类接口约定的内容都处理掉了,剩下在历次调用时索要处理的就是纯粹的业务。

距今项目组决定决不 jQuery 的 Ajax,而是利用 axios 来调用 API(axios
不见得就比 jQuery 好,那里只是比喻),那么只需求修改一下 appAjax()
的落成即可。所有工作调用都不须要修改。

尽管以后的对象环境照旧是 ES5,那么须要第三方 Promise 提供,那里拟用
Bluebird,包容原生 Promise 接口(在 HTML 中引入,未直接现身在 JS
代码中)。

function appAjax(action, params) {
    var deffered = $.Deferred();

    axios
        .post(apiUrl, {
            data: $.extend({
                action: action
            }, params)
        })
        .then(function(data) { ... }, function() { ... });

    return deferred.promise();
}

这一次的包装采取了 axios 来兑现 Web Api
调用。但是为了保全原来的接口(jQuery Promise 对象有提供 .done()、.fail()
和 .always() 事件处理),appAjax 照旧只可以回到 jQuery
Promise。这样,尽管拥有地点都不再要求动用 jQuery,那里仍然得用。

类型中应有用仍旧不要 jQuery?请阅读缘何要用原生 JavaScript 代替
jQuery?

去除 jQuery

就只在那里运用 jQuery 总令人深感如芒在背,想把它去掉。有七个方法

    1.修改所有业务中的调用,去掉 .done()、.fail() 和 .always(),改成
.then()。这一步工作量较大,但主题无痛,因为 jQuery Promise 本人援救.then()。可是有少数内需尤其注意,那点稍后证实
    2.温馨写个适配器,包容 jQuery Promise
的接口,工作量也不小,但关键是要尽量测试,幸免差错。
下边提到第 1 种办法中有好几内需尤其注意,那就是 .then() 和 .done()
种类函数在处理形式上有所不一致。.then() 是按 Promise
的表征设计的,它回到的是另一个 Promise 对象;而 .done()
序列函数是按事件机制已毕的,再次来到的是原本的 Promise
对象。所以像下边那样的代码在改动时就要专注了

appAjax(url, params)
    .done(function(data) { console.log("第 1 处处理", data) })
    .done(function(data) { console.log("第 2 处处理", data) });
// 第 1 处处理 {}
// 第 2 处处理 {}

简单易行的把 .done() 改成 .then() 之后(注意不必要采纳 Bluebird,因为 jQuery
Promise 支持 .then())

appAjax(url, params)
    .then(function(data) { console.log("第 1 处处理", data); })
    .then(function(data) { console.log("第 2 处处理", data); });
// 第 1 处处理 {}
// 第 2 处处理 undefined

缘由上边已经讲了,这都督确的处理方式是统一多少个 done 的代码,大概在
.then() 处理函数中回到 data:

appAjax(url, params)
    .then(function(data) {
        console.log("第 1 处处理", data);
        return data;
    })
    .then(function(data) {
        console.log("第 2 处处理", data);
    });

应用 Promise 接口立异陈设

大家的 appAjax() 接口部分也足以陈设成 Promise
落成,那是一个更通用的接口。既使用不用 ES2015+ 个性,也足以使用像 jQuery
Promise 或 Bluebird 那样的三方库提供的 Promise。

function appAjax(action, params) {
    // axios 依赖于 Promise,ES5 中可以使用 Bluebird 提供的 Promise
    return axios
        .post(apiUrl, {
            data: $.extend({
                action: action
            }, params)
        })
        .then(function(data) {
            // 这里调整了判断顺序,会让代码看起来更简洁
            if (!data.code) { return data; }
            if (!data.message) { throw data; }
            alert(data.message);
        }, function() {
            alert("服务器错误");
        });
}

可是以往前端有营造工具,可以动用 ES2015+ 配置 Babel,也可以采用TypeScript ……
可想而知,选用过多,写起来也很便宜。那么在统筹的时候就绝不局限于 ES5
所援救的内容了。所以可以考虑用 Promise + async/await 来完结

async function appAjax(action, params) {
    // axios 依赖于 Promise,ES5 中可以使用 Bluebird 提供的 Promise
    const data = await axios
        .post(apiUrl, {
            data: $.extend({
                action: action
            }, params)
        })
        // 这里模拟一个包含错误消息的结果,以便后面统一处理错误
        // 这样就不需要用 try ... catch 了
        .catch(() => ({ code: -1, message: "服务器错误" }));

    if (!data.code) { return data; }
    if (!data.message) { throw data; }

    alert(data.message);
}

地方代码中使用 .catch() 来幸免 try … catch … 的技能在从不要
try-catch 已毕的 async/await 语法说错误处理中提到过。

本来业务层调用也得以接纳 async/await(记得写在 async 函数中):

const data = await appAjax("login", {
    username: "uname",
    password: "passwd"
}).catch(() => {
    alert("登录失败");
});

if (data) {
    window.location.assign("home");
}

对此频仍 .done() 的改建:

const data = await appAjax(url, params);
console.log("第 1 处处理", data);
console.log("第 2 处处理", data);

小结

正文以封装 Ajax
调用为例,看似在叙述异步调用。但其实想告诉大家的事物是:怎么样将一个常用的效果封装起来,完成代码重用和更不难的调用;以及在卷入的长河中要求考虑的难点——向前和向后的包容性,在做工具函数封装的时候,应该尽量幸免和某个特定的工具性格绑定,向国有规范靠拢——不知大家是否拥有体会。

相关文章