7.VUE-Ajax
Posted Byte学苑
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了7.VUE-Ajax相关的知识，希望对你有一定的参考价值。
无论是MVC开发模式还是MVVM开发模式AJAX都是重要的一环，其主要功能就是前端和服务端的数据交互，在javascript的学习中，已经初步了解了ajax的原理。在本章内将深入学习Vue AJAX，学习之前需要知道的是Vue本身并没有提供Ajax功能，官方推荐使用axios来完成ajax请求。
1. JavaScript Ajax回顾
在学习vue ajax之前需要回顾一下js ajax，方便和vue ajax进行对比学习，假设现在需要使用ajax进行用户名是否存在验证。
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<title>ajax验证用户名</title>
</head>
<body>
<form action="" method="post">
<label for="username">用户名</label>
<input onblur="valid(this)" type="text" name="username" value="" /><br />
<label for="username">密 码</label>
<input type="text" name="username" value="" /><br />
<input type="submit" value="登录" />
</form>
</body>
<script>
function valid(target) {
//获取文本框的值
var username = target.value;
//创建XMLHttpRequest(此处不考虑IE)
var xmlhttp = new XMLHttpRequest();
//发送请求
xmlhttp.open("POST", "/vue-demo/validUsername", true);
xml.send("username=" + username)
//回调函数处理返回结果
xmlhttp.onreadystatechange = function() {
if (xmlhttp.readyState == 4 && xmlhttp.status == 200) {
alert(xmlhttp.responseText);
}
}
}
</script>
</html>
上例中，我们利用ajax对用户名进行验证，当用户名文本框失去焦点时向服务器发送请求，当用户名为空或者用户名已经被注册时，给出相应的提示信息。
2.axios 的使用
vue本身并没有提供ajax支持，在2.x版本中推荐使用axios，axios则是基于Promise对象的HTTP库，可以用在浏览器中。
Promise是异步编程的一种解决方案，比传统的解决方案——回调函数和事件更合理强大，例如登录成功后拉取用户姓名，头像等信息是就必须在ajax回调函数中再次发送ajax请求获取这些信息。这样就造成回调函数的循环嵌套不仅不利于项目维护，也显得业务逻辑混乱。而Promise则对此类情况有了极大的改善（此处我们对Promise不做深入研究，可自行查阅资料）。
如果要是用axios需要在页面head标签中引入，可以使用CDN引入或者下载至本地后引入。如果使用CDN复制以下代码即可：
<script src="https://unpkg.com/axios/dist/axios.min.js"></script>
2.1发送Get请求
// 发送get请求
axios.get(url).then(
function (response) {
console.log(response);
}).catch(function (error) {
console.log(error);
});
上例中使用axios发送了get请求，其中get后括号内参数为被请求url。then指请求成功后回调函数，其方法参数即服务返回的信息，服务器返回数据后可在该方法内进行处理，catch顾名思义指当get请求发生异常时可在该方法内处理（可省略），其方法参数则是一些异常信息。如果get请求需要传参数有两种方式：1.利用url传参，2.使用get()方法params对象，其中key指参数名，value则是参数值，当使用params后等价于url后拼接请求参数。代码如下。
axios.get('url, {
params: {
key: value
}
}).then(function (response) {
console.log(response);
}).catch(function (error) {
console.log(error);
});
2.2发送Post请求
let params= new URLSearchParams();
params.append("key", value);
axios.post('url', params).then(
function(response) {
alert(response);
}).catch(function(error) {
console.log(error);
});
发送post请求和get请求使用基本方式一致，只是当需要传递参数时，需要创建 URLSearchParams对象，并利用该对象append方法添加请求参数，这是因为默认情况下axios会以json格式向服务器发送数据，如果使用Spring mvc这很好处理，但是在使用Servlet情况下处理过程相对繁琐，因此建议使用URLSearchParams处理请求参数。
除此以外，也可以使用自定义配置新建一个axios实例，用于配置通用配置项，配置完成后可以发送get或者post请求，并省去一些通用配置。
var instance = axios.create({
url: url,
method: method,
data:data
});
除以上基本配置以外，还有一些可用配置选项，其中只有url是必须的，如果没有指定method，默认get请求。
{
// `url` 是用于请求的服务器 URL
url: '/user',
// `method` 是创建请求时使用的方法
method: 'get', // default
// `baseURL` 将自动加在 `url` 前面，除非 `url` 是一个绝对 URL。
// 它可以通过设置一个 `baseURL` 便于为 axios 实例的方法传递相对 URL
baseURL: 'https://some-domain.com/api/',
// `transformRequest` 允许在向服务器发送前，修改请求数据
// 只能用在 'PUT', 'POST' 和 'PATCH' 这几个请求方法
// 后面数组中的函数必须返回一个字符串，或 ArrayBuffer，或 Stream
transformRequest: [function (data, headers) {
// 对 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, // default
// `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', // default
// `responseEncoding` indicates encoding to use for decoding responses
// Note: Ignored for `responseType` of 'stream' or client-side requests
responseEncoding: 'utf8', // default
// `xsrfCookieName` 是用作 xsrf token 的值的cookie的名称
xsrfCookieName: 'XSRF-TOKEN', // default
// `xsrfHeaderName` is the name of the http header that carries the xsrf token value
xsrfHeaderName: 'X-XSRF-TOKEN', // default
// `onUploadProgress` 允许为上传处理进度事件
onUploadProgress: function (progressEvent) {
// Do whatever you want with the native progress event
},
// `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; // default
},
// `maxRedirects` 定义在 node.js 中 follow 的最大重定向数目
// 如果设置为0，将不会 follow 任何重定向
maxRedirects: 5, // default
// `socketPath` defines a UNIX Socket to be used in node.js.
// e.g. '/var/run/docker.sock' to send requests to the docker daemon.
// Only either `socketPath` or `proxy` can be specified.
// If both are specified, `socketPath` is used.
socketPath: null, // default
// `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) {
})
}
下面我们重构js ajax示例，深入学习如何使用axios验证用户名是否可用（省略服务端代码）：
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>axios发送请求</title>
<script src="js/vue.js" type="text/javascript" charset="utf-8"></script>
<script src="js/axios.min.js" type="text/javascript" charset="utf-8"></script>
</head>
<body>
<div id="app">
<form action="" method="post">
<label for="username">用户名</label>
<input @blur="valid" v-model="username" type="text" name="username" value="" /><br />
<label for="password">密 码</label>
<input type="text" name="username" value="" /><br />
<input type="submit" value="登录" />
</form>
</div>
</body>
<script>
new Vue({
el:"#app",
data:{
username:""
},
methods:{
valid:function(e){
//获取用户属于的用户名
var username = this.username;
//发送post请求
let data = new URLSearchParams();
data.append("username",username);
axios.post("http://localhost:8080/vue-demo/validUsername",data).then(
function(response){
alert(response.data);
}
).catch(
function(error){
console.log(error);
}
)
}
}
})
</script>
</html>
上例中，利用@blur监听文本框失去焦点事件并绑定valid()方法，并且使用v-model指令将文本框的值和数据username进行双向绑定。valid方法中先获取用户输入的用户名，23行利用URLSearchParams()对象append方法，封装请求参数，向服务端发送post请求。并显示了服务器返回的数据。
在这里需要注意的是then()方法参数返回的是一个对象，包含以下信息：
{
// `data` 由服务器提供的响应
data: {},
// `status` 来自服务器响应的 HTTP 状态码
status: 200,
// `statusText` 来自服务器响应的 HTTP 状态信息
statusText: 'OK',
// `headers` 服务器响应的头
headers: {},
// `config` 是为请求提供的配置信息
config: {},
// 'request'
// `request` is the request that generated this response
// It is the last ClientRequest instance in node.js (in redirects)
// and an XMLHttpRequest instance the browser
request: {}
}
3.总结
在本章内我们学习了vue ajax，对比原生ajax，我们发现vue ajax更为简便，我们无需关注ajax内部实现，只需要使用axios配置请求连接，请求参数，在then()中处理请求结果。
需要注意的是，当我们发送请求有一些通用配置时，例如，所有请求的url中除去资源部分，前半部分都是一样的，这样我们就可以使用baseUrl；还有发送请求时当响应时间超过3S则认为是请求超时并作出处理，可以利用timeout配置。
以上是关于7.VUE-Ajax的主要内容，如果未能解决你的问题，请参考以下文章