技术文章
当前位置:首页 > vue.js技术文章 > 详解vue axios中文文档

vue axios中文文档知识点概述

  • 发布时间:
  • 作者:码农之家原创
  • 点击:82

这篇文章主要知识点是关于vue、axios、中文文档、vue axios整合使用全攻略 的内容,如果大家想对相关知识点有系统深入的学习,可以参阅以下电子书

Vue.js快速入门
  • 类型:Web前端大小:186.6 MB格式:PDF出版:清华大学出版社作者:申思维
立即下载

更多Vue相关的学习资源可以参阅 Vue电子书程序设计电子书 等栏目。

详解vue axios中文文档

axios中文文档

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

原文地址 : https://github.com/mzabriskie/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(){/*...*

vue axios整合使用全攻略

惯例先安装axios,不多说!

cnpm install axios

1.axios配置

 我的目录结构src/axios/index.js,axios配置都在该文件下

src/axios/index.js 如下:

import axios from 'axios'
import qs from 'qs'
// axios 配置
axios.defaults.timeout = 5000;
axios.defaults.headers.post['Content-Type'] = 'application/x-www-form-urlencoded;charset=UTF-8';
axios.defaults.baseURL = 'http://localhost:8008';

拦截器,axios.interceptors.request.use发送请求前处理

axios.interceptors.response.use接受返回后,回调之前处理处理

//POST传参序列化
axios.interceptors.request.use((config) => {
 if(config.method === 'post'){
  config.data = qs.stringify(config.data);
 }
 return config;
},(error) =>{
 return Promise.reject(error);
});
//返回状态判断
axios.interceptors.response.use((res) =>{
 if(!res.data.success){
  return Promise.reject(res);
 }
 return res;
}, (error) => {
 //404等问题可以在这里处理
 return Promise.reject(error);
});

公共方法:

export function fetch(url, params) {
 return new Promise((resolve, reject) => {
  axios.post(url, params)
   .then(response => {
    resolve(response.data);
   }, err => {
    reject(err);
   })
   .catch((error) => {
    reject(error)
   })
 })
}

业务方法:

export default {
 getAddressJson() {
  return fetch('/address/',{addressId:1})
 }
}

如果不理解可以将以上代码依次copy到src/axios/index.js文件,当然axios.defaults.baseURL = 'http://localhost:8008'; 需要换成自己的api。

2全局注册axios

为了使用axios,在各个组件中引入就可以使用:

import axios from './axios'

但是使用这种方法我们需要在每一个组件中去引入,有些麻烦,下面我们介绍一种全局注册的方法。

在main.js中:

import axios from './axios'
Vue.prototype.$axios = axios

添加这两行代码,将 axios 改写为 Vue 的原型属性,这样在各个组件中都可以使用axios,具体方法如下:

 submitForm () {    
   this.$axios.getAddressJson().then(function (res) {
  //成功之后处理逻辑
    console.log(res)
   },function (res) {
    //失败之后处理逻辑
    console.log("error:"+res)
   })
  }

总结

以上所述是小编给大家介绍的vue axios整合使用全攻略,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对码农之家网站的支持!

以上就是本次给大家分享的关于Vue的全部知识点内容总结,大家还可以在下方相关文章里找到vue-cli开发时ajax跨域的方法、 elementUI table表格动态合并、 Vue2.0利用 v-model 实现组件、 等vue.js文章进一步学习,感谢大家的阅读和支持。

上一篇:element-ui中的select下拉列设置的实例代码

下一篇:vue给input file绑定函数获取当前上传的方法

展开 +

收起 -

相关电子书
学习笔记
网友NO.404861

vue+element-ui+axios实现图片上传

本文实例为大家分享了vue+element-ui+axios实现图片上传的具体代码,供大家参考,具体内容如下 !DOCTYPE htmlhtmlheadmeta charset="utf-8"meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"titleExamples/titlemeta name="description" content=""meta name="keywords" content=""!-- 引入vue --script src="https://cdn.jsdelivr.net/npm/vue"/script!-- 引入axios --script src="https://unpkg.com/axios/dist/axios.min.js"/script!-- 引入样式 --link rel="stylesheet" href=https://unpkg.com/element-ui/lib/theme-chalk/index.css !-- 引入组件库 --script src="https://unpkg.com/element-ui/lib/index.js"/script/headbody div id="app" el-upload :action="posterUrl" :before-upload="beforeUpload" :http-request="(params)=uploadImage(params)" :on-remove="(file, fileList)=removeImage(file, fileList)" list-type="picture" accept="image/*" el-button size="small"选择图片/el-button /el-upload /div script type="text/javascript" new Vue({ el: '#app', data: { posterUrl: '', im……

网友NO.783397

vue axios 二次封装的示例代码

这段时间告诉项目需要,用到了vue。 刚开始搭框架的时候用的是vue-resource后面看到官方推荐axios就换过来了 顺便封装了一下 //引入axiosimport axios from 'axios'let cancel ,promiseArr = {}const CancelToken = axios.CancelToken;//请求拦截器axios.interceptors.request.use(config = { //发起请求时,取消掉当前正在进行的相同请求 if (promiseArr[config.url]) { promiseArr[config.url]('操作取消') promiseArr[config.url] = cancel } else { promiseArr[config.url] = cancel } return config}, error = { return Promise.reject(error)})//响应拦截器axios.interceptors.response.use(response = { return response}, error = { return Promise.resolve(error.response)})axios.defaults.baseURL = '/api'//设置默认请求头axios.defaults.headers = { 'X-Requested-With': 'XMLHttpRequest'}axios.defaults.timeout = 10000export default { //get请求 get (url,param) { return new Promise((resolve,reject) = { axios({ method: 'get', url, params: param, can……

网友NO.281680

vue项目中axios使用详解

axios在项目中(vue)的使用 没有vue项目的使用vue-cli脚手架生成一个webpack模板的项目即可愉快的看下去了~ 如果开发遇到跨域问题可以参考://www.jb51.net/article/134571.htm 安装axios到项目中 npm install axios --save 配置wepack别名,不同环境访问不同的配置接口 配置: 使用: import config from 'config' 封装一个axios实例 新建 fetch.js ,在此创建axios实例与过滤器 若配置了代理。则config.apiBaseUrl则配置代理的前缀即可 import config from 'config'import axios from 'axios'// import qs from 'qs';const instance = axios.create({ baseURL: config.apiBaseUrl, // api的base_url timeout: 10000, // 请求超时时间 // transformRequest: data = qs.stringify(data) }); axios默认提交格式为: application/json ,转换后提交格式为 application/x-www-form-urlencoded 在asp.net core中,需要在action方法上添加 [FromBody] 接收json格式的数据,正常的都是 application/x-www-for……

网友NO.775611

vue+axios+element ui 实现全局loading加载示例

实现全局loading加载 分析需求,我们只需要在请求发起的时候开始loading,响应结束的时候关闭loading,就这么简单 对不对? import axios from 'axios';import { Message, Loading } from 'element-ui';import Cookies from 'js-cookie';import router from '@/router/index'let loading //定义loading变量function startLoading() { //使用Element loading-start 方法 loading = Loading.service({ lock: true, text: '加载中……', background: 'rgba(0, 0, 0, 0.7)' })}function endLoading() { //使用Element loading-close 方法 loading.close()}//那么 showFullScreenLoading() tryHideFullScreenLoading() 要干的事儿就是将同一时刻的请求合并。//声明一个变量 needLoadingRequestCount,每次调用showFullScreenLoading方法 needLoadingRequestCount + 1。//调用tryHideFullScreenLoading()方法,needLoadingRequestCount - 1。needLoadingRequestCount为 0 时,结束 loading。let needLoadingRequestCount = 0export function showFullScreenLoading(……

Copyright 2018-2020 xz577.com 码农之家

电子书资源由网友、会员提供上传,本站记录提供者的基本信息及资源来路

鸣谢: “ 码小辫 ” 公众号提供回调API服务、“ 脚本CDN ”提供网站加速(本站寻求更多赞助支持)

版权投诉 / 书籍推广 / 赞助:520161757@qq.com

上传资源(网友、会员均可提供)

查看最新会员资料及资源信息