左右分离模型之封装 Api 调用

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
调用为例,看似在讲述异步调用。但实在想告诉我们的事物是:怎样将一个常用的效应封装起来,实现代码重用和更简洁的调用;以及在包装的经过中需要考虑的问题——向前和向后的兼容性,在做工具函数封装的时候,应该尽量避免和某个特定的工具特性绑定,向公共规范靠拢——不知我们是否拥有体会。

相关文章