axios是框架吗 axios是做什么的

转载

互联网小思悟 2023-07-04 20:35:02

文章标签 axios是框架吗 javascript node.js http ajax 文章分类 iOS 移动开发

文章目录

👉 前言
👉 一、axios 简介及为什么使用 axios

> 什么是 axios？
> 基本使用
> 为什么使用 axios？

👉 二、为什么要封装 axios ？
👉 三、如何封装？
💬 小温有话说
📃 参考文献
往期内容 💨

👉 前言

在前端开发中，我们时常需要向后端发起HTTP请求，获取后端数据资源。在Jquery广泛使用的时期，有 Ajax 用于请求获取资源。而在框架盛行的今天，主要用 Axios 进行请求（Axios 是一个基于 Promise 用于浏览器和 nodejs 的 HTTP 客户端。简单的理解就是 Ajax 的封装库）。对于 axios 的了解，有些卷王们仅仅只是局限于简单的使用 axios 发送请求，并未去了解其原因及提示效率的途径！

接下来废话不多说，先进入今天的卷王学习时间！

👉 一、axios 简介及为什么使用 axios

> 什么是 axios？

axios 是一个轻量的 HTTP 客户端

基于 XMLHttpRequest 服务来执行 HTTP 请求，支持丰富的配置，支持 Promise，支持浏览器端和 Node.js 端。自 Vue2.0 起，尤大宣布取消对 vue-resource 的官方推荐，转而推荐 axios。现在 axios 已经成为大部分 Vue 开发者的首选。

特性

从浏览器中创建 XMLHttpRequests
从 node.js 创建 http 请求
支持 Promise API
拦截请求和响应
转换请求数据和响应数据
取消请求
自动转换 JSON 数据
客户端支持防御 XSRF

> 基本使用

① 安装

// 项目中安装
npm install axios --S
// cdn 引入
<script src="https://unpkg.com/axios/dist/axios.min.js"></script>

② 导入

// 在Vue的 main.js文件中引用
import axios from 'axios'
// 声明使用名称
Vue.prototype.axios = axios;

③ 基础语法：发送请求

axios({        
  url:'xxx',    // 设置请求的地址
  method:"GET", // 设置请求方法
  params:{      // get请求使用params进行参数凭借,如果是post请求用data
    type: '',
    page: 1
  }
}).then(res => {  
  // res为后端返回的数据
  console.log(res);   
})

④ 并发请求 axios.all([])

function getUserAccount() {
	return axios.get('/user/12345');
}

function getUserPermissions() {
	return axios.get('/user/12345/permissions');
}

axios.all([getUserAccount(), getUserPermissions()])
	.then(axios.spread(function (res1, res2) { 
	// res1第一个请求的返回的内容，res2第二个请求返回的内容
	// 两个请求都执行完成才会执行
}));

> 为什么使用 axios？

原因：

① 功能强大：基于 Ajax 封装的 XMLHttpRequest 网络请求库，拥有多种请求方式。如下：

axios(config)
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] ])

② 支持Promise API 且浏览器支持良好。

③ 支持并发请求（开发过程中，同时发送两个请求，并且请求的数据一起到达后，再继续后续的工作的方式叫做并发请求），提高了请求效率及性能。

④ 能够拦截请求和响应：便于自定义封装一些根据实际请求，需要更改的内容。

👉 二、为什么要封装 axios ？

axios 的 API 很友好，你完全可以很轻松地在项目中直接使用。

不过随着项目规模增大，如果每发起一次 HTTP 请求，就要设置一些基础的配置，比如设置 超时时间、设置请求头、根据项目环境判断使用哪个请求地址、错误处理 等等通用业务操作配置，都需要重新写一遍的。

这种重复劳动不仅浪费时间、降低效率，而且让代码变得冗余不堪，难以维护。为了提高我们的代码质量，就需要我们在项目中二次封装一下 axios 再使用。

举个栗子 🌰

axios('http://localhost:3000/data', {
  // 配置代码
  method: 'GET',
  timeout: 1000,
  withCredentials: true,
  headers: {
    'Content-Type': 'application/json',
    Authorization: 'xxx',
  },
  transformRequest: [function (data, headers) {
    return data;
  }],
  // 其他请求配置...
})
.then((data) => {
  // todo: 真正业务逻辑代码
  console.log(data);
}, (err) => {
  // 错误处理代码  
  if (err.response.status === 401) {
  // handle authorization error
  }
  if (err.response.status === 403) {
  // handle server forbidden error
  }
  // 其他错误处理.....
  console.log(err);
});

如果每个页面都发送类似的请求，都要写一堆的配置与错误处理，就显得过于繁琐了

这时候我们就需要对axios进行二次封装（提取出可复用部分的内容进行封装），让使用更为便利。

👉 三、如何封装？

注意事项：
封装的同时，你需要和后端协商好一些约定，请求头，状态码，请求超时时间…

设置接口请求前缀：根据开发、测试、生产环境的不同，前缀需要加以区分
请求头 : 来实现一些具体的业务，必须携带一些参数才可以请求(例如：会员业务)
状态码: 根据接口返回的不同status ，来执行不同的业务，这块需要和后端约定好
请求方法：根据get、post等方法进行一个再次封装，使用起来更为方便
请求拦截器: 根据请求的请求头设定，来决定哪些请求可以访问
响应拦截器：这块就是根据后端`返回来的状态码判定执行不同业务

① 设置接口请求前缀
利用 node环境变量 来作判断，用来区分开发、测试、生产环境

if (process.env.NODE_ENV === 'development') {
	// 开发
  axios.defaults.baseURL = 'http://dev.xxx.com'
} else if (process.env.NODE_ENV === 'production') {
	// 生产
  axios.defaults.baseURL = 'http://prod.xxx.com'
}

在本地调试的时候，还需要在 vue.config.js 文件中配置 devServer 实现代理转发，从而实现跨域。

devServer: {
  proxy: {
    '/proxyApi': {
      target: 'http://dev.xxx.com',
      changeOrigin: true,
      pathRewrite: {
        '/proxyApi': ''
      }
    }
  }
}

② 设置请求头与超时时间
大部分情况下，请求头都是固定的，只有少部分情况下，会需要一些特殊的请求头，这里将普适性的请求头作为基础配置。当需要特殊请求头时，将特殊请求头作为参数传入，覆盖基础配置。

const service = axios.create({
    ...
	timeout: 30000,  // 请求 30s 超时
	headers: {
		get: {
		  'Content-Type': 'application/x-www-form-urlencoded;charset=utf-8'
		  // 在开发中，一般还需要单点登录或者其他功能的通用请求头，可以一并配置进来
		},
		post: {
		  'Content-Type': 'application/json;charset=utf-8'
		  // 在开发中，一般还需要单点登录或者其他功能的通用请求头，可以一并配置进来
		}
	},
})

③ 封装请求方法
先引入封装好的方法，在要调用的接口重新封装成一个方法暴露出去。

import axios from 'axios'
// get 请求
export function httpGet({
  url,
  params = {}
}) {
  return new Promise((resolve, reject) => {
    axios.get(url, {
      params
    }).then((res) => {
      resolve(res.data)
    }).catch(err => {
      reject(err)
    })
  })
}

// post请求
export function httpPost({
  url,
  data = {},
  params = {}
}) {
  return new Promise((resolve, reject) => {
    axios({
      url,
      method: 'post',
      transformRequest: [function (data) {
        let ret = ''
        for (let it in data) {
          ret += encodeURIComponent(it) + '=' + encodeURIComponent(data[it]) + '&'
        }
        return ret
      }],
      // 发送的数据
      data,
      // url参数
      params

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

把封装的方法放在一个 api.js 文件中，具体写每个模块具体的接口信息：

import { httpGet, httpPost } from './http'
export const getorglist = (params = {}) => {
	 return httpGet({ url: 'apps/api/org/list', params })
}

页面中就能直接调用

// .vue  声明所要引用的接口方法
import { getorglist } from '@/assets/js/api'

getorglist({ id: 200 }).then(res => {
  console.log(res)
})

这样可以把api统一管理起来，以后维护修改只需要在 api.js 文件操作即可

④ 请求拦截器

请求拦截器可以在每个请求里加上token，做了统一处理后维护起来也方便

// 请求拦截器
axios.interceptors.request.use(
  config => {
    // 每次发送请求之前判断是否存在token
    // 如果存在，则统一在http请求的header都加上token，这样后台根据token判断你的登录情况，此处token一般是用户完成登录后储存到localstorage里的
    token && (config.headers.Authorization = token)
    return config
  },
  error => {
    return Promise.error(error)
  })

⑤ 响应拦截器

响应拦截器可以在接收到响应后先做一层操作，如根据状态码判断登录状态、授权等…

// 响应拦截器
axios.interceptors.response.use(response => {
	// 根据和后端沟通协调，枚举指定状态码的对应操作
	if (response.data.code === 511) {
		// 未授权调取授权接口
	} else if (response.data.code === 510) {
		// 未登录跳转登录页
	} else {
		return Promise.resolve(response)
	}
}, error => {
	// 我们可以在这里对异常状态作统一处理
	if (error.response.status) {
		// 处理请求失败的情况
		// 对不同返回码对相应处理
		return Promise.reject(error.response)
	}
})