axios基本用法

2023-05-30 14:23| 来源: 网络整理| 查看: 265

一、什么是axios？

axios 是一个基于Promise 用于浏览器和 nodejs 的 HTTP 客户端。简单的理解就是ajax的封装

axios本身具有以下特征：

从浏览器中创建 XMLHttpRequest 从 node.js 发出 http 请求支持 Promise API 拦截请求和响应转换请求和响应数据取消请求自动转换JSON数据客户端支持防止 CSRF/XSRF 二、安装使用 npm: npm install axios cnpm install axios //taobao源使用 bower: bower install axios 使用 cdn: 三、举个例子 1、发送一个GET请求 //通过给定的ID来发送请求 axios.get('/user?ID=12345') .then(function(response){ console.log(response); }) .catch(function(error){ console.log(error); }); //以上请求也可以通过这种方式来发送 axios.get('/user',{ params:{ ID:12345 } }) .then(function(response){ console.log(response); }) .catch(function(error){ console.log(error); }); 2、发送一个POST请求 axios.post('/user',{ firstName:'Fred', lastName:'Flintstone' }) .then(function(res){ console.log(res); }) .catch(function(error){ console.log(error); }); 3、一次性并发多个请求 function getUserAccount(){ return axios.get('/user/12345'); } function getUserPermissions(){ return axios.get('/user/12345/permissions'); } axios.all([getUserAccount(),getUserPermissions()]) .then(axios.spread(function(acct,perms){ //当这两个请求都完成的时候会触发这个函数，两个参数分别代表返回的结果 })) 四、axios的API （1） axios可以通过配置（config）来发送请求 1、axios(config) //发送一个`POST`请求 axios({ method:"POST", url:'/user/12345', data:{ firstName:"Fred", lastName:"Flintstone" } }); 2、 axios(url[,config]) //发送一个`GET`请求（默认的请求方式） axios('/user/12345'); （2）请求方式的别名，这里对所有已经支持的请求方式都提供了方便的别名 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]])

注意：当我们在使用别名方法的时候，url,method,data这几个参数不需要在配置中声明

（3）并发请求（concurrency）,即是帮助处理并发请求的辅助函数 //iterable是一个可以迭代的参数如数组等 axios.all(iterable) //callback要等到所有请求都完成才会执行 axios.spread(callback) （4）创建一个axios实例，并且可以自定义其配置 1、 axios.create([config]) var instance = axios.create({ baseURL:"https://some-domain.com/api/", timeout:1000, headers: {'X-Custom-Header':'foobar'} }); 2、实例的方法

以下是实例方法，注意已经定义的配置将和利用create创建的实例的配置合并

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]]) 五、请求的配置（request config）

以下就是请求的配置选项，只有url选项是必须的，如果method选项未定义，那么它默认是以GET的方式发出请求

{ //url是请求的服务器地址 url:'/user', //method是请求资源的方式 method:'get'//default //如果url不是绝对地址，那么baseURL将会加到url的前面 //当url是相对地址的时候，设置baseURL会非常的方便 baseURL:'https://some-domain.com/api/', //transformRequest选项允许我们在请求发送到服务器之前对请求的数据做出一些改动 //该选项只适用于以下请求方式：`put/post/patch` //数组里面的最后一个函数必须返回一个字符串、-一个ArrayBuffer或者Stream transformRequest:[function(data){ //在这里根据自己的需求改变数据 return data; }], //transformResponse选项允许我们在数据传送到then/catch方法之前对数据进行改动 transformResponse:[function(data){ //在这里根据自己的需求改变数据 return data; }], //headers选项是需要被发送的自定义请求头信息 headers: {'X-Requested-With':'XMLHttpRequest'}, //params选项是要随请求一起发送的请求参数----一般链接在URL后面 //他的类型必须是一个纯对象或者是URLSearchParams对象 params: { ID:12345 }, //paramsSerializer是一个可选的函数，起作用是让参数（params）序列化 //例如(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`选项时dada必须是以下几种类型之一 //string/plain/object/ArrayBuffer/ArrayBufferView/URLSearchParams //仅仅浏览器：FormData/File/Bold //仅node:Stream data { firstName:"Fred" }, //timeout选项定义了请求发出的延迟毫秒数 //如果请求花费的时间超过延迟的时间，那么请求会被终止 timeout:1000, //withCredentails选项表明了是否是跨域请求 withCredentials:false,//default //adapter适配器选项允许自定义处理请求，这会使得测试变得方便 //返回一个promise,并提供验证返回 adapter: function(config){ /*..........*/ }, //auth表明HTTP基础的认证应该被使用，并提供证书 //这会设置一个authorization头（header）,并覆盖你在header设置的Authorization头信息 auth: { username:"zhangsan", password: "s00sdkf" }, //返回数据的格式 //其可选项是arraybuffer,blob,document,json,text,stream responseType:'json',//default xsrfCookieName: 'XSRF-TOKEN',//default xsrfHeaderName:'X-XSRF-TOKEN',//default //onUploadProgress上传进度事件 onUploadProgress:function(progressEvent){ //下载进度的事件 onDownloadProgress:function(progressEvent){ } }, //相应内容的最大值 maxContentLength:2000, //validateStatus定义了是否根据http相应状态码，来resolve或者reject promise //如果validateStatus返回true(或者设置为null或者undefined),那么promise的状态将会是resolved,否则其状态就是rejected validateStatus:function(status){ return status >= 200 && status { //二次封装，方便更改数据 let option={ //axios的config url, method:type validatestatus(status){ return (status>=200 && status{ if(res.status===200){ resolve(res.data) }else( reject(res.data) ) } ).catch(err=>{ reject({msg:'网络异常'}) }) }) } /* 用法如下： request('/user','POST',{username:'zhangsan',password:'123456'}) .then(data=>{ console.log(data) }) */

在实际例子中，用法部分会再次封装成API（包含路径等），组件调用时候就不用理会路径内容，直接调用方法，方便对数据的管理。

如登录注册页面数据管理：

import request from '@/helpers/request' const URL={ REGISTER:'/auth/register', LOGIN:'/auth/login', LOGOUT:'/auth/logout', GET_INFO:'auth' } export default { register({username,password}){ return request(URL.REGISTER,'POST',{username,password}) }, login({username,password}){ return request(URL.LOGIN,'POST',{username,password}) }, logout(){ return request(URL.LOGOUT) } getInfo(){ return request(URL.GET_INFO) } }

如增删改查页面数据管理：

import request from '@/helpers/request' const URL={ GET:'/notebooks', ADD:'/notebooks', UPDATE:'/notebooks/:id', DELETE:'/notebooks/:id' } export default { getAll(){ return request(URL.GET) }, addNotebooks({title=''}={title:''}){ return request(URL.ADD,'POST',{title}) }, updateNotebooks(notebookId,{title=''}={title:''}){ return request(URL.UPDATE.replace(':id',notebookId),'PATCH',{title}) }, deleteNotebooks(notebookId){ return request(URL.DELETE.replace(':id',notebookID),'DELETE') } }

原文出自链接：https://www.jianshu.com/p/125f0cd044a4

【本文地址】

axios基本用法

axios基本用法

今日新闻

推荐新闻