欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

VueJs 搭建Axios接口请求工具

程序员文章站 2022-06-25 13:27:21
axios 简介 axios 是一个基于promise 用于浏览器和 nodejs 的 http 客户端,它本身具有以下特征: 从浏览器中创建 xmlhttpr...

axios 简介

axios 是一个基于promise 用于浏览器和 nodejs 的 http 客户端,它本身具有以下特征:

  1. 从浏览器中创建 xmlhttprequest
  2. 从 node.js 发出 http 请求
  3. 支持 promise api
  4. 拦截请求和响应
  5. 转换请求和响应数据
  6. 取消请求
  7. 自动转换json数据
  8. 客户端支持防止 csrf/xsrf

上一章,我们认识了项目的目录结构,以及对项目的目录结构做了一些调整,已经能把项目重新跑起来了。今天我们来搭建api接口调用工具axios。vue本身是不支持ajax调用的,如果你需要这些功能就需要安装对应的工具。

支持ajax请求的工具很多,像superagent和axios。今天我们用的就是axios,因为听说最近网上大部分的教程书籍都使用的是axios,本身axios这个工具就已经做了很好的优化和封装,但是在使用时,还是比较繁琐,所以我们来重新封装一下。

安装axios工具

VueJs 搭建Axios接口请求工具

cnpm install axios -d 

在安装的时候,一定要切换进入咱们的项目根目录,再运行安装命令,然后如提示以上信息,则表示安装完成。

封装axios工具

编辑src/api/index.js文件(我们在上一章整理目录结构时,在src/api/目录新建了一个空的index.js文件),现在我们为该文件填写内容。

// 配置api接口地址
var root = 'https://cnodejs.org/api/v1'
// 引用axios
var axios = require('axios')
// 自定义判断元素类型js
function totype (obj) {
 return ({}).tostring.call(obj).match(/\s([a-za-z]+)/)[1].tolowercase()
}
// 参数过滤函数
function filternull (o) {
 for (var key in o) {
  if (o[key] === null) {
   delete o[key]
  }
  if (totype(o[key]) === 'string') {
   o[key] = o[key].trim()
  } else if (totype(o[key]) === 'object') {
   o[key] = filternull(o[key])
  } else if (totype(o[key]) === 'array') {
   o[key] = filternull(o[key])
  }
 }
 return o
}
/*
 接口处理函数
 这个函数每个项目都是不一样的,我现在调整的是适用于
 https://cnodejs.org/api/v1 的接口,如果是其他接口
 需要根据接口的参数进行调整。参考说明文档地址:
 https://cnodejs.org/topic/5378720ed6e2d16149fa16bd
 主要是,不同的接口的成功标识和失败提示是不一致的。
 另外,不同的项目的处理方法也是不一致的,这里出错就是简单的alert
*/
function apiaxios (method, url, params, success, failure) {
 if (params) {
  params = filternull(params)
 }
 axios({
  method: method,
  url: url,
  data: method === 'post' || method === 'put' ? params : null,
  params: method === 'get' || method === 'delete' ? params : null,
  baseurl: root,
  withcredentials: false
 })
 .then(function (res) {
 if (res.data.success === true) {
  if (success) {
   success(res.data)
  }
 } else {
  if (failure) {
   failure(res.data)
  } else {
   window.alert('error: ' + json.stringify(res.data))
  }
 }
 })
 .catch(function (err) {
  let res = err.response
  if (err) {
   window.alert('api error, http code: ' + res.status)
  }
 })
}
// 返回在vue模板中的调用接口
export default {
 get: function (url, params, success, failure) {
  return apiaxios('get', url, params, success, failure)
 },
 post: function (url, params, success, failure) {
  return apiaxios('post', url, params, success, failure)
 },
 put: function (url, params, success, failure) {
  return apiaxios('put', url, params, success, failure)
 },
 delete: function (url, params, success, failure) {
  return apiaxios('delete', url, params, success, failure)
 }
}

更多关于axios的解释请参见:

配置axios工具

我们在使用之前,需要在src/main.js中进行简单的配置,先来看一下原始的main.js文件

// the vue build version to load with the `import` command
// (runtime-only or standalone) has been set in webpack.base.conf with an alias.
import vue from 'vue'
import app from './app'
import router from './router'
vue.config.productiontip = false
/* eslint-disable no-new */
 new vue({
 el: '#app',
 router,
 template: '<app/>',
 components: { app }
})

修改为:

// the vue build version to load with the `import` command
// (runtime-only or standalone) has been set in webpack.base.conf with an alias.
import vue from 'vue'
import app from './app'
import router from './router'
// 引用api文件
import api from './api/index.js'
// 将api方法绑定到全局
vue.prototype.$api = api
vue.config.productiontip = false
/* eslint-disable no-new */
new vue({
 el: '#app',
 router,
 template: '<app/>',
 components: { app }
})

通过以上的配置,我们就可以在项目中使用axios工具了,接下来我们来测试一下这个工具。

使用axios工具

我们来修改一下 src/page/index.vue 文件,将代码调整为以下代码:

<template>
 <div>index page</div>
</template>
<script>
export default {
 created () {
  this.$api.get('topics', null, r => {
   console.log(r)
  })
 }
}
</script>

我们在index.vue中向浏览器的控制台输入一些接口请求到的数据,如果你和我也一样,那说明我们的接口配置完成正确。如下图:

VueJs 搭建Axios接口请求工具

如果你是按我的操作一步一步来,那最终结果应该和我一样。如果出错请仔细检查代码。