axios使用详解+axios二次封装

axios 使用详情

axios 安装注册

axios 安装

npm install axios

axios 注册

main.js 入口文件

import axios from 'axios' // 导入axios
Vue.prototype.$axios = axios // 将axios挂载到Vue实例上

axios GET,POST 请求

GET 请求

this.$axios
  .get('/user?ID=12345')
  .then((res) => {
    console.log(res)
  })
  .catch((err) => {
    console.log(err)
  })

const params = { ID: 12345 }
this.$axios
  .get('/user', params)
  .then((res) => {
    console.log(res)
  })
  .catch((err) => {
    console.log(err)
  })

POST 请求

const data = {
  firstName: 'Fred',
  lastName: 'Flintstone',
}
this.$axios
  .post('/user', data)
  .then((res) => {
    console.log(res)
  })
  .catch((err) => {
    console.log(err)
  })

axios API GET,POST 请求

【注意】get 请求使用 params 传参,post 请求使用 data 传参

GET 请求

this.$axios({
  method: 'get',
  url: '/user/12345',
  params: {
    firstName: 'Fred',
    lastName: 'Flintstone',
  },
})
this.$axios({
  method: 'get',
  url: '/user/12345',
})

POST 请求

this.$axios({
  method: 'post',
  url: '/user/12345',
  data: {
    firstName: 'Fred',
    lastName: 'Flintstone',
  },
})

自定义 axios 实例，统一配置请求响应

自定义 axios 实例

const baseUrl:'http://localhost:8080'
const baseApi:'/lba/inner/manager'
const uploadUrl:'http://localhost:8080/lba/inner/manager/file/upload'
const downloadUrl:'http://localhost:8080/lba/inner/manager/file/downloadUrl'
// 创建axios实例
const instance=axios.create({
    baseURL:${baseUrl}${baseApi},
    withCredentials:false,
    timeout:60000
})

创建请求时可用的配置：

{
  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) {
    // 对 data 进行任意转换处理
    return data;
  }],
  transformResponse: [function (data) {// `transformResponse` 在传递给 then/catch 前，允许修改响应数据
    // 对 data 进行任意转换处理
    return data;
  }],
  headers: {'X-Requested-With': 'XMLHttpRequest'},// `headers` 是即将被发送的自定义请求头
  // `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, // 默认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) {
  })
}

axios 请求拦截

请求拦截器的主要功能：

1. 添加公共请求头
2. 数据加密
3. 设置 baseURL
4. 设置跨域请求是否使用凭证
5. 设置请求超时时间

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

axios 响应拦截

响应信息：

{
  // `data` 由服务器提供的响应
  data: {},

  // `status` 来自服务器响应的 HTTP 状态码
  status: 200,

  // `statusText` 来自服务器响应的 HTTP 状态信息
  statusText: 'OK',

  // `headers` 服务器响应的头
  headers: {},

  // `config` 是为请求提供的配置信息
  config: {}
}

响应拦截器主要功能：

1. 对响应数据 进行格式转化
2. 对响应状态码进行统一处理
   2.1 成功放行
   2.2 失败 提示失败原因
3. 对响应数据进行解密

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

axios 二次封装 与 使用

axios 二次封装

/api/http.js

import axios from 'axios'

// 创建 axios 实例
let baseUrl = '/'
if (process.env.NODE_ENV === 'production') {
  baseUrl = 'localhost:5000'
} else if (process.env.NODE_ENV === 'development') {
  baseUrl = 'localhost:5000'
}
const service = axios.create({
  baseURL: baseUrl,
  headers: {
    get: {
      'Content-Type': 'application/x-www-form-urlencoded;charset=utf-8',
    },
    post: {
      'Content-Type': 'application/json;charset=utf-8',
    },
  },
  // 是否跨站点访问控制请求
  withCredentials: false,
  timeout: 30000,
  //请求数据转换
  transformRequest: [
    (data) => {
      return JSON.stringify(data)
    },
  ],
  //相应数据转换
  transformResponse: [
    (data) => {
      if (typeof data === 'string' && data.startsWith('{')) {
        data = JSON.parse(data)
      }
      return data
    },
  ],
})

// 请求拦截器
service.interceptors.request.use(
  (config) => {
    // 让每个请求携带自定义 token
    config.headers['Authorization'] = 'token'
    return config
  },
  (error) => {
    // 错误抛到业务代码
    error.data = {}
    error.data.msg = '服务器异常，请联系管理员！'
    return Promise.resolve(error)
  },
)

// 响应拦截器
service.interceptors.response.use(
  (response) => {
    const status = response.status
    let msg = ''
    if (status < 200 || status >= 300) {
      // 处理http错误，抛到业务代码
      msg = showStatus(status)
      if (typeof response.data === 'string') {
        response.data = { msg }
      } else {
        response.data.msg = msg
      }
      //拦截异常（通知）
      Notification({
        title: '提示',
        message: msg,
        type: 'error',
      })
    }
    return response
  },
  (error) => {
    // 错误抛到业务代码
    error.data = {}
    error.data.msg = '请求超时或服务器异常，请检查网络或联系管理员！'
    return Promise.resolve(error)
  },
)

const showStatus = (status) => {
  let message = ''
  switch (status) {
    case 400:
      message = '请求错误(400)'
      break
    case 401:
      message = '未授权，请重新登录(401)'
      break
    case 403:
      message = '拒绝访问(403)'
      break
    case 404:
      message = '请求出错(404)'
      break
    case 408:
      message = '请求超时(408)'
      break
    case 500:
      message = '服务器错误(500)'
      break
    case 501:
      message = '服务未实现(501)'
      break
    case 502:
      message = '网络错误(502)'
      break
    case 503:
      message = '服务不可用(503)'
      break
    case 504:
      message = '网络超时(504)'
      break
    case 505:
      message = 'HTTP版本不受支持(505)'
      break
    default:
      message = `连接出错(${status})!`
  }
  return `${message}，请检查网络或联系管理员！`
}

export { service as axios }

统一管理接口

/api/login.js

// 登录接口
import { axios } from './axios'

const userApi = {
  login: '/api/login',
  logout: '/api/logout',
}

export function login(parameter) {
  return axios({
    url: userApi.test,
    method: 'get',
    params: parameter,
  })
}

export function logout(parameter) {
  return axios({
    url: userApi.test,
    method: 'get',
    params: parameter,
  })
}

页面中使用接口

login.vue

import {login} form '@/api/login'

login(data).then((res)=>{consloe.log(res)})