AJAX里的状态锁与封装

本博客著作权归饥人谷_Lyndon和饥人谷所有,转载请注明出处

学习AJAX的时候,对状态锁、代码封装两个部分很感兴趣。状态锁保证了在一些特殊情况下发出正确请求,获得正确的返回数据;代码封装使得代码可读性提升,代码结构化且适合维护。两者都非常有用,因此我写一个博客来梳理一下。


>>> 为什么需要状态锁?

当数据请求速度/网速很慢的时候,如果用户多次点击请求按钮,那么很有可能发出多次重复的请求,在get方式下,如果不对用户的多次重复点击做出处理,那么每次构造的URL很有可能是一致的,最终就会返回很多重复的数据,违背了开发者的初衷。

状态锁是一种优雅的方法,概括而言:状态锁事先声明一个变量,其中true表示开启(锁住用户操作,用户操作无效),false表示关闭(用户可以进行操作,操作将被处理),其核心的步骤如下:

1. 初始状态下,状态锁是关闭的,用户可以进行操作

var lock = false;

2. 创建AJAX对象时进行逻辑判断,如果状态锁为开启(true)状态,那么将忽视用户的频繁点击,否则将发送请求

if(lock){
    return;
}

3. 请求一经发出,需要经历处理过程,在这时,状态锁启动,直到响应就绪才关闭,否则,状态锁开启,无法进行请求

lock = true;
xhr.onreadystatechange = function(){
    if(xhr.readyState === 4){
        ...
        lock = false;
    }
}else{
    lock = true;
}

>>> 不设置状态锁会怎样

以下是不设置状态锁时前端页面和服务器的代码,只需要观察Network的请求就可以获知问题:

<div id="ct">
    <ul id="news"></ul>
    <button id="btn">点我加载</button>
</div>
<script>
    function $(id){
        return document.querySelector(id);
    }
    var btn = $("#btn");
    var ul = $("#news");
    var pageIndex = 0;
    btn.addEventListener("click", function(){
        var xhr = new XMLHttpRequest();
        xhr.open("get", "/loadMore?index=" + pageIndex + "&length=5", true);
        xhr.send();
        xhr.onreadystatechange = function(){
            if(xhr.readyState === 4){
                if(xhr.status === 200 || xhr.status === 304){
                    var results = JSON.parse(xhr.responseText);
                    console.log(results);
                    var fragment = document.createDocumentFragment();
                    for(var i = 0; i < results.length; i++){
                        var node = document.createElement("li");
                        node.innerText = results[i];
                        fragment.appendChild(node);
                    }
                    ul.appendChild(fragment);
                    pageIndex = pageIndex + 5;
                }else{
                    console.log("error");
                }
            }
        };
    })
</script>
app.get('/loadMore', function(req, res) {
    var pageIndex = parseInt(req.query.index);
    var length = parseInt(req.query.length);
    data = [];
    for(var i = 0; i < length; i++){
        var news = "新闻" + (i + pageIndex).toString();
        data.push(news);
    }
    setTimeout(function(){
        res.send(data)}, 5000
    )
});

服务端故意让每次的响应时间延迟5s,也就是点击后不会立即有数据渲染在页面上,数据拖延了5s才向前端进行发送。如果用户很急迫地一连点击5次按钮,返回结果是:

1.png

其原因是:每次的readyState都没有到4(请求已完成,响应已经就绪)时,用户就已经迫不及待地发出了下一个请求,这时候的pageIndex并没有执行加5的操作,导致每次的请求都是http://localhost:8080/loadMore?index=0&length=5,而当数据全部展现到页面上后,再进行一次点击,此时的pageIndex已经变成25了,新的请求就会变成http://localhost:8080/loadMore?index=25&length=5,输出结果会非常的混乱。


>>> 添加状态锁

按照之前的说法,加入一个状态锁可以保证的效果是:当响应还没有完成的时候,无论用户怎么点击按钮,我都让这一行为return为空,也即不返回任何结果/不产生任何效力。

以下是添加注释的JS代码。

// 状态锁初始状态为关闭(false)状态,用户可以发出请求
var lock = false;
function $(id){
    return document.querySelector(id);
}
var btn = $("#btn");
var ul = $("#news");
var pageIndex = 0;
btn.addEventListener("click", function(){
    var xhr = new XMLHttpRequest();
    // 如果状态锁状态为开启(true),则忽略用户点击操作,不发送AJAX请求
    if(lock){
        return;
    }
    // 如果状态锁状态为关闭,则发送AJAX请求
    if(!lock) {
        xhr.open("get", "/loadMore?index=" + pageIndex + "&length=5", true);
        xhr.send();
        // 执行过程中,状态锁为开启状态,用户无论怎样点击都是无效的
        lock = true;
        xhr.onreadystatechange = function () {
            if (xhr.readyState === 4) {
                if (xhr.status === 200 || xhr.status === 304) {
                    var results = JSON.parse(xhr.responseText);
                    console.log(results);
                    var fragment = document.createDocumentFragment();
                    for (var i = 0; i < results.length; i++) {
                        var node = document.createElement("li");
                        node.innerText = results[i];
                        fragment.appendChild(node);
                    }
                    // 如果响应就绪,状态锁为关闭状态,用户可以进行下一次的请求
                    lock = false;
                    ul.appendChild(fragment);
                    pageIndex = pageIndex + 5;
                } else {
                    console.log("error");
                    // 否则,响应出错,状态锁保持开启状态
                    lock = true;
                }
            }
        };
    }
})

添加状态锁后,返回的结果会变为正常。

2.png

>>> AJAX封装

AJAX封装的第一个出发点:一个页面上通常有多处需要使用AJAX,如果不进行封装,每次需要使用AJAX时,都需要写相似度极高的代码,造成信息冗余,而AJAX封装抽取出普遍的通则,这样在多次使用AJAX时仅需要直接调用封装完成的代码即可,便利了前端开发。

AJAX封装的第二个出发点:将复杂的问题进行拆解,由大化小,且力求使得每一个降解的子代码段变得逻辑更加简洁。如果不进行合理的封装,代码中的一个函数内既有if...else...,又有循环,还有其他的变量计算,看起来非常缺乏条理。

针对这一弊端,将原有的代码按照功能划分成多个子部分,比如专门负责创建AJAX的、专门处理数据请求的、数据到来之后渲染页面的,这样在AJAX最核心的部分中只需要调用定义的函数,整个代码段的结构会非常明晰,也方便后期维护。

1. 基础的变量声明放在script的最前面

var btn = document.querySelector("#load-more");
var ct = document.querySelector("#ct");
var pageIndex = 0;
var isDataArrive = true;

2. 创建事件侦听器的时候,尽量在核心部分使用函数,函数的布局跟着逻辑行进,比如:1)数据尚未来临如何应对 2)数据来临如何应对 3)加载数据 4)渲染页面

btn.addEventListener("click", function(e) {
    e.preventDefault();
    // 数据尚未来临,操作无效
    if (!isDataArrive) {
        return;
    }
    // 否则执行数据加载,加载的数据为news,因为news需要经过处理才能展现在页面上,因此构建一个匿名函数用以渲染页面
    loadData(function (news) {
        renderPage(news);
        pageIndex = pageIndex + 5;
        isDataArrive = true;
    })
    isDataArrive = false;
});

3. 在实际应用场景中,一个页面中会有很多需要利用AJAX的地方,所以经常是传递一个AJAX对象,然后直接将其中的value放到相应的函数中。其中每一个AJAX对象应该包含这些要素:1)请求方式 2)请求接口地址 3)传递的参数 4)请求成功后执行什么 5)请求失败后执行什么

function loadData(callback){
    // 请求方式、URL、参数、请求成功后怎样、请求失败后怎样
    // ajax("get", url, data, onSuccess, onError)
    ajax({
        type: "get",
        url: "/loadMore",
        data: {
            index: pageIndex,
            length: 5
        },
        // 请求成功后执行,这里的callback相当于上一段代码后中的匿名函数
        onSuccess: callback,
        onError: function(){
            console.log("error")
        }
    })
}

4. 既然已经定义好了AJAX对象,就要开始将其中的value放入对应的函数中

function ajax(options){
    var xhr = new XMLHttpRequest();
    xhr.onreadystatechange = function(){
        if(xhr.readyState === 4){
            if(xhr.status === 200 || xhr.status === 304){
                var results = JSON.parse(xhr.responseText)
                // 往`callback`中传递参数
                options.onSuccess(results);
            }else{
                options.onError();
            }
        }
    }
    var query = "?";
    for(key in options.data){
        query += key + "=" + options.data[key] + "&"
    }
    query = query.substr(0, query.length - 1);
    xhr.open(options.type, options.url + query, true);
    xhr.send();
}

5. 接下来是渲染页面的部分

function renderPage(news){
    var fragment = document.createDocumentFragment();
    for(var i = 0; i < news.length; i++){
        var node = document.createElement("li");
        node.innerText = news[i];
        fragment.appendChild(node);
    }
    ct.appendChild(fragment);
}

>>> 总结

AJAX封装最明显的特征就是:大问题拆解为小问题,但是小问题之间又环环相扣。需要熟悉的是AJAX对象,以及如何将对象中的值与回调函数结合起来。当然在面临更加灵活的AJAX对象时(比如需要综合考虑到getpost两种请求方式,数据返回格式可能不是JSON字符串),需要对代码做出更优化封装,以应对更多样的情况并考虑到容错。

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

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 170,561评论 25 707
  • AJAX 原生js操作ajax 1.创建XMLHttpRequest对象 var xhr = new XMLHtt...
    碧玉含香阅读 3,050评论 0 7
  • 发现 关注 消息 iOS 第三方库、插件、知名博客总结 作者大灰狼的小绵羊哥哥关注 2017.06.26 09:4...
    肇东周阅读 11,609评论 4 59
  • 谁为谁一瞬执念成魔 误了终生 谁为谁一瞬眷恋成痴 误了轮回 疑爱刻恨的异朽 似正非邪的东方 荡尽心血的恨意决然 倾...
    流落阅读 236评论 0 2
  • 付剑飞阅读 312评论 0 0