美文网首页vue
axios使用指南

axios使用指南

作者: oWSQo | 来源:发表于2019-10-10 17:36 被阅读0次

    Axios 是一个基于promise的 HTTP 库,可以用在浏览器和 node.js 中。

    特点

    • 支持浏览器和node.js
    • 支持promise
    • 能拦截请求和响应
    • 能转换请求和响应数据
    • 能取消请求
    • 自动转换JSON数据
    • 浏览器端支持防止CSRF(跨站请求伪造)

    安装

    npm install axios --save
    

    例子

    1、发送一个GET请求

    //通过给定的ID来发送请求
    axios.get('/user?ID=12345')
      .then(function(response){
        console.log(response);
      })
      .catch(function(err){
        console.log(err);
      });
    //以上请求也可以通过这种方式来发送
    axios.get('/user',{
      params:{
        ID:12345
      }
    })
    .then(function(response){
      console.log(response);
    })
    .catch(function(err){
      console.log(err);
    });
    

    2、发送一个POST请求

    axios.post('/user',{
      firstName:'Fred',
      lastName:'Flintstone'
    })
    .then(function(res){
      console.log(res);
    })
    .catch(function(err){
      console.log(err);
    });
    

    3、一次性并发多个请求

    function getUserAccount(){
      return axios.get('/user/12345');
    }
    function getUserPermissions(){
      return axios.get('/user/12345/permissions');
    }
    axios.all([getUserAccount(),getUserPermissions()])
      .then(axios.spread(function(acct,perms){
        //当这两个请求都完成的时候会触发这个函数,两个参数分别代表返回的结果
      }))
    

    axios的API

    axios可以通过配置(config)来发送请求

    1、axios(config)
    //发送一个`POST`请求
    axios({
        method:"POST",
        url:'/user/12345',
        data:{
            firstName:"Fred",
            lastName:"Flintstone"
        }
    });
    
    2、axios(url[,config])
    //发送一个`GET`请求(默认的请求方式)
    axios('/user/12345');
    

    请求方法的别名

    为方便起见,为所有支持的请求方法提供了别名。

    axios.request(config);
    axios.get(url[,config]);
    axios.delete(url[,config]);
    axios.head(url[,config]);
    axios.post(url[,data[,config]]);
    axios.put(url[,data[,config]])
    axios.patch(url[,data[,config]])
    

    在使用别名方法时,url、method、data这些属性都不必在配置中指定。

    并发请求

    处理并发请求的辅助函数。

    //iterable是一个可以迭代的参数如数组等
    axios.all(iterable)
    //callback要等到所有请求都完成才会执行
    axios.spread(callback)
    

    创建一个axios实例

    可以使用自定义配置新建一个axios实例。

    axios.create([config])
    var instance = axios.create({
      baseURL:"https://some-domain.com/api/",
      timeout:1000,
      headers: {'X-Custom-Header':'foobar'}
    });
    
    实例的方法

    以下是可用的实例方法。指定的配置将与实例的配置合并。

    axios#request(config)
    axios#get(url[,config])
    axios#delete(url[,config])
    axios#head(url[,config])
    axios#post(url[,data[,config]])
    axios#put(url[,data[,config]])
    axios#patch(url[,data[,config]])
    

    请求的配置

    以下就是请求的配置选项,只有url选项是必须的,如果method选项未定义,那么它默认是以GET的方式发出请求。

    {
      // url是请求的服务器地址
      url: '/user',
      //`method`是请求资源的方式
      method: 'get'//default
      //如果url不是绝对地址,那么baseURL将会加到url的前面
      //当url是相对地址的时候,设置baseURL会非常的方便
      baseURL: 'https://some-domain.com/api/',
      //`transformRequest`选项允许我们在请求发送到服务器之前对请求的数据做出一些改动
      //该选项只适用于以下请求方式:put/post/patch
      //数组里面的函数必须返回一个字符串、一个ArrayBuffer或者Stream
      transformRequest: [function(data){
        //在这里根据自己的需求改变数据
        return data;
      }],
      //transformResponse选项允许我们在数据传送到then/catch方法之前对数据进行改动
      transformResponse: [function(data){
        //在这里根据自己的需求改变数据
        return data;
      }],
      //headers选项是需要被发送的自定义请求头信息
      headers: {'X-Requested-With':'XMLHttpRequest'},
      //`params`选项是要随请求一起发送的请求参数----一般链接在URL后面
      //他的类型必须是一个纯对象或者是URLSearchParams对象
      params: {
        ID:12345
      },
      //`paramsSerializer`是一个可选的函数,作用是让参数(params)序列化
      paramsSerializer: function(params){
        return Qs.stringify(params,{arrayFormat:'brackets'})
      },
      //`data`选项是作为一个请求体而需要被发送的数据
      //该选项只适用于方法:put/post/patch
      //当没有设置`transformRequest选项时data必须是以下几种类型之一
      //string/plain/object/ArrayBuffer/ArrayBufferView/URLSearchParams
      //仅仅浏览器:FormData/File/Bold
      //仅node: Stream
      data {
        firstName:"Fred"
      },
      //timeout选项定义了请求发出的延迟毫秒数
      //如果请求花费的时间超过延迟的时间,那么请求会被终止
    
      timeout:1000,
      //withCredentails选项表示跨域请求时是否需要使用凭证
      
      withCredentials: false, // default
      //`adapter`适配器选项允许自定义处理请求,这会使得测试变得方便
      //返回一个promise,并提供验证返回
      adapter: function(config){
        /*..........*/
      },
      //`auth`表明HTTP基础的认证应该被使用,并提供证书
      //这会设置一个authorization头(header),并覆盖你在header设置的Authorization头信息
      auth: {
        username:"zhangsan",
        password: "s00sdkf"
      },
      //返回数据的格式
      //其可选项是arraybuffer,blob,document,json,text,stream
      responseType:'json',//default
      // xsrfCookieName是用作 xsrf token 的值的cookie的名称
      xsrfCookieName: 'XSRF-TOKEN',//default
      xsrfHeaderName:'X-XSRF-TOKEN',//default
      //onUploadProgress上传进度事件
      onUploadProgress: function(progressEvent){
      }
      //下载进度的事件
      onDownloadProgress: function(progressEvent){
      },
      //响应内容的最大值
      maxContentLength:2000,
      //`validateStatus`定义了是否根据http相应状态码,来resolve或者reject promise
      //如果`validateStatus`返回true(或者设置为`null`或者`undefined`),那么promise的状态将会是resolved,否则其状态就是rejected
      validateStatus:function(status){
        return status >= 200 && status <300;//default
      },
      //`maxRedirects`定义了在nodejs中重定向的最大数量
      maxRedirects: 5,//default
      //`httpAgent/httpsAgent`定义了当发送http/https请求要用到的自定义代理
      //keeyAlive在选项中没有被默认激活
      httpAgent: new http.Agent({keeyAlive:true}),
      httpsAgent: new https.Agent({keeyAlive:true}),
      //proxy定义了主机名字和端口号,
      //`auth`表明http基本认证应该与proxy代理链接,并提供证书
      //这将会设置一个`Proxy-Authorization` header,并且会覆盖掉已经存在的`Proxy-Authorization`  header
      proxy: {
        host:'127.0.0.1',
        port: 9000,
        auth: {
          username:'skda',
          password:'radsd'
        }
      },
      //`cancelToken`定义了一个用于取消请求的cancel token
      cancelToken: new CancelToken(function(cancel){
      })
    }
    

    请求返回的内容

    某个请求的响应包含以下信息。

    {
      // `data` 由服务器提供的响应
      data: {},
    
      // `status` 来自服务器响应的 HTTP 状态码
      status: 200,
    
      // `statusText` 来自服务器响应的 HTTP 状态信息
      statusText: 'OK',
    
      // `headers` 服务器响应的头
      headers: {},
    
       // `config` 是为请求提供的配置信息
      config: {},
      request: {}
    }
    

    使用then时,你将接收下面这样的响应 :

    axios.get('/user/12345')
      .then(function(response) {
        console.log(response.data);
        console.log(response.status);
        console.log(response.statusText);
        console.log(response.headers);
        console.log(response.config);
      });
    

    默认配置

    你可以指定将被用在各个请求的配置默认值。

    全局默认配置

    axios.defaults.baseURL = 'https://api.example.com';
    axios.defaults.headers.common['Authorization'] = AUTH_TOKEN;
    axios.defaults.headers.post['Content-Type'] = 'application/x-www-form-urlencoded';
    

    自定义实例的默认设置

    //当创建实例的时候配置默认配置
    var instance = axios.create({
        baseURL: 'https://api.example.com'
    });
    
    //当实例创建后修改配置
    instance.defaults.headers.common["Authorization"] = AUTH_TOKEN;
    

    配置的优先顺序

    配置会以一个优先顺序进行合并。这个顺序是:在lib/defaults.js找到的库的默认值,然后是实例的defaults属性,最后是请求的config参数。后者将优先于前者。这里是一个例子:

    //创建一个实例的时候会使用libray目录中的默认配置
    //在这里timeout配置的值为0,来自于libray的默认值
    var instance = axios.create();
    
    //会覆盖掉library的默认值
    //现在所有的请求都要等2.5S之后才会发出
    instance.defaults.timeout = 2500;
    
    // 这里的timeout回覆盖之前的2.5S变成5s
    instance.get('/longRequest', {
      timeout: 5000
    });
    

    拦截器

    在请求或响应被thencatch处理前拦截它们。

    // 添加请求拦截器
    axios.interceptors.request.use(function (config) {
        // 在发送请求之前做些什么
        return config;
      }, function (error) {
        // 对请求错误做些什么
        return Promise.reject(error);
      });
    
    // 添加响应拦截器
    axios.interceptors.response.use(function (response) {
        // 对响应数据做点什么
        return response;
      }, function (error) {
        // 对响应错误做点什么
        return Promise.reject(error);
      });
    

    取消拦截器

    var myInterceptor = axios.interceptor.request.use(function(){/*....*/});
    axios.interceptors.request.eject(myInterceptor);
    

    给自定义的axios实例添加拦截器

    var instance = axios.create();
    instance.interceptors.request.use(function(){})
    

    错误处理

    axios.get('/user/12345')
      .catch(function(error){
        if(error.response){
          //请求已经发出,但是服务器响应返回的状态吗不在2xx的范围内
          console.log(error.response.data);
          console.log(error.response.status);
          console.log(error.response.header);
        }else {
          //一些错误是在设置请求的时候触发
          console.log('Error',error.message);
        }
        console.log(error.config);
      });
    

    取消

    使用cancel token取消请求

    你可以通过CancelToken.source工厂函数来创建一个cancel token

    var CancelToken = axios.CancelToken;
    var source = CancelToken.source();
    
    axios.get('/user/12345',{
      cancelToken: source.token
    }).catch(function(thrown){
      if(axios.isCancel(thrown)){
        console.log('Request canceled',thrown.message);
      }else {
        //handle error
      }
    });
    
    //取消请求(message 参数是可选的)
    source.cance("操作被用户取消");
    

    还可以通过传递一个executor函数到CancelToken的构造函数来创建cancel token

    const CancelToken = axios.CancelToken;
    let cancel;
    
    axios.get('/user/12345', {
      cancelToken: new CancelToken(function executor(c) {
        // executor 函数接收一个 cancel 函数作为参数
        cancel = c;
      })
    });
    
    // cancel the request
    cancel();
    

    相关文章

      网友评论

        本文标题:axios使用指南

        本文链接:https://www.haomeiwen.com/subject/errapctx.html