Vue 搭配 Axios 进行 Ajax 请求
  WebVue   0 评论

Vue 搭配 Axios 进行 Ajax 请求

  WebVue   0 评论

安装

npm install axios -S

配置

使用

Axios 的 API

通过配置(config)来发送请求

  1. axios(config)

    // 发送一个`POST`请求
    axios({
       method: 'POST',
       url: '/user/12345',
       data:{
           firstName: 'Fred',
           lastName: 'Flintstone'
       }
    })
  2. axios(url[,config])

    // 发送一个`GET`请求(默认的请求方式)
    axios('/user/12345')

请求方式的别名

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]])

并发请求(concurrency)

// iterable是一个可以迭代的参数如数组等
axios.all(iterable)
// callback要等到所有请求都完成才会执行
axios.spread(callback)

创建一个 axios 实例,并且自定义其配置

  1. axios.create([config])

    var instance = axios.create({
     baseURL: 'https://some-domain.com/api/',
     timeout: 1000,
     headers: {'X-Custom-Header': 'foobar'}
    })
  2. 实例的方法

    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` 是请求的服务器地址
  url: '/user',
  // `method` 是请求资源的方式
  method: 'get' //default
  // 如果 `url` 不是绝对地址,那么 `baseURL` 将会加到 `url` 的前面
  // 当 `url` 是相对地址的时候,设置`baseURL`会非常的方便
  baseURL: 'https://some-domain.com/api/',
  // `transformRequest` 选项允许我们在请求发送到服务器之前对请求的数据做出一些改动
  // 该选项只适用于以下请求方式: `put/post/patch`
  // 数组里面的最后一个函数必须返回一个字符串、-一个 `ArrayBuffer` 或者 `Stream`
  transformRequest:[function(data){
    // 在这里根据自己的需求改变数据
    return data;
  }],
  // `transformResponse` 选项允许我们在数据传送到 `then/catch` 方法之前对数据进行改动
  transformResponse:[function(data){
    // 在这里根据自己的需求改变数据
    return data;
  }],
  // `headers` 选项是需要被发送的自定义请求头信息
  headers: {'X-Requested-With': 'XMLHttpRequest'},
  // `params` 选项是要随请求一起发送的请求参数----一般链接在URL后面
  // 他的类型必须是一个纯对象或者是URLSearchParams对象
  params: {
    ID: 12345
  },
  // `paramsSerializer`是一个可选的函数,起作用是让参数(params)序列化
  // 例如(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` 选项时dada必须是以下几种类型之一
  // string/plain/object/ArrayBuffer/ArrayBufferView/URLSearchParams
  // 仅仅浏览器: FormData/File/Bold
  // 仅node: Stream
  data {
    firstName: 'Fred'
  },
  // `timeout`选项定义了请求发出的延迟毫秒数
  // 如果请求花费的时间超过延迟的时间,那么请求会被终止

  timeout:1000,
  // `withCredentails` 选项表明了是否是跨域请求

  withCredentials: false, // default
  // `adapter` 适配器选项允许自定义处理请求,这会使得测试变得方便
  // 返回一个promise,并提供验证返回
  adapter: function (config) {
    /*..........*/
  },
  // `auth` 表明HTTP基础的认证应该被使用,并提供证书
  // 这会设置一个authorization头(header),并覆盖你在header设置的Authorization头信息
  auth: {
    username: 'zhangsan',
    password: 's00sdkf'
  },
  // 返回数据的格式
  // 其可选项是arraybuffer,blob,document,json,text,stream
  responseType: 'json', // default
  xsrfCookieName: 'XSRF-TOKEN', // default
  xsrfHeaderName: 'X-XSRF-TOKEN', // default
  // `onUploadProgress` 上传进度事件
  onUploadProgress: function (progressEvent) {
  },
  // 下载进度的事件
  onDownloadProgress: function (progressEvent) {
  },
  //相应内容的最大值
  maxContentLength: 2000,
  // `validateStatus`定义了是否根据http相应状态码,来resolve或者reject promise
  // 如果`validateStatus`返回true(或者设置为`null`或者`undefined`),那么promise的状态将会是resolved,否则其状态就是rejected
  validateStatus: function (status) {
    return status >= 200 && status <300; // default
  },
  // `maxRedirects`定义了在nodejs中重定向的最大数量
  maxRedirects: 5, // default
  // `httpAgent/httpsAgent`定义了当发送http/https请求要用到的自定义代理
  // keeyAlive在选项中没有被默认激活
  httpAgent: new http.Agent({keeyAlive: true}),
  httpsAgent: new https.Agent({keeyAlive: true}),
  // proxy定义了主机名字和端口号,
  // `auth`表明http基本认证应该与proxy代理链接,并提供证书
  // 这将会设置一个`Proxy-Authorization` header,并且会覆盖掉已经存在的`Proxy-Authorization`  header
  proxy: {
    host: '127.0.0.1',
    port: 9000,
    auth: {
      username: 'skda',
      password: 'radsd'
    }
  },
  // `cancelToken`定义了一个用于取消请求的cancel token
  // 详见cancelation部分
  cancelToken: new cancelToken(function (cancel) {

  })
}

返回数据格式

{
  data: {},
  status: 200,
  // 从服务器返回的http状态文本
  statusText: 'OK',
  // 响应头信息
  headers: {},
  // `config`是在请求的时候的一些配置信息
  config: {}
}

默认配置

全局默认配置

axios.defaults.baseURL = 'http://api.exmple.com'
axios.defaults.headers.common['Authorization'] = AUTH_TOKEN
axios.defaults.headers.post['content-Type'] = 'appliction/x-www-form-urlencoded'

自定义的实例默认设置

//当创建实例的时候配置默认配置
var instance = axios.create({
    baseURL: 'https://api.example.com'
})

//当实例创建时候修改配置
instance.defaults.headers.common['Authorization'] = AUTH_TOKEN

配置中的有优先级

// 创建一个实例的时候会使用libray目录中的默认配置
// 在这里timeout配置的值为0,来自于libray的默认值
var instance = axios.create()
// 回覆盖掉library的默认值
// 现在所有的请求都要等2.5S之后才会发出
instance.defaults.timeout = 2500
// 这里的timeout回覆盖之前的2.5S变成5s
instance.get('/longRequest', {
  timeout: 5000
})

拦截器

取消拦截器

var myInterceptor = axios.interceptor.request.use(function () {/*....*/})
axios.interceptors.request.eject(myInterceptor)

给自定义的axios实例添加拦截器

var instance = axios.create()
instance.interceptors.request.use(function () {})

错误处理

axios.get('/user/12345')
  .catch(function (error) {
    if (error.response) {
      // 请求已经发出,但是服务器响应返回的状态吗不在2xx的范围内
      console.log(error.response.data)
      console.log(error.response.status)
      console.log(error.response.header)
    } else {
      // 一些错误是在设置请求的时候触发
      console.log('Error', error.message)
    }
    console.log(error.config)
  })

取消请求

参考来源

回复