一分钟教你学会ajax、async/await联调接口！！！

柔光的暖阳◎ 2023-06-30 04:28 10阅读 0赞

在实现前后台分离之后，后台只需要给前台提供相应的接口（数据请求地址），而众多的接口如果没有很好的管理，对于开发和维护都是很不友好的，如果我们在每个页面需要获取数据的时候直接，通过Ajax调用传参如:

$.ajax({
        url:"http://www.microsoft.com",    //请求的url地址
        dataType:"json",   //返回格式为json
        async:true,//请求是否异步，默认为异步，这也是ajax重要特性
        data:{"id":"value"},    //参数值
        type:"GET",   //请求方式
        beforeSend:function(){
            //请求前的处理
        },
        success:function(req){
            //请求成功时处理
        },
        complete:function(){
            //请求完成的处理
        },
        error:function(){
            //请求出错处理
        }
    });

下面是参数：

> 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)。通常在本地和远程的内容编码不同时使用。
> 
>

如果每次通过这样的方式有一个请求就要写一次，这样代码很长也不易阅读和维护。于是有人可能是把Ajax再分装一个方法，把公共的部分写进方法里，把一些如url、data当做参数传递,但这种方式依然不是很好。

--------------------

### 第一步 ###

那么今天我们重点来说一说如何通过async方法实现api接口调用。在jquery 2.x.x的版本之后`$.ajax()`都可以返回Promise对象,所以我们可以在async方法中await之后直接写 `$.ajax()`，然后再把它`return`出去如下所示

const myRequest = async (params = {},url) => {
        let data = params.query || {};
        data.id = 'value',
        let res = await $.ajax({
          url:url,
          method: params.method || 'GET',
          data:data,
          
        })
        return res;
     }

## 第二步 ##

我们可以把我们所有需要请求的，请求方法都写在一个单独的文件,命名为api.js。因为相同的请求地址请求的参数也有可能是不同的，所以我们需要把请求参数，作为新的方法的参数传递进去。

// api.js  
    
    const baseUrl= 'https://sujiefs.com/';
    
    const getAdList = (params) => myRequest(params, apiMall + '/api/adverts/list');
    const getAdList2 = (params) => myRequest(params, apiMall + '/api/adverts/list2');
    const getAdList3 = (params) => wxRequest(params, apiMall + '/api/adverts/list3');
    const getAdList4 = (params) => myRequest(params, apiMall + '/api/adverts/list4');

### 第三步 ###

此时我们就可以根据需求在需要的地方调用对应的请求数据，

getAdList({query: {}}).then(res => console.log(JSON.parse(res)));

--------------------

### async/await多个函数关联调用 ###

> async/await使得异步代码看起来像同步代码  
> async函数会隐式地返回一个promise，而promise的reosolve值就是函数return的值  
> Async/Await不需要写.then，不需要写匿名函数处理Promise的resolve值，也不需要定义多余的data变量，还避免了嵌套代码  
> async声明一个异步函数  
> await只能在async函数中使用，后面跟一个promise对象  
> 所以在模拟异步调用函数时，函数体内返回promise

### async/await缺点 ###

> async函数里，无论是Promise reject的数据还是逻辑报错，都会被默默吞掉。所以最好把await放入try\{\}catch\{\}中，或者在async返回的promise对象中使用.cache捕获错误。

### 实现 ###

项目中实现三个不同的接口调用，三个接口是相互关联的，前一个接口的返回值是后一个接口的参数，如果使用Promise实现的话，只能实现异步调用，但是无法相互关联，也就是数据不互通，所以使用async/await实现

*  接口调用的方法独立封装，参数可动态设置
 *  async声明异步方法，内部使用await关键字调用封装的接口，参数可直接传入
 *  async/await相当于将Promise异步调用同步化，数据可实现关联
 *  async/await会默认返回一个Promise对象，在实际调用中使用cache捕获错误

### 代码实现 ###

到此，分享就结束了，此文只是本人在学习过程中的一些总结，也怕自己忘了就把它大致的记了一下，如果我说的不对或有问题的地方烦请大家指出或提问，彼此也可以互相学习一下，如果能帮到你，请点个赞再走吧~~~~~