欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

详解vue axios中文文档

程序员文章站 2022-09-08 12:05:48
axios中文文档 在用vue做开发的时候,官方推荐的前后端通信插件是axios,github上axios的文档虽然详细,但是却是英文版.现在发现有个axios的中文文档...

axios中文文档

在用vue做开发的时候,官方推荐的前后端通信插件是axios,github上axios的文档虽然详细,但是却是英文版.现在发现有个axios的中文文档,于是就转载过来了!

原文地址 :

简介

版本:v0.16.1

基于http客户端的promise,面向浏览器和nodejs

特色

  • 浏览器端发起xmlhttprequests请求
  • node端发起http请求
  • 支持promise api
  • 拦截请求和返回
  • 转化请求和返回(数据)
  • 取消请求
  • 自动转化json数据
  • 客户端支持抵御xsrf(跨站请求伪造)

安装

使用npm:

$ npm i axios

使用 bower

$ bower instal axios

使用cdn

<!--国内bootcdn-->
<script src="https://cdn.bootcss.com/axios/0.16.0/axios.min.js"></script>

示例

发起一个get请求

//发起一个user请求,参数为给定的id
axios.get('/user?id=1234')
.then(function(respone){
  console.log(response);
})
.catch(function(error){
  console.log(error);
});

//上面的请求也可选择下面的方式来写
axios.get('/user',{
  params:{
    id:12345
  }
})
  .then(function(response){
    console.log(response);
  })
  .catch(function(error){
    console.log(error)
  });

发起一个post请求

axios.post('/user',{
  firstname:'friend',
  lastname:'flintstone'
})
.then(function(response){
  console.log(response);
})
.catch(function(error){
  console.log(error);
});

发起一个多重并发请求

function getuseraccount(){
  return axios.get('/user/12345');
}

function getuserpermissions(){
  return axios.get('/user/12345/permissions');
}

axios.all([getueraccount(),getuserpermissions()])
  .then(axios.spread(function(acc,pers){
    //两个请求现在都完成
  }));

axios api

可以对axios进行一些设置来生成请求。

axios(config)

//发起 post请求

axios({
  method:'post',//方法
  url:'/user/12345',//地址
  data:{//参数
    firstname:'fred',
    lastname:'flintstone'
  }
});
//通过请求获取远程图片
axios({
  method:'get',
  url:'http://bit.ly/2mtm3ny',
  responsetype:'stream'
})
  .then(function(response){
    response.data.pipe(fs.createwritestream('ada_lovelace.jpg'))
  })

axios(url[,config])

//发起一个get请求
axios('/user/12345/);

请求方法的重命名。

为了方便,axios提供了所有请求方法的重命名支持

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

注意

当时用重命名方法时url,method,以及data属性不需要在config中指定。

并发 concurrency

有用的方法

  • axios.all(iterable)
  • axios.spread(callback)

创建一个实例

你可以使用自定义设置创建一个新的实例

axios.create([config])

var instance = axios.create({
  baseurl:'http://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]])

requese config请求设置

以下列出了一些请求时的设置选项。只有url是必须的,如果没有指明method的话,默认的请求方法是get.

{
  //`url`是服务器链接,用来请求
  url:'/user',

  //`method`是发起请求时的请求方法
  method:`get`,

  //`baseurl`如果`url`不是绝对地址,那么将会加在其前面。
  //当axios使用相对地址时这个设置非常方便
  //在其实例中的方法
  baseurl:'http://some-domain.com/api/',

  //`transformrequest`允许请求的数据在传到服务器之前进行转化。
  //这个只适用于`put`,`get`,`patch`方法。
  //数组中的最后一个函数必须返回一个字符串或者一个`arraybuffer`,或者`stream`,`buffer`实例,`arraybuffer`,`formdata`
  transformrequest:[function(data){
    //依自己的需求对请求数据进行处理
    return data;
  }],

  //`transformresponse`允许返回的数据传入then/catch之前进行处理
  transformresponse:[function(data){
    //依需要对数据进行处理
    return data;
  }],

  //`headers`是自定义的要被发送的头信息
  headers:{'x-requested-with':'xmlhttprequest'},

  //`params`是请求连接中的请求参数,必须是一个纯对象,或者urlsearchparams对象
  params:{
    id:12345
  },

  //`paramsserializer`是一个可选的函数,是用来序列化参数
  //例如:(https://ww.npmjs.com/package/qs,http://api.jquery.com/jquery.param/)
  paramsserializer: function(params){
    return qs.stringify(params,{arrayformat:'brackets'})
  },

  //`data`是请求提需要设置的数据
  //只适用于应用的'put','post','patch',请求方法
  //当没有设置`transformrequest`时,必须是以下其中之一的类型(不可重复?):
  //-string,plain object,arraybuffer,arraybufferview,urlsearchparams
  //-仅浏览器:formdata,file,blob
  //-仅node:stream
  data:{
    firstname:'fred'
  },
  //`timeout`定义请求的时间,单位是毫秒。
  //如果请求的时间超过这个设定时间,请求将会停止。
  timeout:1000,

  //`withcredentials`表明是否跨网站访问协议,
  //应该使用证书
  withcredentials:false //默认值

  //`adapter`适配器,允许自定义处理请求,这会使测试更简单。
  //返回一个promise,并且提供验证返回(查看[response docs](#response-api))
  adapter:function(config){
    /*...*/
  },

  //`auth`表明http基础的认证应该被使用,并且提供证书。
  //这个会设置一个`authorization` 头(header),并且覆盖你在header设置的authorization头信息。
  auth:{
    username:'janedoe',
    password:'s00pers3cret'
  },

  //`responsetype`表明服务器返回的数据类型,这些类型的设置应该是
  //'arraybuffer','blob','document','json','text',stream'
  responsetype:'json',

  //`xsrfheadername` 是http头(header)的名字,并且该头携带xsrf的值
  xrsfheadername:'x-xsrf-token',//默认值

  //`onuploadprogress`允许处理上传过程的事件
  onuploadprogress: function(progressevent){
    //本地过程事件发生时想做的事
  },

  //`ondownloadprogress`允许处理下载过程的事件
  ondownloadprogress: function(progressevent){
    //下载过程中想做的事
  },

  //`maxcontentlength` 定义http返回内容的最大容量
  maxcontentlength: 2000,

  //`validatestatus` 定义promise的resolve和reject。
  //http返回状态码,如果`validatestatus`返回true(或者设置成null/undefined),promise将会接受;其他的promise将会拒绝。
  validatestatus: function(status){
    return status >= 200 && stauts < 300;//默认
  },

  //`httpagent` 和 `httpsagent`当产生一个http或者https请求时分别定义一个自定义的代理,在nodejs中。
  //这个允许设置一些选选个,像是`keepalive`--这个在默认中是没有开启的。
  httpagent: new http.agent({keepalive:treu}),
  httpsagent: new https.agent({keepalive:true}),

  //`proxy`定义服务器的主机名字和端口号。
  //`auth`表明http基本认证应该跟`proxy`相连接,并且提供证书。
  //这个将设置一个'proxy-authorization'头(header),覆盖原先自定义的。
  proxy:{
    host:127.0.0.1,
    port:9000,
    auth:{
      username:'cdd',
      password:'123456'
    }
  },

  //`canceltaken` 定义一个取消,能够用来取消请求
  //(查看 下面的cancellation 的详细部分)
  canceltoken: new canceltoken(function(cancel){
  })
}

返回响应概要 response schema

一个请求的返回包含以下信息

{
  //`data`是服务器的提供的回复(相对于请求)
  data{},

  //`status`是服务器返回的http状态码
  status:200,

  //`statustext`是服务器返回的http状态信息
  statustext: 'ok',

  //`headers`是服务器返回中携带的headers
  headers:{},

  //`config`是对axios进行的设置,目的是为了请求(request)
  config:{}
}

使用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);
  });

使用catch时,或者传入一个reject callback作为then的第二个参数,那么返回的错误信息将能够被使用。

默认设置(config default)

你可以设置一个默认的设置,这设置将在所有的请求中有效。

全局默认设置 global axios defaults

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';

实例中自定义默认值 custom instance default

//当创建一个实例时进行默认设置
var instance = axios.create({
  baseurl:'https://api.example.com'
});

//在实例创建之后改变默认值
instance.defaults.headers.common['authorization'] = auth_token;

设置优先级 config order of precedence

设置(config)将按照优先顺序整合起来。首先的是在lib/defaults.js中定义的默认设置,其次是defaults实例属性的设置,最后是请求中config参数的设置。越往后面的等级越高,会覆盖前面的设置。

看下面这个例子:

//使用默认库的设置创建一个实例,
//这个实例中,使用的是默认库的timeout设置,默认值是0。
var instance = axios.create();

//覆盖默认库中timeout的默认值
//此时,所有的请求的timeout时间是2.5秒
instance.defaults.timeout = 2500;

//覆盖该次请求中timeout的值,这个值设置的时间更长一些
instance.get('/longrequest',{
  timeout:5000
});

拦截器 interceptors

你可以在请求或者返回被then或者catch处理之前对他们进行拦截。

//添加一个请求拦截器
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.interceptors.request.use(function(){/*...*/});
axios.interceptors.rquest.eject(myinterceptor);

你可以在一个axios实例中使用拦截器

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

错误处理 handling errors

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.headers);
    }else{
      //一些错误是在设置请求时触发的
      console.log('error',error.message);
    }
    console.log(error.config);
  });

你可以使用validatestatus设置选项自定义http状态码的错误范围。

axios.get('user/12345',{
  validatestatus:function(status){
    return status < 500;//当返回码小于等于500时视为错误
  }
});

取消 cancellation

你可以使用cancel token取消一个请求

axios的cancel token api是基于**cnacelable promises proposal**,其目前处于第一阶段。

你可以使用canceltoken.source工厂函数创建一个cancel token,如下:

var canceltoken = axios.canceltoken;
var source = canceltoken.source();

axios.get('/user/12345', {
  canceltoken:source.toke
}).catch(function(thrown){
  if(axiso.iscancel(thrown)){
    console.log('rquest canceled', thrown.message);
  }else{
    //handle error
  }
});

//取消请求(信息参数设可设置的)
source.cancel("操作被用户取消");

你可以给canceltoken构造函数传递一个executor function来创建一个cancel token:

var canceltoken = axios.canceltoken;
var cancel;

axios.get('/user/12345', {
  canceltoken: new canceltoken(function executor(c){
    //这个executor 函数接受一个cancel function作为参数
    cancel = c;
  })
});

//取消请求
cancel();

注意:你可以使用同一个cancel token取消多个请求。

使用 application/x-www-form-urlencoded 格式化

默认情况下,axios串联js对象为json格式。为了发送application/x-wwww-form-urlencoded格式数据,
你可以使用一下的设置。

浏览器 browser

在浏览器中你可以如下使用urlsearchparams api:

var params = new urlsearchparams();
params.append('param1','value1');
params.append('param2','value2');
axios.post('/foo',params);

注意:urlsearchparams不支持所有的浏览器,但是这里有个垫片(poly fill)可用(确保垫片在浏览器全局环境中)

其他方法:你可以使用qs库来格式化数据。

var qs = require('qs');
axios.post('/foo', qs.stringify({'bar':123}));

node.js

在nodejs中,你可以如下使用querystring:

var querystring = require('querystring');
axios.post('http://something.com/', querystring.stringify({foo:'bar'}));

你同样可以使用qs库。

promises

axios 基于原生的es6 promise 实现。如果环境不支持请使用垫片.

typescript

axios 包含typescript定义

import axios from 'axios'
axios.get('/user?id=12345')

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。