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
调用为例,看似在叙述异步调用。但事实上想告知我们的东西是:如何将一个常用的效能封装起来,实现代码重用和更简单的调用;以及在卷入的长河中需要考虑的题目——向前和向后的兼容性,在做工具函数封装的时候,应该尽量避免和某个特定的工具特性绑定,向国有规范靠拢——不知我们是否具有体会。

相关文章

网站地图xml地图