参考文档:http://www.axios-js.com/zh-cn/docs/
它是一个类库,基于promise管理的Ajax库
关于get
、post
方法的参数
axios.get('https://v1.hitokoto.cn/', {
params: {
c: "b"
}
}).then(function (res) {
console.log(res);
}).catch(function (err) {
console.log(err);
})
get请求会把params中的键值对拼接成urlencode格式的字符串,然后以问号传递参数的形式,传递给服务器。
post方法与get稍有些不同,其第二个参数直接传入对象即代表请求数据。
axios.post('https://v1.hitokoto.cn/', {
c: "b"
}).then(function (res) {
console.log(res);
}).catch(function (err) {
console.log(err);
})
配置项中传递的内容都相当于请求的参数,传递的内容格式为x-www-form-urlencoded
请求数据返回的是一个对象。
同时请求多个,只有当这几个请求同时成功才做响应。其返回结果为一个数组。
let sendArry = [
axios.get('https://v1.hitokoto.cn/'),
axios.get('https://v1.hitokoto.cn/'),
]
axios.all(sendArry).then(result => {
console.log(result);
})
let sendArry = [
axios.get('https://v1.hitokoto.cn/'),
axios.get('https://v1.hitokoto.cn/'),
]
axios.all(sendArry).then(axios.spread((resA, resB) => {
// 传入参数分别对应请求的结果
console.log(resA);
console.log(resB);
}))
类似于Ajax,传入一个对象。在对象中写一些请求配置即可。
GET与POST相似。
axios({
method: "GET",
url: 'https://v1.hitokoto.cn/',
data: {
c: "b",
}
}).then(res => {
console.log(res);
});
常用的修改默认配置的方式
axios.defaults.baseURL = 'https://domain.com'
自定义成功失败规则
axios.defaults.validateStatus: function (status) {
return /^(2|3)\d{2}$/.test(status) // default
}
以上表示,当返回状态码为2xx或3xx都为成功,则都会执行then方法。
设置默认超时时间
axios.defaults.timeout = 3300;
设置默认请求头
axios.defaults.headers = {
key:'value'
}
设置post请求中基于请求主体向服务器发送的内容格式
// 设置请求头
axios.defaults.headers['content-Type'] = 'application/x-www-form-urlencoded';
// 修改数据格式
axios.transformResponse = function(data){
let str = ``;
for(let attr in data){
if(data.hasOwnProperty(attr)){
str += `${attr}=${data[attr]}&`
}
}
return str.substring(0,str.length-1)
}
默认为RAW,项目中常用的是x-www-form-urlencoded
设置响应拦截器
axios.interceptors.response.use(function success(result){
// 响应成功时
// 如下配置表示 只返回响应返回来的data即响应主体
return result.data
},function error(){
// 响应成功时
})
设置默认baseURL后,在发送请求则无需写完整地址;例如:
axios.defaults.baseURL = 'https://v1.hitokoto.cn'
axios.get('/?c=b').then(res => {
console.log(res);
})
完整的请求配置
{
// `url` 是用于请求的服务器 URL
url: '/user',
// `method` 是创建请求时使用的方法
method: 'get', // default
// `baseURL` 将自动加在 `url` 前面,除非 `url` 是一个绝对 URL。
// 它可以通过设置一个 `baseURL` 便于为 axios 实例的方法传递相对 URL
baseURL: 'https://some-domain.com/api/',
// `transformRequest` 允许在向服务器发送前,修改请求数据
// 只能用在 'PUT', 'POST' 和 'PATCH' 这几个请求方法
// 后面数组中的函数必须返回一个字符串,或 ArrayBuffer,或 Stream
transformRequest: [function (data, headers) {
// 对 data 进行任意转换处理
return data;
}],
// `transformResponse` 在传递给 then/catch 前,允许修改响应数据
transformResponse: [function (data) {
// 对 data 进行任意转换处理
return data;
}],
// `headers` 是即将被发送的自定义请求头
headers: {'X-Requested-With': 'XMLHttpRequest'},
// `params` 是即将与请求一起发送的 URL 参数
// 必须是一个无格式对象(plain object)或 URLSearchParams 对象
params: {
ID: 12345
},
// `paramsSerializer` 是一个负责 `params` 序列化的函数
// (e.g. https://www.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` 指定请求超时的毫秒数(0 表示无超时时间)
// 如果请求话费了超过 `timeout` 的时间,请求将被中断
timeout: 1000,
// `withCredentials` 表示跨域请求时是否需要使用凭证
withCredentials: false, // default
// `adapter` 允许自定义处理请求,以使测试更轻松
// 返回一个 promise 并应用一个有效的响应 (查阅 [response docs](#response-api)).
adapter: function (config) {
/* ... */
},
// `auth` 表示应该使用 HTTP 基础验证,并提供凭据
// 这将设置一个 `Authorization` 头,覆写掉现有的任意使用 `headers` 设置的自定义 `Authorization`头
auth: {
username: 'janedoe',
password: 's00pers3cret'
},
// `responseType` 表示服务器响应的数据类型,可以是 'arraybuffer', 'blob', 'document', 'json', 'text', 'stream'
responseType: 'json', // default
// `responseEncoding` indicates encoding to use for decoding responses
// Note: Ignored for `responseType` of 'stream' or client-side requests
responseEncoding: 'utf8', // default
// `xsrfCookieName` 是用作 xsrf token 的值的cookie的名称
xsrfCookieName: 'XSRF-TOKEN', // default
// `xsrfHeaderName` is the name of the http header that carries the xsrf token value
xsrfHeaderName: 'X-XSRF-TOKEN', // default
// `onUploadProgress` 允许为上传处理进度事件
onUploadProgress: function (progressEvent) {
// Do whatever you want with the native progress event
},
// `onDownloadProgress` 允许为下载处理进度事件
onDownloadProgress: function (progressEvent) {
// 对原生进度事件的处理
},
// `maxContentLength` 定义允许的响应内容的最大尺寸
maxContentLength: 2000,
// `validateStatus` 定义对于给定的HTTP 响应状态码是 resolve 或 reject promise 。如果 `validateStatus` 返回 `true` (或者设置为 `null` 或 `undefined`),promise 将被 resolve; 否则,promise 将被 rejecte
validateStatus: function (status) {
return status >= 200 && status < 300; // default
},
// `maxRedirects` 定义在 node.js 中 follow 的最大重定向数目
// 如果设置为0,将不会 follow 任何重定向
maxRedirects: 5, // default
// `socketPath` defines a UNIX Socket to be used in node.js.
// e.g. '/var/run/docker.sock' to send requests to the docker daemon.
// Only either `socketPath` or `proxy` can be specified.
// If both are specified, `socketPath` is used.
socketPath: null, // default
// `httpAgent` 和 `httpsAgent` 分别在 node.js 中用于定义在执行 http 和 https 时使用的自定义代理。允许像这样配置选项:
// `keepAlive` 默认没有启用
httpAgent: new http.Agent({ keepAlive: true }),
httpsAgent: new https.Agent({ keepAlive: true }),
// 'proxy' 定义代理服务器的主机名称和端口
// `auth` 表示 HTTP 基础验证应当用于连接代理,并提供凭据
// 这将会设置一个 `Proxy-Authorization` 头,覆写掉已有的通过使用 `header` 设置的自定义 `Proxy-Authorization` 头。
proxy: {
host: '127.0.0.1',
port: 9000,
auth: {
username: 'mikeymike',
password: 'rapunz3l'
}
},
// `cancelToken` 指定用于取消请求的 cancel token
// (查看后面的 Cancellation 这节了解更多)
cancelToken: new CancelToken(function (cancel) {
})
}