AJAX封装函数

用ajax的局部刷新来给网站提升用户体验我们已经用过很多了,ajax已然成为了前端开发最重要的“工具”之一。

但是,我想应该会有不少人在使用ajax的时候都在依赖于jQuery或者prototype或者其他js库。但现实是,假设某一天一个项目不能引入任何一个js库,只能用原生js写代码,那你怎么办?又或者是一个非常简单的页面,但是要用到ajax,难道就为了下这么一个ajax请求要引用一个jq这么大的js库?我想这是不值得的,所以我们应该学会用原生的js来写ajax,并且把它封装好以便于以后使用。

由于之前使用过jq的ajax而且觉得他使用起来挺舒服的,所以我在封装ajax的时候一方面舍去了很多不常用的参数只留下了最常用的几个功能,另一方面尽量保持它原有的使用风格。

我一共只留了五个参数,他们分别是发送方式(type)、发请求的url(url)、是否为异步请求(async)、发送的参数(data)、传输成功的回调函数(success),函数代码如下:

/* 封装ajax函数

* @param {string}opt.type http连接的方式,包括POST和GET两种方式,默认使用GET

* @param {string}opt.url 发送请求的url

* @param {boolean}opt.async 是否为异步请求,true为异步的,false为同步的

* @param {object}opt.data 发送的参数,格式为对象类型

* @param {function}opt.success ajax发送并接收成功调用的回调函数

*/

function ajax(opt) {

opt = opt || {};

var method = opt.method || 'GET';

method = method.toUpperCase() || 'GET';

var url = opt.url || '';

var async = opt.async || true;

var data = opt.data || null;

var success = opt.success || function () {};

var xmlHttp = null;

if (XMLHttpRequest) {

xmlHttp = new XMLHttpRequest();

}

else {

xmlHttp = new ActiveXObject('Microsoft.XMLHTTP');

}

var params = [];

for (var key in data){

params.push(key + '=' + data[key]);

}

var dataStr = params.join('&');

if (method === 'POST') {

xmlHttp.open(method, url, async);

xmlHttp.setRequestHeader('Content-Type', 'application/x-www-form-urlencoded;charset=utf-8');

xmlHttp.send(dataStr);

}

else {

xmlHttp.open(method, url + '?' + dataStr, async);

xmlHttp.send(null);

}

xmlHttp.onreadystatechange = function () {

if (xmlHttp.readyState == 4 && xmlHttp.status == 200) {

success(xmlHttp.responseText);

}

};

}

以对象的形式做函数的参数还是比较灵活的,不用拘泥于参数个数的问题。但这容易出现一个问题,就是使用参数的时候很有可能参数没给却在函数内部使用了,比如在调用函数时忘了写success回调函数,而定义的时候却用到了他,这就会报错了,因为success是undefined了。所以为了避免这种情况我觉得最好在封装函数的时候尽量给每一个参数一个默认值,如果调用的时候未给出某个参数那么他就使用默认值代替,这样就不会出现上述情况了。

接下来下面是创建XMLHttpRequest对象,写了两种创建方式是为了兼容IE才有的写法,旧版本的IE浏览器不支持XMLHttpRequest构造函数,IE有他自己独特的构造函数来支持ajax那就是ActiveXObject构造函数。

创建好了XMLHttpRequest对象,接下来写的是对发送参数data的转换,在使用ajax函数的时候data也用json的数据格式会有一种亲切感,因为大部分ajax传输的时候返回数据都使用json格式,所以发送的时候也使用json格式显得很友好。这里需要将{a: b, c: d}的格式转换为a=b&c=d的格式。

然后是对"POST"和"GET"两种不同的发送方式做处理。GET方法比较简单,直接把整理好的数据接在open方法的url参数的后面就行了(要记得在url后面加上"?"),send方法也不用带参数了,因为参数已经在url后面带着发过去了,所以send方法的参数直接给个null;POST方法这里有个坑,如果不注意可能会很烦恼为什么会得不到想要的结果,那就是需要设定Content-Type头信息,模拟HTTP的POST方法发送一个表单,这样服务器才会知道如何处理上传的内容。send方法中参数的提交格式和GET方法中url的写法一样,也是a=b&c=d格式。注意open方法必须放在设定头信息的前面,否则也会报错。async参数可以是true也可以是false,true代表使用异步方式调用,false代表使用同步方式调用,理所当然使用ajax是一定用异步的,这里只是提供一个选择,而且他的默认值也是true。

最后需要注册一个onreadystatechange事件,当XMLHttpRequest对象的readyState属性等于4了(代表收到完整的服务器响应了),同时status属性等于200(代表服务器响应的状态值为OK,状态正常)就可以判定这次ajax从发送过程到响应过程全程传输成功了,我们可以对返回的数据做一些处理,把要处理的代码写在success函数中,ajax成功就会调用之。

// 使用示例

ajax({

    method:'POST',

    url: 'test.php',

    data: {

        name1: 'value1',

        name2: 'value2'    },

    success: function (response) {

        // codes here    }

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

推荐阅读更多精彩内容