当前位置: 首页 > news >正文

Axios 完整功能介绍和完整示例演示

Axios 是一个基于 Promise 的现代化 HTTP 客户端库,用于浏览器和 Node.js 环境。它提供了简洁的 API 和强大的功能,是前端开发中最常用的网络请求工具之一。


核心功能

  1. 浏览器 & Node.js 双平台支持
    • 浏览器中使用 XMLHttpRequest
    • Node.js 中使用 http 模块
  2. Promise API
    所有请求返回 Promise 对象,支持 async/await
  3. 请求/响应拦截器
    全局拦截请求和响应
  4. 请求取消
    使用 AbortController 取消请求
  5. 自动转换数据
    自动转换 JSON 数据,支持请求/响应数据转换
  6. 客户端 XSRF 防护
    自动添加 CSRF 令牌
  7. 并发请求
    提供 axios.all()axios.spread()
  8. 进度监控
    支持上传/下载进度跟踪
  9. 配置默认值
    全局配置 baseURL、headers 等

完整示例演示

1. 基础安装
npm install axios
# 或
yarn add axios
2. 发起请求
import axios from 'axios';// GET 请求
axios.get('https://jsonplaceholder.typicode.com/posts/1').then(response => console.log(response.data)).catch(error => console.error(error));// POST 请求
axios.post('https://jsonplaceholder.typicode.com/posts', {title: 'foo',body: 'bar',userId: 1
})
.then(response => console.log(response.data));
3. 并发请求
const getUser = () => axios.get('https://jsonplaceholder.typicode.com/users/1');
const getPosts = () => axios.get('https://jsonplaceholder.typicode.com/posts?userId=1');Promise.all([getUser(), getPosts()]).then(([userResponse, postsResponse]) => {console.log('User:', userResponse.data);console.log('Posts:', postsResponse.data);});
4. 创建实例 & 全局配置
const api = axios.create({baseURL: 'https://api.example.com',timeout: 5000,headers: {'X-Custom-Header': 'foobar'}
});api.get('/data'); // 实际请求 https://api.example.com/data
5. 拦截器 (身份认证示例)
// 请求拦截器
axios.interceptors.request.use(config => {config.headers.Authorization = `Bearer ${localStorage.getItem('token')}`;return config;
});// 响应拦截器
axios.interceptors.response.use(response => response,error => {if (error.response.status === 401) {alert('Session expired!');window.location = '/login';}return Promise.reject(error);}
);
6. 取消请求
const controller = new AbortController();axios.get('https://jsonplaceholder.typicode.com/posts', {signal: controller.signal
})
.catch(err => {if (axios.isCancel(err)) {console.log('Request canceled');}
});// 取消请求
controller.abort();
7. 文件上传 & 进度跟踪
<input type="file" id="fileInput">
document.getElementById('fileInput').addEventListener('change', (e) => {const file = e.target.files[0];const formData = new FormData();formData.append('file', file);axios.post('https://api.example.com/upload', formData, {headers: {'Content-Type': 'multipart/form-data'},onUploadProgress: progressEvent => {const percent = Math.round((progressEvent.loaded * 100) / progressEvent.total);console.log(`Upload: ${percent}%`);}});
});
8. 错误处理
axios.get('https://invalid-url.example.com').catch(error => {if (error.response) {// 服务器返回 4xx/5xx 响应console.log('Server Error:', error.response.status);} else if (error.request) {// 请求已发送但无响应console.log('Network Error:', error.message);} else {// 请求配置错误console.log('Config Error:', error.message);}});
9. 自定义实例默认值
// 设置全局默认值
axios.defaults.baseURL = 'https://api.example.com';
axios.defaults.headers.common['Accept'] = 'application/json';// 实例级覆盖
const instance = axios.create({baseURL: 'https://api.special.com'
});
10. XSRF 防护
// 设置 Cookie 名称和 Header 名称
axios.defaults.xsrfCookieName = 'csrftoken';
axios.defaults.xsrfHeaderName = 'X-CSRFToken';

完整项目示例

// api.js
import axios from 'axios';const api = axios.create({baseURL: 'https://jsonplaceholder.typicode.com',timeout: 10000
});// 请求拦截器
api.interceptors.request.use(config => {console.log(`Sending ${config.method} request to ${config.url}`);return config;
});// 响应拦截器
api.interceptors.response.use(response => {console.log('Received response:', response.status);return response;},error => {console.error('API Error:', error.message);return Promise.reject(error);}
);export const fetchPosts = () => api.get('/posts');
export const createPost = data => api.post('/posts', data);
export const deletePost = id => api.delete(`/posts/${id}`);
// App.js
import { fetchPosts, createPost } from './api';async function main() {try {// 获取数据const posts = await fetchPosts();console.log('Fetched posts:', posts.data.slice(0, 3));// 创建新数据const newPost = await createPost({title: 'Axios Guide',body: 'Complete tutorial for Axios',userId: 1});console.log('Created post:', newPost.data);} catch (error) {console.error('Main error:', error);}
}main();

常见场景解决方案

  1. 处理不同内容类型

    // 发送 URL 编码数据
    axios.post('/submit', 'key1=value1&key2=value2', {headers: {'Content-Type': 'application/x-www-form-urlencoded'}
    });// 发送纯文本
    axios.post('/log', 'Raw text data', {headers: {'Content-Type': 'text/plain'}
    });
    
  2. 处理二进制数据

    axios.get('https://example.com/image.png', {responseType: 'arraybuffer'
    }).then(response => {const buffer = Buffer.from(response.data, 'binary');fs.writeFileSync('image.png', buffer);
    });
    
  3. 自定义序列化

    axios.post('/data', { special: '@value' }, {transformRequest: [(data) => {return JSON.stringify(data).replace('@', '');}]
    });
    

Axios 通过其简洁的 API 设计和丰富的功能,极大简化了 HTTP 请求的处理流程。无论是简单的 GET 请求还是复杂的文件上传场景,都能提供优雅的解决方案,是现代化前端开发不可或缺的工具。

http://www.lryc.cn/news/588629.html

相关文章:

  • 分布式全局唯一ID生成:雪花算法 vs Redis Increment,怎么选?
  • gRPC实战指南:像国际快递一样调用跨语言服务 —— 解密Protocol Buffer与HTTP/2的完美结合
  • TCP可靠性设计的核心机制与底层逻辑
  • Java基础(八):封装、继承、多态与关键字this、super详解
  • Java全栈工程师面试实录:从电商系统到AIGC的层层递进
  • 通用综合文字识别联动 MES 系统:OCR 是数据流通的核心
  • 在百亿流量面前,让“不存在”无处遁形——Redis 缓存穿透的极限攻防实录
  • 【Ubuntu22.04】repo安装方法
  • 1.2 vue2(组合式API)的语法结构以及外部暴露
  • 如何把手机ip地址切换到外省
  • 【深度学习优化算法】06:动量法
  • 从springcloud-gateway了解同步和异步,webflux webMvc、共享变量
  • iOS V2签名网站系统源码/IPA在线签名/全开源版本/亲测
  • iOS 抓包工具精选对比:不同调试需求下的工具适配策略
  • 项目总体框架(servlet+axios+Mybatis)
  • 【解决】联想电脑亮度调节
  • iOS高级开发工程师面试——多线程
  • Axios 和 Promise 区别对比
  • Supervisor 使用教程:进程守护的最佳实践指南
  • 【Git】详解git commit --amend用法以及使用遇到的问题
  • eVTOL分布式电推进(DEP)适航审定探究
  • Python 操作Excel工作表:添加、删除、移动、隐藏
  • redis集群的部署
  • 线性代数小述(三)
  • Pitaya 是一个简单、快速、轻量级的游戏服务器框架,它为分布式多人游戏和服务器端应用程序提供了一个基本的开发框架
  • 【橘子分布式】Thrift RPC(编程篇)
  • Vim多列操作指南
  • 028_分布式部署架构
  • 淘宝扭蛋机小程序开发:重构电商娱乐化体验的新范式
  • GaussDB 数据库架构师修炼(四) 备份容量估算