整合营销服务商

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

免费咨询热线:

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完整示例代码

JAX上传的用户体验更好,HTML上传用户使用更方便一点,直接在网页里面就能够操作了。示例在下面提供了,是完整的源代码,有教程,有视频教程,基本上使用非常简单,开发也非常简单,有技术支持,

网上搜了一下,基本上讲这块的文章还是很多,但是就是一个字乱,讲的很混乱。也没有提供完整的前后端示例。

用户上传的文件比较大,有20G左右,直接用HTML传的话容易失败,服务器也容易出错,需要分片,分块,分割上传。也就是将一个大的文件分成若干个小文件块来上传,另外就是需要实现秒传功能和防重复功能,秒传就是用户如果上传过这个文件,那么直接在数据库中查找记录就行了,不用再上传一次,节省时间,实现的思路是对文件做MD5计算,将MD5值保存到数据库,算法可以用MD5,或者CRC,或者SHA1,这个随便哪个算法都行。

分片还需要支持断点续传,现在HTML5虽然提供了信息记录功能,但是只支持到了会话级,也就是用户不能关闭浏览器,也不能清空缓存。但是有的政府单位上传大文件,传了一半下班了,明天继续传,电脑一关结果进度信息就丢失了,这个是他们的一个痛点。

切片的话还有一点就是在服务器上合并,一个文件的所有分片数据上传完后需要在服务器端进行合并操作。


1.下载示例

https://gitee.com/xproer/up6-vue-cli



将up6组件复制到项目中

示例中已经包含此目录



1.引入up6组件



2.配置接口地址

接口地址分别对应:文件初始化,文件数据上传,文件进度,文件上传完毕,文件删除,文件夹初始化,文件夹删除,文件列表

参考:http://www.ncmem.com/doc/view.aspx?id=e1f49f3e1d4742e19135e00bd41fa3de



3.处理事件



启动测试



启动成功



效果



数据库

:基本概念

jQuery的Ajax请求实际上是封装的一个XHLHttpRequest,从字面意思来看是,XML是一种文件格式,Http是一个网络请求,Request最开始是用于请求XML文件的,后来不断扩展可以请求多种类型的文件。

XHLHttpRequest,网络请求模块,或者是一个浏览器网络线程。用于从URL网络上获取数据,有了对象,就可以实现页面的无刷新请求数据,就可以做到一个局部的更新,也可以获取多种类型的数据(ftp、文件)。

2:要实现和使用XMLHttpRequest

它是一个对象,首先我们需要实例化,定义一个:

var xhr = new XMLHttpRequest();

3:初始化请求,给定一些必要的配置,给它一些property

//Ajax请求时的参数设置
method 请求方式
url 请求地址
async 是否异步
user 用户名
password 密码
​
xhr.open(method,url,async,user,password);

4:发送请求(encodeURLComponent)

xhr.send(data);
等待接收

5:接收网络请求返回

一般有如下属性:

  • responseText,请求返回的数据内容,可以是一段文本,是一段二进制或者是一个json
  • responseXML

是一个文件,如果响应头内容是text/xml,这个属性将保留响应数据的XML、DOM文档。

  • status,响应的HTTP状态,如 200(正常,200-300之间都表示成功) 304(使用缓存) 404(没找到) 500(服务器内部错误)等
  • statusText,HTTP状态说明
  • readyStatus,请求/响应过程的当前活动阶段,一共有5个值:0(未被调用open),1(已被调用open但未发送),2(已调用send),3(已接收到请求返回的数据),4(请求已完成)。
  • timeout,设置请求超时时间
xhr.onreadystatechange = () => {
 if (xhr.readyStatus === 4) {
 /* HTTP 状态在 200-300 之间表示请求成功 */
 /* HTTP 状态为 304 表示请求内容未发生改变,可直接从缓存中读取 */
 if (xhr.status >= 200 &&
 xhr.status < 300 ||
 xhr.status == 304) {
 console.log('请求成功', xhr.responseText)
 }
 }
}

6:封装(promise)

function ajax (options) {
 /* 获取请求地址 */
 let url = options.url;
 /* 获取请求方法 */
 const method = options.method.toLocaleLowerCase() || 'get';
 /* 默认异步 */
 const async = options.async != false;
 /* 获取请求request数据 */
 const data = options.data;
 /* 实例化XMLHttpRequest */
 const xhr = new XMLHttpRequest();
 /* 设置超时时间 */
 if (options.timeout && options.timeout > 0) {
 xhr.timeout = options.timeout
 }
​
 return new Promise ( (resolve, reject) => {
 /* 添加超时回调 */
 xhr.ontimeout = () => reject && reject('请求超时');
 /* 成功回调 */
 xhr.onreadystatechange = () => {
 if (xhr.readyState == 4) {
 if (xhr.status >= 200 && xhr.status < 300 || xhr.status == 304) {
 resolve && resolve(xhr.responseText);
 } else {
 reject && reject();
 }
 }
 }
​
 /* 失败回调 */
 xhr.onerror = err => reject && reject(err);
​
 /* 拼接参数 */
 let paramArr = [];
 let encodeData;
 if (data instanceof Object) {
 for (let key in data) {
 paramArr.push( encodeURIComponent(key) + '=' + encodeURIComponent(data[key]) );
 }
 encodeData = paramArr.join('&');
 }
​
 /* get请求 */
 if (method === 'get') {
 const index = url.indexOf('?')
 if (index === -1) url += '?'
 else if (index !== url.length -1) url += '&'
 url += encodeData
 }
​
 /* 初始化请求 */
 xhr.open(method, url, async);
​
 /* get直接发送拼接的URL */
 if (method === 'get') xhr.send(null);
​
 if (method === 'post') {
 xhr.setRequestHeader('Content-Type','application/x-www-form-urlencoded;charset=UTF-8')
 xhr.send(encodeData)
 }
 })
}

总结:关于网络请求,一般常用的有四种:

一个是get,获取网络资源

然后是post,一般用于提交数据,提交数据的参数是放在请求的body里面的

delete,删除

put,标准的一个修改

关于Http的简单请求和非简单请求或者是跨域,在跨域时由于浏览器的安全机制,涉及到一个问题关于在Ajax请求 ,是在请求之后还是请求之前判断跨域,这时候就需要了解一下简单请求和复杂请求。

简单请求是先把资源请求回来,然后再去判断是否跨域。如果是一个复杂请求,浏览器会先去发送一个嗅探或者是欲请求(一般是一个option),先判断是否跨域,如果不是跨域那就执行,如果是跨域那就直接不请求了。一般来讲,如果get不修改它的Content-Type,那么基本上都是简单请求。post如果采用www-form的形式,也是一个简单请求。

这篇文章主要是分享了Javascript中XMLHttpRequest对象的基本属性和方法, 从实例化、初始化、发送和接受四个阶段完成了Ajax网络请求核心内容封装。