axios,vue-axios在项目中的应用
Axios 是一个基于 promise 的 HTTP 库,可以用在浏览器和 node.js 中
关于axios的功能:
1,从浏览器中创建XMLHttpRequests
2,从node.js常见Http请求
3,支持Promise API
4,拦截请求和响应
5,转换请求数据和响应数据
6,取消请求
7,自动转换JSON数据
8,客户端支持防御XSRF
安装:
使用node.js自带的npm:
$ npm install axios
如果是vue项目:
$ npm install vue-axios --save
vue项目axios配置:
在mian.js中配置如下代码:
import Vue from 'vue' import axios from 'axios' import VueAxios from 'vue-axios'Vue.use(VueAxios, axios)
同也可以直接全局引入cdn:
<script src="https://unpkg.com/axios/dist/axios.min.js"></script>
GET:
axios.get('/user?ID=123').then( res => {// 请求数据成功并返回数据 console.info(res)}).catch( err => {if (e.response) {// 请求已发出,服务器返回状态码不是 2xx console.info(err.response.data)console.info(err.response.status)console.info(err.response.headers)} else if (err.request) {// 请求已发出,但没有收到响应// e.request 在浏览器里是一个 XMLHttpRequest 实例// 在 node 中是一个 http.ClientRequest 实例 console.info(err.request)} else {// 发送请求时异常,捕获到错误console.info('error', err.message)}console.info(err.config)})// 等同于以下写法 axios({url: '/user',methods: 'GET',params: {ID: 123}}).then(res => {console.info(res)}).catch(err => {console.info(err)})// 为给定 ID 的 user 创建请求axios.get('/user?ID=12345').then((response)=> {console.log(response);}).catch((error)=> {console.log(error);});// 可选地,上面的请求可以这样做axios.get('/user', {params: {ID: 12345}}).then((response)=> {console.log(response);}).catch((error)=> {console.log(error);});
POST:
axios.post('/user', {firstName: 'Mike',lastName: 'Allen'}).then(res => {console.info(res)}).catch(err => {console.info(err)})// 等同于以下写法 axios({url: '/user',method: 'POST',data: {firstName: 'Mike',lastName: 'Allen'}}).then(res => {console.info(res)}).catch(err => {console.info(err)})axios.post('/user', {firstName: 'Fred',lastName: 'Flintstone'}).then( (res)=> {console.log(res);}).catch( (err)=> {console.log(err);});
执行多个并发请求:
function getUserAccount() {return axios.get('/user/12345');}function getUserPermissions() {return axios.get('/user/12345/permissions');}axios.all([getUserAccount(), getUserPermission()]).then(axios.spread(function (acct, perms) {// 两个请求现在都执行完成}));
注意事项:
在使用 GET
方法传递参数时使用的是 params
,并且官方文档中介绍:
params are the URL parameters to be sent with the request. Must be a plain object or a URLSearchParams object.
params
作为 URL 链接中的参数发送请求,且其必须是一个 plain object
或者是 URLSearchParams object
。
plain object
(纯对象):是指JSON
形式定义的普通对象或者new Object()
创建的简单对象;URLSearchParams object
:指的是一个可以由 URLSearchParams 接口定义的一些实用方法来处理 URL 的查询字符串的对象,也就是说params
传参是以/user?ID=1&name=mike&sex=male
形式传递的。
而在使用 POST
时对应的传参使用的是 data
,data
是作为 请求体 发送的,同样使用这种形式的还有 PUT
、PATCH
等请求方法。有一点需要注意的是,axios
中 POST
的默认请求体类型为 Content-Type:application/json
(JSON 规范流行),这也是最常见的请求体类型,也就是说使用的是序列化后的 json
格式字符串来传递参数,如: { "name" : "mike", "sex" : "male" }
;同时,后台必须要以支持 @RequestBody
的形式来接收参数,否则会出现前台传参正确,后台不接收的情况。
如果想要设置类型为 Content-Type:application/x-www-form-urlencoded
(浏览器原生支持),axios
提供了两种方式,如下:
浏览器端
const params = new URLSearchParams();params.append('param1', 'value1');params.append('param2', 'value2');axios.post('/user', params);
不过,并不是所有浏览器都支持 URLSearchParams
,兼容性查询caniuse.com,但是这里有一个Polyfill(polyfill
:用于实现浏览器并不支持的原生 API 的代码,可以模糊理解为补丁,同时要确保 polyfill
在全局环境中)
或者,你也可以用 qs
这个库来格式化数据,默认情况下在安装完 axios
后就可以使用 qs
库。
const qs = require('qs');axios.post('/user', qs.stringify({'name': 'mike'}));
node 层
在 node
环境中可以使用 querystring
。同样,也可以使用 qs
来格式化数据。
const querystring = require('querystring');axios.post('http://something.com/', querystring.stringify({'name':'mike'}));
axios API
请求方法的别名:
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
、methods
、data
这些属性都不必在配置中指定。
并发
axios.all(iterable) axios.spread(callback)
创建实例
axios.create([config])
var instance = axios.create({baseURL: 'https://something.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` 是用于请求的服务器 URLurl: '/user',// `method` 是创建请求时使用的方法method: 'get', // 默认是 get // `baseURL` 将自动加在 `url` 前面,除非 `url` 是一个绝对 URL。// 它可以通过设置一个 `baseURL` 便于为 axios 实例的方法传递相对 URLbaseURL: 'https://some-domain.com/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: {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, // 默认的 // `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', // 默认的 // `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// (查看后面的 Cancellation 这节了解更多)cancelToken: new CancelToken(function (cancel) {})}6 - 响应结构 某个请求的响应包含以下信息:{// `data` 由服务器提供的响应 data: {},// `status` 来自服务器响应的 HTTP 状态码status: 200,// `statusText` 来自服务器响应的 HTTP 状态信息statusText: 'OK',// `headers` 服务器响应的头 headers: {},// `config` 是为请求提供的配置信息 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
时,或传递 rejection callback 作为 then
的第二个参数时,响应可以通过 error
对象可被使用,正如在错误处理这一节。
全局的 axios 默认值
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;
配置的优先顺序
// 使用由库提供的配置的默认值来创建实例// 此时超时配置的默认值是 `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);});
如果你想在稍后移除拦截器,可以这样:
var myInterceptor = axios.interceptors.request.use(function () {/*...*/});axios.interceptors.request.eject(myInterceptor);
可以为自定义 axios 实例添加拦截器:
var instance = axios.create();instance.interceptors.request.use(function () {/*...*/});
转载于:https://www.cnblogs.com/fengrenfan/p/10740495.html
axios,vue-axios在项目中的应用相关推荐
- axios nodejs 上传图片_vue项目中使用axios上传图片等文件操作
axios 简介 axios 是一个基于Promise 用于浏览器和 nodejs 的 HTTP 客户端,它本身具有以下特征: 从浏览器中创建 XMLHttpRequest 从 node.js 发出 ...
- Mock.js和axios在vue-cli创建项目中的使用
背景 由于大觅项目采用的是前后端完全分离的方式,实现前后端环境的分离开发,这样不仅能提高开发效率,还能减少服务器直接的互相影响,同时能保证数据安全等.但是随之而来的问题也比较明显,前端如何进行快速的开 ...
- axios vue 回调函数_vue中ajax请求与axios包完美处理
这次给大家带来vue中ajax请求与axios包完美处理,vue中ajax请求与axios包处理的注意事项有哪些,下面就是实战案例,一起来看一下. 在vue中,经常会用到数据请求,常用的有:vue-r ...
- axios vue 回调函数_vue中的ajax请求和axios包详解
在vue中,经常会用到数据请求,常用的有:vue-resourse.axios 首先,引入axios CDN: npm: npm install axios 并在全局的js中引入:import axi ...
- vue导入swiper_vue项目中导入swiper插件的方法
这篇文章主要为大家详细介绍了vue项目中导入swiper插件的方法,具有一定的参考价值,可以用来参考一下. 感兴趣的小伙伴,下面一起跟随512笔记的小编两巴掌来看看吧! 版本选择 swiper是个常用 ...
- vue移动端项目中统一滚动条样式与效果
写在前面 原生的滚动条安卓端与苹果端有诸多不一样的地方,在我们的用户体验中,自然是想统一用户体验,而最常见的滚动条必然是要考虑在其中的,这篇文章主要是介绍vue项目中插件better-scroll的使 ...
- SpringBoot+Vue博客项目中遇到的坑
shiro整合jwt,用于用户登录逻辑流程: 登录流程: 用户登录:输入用户名和密码–>后端校验: –>有异常:处理异常 –>正常,生成jwt 访问接口时,统一被jwtFilter, ...
- Vue电商项目中遇到的一些问题
1.为什么vue组件有的写成export default,有什么用? 声明一个vue,相当于 new Vue({}) 达到可复用的目的,也就是说,export default 相当于导出当前vue组件 ...
- js定义全局变量 vue页面_vue项目中定义全局变量、函数的几种方法
前言 在项目中,经常会复用一些变量和函数,比如用户的登录token,用户信息等.这时将它们设为全局的就显得很重要了,全局变量和全局函数之间有一些相通之处,它们其实很简单,但是有些人可能还不太了解.简单 ...
最新文章
- console的高级使用
- 计算机科学与教育信息化国际会议,A Courses Ontology System for Computer Science Education...
- poj3264Balanced Lineup(倍增ST表)
- “牛津第一,16岁上大学”,中国美女学霸被骂学术媛?学术人“光鲜亮丽”就是错?...
- hdu 1811Rank of Tetris (并查集 + 拓扑排序)
- 字符串转码中文乱码问题的进一步理解 UTF-8 GBK转码
- 西电计科《算法分析与设计》上机(源码+实验报告+历次作业)(渗透问题+排序算法性能比较+地图路由+文本索引)(2019级 霍红卫老师)
- buuctf [GhostScript]CVE-2018-16509
- 7-1 厘米换算英尺英寸 (c语言)
- 【ARM基础概念:ARMv7架构,ARM(ARM7、ARM9)、Cortex-M4、M7等内核、MCU、MPU、SOC,STM32的一些概念】
- 设置gradle远程仓库_Gradle 创建java项目详细步骤
- 新安装的福昕阅读器总是弹出“文件安全进程防护”
- 用Python画大学物理实验曲线
- 杭州电子科技大学acm--2019
- zookeeper 分布式barrier
- 数据中心服务器机柜电气参数,数据中心服务器机柜一些安装与参数
- 字典制作工具-创建自己的密码字典文件
- arcmap中的几个实用插件----加载互联网地图影像
- 基于 phpCMS 企业建站流程
- transmac使用方法_如何使用TransMac制作Mac启动盘?TransMac使用说明