axios是一个HTTP库,我们可以使用它来便捷的发送网络请求,不需要使用繁琐的原生XMLHttpRequest,有点类似于jquery的ajax,但是我们没有必要单单为了一个$.ajax引入整个jquery,所以我们可以使用axios
axios有如下特点
通常使用 npm方式:
npm install axios
使用 cdn亦可:
<script src="https://unpkg.com/axios/dist/axios.min.js"></script>
axios.get('/user?name=xz&age=18')
.then(function (res) {
console.log(res);
})
.catch(function (error) {
console.log(error);
});
// axios使用的是promise的方式,所以我们通过then和catch来获取响应
// 默认是在2xx范围内resolve,不在2xx范围内reject,可以自行配置
// get的参数也可以使用params来添加
// 上面的请求还可以这样做
axios.get('/user',{
params:{
name:'xz',
age:18
}
})
.then(function (res) {
console.log(res);
})
.catch(function (error) {
console.log(error);
});
axios.post('/login', {
name: 'xz',
password: '123456'
})
.then(function (res) {
console.log(res);
})
.catch(function (error) {
console.log(error);
});
// 上面的方法使用的是axios提供的别名,还可以使用下面的方法来发送请求
axios({
method: 'post',
url: '/login',
data: {
name: 'xz',
password: '123456'
}
}).then(function (res) {
console.log(res);
})
.catch(function (error) {
console.log(error);
});
// 在使用别名的方法时method,url,data均无需给出
以下是所以请求时可用的配置项目,只有url是必须的参数,method没有的话默认为get
{
// `url` 是用于请求的服务器 URL
url: '/user',
// `method` 是创建请求时使用的方法
method: 'get', // 默认是 get
// `baseURL` 将自动加在 `url` 前面,除非 `url` 是一个绝对 URL。
// 它可以通过设置一个 `baseURL` 便于为 axios 实例的方法传递相对 URL
baseURL: 'https://httpServer/api/',
// `transformRequest` 允许在向服务器发送前,修改请求数据
// 只能用在 'PUT', 'POST' 和 'PATCH' 这几个请求方法
// 后面数组中的函数必须返回一个字符串,或 ArrayBuffer,或 Stream
transformRequest: [function (data) {
// 对 data 进行任意转换处理
return data;
}],
// `transformResponse` 在传递给 then/catch 前,允许修改响应数据
transformResponse: [function (data) {
// 对 data 进行任意转换处理
return data;
}],
// `headers` 是即将被发送的自定义请求头
headers: {'X-Requested-With': 'XMLHttpRequest'},
// `params` 是即将与请求一起发送的 URL 参数
// 必须是一个无格式对象(plain object)或 URLSearchParams 对象
params: {
name: 'xz',
age:18
},
// `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: {
username: 'xz',
password:123456
},
// `timeout` 指定请求超时的毫秒数(0 表示无超时时间)
// 如果请求话费了超过 `timeout` 的时间,请求将被中断
timeout: 1000,
// `withCredentials` 表示跨域请求时是否需要使用凭证
withCredentials: false, // 默认的
// `adapter` 允许自定义处理请求,以使测试更轻松
// 返回一个 promise 并应用一个有效的响应 (查阅 [response docs](#response-api)).
adapter: function (config) {
/* ... */
},
// `auth` 表示应该使用 HTTP 基础验证,并提供凭据
// 这将设置一个 `Authorization` 头,覆写掉现有的任意使用 `headers` 设置的自定义 `Authorization`头
// 用于发送basic auth格式请求头
auth: {
username: 'janedoe',
password: 's00pers3cret'
},
// `responseType` 表示服务器响应的数据类型,可以是 'arraybuffer', 'blob', 'document', 'json', 'text', 'stream'
responseType: 'json', // 默认的
// `xsrfCookieName` 是用作 xsrf token 的值的cookie的名称
xsrfCookieName: 'XSRF-TOKEN', // default
// `xsrfHeaderName` 是承载 xsrf token 的值的 HTTP 头的名称
xsrfHeaderName: 'X-XSRF-TOKEN', // 默认的
// `onUploadProgress` 允许为上传处理进度事件
onUploadProgress: function (progressEvent) {
// 对原生进度事件的处理
},
// `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; // 默认的
},
// `maxRedirects` 定义在 node.js 中 follow 的最大重定向数目
// 如果设置为0,将不会 follow 任何重定向
maxRedirects: 5, // 默认的
// `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
cancelToken: new CancelToken(function (cancel) {
})
}
{
// `data` 由服务器提供的响应
data: {},
// `status` 来自服务器响应的 HTTP 状态码
status: 200,
// `statusText` 来自服务器响应的 HTTP 状态信息
statusText: 'OK',
// `headers` 服务器响应的头
headers: {},
// `config` 是为请求提供的配置信息
config: {}
}
可以通过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';
拦截器可以让请求在发出之前或者在响应返回后被then和catch处理之前拦截下来添加自定义逻辑
// 添加请求拦截器
axios.interceptors.request.use(function (config) {
if (token) {
config.headers.Authorization =
"Bearer " + window.localStorage.getItem("token");
}
// 如果有token的记录,则统一加上bearer token格式的请求头
return config;
}, function (error) {
// 对请求错误做些什么
return Promise.reject(error);
});
// 添加响应拦截器
axios.interceptors.response.use(function (response) {
// 对响应数据做点什么
return response;
}, function (error) {
if(error.response.data.err_msg == 'token_verify_fail_error'){
alert('登录过期,请重新登录')
// 如果服务器响应结果为token错误,则统一告知用户登录过期,让用户重新登录获取token
}
return Promise.reject(error);
});
移除拦截器
var myInterceptor = axios.interceptors.request.use(function () {/*...*/});
axios.interceptors.request.eject(myInterceptor);
可以通过axios.create()方法新建一个axios实例
var instance = axios.create({
// 可以在新建时添加一些配置,也可以给新建的实例添加拦截器
baseURL: 'apiEp',
});
instance.interceptors.request.use(function () {/*...*/});
可以使用使用 cancel token 取消请求,具体方法如下
// 通过CancelToken.source 工厂方法创建 cancel token
var CancelToken = axios.CancelToken;
var source = CancelToken.source();
axios.get('/user', {
cancelToken: source.token
}).catch(function(thrown) {
if (axios.isCancel(thrown)) {
console.log('Request canceled', thrown.message);
} else {
// 处理错误
}
});
// 取消请求(message 参数是可选的)
source.cancel('Operation canceled by the user.');
// 通过传递一个 executor 函数到 CancelToken 的构造函数来创建 cancel token
var CancelToken = axios.CancelToken;
var cancel;
axios.get('/user/12345', {
cancelToken: new CancelToken(function executor(c) {
// executor 函数接收一个 cancel 函数作为参数
cancel = c;
})
});
// 取消请求
cancel();
通常会将所有的api封装至一个文件内,如果后期需要修改接口,在这个文件内修改即可,不需要在每个文件中找来找去,不过一定要注意写好注释啊!
export function orderList(){
return axios.post('order/get_order_list/')
}
// 获取订单列表
export function charge(order_id){
return axios.post('order/charge_order/',{
order_id
})
}
// 充值
export function refund(order_id){
return axios.post('order/refund_order/',{
order_id
})
}
// 退款
export function fillExpressInfo (data){
return axios.post('order/fill_express_info/',{
...data
})
}
// 填写物流信息
在对应的页面中需要哪个接口导入即可
import {orderList,charge,refund,fillExpressInfo} from api.js