整合营销服务商

电脑端+手机端+微信端=数据同步管理

免费咨询热线:

JavaScript封装一个自己的Ajax并完善与拓展Ajax

在所有主流的网站,基本上都用到了ajax技术,通过异步请求数据已经是一个很普及的实现方式。市面上主流的web前端框架也都有自己封装的ajax,而且都是大同小异的。也就是说,Ajax这个轮子已经是多的不能再多了,那为什么我们还要自己封装一个Ajax呢?

想要了解一个技术或者某个功能的实现原理,只有动手实践才能真正的了解。就如我在csdn上第一篇博客的博文描述。探索技术的路上本应该自己造轮子,即使市面上有再多的选择,自己动手尝试也是必要的,第一次尝试必然会问题众多,但你不觉得解决他是一件很有成就感的事情吗,这样才能带给你更大的进步和更深刻的领悟。

废话不说,先来写一个最基础的ajax:

[javascript] view plain copy

  1. function ajax(a){
  2. var ajax = new XMLHttpRequest();
  3. ajax.onreadystatechange = function(){
  4. if (ajax.readyState == 4 && ajax.status == 200) {
  5. a.success(JSON.stringify(ajax.responseText))
  6. }
  7. }
  8. ajax.open(a.method, a.url,true)
  9. ajax.send(a.data)
  10. }
  11. ajax({
  12. method:'get',
  13. url:'http://127.0.0.1:8081/test',
  14. success:function(res){
  15. console.log(res)
  16. }
  17. })

一个ajax出炉了,通过调用、填写参数即可请求到服务器。先来分析一下这个ajax的结构,可以看得出来,其实很简单,只是new了一个XMLHttpRequest对象,然后通过onreadystatechange方法来处理返回值,现在我们只是做了一个判断,当请求成功时就调用success方法,如果请求失败,我们还没有写上去,后面我们慢慢完善这个ajax的逻辑。

然后调用ajax的open方法,open方法里有三个参数,第一个是请求方式(如:get或post),第二个是请求的url地址,第三个是一个bool值,是否要异步请求。

最后使用send方法带上参数发送请求即可。

这是,我的服务器已经收到一个请求,但他报了404错误,也就是找不到对应的页面或路由,这时success方法也不会被调用执行。

那我们再来完善一下这个新生的ajax。我们只需要在onreadystatechange方法里增加一个条件,当请求不成功时调用自身的error方法:

[javascript] view plain copy

  1. ajax.onreadystatechange = function(){
  2. if (ajax.readyState == 4 && ajax.status == 200) {
  3. a.success(JSON.stringify(ajax.responseText))
  4. }else{
  5. a.error(ajax)
  6. }
  7. }

这样我们就可以在ajax请求的时候加上error方法,当ajax请求失败的时候执行我们想要执行的操作。现在我们抛除跨域请求的问题,当你发送post请求时,你会发现后台接收不到传过来的参数,调用如下:

[javascript] view plain copy

  1. ajax({
  2. method:'get',
  3. url:'http://localhost:8081/test',
  4. data:'a=1',
  5. success:function(res){
  6. console.log(res)
  7. },
  8. error:function(res){
  9. console.log(res)
  10. }
  11. })

后端打印一下传过来的参数,为空。

出现这个问题的原因主要是请求头没有声明,这时候我们需要初始化声明一下请求头,那我们加入一行代码:

[javascript] view plain copy

  1. ajax.setRequestHeader("Content-type", "application/x-www-form-urlencoded");

设置Conten-type为application/x-www-form-urlencoded,现在后端应该是已经可以收到参数了。那我们现在的ajax调用时实在太繁琐,有些东西我们不想填的我们应该给他设置一个默认值,不然就会报错。

比如error方法、method、还有是否异步的bool值等等。那我们再加入一些默认值,现在的ajax是这样的:

[javascript] view plain copy

  1. function ajax(a){
  2. a.method = a.method || 'get';
  3. a.ajax = a.ajax || true;
  4. a.error = a.error || function(){
  5. console.warn('Ajax请求失败');
  6. };
  7. var ajax = new XMLHttpRequest();
  8. ajax.onreadystatechange = function(){
  9. if (ajax.readyState == 4 && ajax.status == 200) {
  10. a.success(JSON.stringify(ajax.responseText))
  11. }else{
  12. a.error(ajax)
  13. }
  14. }
  15. ajax.open(a.method, a.url,a.ajax)
  16. ajax.setRequestHeader("Content-type", "application/x-www-form-urlencoded");
  17. ajax.send(a.data)
  18. }

现在的ajax还存在一个问题,在post请求的时候,如果我们要传参,是需要通过字符串传参的。那这种的书写规则并不是很友好的:

[javascript] view plain copy

  1. a=1&b=2

而一般框架的传参都是通过json的格式来输入的,我们也不能偏离大众习惯搞独立,当然我们也要保留字符串的传参方式,只是要扩展功能。

那我们需要加一个控制格式的参数,我们这里用dataType这个参数来控制传参格式,默认是字符串格式传参好了,可以选择json格式进行传参即可。如果是json格式传参,我们需要把json转化成字符串类型,代码如下:

[javascript] view plain copy

  1. a.dataType = a.dataType || 'string';
  2. var data = a.data;
  3. if (a.dataType == 'json') {
  4. var nowData = "";
  5. for (var i in data) {
  6. nowData += (nowData != ''?'&':'')+i+'='+data[i];
  7. }
  8. data = nowData;
  9. }

这样,我们的ajax也就可以通过json格式进行传参了。现在的ajax完整代码和调用方式如下:

[javascript] view plain copy

  1. function ajax(a){
  2. a.method = a.method || 'get';
  3. a.ajax = a.ajax || true;
  4. a.dataType = a.dataType || 'string';
  5. a.error = a.error || function(){
  6. console.warn('Ajax请求失败');
  7. };
  8. var ajax = new XMLHttpRequest();
  9. ajax.onreadystatechange = function(){
  10. if (ajax.readyState == 4 && ajax.status == 200) {
  11. a.success(JSON.stringify(ajax.responseText))
  12. }else{
  13. a.error(ajax)
  14. }
  15. }
  16. var data = a.data;
  17. if (a.dataType == 'json') {
  18. var nowData = "";
  19. for (var i in data) {
  20. nowData += (nowData != ''?'&':'')+i+'='+data[i];
  21. }
  22. data = nowData;
  23. }
  24. ajax.open(a.method, a.url,a.ajax)
  25. ajax.setRequestHeader("Content-type", "application/x-www-form-urlencoded");
  26. ajax.send(data)
  27. }
  28. //调用Ajax示例
  29. ajax({
  30. method:'post',
  31. url:'http://localhost:8081/test',
  32. dataType:'json',
  33. data:{
  34. a:'1',
  35. b:'2'
  36. },
  37. success:function(res){
  38. console.log(res)
  39. }
  40. })

现在这个Ajax基本上已经可以满足业务上的所以需求,不过还有一点没有实现,我们的Ajax不能设置请求头?!为了一些特殊需求的情况下,我们还是要把这一功能加上的:

[javascript] view plain copy

  1. if (a.requestHeader) {
  2. for (var i in a.requestHeader) {
  3. ajax.setRequestHeader(i,a.requestHeader[i])
  4. }
  5. }

现在的完整代码入下:

[javascript] view plain copy

  1. function ajax(a){
  2. a.method = a.method || 'get';
  3. a.ajax = a.ajax || true;
  4. a.dataType = a.dataType || 'string';
  5. a.error = a.error || function(){
  6. console.warn('Ajax请求失败');
  7. };
  8. var ajax = new XMLHttpRequest();
  9. ajax.onreadystatechange = function(){
  10. if (ajax.readyState == 4 && ajax.status == 200) {
  11. a.success(JSON.parse(ajax.responseText))
  12. }else if (ajax.readyState != 4 && ajax.status != 200){
  13. a.error(ajax)
  14. }
  15. }
  16. var data = a.data;
  17. if (a.dataType == 'json') {
  18. var nowData = "";
  19. for (var i in data) {
  20. nowData += (nowData != ''?'&':'')+i+'='+data[i];
  21. }
  22. data = nowData;
  23. }
  24. ajax.open(a.method, a.url,a.ajax)
  25. if (a.requestHeader) {
  26. for (var i in a.requestHeader) {
  27. ajax.setRequestHeader(i,a.requestHeader[i])
  28. }
  29. }
  30. ajax.setRequestHeader("Content-type", "application/x-www-form-urlencoded");
  31. ajax.send(data)
  32. }

完整示例代码文件:JavaScript封装Ajax完整示例代码

AJAX 是一个缩写,它的全名是 Asynchronous JavaScript and XML,意思就是异步 JavaScript 和 XML,即用JavaScript执行异步网络请求

AJAX 不是一种新技术,而是一个在 2005 年被 Jesse James Garrett 提出的新术语,用来描述一种使用现有技术集合的‘新’方法,包括:

  • HTML 或 XHTML
  • CSS
  • JavaScript
  • DOM
  • XML
  • XSLT
  • XMLHttpRequest

尽管 X 在 AJAX 中代表 XML, 但由于 JSON 的许多优势,比如更加轻量以及作为 Javascript 的一部分,目前 JSON 的使用比 XML 更加普遍。JSON 和 XML 都被用于在 AJAX 模型中打包信息。

AJAX 的优势

传统的网页(不使用 AJAX)如果需要更新内容,必须重载整个网页面。

AJAX 通过在后台与服务器进行少量数据交换,可以使网页实现异步更新。这意味着可以在不重新加载整个网页的情况下,对网页的某部分进行更新。

XMLHttpRequest 对象

XMLHttpRequest(XHR)对象用于与服务器交互。通过 XMLHttpRequest 可以在不刷新页面的情况下请求特定 URL,获取数据。这允许网页在不影响用户操作的情况下,更新页面的局部内容。XMLHttpRequest 在 AJAX 编程中被大量使用。

AJAX 的工作原理

其工作原理基本经过以下几个步骤:

  1. 客户端发送请求,请求交给 xhr。
  2. xhr 把请求提交给服务。
  3. 服务器进行业务处理。
  4. 服务器响应数据交给 xhr 对象。
  5. xhr 对象接收数据,由 JavaScript 把数据写到页面上。

AJAX 的创建步骤

根据 AJAX 的工作原理,它的创建步骤主要包括:

  1. 创建 XMLHttpRequest 对象,即创建一个异步调用对象。
  2. 创建一个新的 HTTP 请求,并指定该 HTTP 请求的方法、URL 及验证信息。
  3. 设置响应 HTTP 请求状态变化的函数。
  4. 发送 HTTP 请求。
  5. 获取异步调用返回的数据。
  6. 使用 JavaScript 和 DOM 实现局部刷新。

AJAX 的具体使用

以下是 使用 AJAX 的完整流程。

1. 创建 XMLHttpRequest 对象

const request = new XMLHttpRequest();

2. 创建一个新的 HTTP 请求,并指定该 HTTP 请求的方法、URL 及验证信息

创建 HTTP 请求可以使用 XMLHttpReques t对象的 open() 方法,其语法代码如下:

request.open(method, url, async, user, password);

参数解析:

  • method 要使用的HTTP方法,比如 "GET"、"POST"、"PUT"、"DELETE" 等。
  • url 表示要向其发送请求的 URL 地址。
  • async (可选) 一个可选的布尔参数,表示是否异步执行操作,默认为 true。如果值为 false,send() 方法直到收到答复前不会返回。如果 true,已完成事务的通知可供事件监听器使用。如果 multipart 属性为 true 则这个必须为 true,否则将引发异常。
  • user (可选 用于认证用途的用户名,默认值为 null。
  • password (可选) 用于认证用途的密码,默认值为 null。

3. 设置响应 HTTP 请求状态变化的函数和服务端返回信息函数

创建完 HTTP 请求之后,应该就可以将 HTTP 请求发送给 Web 服务器了。然而,发送 HTTP 请求的目的是为了接收从服务器中返回的数据。从创建 XMLHttpRequest 对象开始,到发送数据、接收数据、XMLHttpRequest 对象一共会经历以下 5 种状态:

  • 未初始化状态。在创建完 XMLHttpRequest 对象时,该对象处于未初始化状态,此时 XMLHttpRequest 对象的 readyState 属性值为 0。
  • 初始化状态。在创建完 XMLHttpRequest 对象后使用 open() 方法创建了 HTTP 请求时,该对象处于初始化状态。此时 XMLHttpRequest 对象的readyState属性值为 1。
  • 发送数据状态。在初始化 XMLHttpRequest 对象后,使用 send() 方法发送数据时,该对象处于发送数据状态,此时XMLHttpRequest 对象的 readyState 属性值为 2。
  • 接收数据状态。Web 服务器接收完数据并进行处理完毕之后,向客户端传送返回的结果。此时,XMLHttpRequest 对象处于接收数据状态,XMLHttpRequest 对象的 readyState 属性值为 3。
  • 完成状态。XMLHttpRequest 对象接收数据完毕后,进入完成状态,此时 XMLHttpRequest 对象的 readyState 属性值为 4。此时接收完毕后的数据存入在客户端计算机的内存中,可以使用 responseText 属性或 responseXml 属性来获取数据。

总的来说,readyState 属性的值有以下几种:

  • 0 (未初始化) or (请求还未初始化)
  • 1 (正在加载) or (已建立服务器链接)
  • 2 (加载成功) or (请求已接受)
  • 3 (交互) or (正在处理请求)
  • 4 (完成) or (请求已完成并且响应已准备好)

只读属性 XMLHttpRequest.status 返回了 XMLHttpRequest 响应中的数字状态码。status 的值是一个无符号短整型。在请求完成前,status 的值为 0。值得注意的是,如果 XMLHttpRequest 出错,浏览器返回的 status 也为0:

  • UNSENT(未发送) 0
  • OPENED(已打开) 0
  • LOADING(载入中) 200
  • DONE(完成) 200
var xhr = new XMLHttpRequest();
console.log('UNSENT', xhr.readyState); // readyState 为 0

xhr.open('GET', '/api', true);
console.log('OPENED', xhr.readyState); // readyState 为 1

xhr.onprogress = function () {
    console.log('LOADING', xhr.readyState); // readyState 为 3
};

xhr.onload = function () {
    console.log('DONE', xhr.readyState); // readyState 为 4
};

xhr.send(null);

只有在XMLHttpRequest对象完成了以上5个步骤之后,才可以获取从服务器端返回的数据。因此,如果要获得从服务器端返回的数据,就必须要先判断XMLHttpRequest对象的状态:

const xhr = new XMLHttpRequest();
xmlHttpRequest.onreadystatechange = function () {
    if (xhr.readyState === 4 && xhr.status === 200) {
        // do something here
    }
}

4. 发送HTTP请求

XMLHttpRequest.send(data);

结束

最后,附上一个简单的完整 AJAX 实例:

<button id="ajaxButton" type="button">Make a request</button>

<script>
    var httpRequest;
    document.getElementById("ajaxButton").addEventListener('click', makeRequest);

    function makeRequest() {
        httpRequest = new XMLHttpRequest();

        httpRequest.onreadystatechange = alertContents;
        httpRequest.open('GET', 'test.html');
        httpRequest.send();
    }

    function alertContents() {
        if (httpRequest.readyState === XMLHttpRequest.DONE) {
            if (httpRequest.status === 200) {
                alert(httpRequest.responseText);
            } else {
                alert('There was a problem with the request.');
            }
        }
    }
</script>

~

~

~ 本文完

~

学习有趣的知识,结识有趣的朋友,塑造有趣的灵魂!

大家好!我是〖编程三昧〗的作者 隐逸王,我的公众号是『编程三昧』,欢迎关注,希望大家多多指教!

知识与技能并重,内力和外功兼修,理论和实践两手都要抓、两手都要硬!

JAX 是一种与服务器交换数据的技术,可以在补充在整个页面的情况下更新网页的一部分。接下来通过本文给大家介绍ajax一些常用方法,大家有需要可以一起学习。

1.url:

要求为String类型的参数,(默认为当前页地址)发送请求的地址。

2.type:

要求为String类型的参数,请求方式(post或get)默认为get。注意其他http请求方法,例如put和delete也可以使用,但仅部分浏览器支持。

3.timeout:

要求为Number类型的参数,设置请求超时时间(毫秒)。此设置将覆盖$.ajaxSetup()方法的全局设置。

4.async:

要求为Boolean类型的参数,默认设置为true,所有请求均为异步请求。如果需要发送同步请求,请将此选项设置为false。注意,同步请求将锁住浏览器,用户其他操作必须等待请求完成才可以执行。


5.cache:

要求为Boolean类型的参数,默认为true(当dataType为script时,默认为false),设置为false将不会从浏览器缓存中加载请求信息。

6.data:

要求为Object或String类型的参数,发送到服务器的数据。如果已经不是字符串,将自动转换为字符串格式。get请求中将附加在url后。防止这种自动转换,可以查看 processData选项。对象必须为key/value格式,例如{foo1:"bar1",foo2:"bar2"}转换为&foo1=bar1&foo2=bar2。如果是数组,JQuery将自动为不同值对应同一个名称。例如{foo:["bar1","bar2"]}转换为&foo=bar1&foo=bar2。

7.dataType:

要求为String类型的参数,预期服务器返回的数据类型。如果不指定,JQuery将自动根据http包mime信息返回responseXML或responseText,并作为回调函数参数传递。可用的类型如下:

xml:返回XML文档,可用JQuery处理。

html:返回纯文本HTML信息;包含的script标签会在插入DOM时执行。

script:返回纯文本JavaScript代码。不会自动缓存结果。除非设置了cache参数。注意在远程请求时(不在同一个域下),所有post请求都将转为get请求。

json:返回JSON数据。

jsonp:JSONP格式。使用SONP形式调用函数时,例如myurl?callback=?,JQuery将自动替换后一个“?”为正确的函数名,以执行回调函数。

text:返回纯文本字符串。

8.beforeSend:

要求为Function类型的参数,发送请求前可以修改XMLHttpRequest对象的函数,例如添加自定义HTTP头。在beforeSend中如果返回false可以取消本次ajax请求。XMLHttpRequest对象是惟一的参数。

function(XMLHttpRequest){

this; //调用本次ajax请求时传递的options参数

}

9.complete:

要求为Function类型的参数,请求完成后调用的回调函数(请求成功或失败时均调用)。参数:XMLHttpRequest对象和一个描述成功请求类型的字符串。

function(XMLHttpRequest, textStatus){

this; //调用本次ajax请求时传递的options参数

}

10.success:

要求为Function类型的参数,请求成功后调用的回调函数,有两个参数。

(1)由服务器返回,并根据dataType参数进行处理后的数据。

(2)描述状态的字符串。

function(data, textStatus){

//data可能是xmlDoc、jsonObj、html、text等等

this; //调用本次ajax请求时传递的options参数

}

11.error:

要求为Function类型的参数,请求失败时被调用的函数。该函数有3个参数,即XMLHttpRequest对象、错误信息、捕获的错误对象(可选)。ajax事件函数如下:

function(XMLHttpRequest, textStatus, errorThrown){

//通常情况下textStatus和errorThrown只有其中一个包含信息

this; //调用本次ajax请求时传递的options参数

}

12.contentType:

要求为String类型的参数,当发送信息至服务器时,内容编码类型默认为"application/x-www-form-urlencoded"。该默认值适合大多数应用场合。

13.dataFilter:

要求为Function类型的参数,给Ajax返回的原始数据进行预处理的函数。提供data和type两个参数。data是Ajax返回的原始数据,type是调用jQuery.ajax时提供的dataType参数。函数返回的值将由jQuery进一步处理。

function(data, type){

//返回处理后的数据

return data;

}

14.dataFilter:

要求为Function类型的参数,给Ajax返回的原始数据进行预处理的函数。提供data和type两个参数。data是Ajax返回的原始数据,type是调用jQuery.ajax时提供的dataType参数。函数返回的值将由jQuery进一步处理。

function(data, type){

//返回处理后的数据

return data;

}

15.global:

要求为Boolean类型的参数,默认为true。表示是否触发全局ajax事件。设置为false将不会触发全局ajax事件,ajaxStart或ajaxStop可用于控制各种ajax事件。

16.ifModified:

要求为Boolean类型的参数,默认为false。仅在服务器数据改变时获取新数据。服务器数据改变判断的依据是Last-Modified头信息。默认值是false,即忽略头信息。

17.jsonp:

要求为String类型的参数,在一个jsonp请求中重写回调函数的名字。该值用来替代在"callback=?"这种GET或POST请求中URL参数里的"callback"部分,例如{jsonp:'onJsonPLoad'}会导致将"onJsonPLoad=?"传给服务器。

18.username:

要求为String类型的参数,用于响应HTTP访问认证请求的用户名。

19.password:

要求为String类型的参数,用于响应HTTP访问认证请求的密码。

20.processData:

要求为Boolean类型的参数,默认为true。默认情况下,发送的数据将被转换为对象(从技术角度来讲并非字符串)以配合默认内容类型"application/x-www-form-urlencoded"。如果要发送DOM树信息或者其他不希望转换的信息,请设置为false。

21.scriptCharset:

要求为String类型的参数,只有当请求时dataType为"jsonp"或者"script",并且type是GET时才会用于强制修改字符集(charset)。通常在本地和远程的内容编码不同时使用。

案例代码:

$(function(){

$('#send').click(function(){

$.ajax({

type: "GET",

url: "test.json",

data: {username:$("#username").val(), content:$("#content").val()},

dataType: "json",

success: function(data){

$('#resText').empty(); //清空resText里面的所有内容

var html = '';

$.each(data, function(commentIndex, comment){

html += '<div class="comment"><h6>' + comment['username']

+ ':</h6><p class="para"' + comment['content']

+ '</p></div>';

});