vlambda博客
学习文章列表

VUE框架【第4期】--Vue请求:Axios请求

VUE框架【第4期】--Vue请求:Axios请求

导读:

    大家好，我是老田。前后端交互中发送网络请求的方式有很多种,例如原生ajax,jquery中的ajax等,今天我们学习Vue中推荐使用的Axios请求方式。

第一部分 Axios请求

1.1 Axios简介

Axios 是一个基于 promise 的 HTTP 库，可以用在浏览器和 node.js 中。

特点

  1. 支持node端和浏览器端: 同样的API，node和浏览器全支持，平台切换无压力

  2. 支持 Promise: 使用Promise管理异步，告别传统callback方式

  3. 丰富的配置项: 支持请求和响应的拦截, 提前处理请求和响应数据

1.2 axios 使用

下载安装axios包

 $ npm install axios

引入使用axios

 // 引入包
 import axios from "axios"

当然也可以用script引入(在线引入)

 <script ></script>

1.3 axios API

 axios(config)
 // 发送 POST 请求
 axios({
   method: 'post',
   url: '/user/login',
   data: {
     userName: 'admin',
     password: '123456'
   }
 });
 axios(url[, config])
 // 发送 GET 请求（默认的方法）
 axios('/user/12345');

1.4 发送基本的请求

 // 使用axios
 axios({
     url:"https://localhost:8081/demo/users"
 }).then(result => {
     console.log(result);
 })

示例中,我们并没有请求类型, axios默认请求为get请求,

如果希望发送post等其他方式的 请求, 可以在配置对象中添加method选项

例如:

 // 使用post发送请求
 axios({
     url:"https://localhost:8081/demo/users",
     method: "post"
 }).then(result => {
     console.log(result);
 })

1.5 配置对象中指定get请求参数

我们可以像传统get请求传参一样在url路径后拼接请求数据.

例如:

 axios({
     url:"https://localhost:8081/demo/users?userId=1",
 }).then(result => {
     console.log(result);
 })

也可以将get的请求数据放在axios的配置对象中例如: 将get请求数据放在配置对象的params选项中

 axios({
     url:"https://localhost:8081/demo/users",
     params:{
         userId: 1
     }
 }).then(result => {
     console.log(result);
 })

第二部分 axios 请求方式

2.1 请求方式

请求方法的别名

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

axios(config)

axios.request(config)

axios.get(url[, config])

axios.delete(url[, config])

axios.head(url[, config])

axios.options(url[, config])

axios.post(url[, data[, config]])

axios.put(url[, data[, config]])

axios.patch(url[, data[, config]]

上面基本的示例中,我们是在axios()请求的配置对象中配置请求方式,axios也提供了通过不同的方式发送请求

指定了请求方式发送请求说明

  1. 第一个参数将是发送的url,

  2. 第二个参数是请求的配置对象,可以省略,使用默认配置

注意：在使用别名方法时， url、method、data 这些属性都不必在配置中指定。

示例:

不是用配置对象  

axios.get("https://localhost:8081/demo/users?userId=1")
    .then(result => {
    console.log(result);
})

使用配置对象

axios.get("https://localhost:8081/demo/users",{
    params:{
        userId:1
    }
}).then(result => {
    console.log(result);
})

2.2 请求配置项

下面是创建请求时可用的配置选项，注意只有 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 &gt;= 200 &amp;&amp; status &lt; 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) {
  })
}

2.3 响应结构

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);
  });

在使用 catch 时响应可以通过 error 对象可被使用。

axios.get("http://localhost:8080/jpa/api/findUsersDemo.json")
.then(response=>(this.info=response))
.catch(function(error){console.log(error);})
}


第三部分 完整案例

后端接口：

package com.tian.jpademo.web;

import com.tian.jpademo.biz.UserBiz;
import com.tian.jpademo.domain.User;
import com.tian.jpademo.util.ResponseJson;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.List;
import java.util.Map;

/**
 * @Author tian
 * @DateTime 2020/11/30 14:00
 */
@RestController
@RequestMapping("/api")
public class UserController {

    @Autowired
    private UserBiz userBiz;

    @RequestMapping("findUsersDemo.json")
    public ResponseJson findUsersDemo(){
        List<User> list = userBiz.findUsers();
        ResponseJson json = new ResponseJson("200","success",list);
        return json;
    }
    @RequestMapping("findUsersDemo1.json")
    public ResponseJson findUsersDemo1(String name){
        System.out.println(name);
        List<User> list = userBiz.findUsers();
        ResponseJson json = new ResponseJson("200","success",list);
        return json;
    }
    @RequestMapping("findUsersDemo2.json")
    public ResponseJson findUsersDemo2(String name){
        System.out.println("demo2:");
        System.out.println(name);
        List<User> list = userBiz.findUsers();
        ResponseJson json = new ResponseJson("200","success",list);
        return json;
    }
    @RequestMapping("findUsersDemo3.json")
    public ResponseJson findUsersDemo3(User user){
        System.out.println("demo3:"+user.toString());

        List<User> list = userBiz.findUsers();
        ResponseJson json = new ResponseJson("200","success",list);
        return json;
    }

    @RequestMapping("findUsersDemo4.json")
    public ResponseJson findUsersDemo4(@RequestBody Map<String,String>map){
        System.out.println("-----------------------------"+map.size());
        for(Map.Entry<String ,String>entry:map.entrySet()){
            System.out.println(entry.getKey()+"----"+entry.getValue());
        }
        List<User> list = userBiz.findUsers();
        ResponseJson json = new ResponseJson("200","success",list);
        return json;
    }
    @RequestMapping("findUsersDemo5.json")
    public ResponseJson findUsersDemo5(@RequestBody User user){
        System.out.println("demo5:"+user.toString());

        List<User> list = userBiz.findUsers();
        ResponseJson json = new ResponseJson("200","success",list);
        return json;
    }
}

前端请求：

 <!DOCTYPE html>
 <html>
  <head>
   <meta charset="utf-8" />
   <title></title>
  </head>
  <body>
   <div id="app">
    <button type="button" @click="demo">demo</button>
    <button type="button" @click="demo1">demo1</button>
    <button type="button" @click="demo2">demo2</button>
    <button type="button" @click="demo3">demo3</button>
    <button type="button" @click="demo4">demo4</button>
    <button type="button" @click="demo5">demo5</button>
    {{info}}
   </div>
   <script src="js/vue.js" type="text/javascript" charset="utf-8"></script>
 
   <script src="https://cdn.staticfile.org/axios/0.18.0/axios.min.js"></script>
   <script>
    var app = new Vue({
     el: "#app",
     data: {
      info: null
     },
     methods: {
      //普通get异步请求
      demo: function() {
       axios.get("http://localhost:8080/jpa/api/findUsersDemo.json")
        .then(response => (this.info = response))
        .catch(function(error) {
         console.log(error);
        })
      },
      //get请求以url形式传参
      demo1: function() {
       axios.get("http://localhost:8080/jpa/api/findUsersDemo1.json?name=tian")
        .then(response => (this.info = response))
        .catch(function(error) {
         console.log(error);
        })
      },
      //get请求以params形式传参
      demo2: function() {
       axios.get("http://localhost:8080/jpa/api/findUsersDemo2.json", {
         params: {
          name: "天"
         }
        })
        .then(response => (this.info = response))
        .catch(function(error) {
         console.log(error);
        })
      },
      //get请求以params形式传入多参
      demo3: function() {
       axios.get("http://localhost:8080/jpa/api/findUsersDemo3.json", {
         params: {
          userName: "天",
          password: "123",
          sex: 1
         }
        })
        .then(response => (this.info = response))
        .catch(function(error) {
         console.log(error);
        })
      },
      //以json形式传递数请求数据
      demo4: function() {
       axios({
        headers: {
         'Content-Type': 'application/json'
        },
        transformRequest: [function(data) {
         data = JSON.stringify(data)
         return data
        }],
        url: 'http://localhost:8080/jpa/api/findUsersDemo4.json',
        method: 'post',
        data:{
         userName: "天",
         password: "123",
         sex: 1
        }
       }).then(response => (this.info = response))
        .catch(function(error) {
         console.log(error);
        })
      },//以json形式传递数请求数据
      demo5: function() {
       axios({
        headers: {
         'Content-Type': 'application/json'
        },
        transformRequest: [function(data) {
         data = JSON.stringify(data)
         return data
        }],
        url: 'http://localhost:8080/jpa/api/findUsersDemo5.json',
        method: 'post',
        data:{
         userName: "天",
         password: "123",
         sex: 1
        }
       }).then(response => (this.info = response))
        .catch(function(error) {
         console.log(error);
        })
      }
 
     }
    });
   </script>
  </body>
 </html>
 

博观而约取，厚积而薄发！


--END--


推荐阅读

真女神转生5：复仇 正式版替换包 试玩版游玩完整游戏方法 真女神转生5：复仇 正式版替换包 试玩版游玩完整游戏方法
开发永不过时！Java入行学习超详细路线不来看看吗？ 开发永不过时！Java入行学习超详细路线不来看看吗？

相关文章