快速学会 Vue-Axios

Vue-Axios

除去jQuery所提供的异步通信ajax方法，在Vue中也提供了ajax的异步通信方法，叫做axios

通过axios可以像ajax一样很轻松的完成前后端数据的交互，脚手架中也推荐使用axios进行请求

安装axios

shell 复制代码

npm install axios --save

axios默认会将后端返回的数据进行json格式的解析

js 复制代码

import axios from "axios"
axios.get('/get_ajax/', 
    {
    	params: { // 这部分为get方式进行传参时使用的
        id: 123}
    // /get_ajax/?id=123
}).then(res => { // 打印输出get方式进行ajax请求时获取到的数据
    console.log(res) 
}).catch(err => { // 当get方式ajax请求报错时，会进入该函数
    console.log(err) 
})

如果希望通过post提交数据，可以

js 复制代码

axios.post('/user', {
    account: 'admin',
    password: '123456'
}).then(res => {
    console.log(res);
}).catch(err => {
    console.log(err);
});

或者直接通过axios对象进行请求，在对象中声明请求方式及其他属性

js 复制代码

axios({
  method: 'POST',
  url: '/login', // 接口地址
  data: {
    account: 'admin',
    password: '123456'
  }
}).then(res=>{
    ...
})

请求实例

在实际开发过程中，经常需要对请求进行封装，比如定义全局的请求域名，区分开发、测试等环境

那么可以使用axios.create方法进行axios实例对象的初始化

js 复制代码

const instance = axios.create({
  baseURL: 'https://some-domain.com/api/',
  timeout: 1000,
  headers: {'X-Custom-Header': 'foobar'}
});
// axios.post !
// instance.get

js 复制代码

const service = axios.create({
  // baseURL: 'http://localhost:8000', // 本地环境
  baseURL: 'http://dev.com/', // 测试环境
  // baseURL: 'http://prod.com', // 正式环境
  timeout: 500000 // request timeout
})

请求配置

摘自: www.axios-js.com/zh-cn/docs/

js 复制代码

{
  url: '/user', // `url` 是用于请求的服务器 URL
  method: 'get', // `method` 是创建请求时使用的方法，默认GET

  // `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: {}
}

请求回调

通过上面的示例，两个常用的axios回调方法已经清晰可见

当请求成功时

js 复制代码

.then(res=>{
    this.data = res.data
})

请求失败

js 复制代码

.catch(err=>{
    console.log(err)
})

请求响应

在回调方法中，比如.then回调方法获取到的res对象，其中还支持如下属性可以获取

其中data属性是我们最常用的，而status等属性是为了进行更为细化的请求流程控制判断

js 复制代码

{
  // `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: {}
}

全局配置

axios处理定义axios.create的实例对象，也可以设置全局的配置默认值

js 复制代码

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';

拦截器

axios提供了拦截器方法，可以在请求的生命过程中进行干预控制

请求拦截器

js 复制代码

// 添加请求拦截器
axios.interceptors.request.use(function (config) {
    // 在发送请求之前做些什么
    return config;
}, function (error) {
    // 对请求错误做些什么
    return Promise.reject(error);
});

比如经常需要在请求前，加入类似JWT等的头部字段，免去在每次请求时添加的繁琐，可以这样

js 复制代码

axios.interceptors.request.use(config => {
  let token = localStorage.getItem('token'); // token 存储地址
  console.log(token)
  if (token) {
    config.headers.common['Authorization'] = "JWT " + token // 头部设置
  }
  return config;
}, error => {
  console.log(error)
  return Promise.reject(error);
});

响应拦截器

js 复制代码

axios.interceptors.response.use(function (response) {
    // 对响应数据做点什么
    return response;
}, function (error) {
    // 对响应错误做点什么
    return Promise.reject(error);
});

比如在响应状态码为401时，这很明显是缺乏了认证缓解，那么可以重定向页面至认证页面，比如login

js 复制代码

axios.interceptors.response.use(response => {
  return response;
}, error => {
  console.log(error.request.response)
  if (error.request.status == 401) {
    window.location.href = "/login"
  }
  return error
});

请求封装

为了更好的管理项目代码，构建合理的结构框架，我们常常需要对请求进行封装，在组件处不会大规模的编写axios.get...axios.post..

首先可以在项目目录下定义http目录，在其中封装基本的axios请求

js 复制代码

// ./http/request.js
const axios = require('axios')

axios.defaults.baseURL = 'http://127.0.0.1:8000' // 请求的接口主域名
axios.defaults.timeout = 10000 // 请求超时的设置 10s

如果有必要，可以参考上节对请求进行拦截

接下来封装基本的请求函数

js 复制代码

/**
 * post方法，对应post请求
 * @param {String} url [请求的url地址]
 * @param {Object} params [请求时携带的参数]
 * @param {Object} headers [请求时的头部]
 **/
export function get(url, params, headers) {
  return new Promise((resolve, reject) => {
    axios.get(url, {params, headers}).then(res => {
      resolve(res)
    }).catch(err => {
      reject(err)
    })
  })
}

如果某些组件页面需要请求数据，那么可以额外定义api文件，用以封装请求

js 复制代码

// ./http/api.js
import {get, post, put, del} from './index'

/**
 * 注册接口
 * @parameter: {username:username, phone:phone} [object]
 */
export const signUp = parameter => {
  return post(
    'signup/',
    parameter,
  )
}

在需要使用的组件处，导入使用即可，记得是在组件的script中

js 复制代码

// views/Sigin.vue
import { signUp } from '@/http/api'
methods:{
    signup(){
        signUp({
            account: this.account
            ...
        }).then(res=>{
            ...
        })
    }
}