• Vue笔记:使用 axios 发送请求


    在Vue1.0的时候有一个官方推荐的 ajax 插件 vue-resource,但是自从 Vue 更新到 2.0 之后,官方就不再更新 vue-resource。

    关于为什么放弃推荐? -> 尤大原话

    最近团队讨论了一下,Ajax 本身跟 Vue 并没有什么需要特别整合的地方,使用 fetch polyfill 或是 axios、superagent 等等都可以起到同等的效果,

    vue-resource 提供的价值和其维护成本相比并不划算,所以决定在不久以后取消对 vue-resource 的官方推荐。已有的用户可以继续使用,

    但以后不再把 vue-resource 作为官方的 ajax 方案。这里可以去掉 vue-resource,文档也不必翻译了。

    目前主流的 Vue 项目,都选择 axios 来完成 ajax 请求,下面来具体介绍一下axios的使用。

    axios 简介

    axios 是一个基于Promise 用于浏览器和 nodejs 的 HTTP 客户端,它本身具有以下特征:

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

    引入方式:

    $ npm install axios
    //使用淘宝源 $ cnpm install axios //或者使用cdn: <script src="https://unpkg.com/axios/dist/axios.min.js"></script>

    安装其他插件的时候,可以直接在 main.js 中引入并使用 Vue.use()来注册,但是 axios并不是vue插件,所以不能 使用Vue.use(),所以只能在每个需要发送请求的组件中即时引入。

    为了解决这个问题,我们在引入 axios 之后,通过修改原型链,来更方便的使用。

    //main.js

    import axios from 'axios'
    Vue.prototype.$http = axios

    在 main.js 中添加了这两行代码之后,就能直接在组件的 methods 中使用 $http命令

    复制代码
    methods: {
      postData () {
        this.$http({
          method: 'post',
          url: '/user',
          data: {
            name: 'xiaoming',
            info: '12'
          }
       })
    }
    复制代码

    下面来介绍axios的具体使用:

    执行 GET 请求

    复制代码
    // 向具有指定ID的用户发出请求
    $http.get('/user?ID=12345')
      .then(function (response) {
        console.log(response);
      })
      .catch(function (error) {
        console.log(error);
      });
    // 也可以通过 params 对象传递参数
    $http.get('/user', {
        params: {
          ID: 12345
        }
      })
      .then(function (response) {
        console.log(response);
      })
      .catch(function (error) {
        console.log(error);
      });
    复制代码

    执行 POST 请求

    复制代码
    $http.post('/user', {
        firstName: 'Fred',
        lastName: 'Flintstone'
      })
      .then(function (response) {
        console.log(response);
      })
      .catch(function (error) {
        console.log(error);
      });
    复制代码

    执行多个并发请求

    复制代码
    function getUserAccount() {
      return $http.get('/user/12345');
    }
    function getUserPermissions() {
      return $http.get('/user/12345/permissions');
    }
    axios.all([getUserAccount(), getUserPermissions()])
      .then($http.spread(function (acct, perms) {
        //两个请求现已完成
      }));
    复制代码

    axios API

    可以通过将相关配置传递给 axios 来进行请求。

    axios(config)

    复制代码
    // 发送一个 POST 请求
    axios({
      method: 'post',
      url: '/user/12345',
      data: {
        firstName: 'Fred',
        lastName: 'Flintstone'
      }
    });
    复制代码

    axios(url[, config])

    1
    2
    // 发送一个 GET 请求 (GET请求是默认请求模式)
    axios('/user/12345');

    请求方法别名

    为了方便起见,已经为所有支持的请求方法提供了别名。

    • 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]])

    注意
    当使用别名方法时,不需要在config中指定url,method和data属性。

    并发

    帮助函数处理并发请求。

    • axios.all(iterable)
    • axios.spread(callback)

    创建实例

    您可以使用自定义配置创建axios的新实例。

    axios.create([config])

    var instance = axios.create({
      baseURL: 'https://some-domain.com/api/',
      timeout: 1000,
      headers: {'X-Custom-Header': 'foobar'}
    });

    实例方法

    可用的实例方法如下所示。 指定的配置将与实例配置合并。

    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是必需的。 如果未指定方法,请求将默认为GET。

    复制代码
    {
      // `url`是将用于请求的服务器URL
      url: '/user',
      // `method`是发出请求时使用的请求方法
      method: 'get', // 默认
      // `baseURL`将被添加到`url`前面,除非`url`是绝对的。
      // 可以方便地为 axios 的实例设置`baseURL`,以便将相对 URL 传递给该实例的方法。
      baseURL: 'https://some-domain.com/api/',
      // `transformRequest`允许在请求数据发送到服务器之前对其进行更改
      // 这只适用于请求方法'PUT','POST'和'PATCH'
      // 数组中的最后一个函数必须返回一个字符串,一个 ArrayBuffer或一个 Stream
      transformRequest: [function (data) {
        // 做任何你想要的数据转换
        return data;
      }],
      // `transformResponse`允许在 then / catch之前对响应数据进行更改
      transformResponse: [function (data) {
        // Do whatever you want to transform the data
        return data;
      }],
      // `headers`是要发送的自定义 headers
      headers: {'X-Requested-With': 'XMLHttpRequest'},
      // `params`是要与请求一起发送的URL参数
      // 必须是纯对象或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
      // - Browser only: FormData, File, Blob
      // - Node only: Stream
      data: {
        firstName: 'Fred'
      },
      // `timeout`指定请求超时之前的毫秒数。
      // 如果请求的时间超过'timeout',请求将被中止。
      timeout: 1000,
      // `withCredentials`指示是否跨站点访问控制请求
      // should be made using credentials
      withCredentials: false, // default
      // `adapter'允许自定义处理请求,这使得测试更容易。
      // 返回一个promise并提供一个有效的响应(参见[response docs](#response-api))
      adapter: function (config) {
        /* ... */
      },
      // `auth'表示应该使用 HTTP 基本认证,并提供凭据。
      // 这将设置一个`Authorization'头,覆盖任何现有的`Authorization'自定义头,使用`headers`设置。
      auth: {
        username: 'janedoe',
        password: 's00pers3cret'
      },
      // “responseType”表示服务器将响应的数据类型
      // 包括 'arraybuffer', 'blob', 'document', 'json', 'text', 'stream'
      responseType: 'json', // default
      //`xsrfCookieName`是要用作 xsrf 令牌的值的cookie的名称
      xsrfCookieName: 'XSRF-TOKEN', // default
      // `xsrfHeaderName`是携带xsrf令牌值的http头的名称
      xsrfHeaderName: 'X-XSRF-TOKEN', // default
      // `onUploadProgress`允许处理上传的进度事件
      onUploadProgress: function (progressEvent) {
        // 使用本地 progress 事件做任何你想要做的
      },
      // `onDownloadProgress`允许处理下载的进度事件
      onDownloadProgress: function (progressEvent) {
        // Do whatever you want with the native progress event
      },
      // `maxContentLength`定义允许的http响应内容的最大大小
      maxContentLength: 2000,
      // `validateStatus`定义是否解析或拒绝给定的promise
      // HTTP响应状态码。如果`validateStatus`返回`true`(或被设置为`null` promise将被解析;否则,promise将被
      // 拒绝。
      validateStatus: function (status) {
        return status >= 200 && status < 300; // default
      },
      // `maxRedirects`定义在node.js中要遵循的重定向的最大数量。
      // 如果设置为0,则不会遵循重定向。
      maxRedirects: 5, // 默认
      // `httpAgent`和`httpsAgent`用于定义在node.js中分别执行http和https请求时使用的自定义代理。
      // 允许配置类似`keepAlive`的选项,
      // 默认情况下不启用。
      httpAgent: new http.Agent({ keepAlive: true }),
      httpsAgent: new https.Agent({ keepAlive: true }),
      // 'proxy'定义代理服务器的主机名和端口
      // `auth`表示HTTP Basic auth应该用于连接到代理,并提供credentials。
      // 这将设置一个`Proxy-Authorization` header,覆盖任何使用`headers`设置的现有的`Proxy-Authorization` 自定义 headers。
      proxy: {
        host: '127.0.0.1',
        port: 9000,
        auth: : {
          username: 'mikeymike',
          password: 'rapunz3l'
        }
      },
      // “cancelToken”指定可用于取消请求的取消令牌
      // (see Cancellation section below for details)
      cancelToken: new CancelToken(function (cancel) {
      })
    }
    复制代码

    使用 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);
      });
    复制代码

    配置默认值

    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';

    拦截器

    你可以截取请求或响应在被 then 或者 catch 处理之前

    复制代码
    //添加请求拦截器
    axios.interceptors.request.use(function(config){
         //在发送请求之前做某事
         return config;
       },function(error){
         //请求错误时做些事
         return Promise.reject(error);
       });
     
    //添加响应拦截器
    axios.interceptors.response.use(function(response){
         //对响应数据做些事
          return response;
       },function(error){
         //请求错误时做些事
         return Promise.reject(error);
       });
    复制代码

    处理错误

    复制代码
    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 {
           //在设置触发错误的请求时发生了错误
           console.log('Error',error.message);
         }}
         console.log(error.config);
       });
    复制代码

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

    axios.get('/ user / 12345',{
       validateStatus:function(status){
         return status < 500; //仅当状态代码大于或等于500时拒绝
       }}
    })

    使用application / x-www-form-urlencoded格式

    默认情况下,axios将JavaScript对象序列化为JSON。 要以应用程序/ x-www-form-urlencoded格式发送数据,您可以使用以下选项之一。

    浏览器

    在浏览器中,您可以使用URLSearchParams API,如下所示:

    var params = new URLSearchParams();
    params.append('param1', 'value1');
    params.append('param2', 'value2');
    axios.post('/foo', params);

    请注意,所有浏览器都不支持URLSearchParams,但是有一个polyfill可用(确保polyfill全局环境)。

    或者,您可以使用qs库对数据进行编码:

    var qs = require('qs');
    axios.post('/foo', qs.stringify({ 'bar': 123 });

    查看更多 请访问我的独立博客 https://www.aaz5.com/

    关注前端开发 关注用户体验 请访问我的新博客: https://www.cssge.com  
     
    本文转载自
    原文作者:前端小子
  • 相关阅读:
    Linux命令大全
    paramiko 使用总结(SSH 操作远端机器)
    Django之ModelForm详解
    django模板之forloop
    学习VUE笔记及遇到的坑
    bootstrap table加载失败
    使用RedisTemplate遇到的坑
    grunt 不是内部或外部命令,也不是可运行的程序或批处理文件
    SpringBoot关于系统之间的远程互相调用
    数据在网络中的传输
  • 原文地址:https://www.cnblogs.com/xifengxiaoma/p/9518805.html
Copyright © 2020-2023  润新知