vue中Ajax(axios)及Ajax(vue-resource)的使用方法

Posted 孙叫兽

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了vue中Ajax(axios)及Ajax(vue-resource)的使用方法相关的知识,希望对你有一定的参考价值。

目录

Vue.js Ajax(axios)

GET 方法

请求方法的别名

并发

请求配置项

响应结构

拦截器

取消

请求时使用 application/x-www-form-urlencoded

Node.js 环境

Promises

TypeScript支持

Vue.js Ajax(vue-resource)

Get 请求

post 请求



Vue.js Ajax(axios)

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

Vue.js 2.0 版本推荐使用 axios 来完成 ajax 请求。

 Github开源地址: GitHub - axios/axios: Promise based HTTP client for the browser and node.js

安装方法 

<script src="https://unpkg.com/axios/dist/axios.min.js"></script>

<script src="https://cdn.staticfile.org/axios/0.18.0/axios.min.js"></script>

使用 npm:

$ npm install axios

使用 bower:

$ bower install axios

使用 yarn:

$ yarn add axios

GET 方法

我们可以简单的读取 JSON 数据:

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Vue 测试实例 - 孙叫兽的博客</title>
<script src="https://cdn.staticfile.org/vue/2.4.2/vue.min.js"></script>
<script src="https://cdn.staticfile.org/axios/0.18.0/axios.min.js"></script>
</head>
<body>
<div id="app">
   info 
</div>
<script type = "text/javascript">
new Vue(
  el: '#app',
  data () 
    return 
      info: null
    
  ,
  mounted () 
    axios
      .get('https://www.sunjiaoshou.com/try/ajax/json_demo.json')
      .then(response => (this.info = response))
      .catch(function (error)  // 请求失败处理
        console.log(error);
      );
  
)
</script>
</body>
</html>

 POST 方法

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Vue 测试实例 - sunjiaoshou</title>
<script src="https://cdn.staticfile.org/vue/2.4.2/vue.min.js"></script>
<script src="https://cdn.staticfile.org/axios/0.18.0/axios.min.js"></script>
</head>
<body>
<div id="app">
   info 
</div>
<script type = "text/javascript">
new Vue(
  el: '#app',
  data () 
    return 
      info: null
    
  ,
  mounted () 
    axios
      .post('https://www.sunjiaoshou.com/try/ajax/demo_axios_post.php')
      .then(response => (this.info = response))
      .catch(function (error)  // 请求失败处理
        console.log(error);
      );
  
)
</script>
</body>
</html>

请求方法的别名

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

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

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

并发

处理并发请求的助手函数:

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

请求配置项

下面是创建请求时可用的配置选项,注意只有 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) 
  )

响应结构

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 时,或传递 rejection callback 作为 then 的第二个参数时,响应可以通过 error 对象可被使用。

拦截器

在请求或响应被 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);
  );

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

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

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

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

取消

使用 cancel token 取消请求。

Axios 的 cancel token API 基于cancelable promises proposal

可以使用 CancelToken.source 工厂方法创建 cancel token,像这样:

var CancelToken = axios.CancelToken;
var source = CancelToken.source();

axios.get('/user/12345', 
  cancelToken: source.token
).catch(function(thrown) 
  if (axios.isCancel(thrown)) 
    console.log('Request canceled', thrown.message);
   else 
    // 处理错误
  
);

// 取消请求(message 参数是可选的)
source.cancel('Operation canceled by the user.');

 还可以通过传递一个 executor 函数到 CancelToken 的构造函数来创建 cancel token:

var CancelToken = axios.CancelToken;
var cancel;

axios.get('/user/12345', 
  cancelToken: new CancelToken(function executor(c) 
    // executor 函数接收一个 cancel 函数作为参数
    cancel = c;
  )
);

// 取消请求
cancel();

注意:可以使用同一个 cancel token 取消多个请求。

请求时使用 application/x-www-form-urlencoded

axios 会默认序列化 JavaScript 对象为 JSON。 如果想使用 application/x-www-form-urlencoded 格式,你可以使用下面的配置。

浏览器

在浏览器环境,你可以使用 URLSearchParams API:

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

URLSearchParams 不是所有的浏览器均支持。

除此之外,你可以使用 qs 库来编码数据:

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

// Or in another way (ES6),

import qs from 'qs';
const data =  'bar': 123 ;
const options = 
  method: 'POST',
  headers:  'content-type': 'application/x-www-form-urlencoded' ,
  data: qs.stringify(data),
  url,
;
axios(options);

Node.js 环境

在 node.js里, 可以使用 querystring 模块:

const querystring = require('querystring');
axios.post('http://something.com/', querystring.stringify( foo: 'bar' ));

当然,同浏览器一样,你还可以使用 qs 库。

Promises

axios 依赖原生的 ES6 Promise 实现而被支持

如果你的环境不支持 ES6 Promise,你可以使用 post 请求

TypeScript支持

axios 包含 TypeScript 的定义。

import axios from "axios";
axios.get("/user?ID=12345");

Vue.js Ajax(vue-resource)

Vue 要实现异步加载需要使用到 vue-resource 库。

<script src="https://cdn.staticfile.org/vue-resource/1.5.1/vue-resource.min.js"></script>

Get 请求

以下是一个简单的 Get 请求实例,请求地址是一个简单的 txt 文本:

window.onload = function()
    var vm = new Vue(
        el:'#box',
        data:
            msg:'Hello World!',
        ,
        methods:
            get:function()
                //发送get请求
                this.$http.get('/try/ajax/ajax_info.txt').then(function(res)
                    document.write(res.body);    
                ,function()
                    console.log('请求失败处理');
                );
            
        
    );

如果需要传递数据,可以使用 this.$http.get('get.php',params : jsonData) 格式,第二个参数 jsonData 就是传到后端的数据

this.$http.get('get.php',params : a:1,b:2).then(function(res)
    document.write(res.body);    
,function(res)
    console.log(res.status);
);

post 请求

post 发送数据到后端,需要第三个参数 emulateJSON:true。

emulateJSON 的作用: 如果Web服务器无法处理编码为 application/json 的请求,你可以启用 emulateJSON 选项。

window.onload = function()
    var vm = new Vue(
        el:'#box',
        data:
            msg:'Hello World!',
        ,
        methods:
            post:function()
                //发送 post 请求
                this.$http.post('/try/ajax/demo_test_post.php',name:"sunjiaoshou教程",url:"http://www.sunjiaoshou.com",emulateJSON:true).then(function(res)
                    document.write(res.body);    
                ,function(res)
                    console.log(res.status);
                );
            
        
    );

demo_test_post.php 代码如下:

<?php
$name = isset($_POST['name']) ? htmlspecialchars($_POST['name']) : '';
$city = isset($_POST['url']) ? htmlspecialchars($_POST['url']) : '';
echo '网站名: ' . $name;
echo "\\n";
echo 'URL 地址: ' .$city;
?>

可以使用全局对象方式 Vue.http 或者在一个 Vue 实例的内部使用 this.$http来发起 HTTP 请求。

// 基于全局Vue对象使用http
Vue.http.get('/someUrl', [options]).then(successCallback, errorCallback);
Vue.http.post('/someUrl', [body], [options]).then(successCallback, errorCallback);

// 在一个Vue实例内使用$http
this.$http.get('/someUrl', [options]).then(successCallback, errorCallback);
this.$http.post('/someUrl', [body], [options]).then(successCallback, errorCallback);

vue-resource 提供了 7 种请求 API(REST 风格):

get(url, [options])
head(url, [options])
delete(url, [options])
jsonp(url, [options])
post(url, [body], [options])
put(url, [body], [options])
patch(url, [body], [options])

除了 jsonp 以外,另外 6 种的 API 名称是标准的 HTTP 方法。

options 参数说明:

通过如下属性和方法处理一个请求获取到的响应对象:

 

 

以上是关于vue中Ajax(axios)及Ajax(vue-resource)的使用方法的主要内容,如果未能解决你的问题,请参考以下文章

为啥vue不使用ajax

vue中使用Ajax(axios)

vue使用Axios做ajax请求

Vue.js Ajax(axios)

vue.js 配置axios 用来ajax请求数据

axios和ajax区别