14.Vue网络请求：axios

tech2025-03-17 7

简介

Vue.js 2.0 版本推荐使用 axios 来完成 ajax 请求。 Axios 是一个基于 Promise 的 HTTP 库，可以用在浏览器和 node.js 中。

请求方法的别名

为方便使用，官方为所有支持的请求方法提供了别名，可以直接使用别名来发起请求：

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，请求将默认使用 get 方法。

{ // `url` 是用于请求的服务器 URL url: "/user", // `method` 是创建请求时使用的方法 method: "get", // 默认是 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` 在传递给 then/catch 前，允许修改响应数据 transformResponse: [function (data) { // 对 data 进行任意转换处理 return data; }], // `headers` 是即将被发送的自定义请求头 headers: {"X-Requested-With": "XMLHttpRequest"}, // `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, // 默认的 // `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 默认值：

axios.defaults.baseURL = 'https://api.example.com'; axios.defaults.headers.common['Authorization'] = AUTH_TOKEN; axios.defaults.headers.post['Content-Type'] = 'application/x-www-form-urlencoded';

自定义实例默认值：

// 创建实例时设置配置的默认值 var myHttp = axios.create({ baseURL: 'https://api.example.com' }); // 在实例已创建后修改默认值 myHttp.defaults.headers.common['Authorization'] = AUTH_TOKEN; // 在实例发起请求 myHttp.get("/admin/user.com").then(function(){...});

响应结构

axios请求的响应包含以下信息：

{ // `data` 由服务器提供的响应 data: {}, // `status` HTTP 状态码 status: 200, // `statusText` 来自服务器响应的 HTTP 状态信息 statusText: "OK", // `headers` 服务器响应的头 headers: {}, // `config` 是为请求提供的配置信息 config: {} }

使用 then 时，会接收下面这样的响应：

axios.get("/user/12345") .then(function(response) { console.log(response.data); console.log(response.status); console.log(response.statusText); console.log(response.headers); console.log(response.config); });

拦截器

在请求或响应被 then 或 catch 处理前拦截它们。

// 添加请求拦截器 axios.interceptors.request.use(function (config) { // 在发送请求之前做些什么 config.headers.Authorization = token; //比如吧token变量赋值给Authorization return config; }, function (error) { // 对请求错误做些什么 return Promise.reject(error); }); // 添加响应拦截器 axios.interceptors.response.use(function (response) { // 对响应数据做点什么 return response; }, function (error) { // 对响应错误做点什么 return Promise.reject(error); });

如果你想在稍后移除拦截器，可以这样：

var myInterceptor = axios.interceptors.request.use(function () {/*...*/}); axios.interceptors.request.eject(myInterceptor);

可以为自定义 axios 实例添加拦截器。

var instance = axios.create(); instance.interceptors.request.use(function () {/*...*/});

错误处理

axios.get('/user/12345') .catch(function (error) { if (error.response) { // 请求已发出，但服务器响应的状态码不在 2xx 范围内 console.log(error.response.data); console.log(error.response.status); console.log(error.response.headers); } else { // Something happened in setting up the request that triggered an Error console.log('Error', error.message); } console.log(error.config); });

可以使用 validateStatus 配置选项定义一个自定义 HTTP 状态码的错误范围。

axios.get('/user/12345', { validateStatus: function (status) { return status < 500; // 状态码在大于或等于500时才会 reject } })

简单演示

then

测试json：

{ "name":"网站", "num":3, "sites": [ { "name":"Google", "info":[ "Android", "Google 搜索", "Google 翻译" ] }, { "name":"Runoob", "info":[ "菜鸟教程", "菜鸟工具", "菜鸟微信" ] }, { "name":"Taobao", "info":[ "淘宝", "网购" ] } ] }

程序代码：

<html> <head> <meta charset="utf-8"> <title></title> <script src="js/vue.js" type="text/javascript" charset="utf-8"></script>  <script src="js/axios.js" type="text/javascript" charset="utf-8"></script> </head> <body> <div id="content"> <p>{{msg}}</p> <button v-on:click="send">发送普通GET请求</button> </div> </body> <script> var vm = new Vue({ el: "#content", data: { msg: "" }, methods: { send() { //axios请求 axios({ method: "get", url: "json/send.json" }) .then(function(res) { console.log(res); }); } } }); </script> </html>

运行，发现响应res中东西，data中是想要的响应内容：

data对象

其实上面的res是个Promise对象，要取res.data作为内容：

axios({ method: "get", url: "json/send.json" }) .then(function(res) { //取res.data console.log(res.data); });

运行：

catch

对错误的判断可以用catch方法：

axios({ method: "get", url: "http://msadsasg.uasdsameng.com/api/" //这是个不存在的域名 }) .then(function(res) { // console.log(res.data); }) .catch(function(err) { console.log("state:" + err.state + " statusText:" + err.statusText); });

运行：

结合箭头函数操作vue属性

要将数据显示到页面msg，运行点击按钮并无效果，因为其中的this并非对vm的引用：

axios({ method: "get", url: "json/send.json" }) .then(function(res) { this.msg = res.data; });

这里可以使用箭头函数：

axios({ method: "get", url: "json/send.json" }) .then(res => { //箭头函数 this.msg = res.data; });

运行点击：

带参GET请求

GET请求用params对象传参：

axios.get( "json/send.json", { //GET请求用params对象传参,但post不是 params: { a: 1, user: "abc" } } ) .then(res => { console.log(res.data); });

运行：

带参POST请求

POST请求直接用对象传参，不用params对象：

axios.post( "http://127.0.0.1:8080/upush/vue", { num: 1, user: "cbe" } ) .then(res => { console.log(res.data); });

服务端：

@RequestMapping(value = "/vue", method = RequestMethod.POST) public String vue(String user,Integer num){ System.out.println(num + user); return "index"; }

运行，发现居然是OPTIONS请求，而且返回是403：应该是跨域导致的问题，由于axios不支持跨域，所以用服务端CORS解决：

@CrossOrigin //增加CrossOrigin解决跨域 @RequestMapping(value = "/vue", method = RequestMethod.POST) public String vue(String user,Integer num){ System.out.println(num + user); return "index"; }

运行，发现会发出两个请求，第一个OPTIONS，再接一个POST：爬坑发现添加header【application/x-www-form-urlencoded】可以解决：

但服务端接收不到参数，仔细观察请求，发现其传参方式要么是Payload，要么是格式错误的Form Date。 application/json： application/x-www-form-urlencoded：又爬坑发现，post需要把参数构建成【xxx=a&yyy=b】的形式：

axios.post( "http://127.0.0.1:8080/upush/vue", "user=cbq&num=2", //这样传参 config ) .then(res => { console.log(res.data); });

服务端才能正确接收到数据。