Axios основан на обещании библиотеки HTTP, вы можете использовать браузер и node.js.
axios
Axios основан на обещании библиотеки HTTP, вы можете использовать браузер и node.js.
характеристика
- Создан из браузераXMLHttpRequests
- Создано из node.jshttp просить
- служба поддержки Promise API
- Перехват запросов и ответов
- Преобразование данных запроса и данных ответа
- отменить запрос
- Автоматически преобразовывать данные JSON
- Защита поддержки клиентовXSRF
Поддержка браузера
| Последние ✔ | Последние ✔ | Последние ✔ | Последние ✔ | Последние ✔ |
Установить
npm install axios
bower install axios
Используйте CDN:
кейс
воплощать в жизнь GET просить
// 为给定 ID 的 user 创建请求
axios.get('/user?ID=12345')
.then(function (response) {
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: 'Fred',
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([getUserAccount(), getUserPermissions()])
.then(axios.spread(function (acct, perms) {
// 两个请求现在都执行完成
}));
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.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Ни один из этих свойств не должен быть указан в конфигурации.
параллелизм
Вспомогательные функции для обработки параллельных запросов
axios.all(iterable)
axios.spread(callback)
Создать экземпляр
Вы можете создать новый экземпляр axios с пользовательской конфигурацией.
axios.create([config])
const 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#options(url[, config])
axios#post(url[, data[, config]])
axios#put(url[, data[, config]])
axios#patch(url[, data[, config]])
这些是创建请求时可以用的配置选项。 Только urlявляется обязательным. Если не указаноmethod, запрос будет использовать по умолчаниюgetметод.
{
// `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) {
})
}
структура ответа
Ответ на запрос содержит следующую информацию
{
// `data` 由服务器提供的响应
data: {},
// `status` 来自服务器响应的 HTTP 状态码
status: 200,
// `statusText` 来自服务器响应的 HTTP 状态信息
statusText: 'OK',
// `headers` 服务器响应的头
headers: {},
// `config` 是为请求提供的配置信息
config: {},
// 'request'
// `request` is the request that generated this response
// It is the last ClientRequest instance in node.js (in redirects)
// and an XMLHttpRequest instance the browser
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);
});
В использовании catchкогда или пройтиrejection callbackтак какthenКогда второй параметр , ответ может быть передан черезerrorобъект может использоваться как вобработка ошибокВ этом разделе речь идет о.
Настроить значения по умолчанию
Вы можете указать настройки по умолчанию, которые будут использоваться для отдельных запросов.
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';
Пользовательские значения по умолчанию для экземпляра
// Set config defaults when creating the instance
const instance = axios.create({
baseURL: 'https://api.example.com'
});
// Alter defaults after instance has been created
instance.defaults.headers.common['Authorization'] = AUTH_TOKEN;
Приоритет конфигурации
Конфигурации объединяются в порядке приоритета. Порядок такой: вlib/defaults.jsЗначение по умолчанию для найденной библиотеки, затем экземплярdefaultsатрибут, наконец, запрошенныйconfigпараметр. Последнее будет иметь приоритет над первым. Вот пример:
// 使用由库提供的配置的默认值来创建实例
// 此时超时配置的默认值是 `0`
var instance = axios.create();
// 覆写库的超时默认值
// 现在，在超时前，所有请求都会等待 2.5 秒
instance.defaults.timeout = 2500;
// 为已知需要花费很长时间的请求覆写超时设置
instance.get('/longRequest', {
timeout: 5000
});
перехватчик
В запросе или ответе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);
});
Если вы хотите удалить перехватчик позже, вы можете сделать это:
const myInterceptor = axios.interceptors.request.use(function () {/*...*/});
axios.interceptors.request.eject(myInterceptor);
Перехватчики могут быть добавлены для пользовательских экземпляров axios.
const instance = axios.create();
instance.interceptors.request.use(function () {/*...*/});
обработка ошибок
axios.get('/user/12345')
.catch(function (error) {
if (error.response) {
// The request was made and the server responded with a status code
// that falls out of the range of 2xx
console.log(error.response.data);
console.log(error.response.status);
console.log(error.response.headers);
} else if (error.request) {
// The request was made but no response was received
// `error.request` is an instance of XMLHttpRequest in the browser and an instance of
// http.ClientRequest in node.js
console.log(error.request);
} else {
// Something happened in setting up the request that triggered an Error
console.log('Error', error.message);
}
console.log(error.config);
});
Y может использоватьvalidateStatusПараметр конфигурации определяет настраиваемый диапазон ошибок кода состояния HTTP.
axios.get('/user/12345', {
validateStatus: function (status) {
return status < 500; // Reject only if the status code is greater than or equal to 500
}
})
Отмена
использовать cancel tokenотменить запрос
API токена отмены Axios основан наcancelable promises proposal, который все еще находится в своей первой фазе.
можно использовать CancelToken.sourceФабричный метод создает токен отмены следующим образом:
const CancelToken = axios.CancelToken;
const source = CancelToken.source();
axios.get('/user/12345', {
cancelToken: source.token
}).catch(function(thrown) {
if (axios.isCancel(thrown)) {
console.log('Request canceled', thrown.message);
} else {
// 处理错误
}
});
axios.post('/user/12345', {
name: 'new name'
}, {
cancelToken: source.token
})
// 取消请求（message 参数是可选的）
source.cancel('Operation canceled by the user.');
Вы также можете передать функцию-исполнитель вCancelTokenКонструктор для создания токена отмены:
const CancelToken = axios.CancelToken;
let cancel;
axios.get('/user/12345', {
cancelToken: new CancelToken(function executor(c) {
// executor 函数接收一个 cancel 函数作为参数
cancel = c;
})
});
// cancel the request
cancel();
Примечание. Несколько запросов можно отменить с помощью одного и того же токена отмены.
Используйте формат application/x-www-form-urlencoded
По умолчанию axios сериализует объекты JavaScript в JSON. Чтобы отправить данные в формате application/x-www-form-urlencoded, вы можете использовать один из следующих вариантов.
браузер
const params = new URLSearchParams();
params.append('param1', 'value1');
params.append('param2', 'value2');
axios.post('/foo', params);
const qs = require('qs');
axios.post('/foo', qs.stringify({ 'bar': 123 }));
Или по-другому (ES6),
import qs from 'qs';
const data = { 'bar': 123 };
const options = {
method: 'POST',
headers: { 'content-type': 'application/x-www-form-urlencoded' },
data: qs.stringify(data),
url,
};
axios(options);
Node.js
В node.js вы можете использовать модуль строки запроса, как показано ниже:
const querystring = require('querystring');
axios.post('http://something.com/', querystring.stringify({ foo: 'bar' }));
Вы также можете использовать библиотеку qs.
Semver
Критические изменения будут выпущены в новой минорной версии до того, как axios достигнет версии 1.0. Например, в версиях 0.5.1 и 0.5.4 будет один и тот же API, но в версии 0.6.0 будут критические изменения.
Promises
axios опирается на собственные реализации ES6 Promise иподдерживается, Если ваша среда не поддерживает обещания ES6, вы можете использоватьpolyfill. ##3 Машинопись axios включает определения TypeScript.
import axios from 'axios';
axios.get('/user?ID=12345');
ресурс
Credits
axios во многом вдохновлен сервисом $http, предоставляемым Angular. В конечном счете, axios — это автономный $http-подобный сервис для использования вне Angular.
2 Применение аксиом в проекте
/**
* 全站http配置
*
* axios参数说明
* isSerialize是否开启form表单提交
* isToken是否需要token
*/
import axios from 'axios'
import store from '@/store/';
import router from '@/router/router'
import { serialize } from '@/util/util'
import {getToken,getRoleTitle} from '@/util/auth' // 获取相对应的权限
import {Message} from 'element-ui' // 调用弹窗组件
import website from '@/config/website'; // statusWhiteList 通过此处，获取白名单，默认[400]
import NProgress from 'nprogress' // progress bar vue中的进度条
import 'nprogress/nprogress.css' // progress bar style
import Cookies from 'js-cookie'
axios.defaults.timeout = 20000; // 设置超时时间
// 返回其他状态吗
// 定义对于给定的HTTP 响应状态码是 resolve 或 reject promise 。
// 如果 `validateStatus` 返回 `true` (或者设置为 `null` 或 `undefined`)，
// promise 将被 resolve; 否则，promise 将被 rejecte
axios.defaults.validateStatus = function (status) {
return status >= 200 && status <= 500; // 默认的
};
//跨域请求，允许保存cookie
axios.defaults.withCredentials = true;
// NProgress Configuration
// 通过设置为false关闭加载旋转器。(默认值是ture)
NProgress.configure({
showSpinner: false
});
//HTTPrequest拦截-添加请求拦截器
axios.interceptors.request.use(config => {
NProgress.start() // start progress bar 加载器开始加载
const meta = (config.meta || {}); //
const isToken = meta.isToken === false;
if (getToken() && !isToken) {
config.headers['Admin.Authority.Token.cashloan'] = getToken();
// 'Bearer ' + getToken() // 让每个请求携带token--['Authorization']为自定义key 请根据实际情况自行修改
}
//headers中配置serialize为true开启序列化 是否开启form表单提交
if (config.methods === 'post' && meta.isSerialize === true) {
config.data =config.data => {
let list = [];
Object.keys(data).forEach(ele => {
list.push(`${ele}=${data[ele]}`)
})
return list.join('&');
};
}
return config
}, error => {
return Promise.reject(error)
});
//HTTPresponse拦截-添加响应拦截器
axios.interceptors.response.use(res => {
NProgress.done(); // 进度条关闭
const status = Number(res.status) || 200; // 返回值必须是200
const statusWhiteList = website.statusWhiteList || []; // 白名单 400
const message = res.data.message || '未知错误'; // 确定的返回值或者是'未知错误'
const code = res.data.code
if (code === 11002) {
Message({
message,
type: "error"
})
}
if (code === 10004) {
Message({
message: "有另一台设备登录",
type: 'error'
})
store.dispatch('FedLogOut').then(() => router.push({
path: '/login'
}));
}
if (code === 10001) {
Message({
message: "请重新登录",
type: 'error'
})
Cookies.set('loading', true)
store.dispatch('FedLogOut').then(() => router.push({
path: '/login'
}));
}
if (code === 10002) {
Message({
dangerouslyUseHTMLString: true,
message: `接口为${res.request.custom.url}</br></br>${getRoleTitle()}没有权限`,
type: 'error'
})
}
if (code === 10003) {
Message({
dangerouslyUseHTMLString: true,
message,
type: 'error'
})
}
if (code === 404) {
Message({
dangerouslyUseHTMLString: true,
message: `接口为${res.request.custom.url}</br></br>${JSON.stringify(res.data)}`,
type: 'error'
})
}
if (code === 400) {
if (res.data.message.includes('/')) {
Message({
dangerouslyUseHTMLString: true,
message: message.split('/')[1],
type: 'error'
})
return
}
Message({
dangerouslyUseHTMLString: true,
message: `${JSON.stringify(res.data)}`,
type: 'error'
})
}
if (code === 500) {
if(!res.data.message.includes("TIMEOUT")){
Message({
dangerouslyUseHTMLString: true,
message:`服务器故障，请稍后重试`,
// message: `接口为${res.request.custom.url}</br></br>${JSON.stringify(res.data)}`,
type: 'error'
})
}
}
//如果在白名单里则自行catch逻辑处理
if (statusWhiteList.includes(status)) return Promise.reject(res);
//如果是401则跳转到登录页面
if (status === 401) store.dispatch('FedLogOut').then(() => router.push({ path: '/login' }));
// 如果请求为非200否者默认统一处理
if (status !== 200) {
Message({
message: message,
type: 'error'
})
return Promise.reject(new Error(message))
}
return res;
}, error => {
NProgress.done();
return Promise.reject(new Error(error));
})
export default axios;