详解vue前后台数据交互vue-resource文档
这两天学习了vue-resource插件个地方知识点挺多的,而且很重要,所以,今天添加一点小笔记。
vue可以构建一个完全不依赖后端服务的应用,同时也可以与服务端进行数据交互来同步界面的动态更新。
vue通过插件的形式实现了基于ajax,jspnp等技术的服务端通信。
vue-resource
是一个通过xmlhttprequrest
或jsonp
技术实现异步加载服务端数据的vue插件
提供了一般的 http请求接口和restful架构请求接口,并且提供了全局方法和vue组件实例方法。
使用的版本是:vue-resource 0.7.2
配置
参数配置
分为:
- 全局配置
- 组件实例配置
- 调用配置
这三部分的优先级依次增高,游戏机高的配置会覆盖优先级低的配置。
全局配置
vue.http.options.root = '/root';
全局配置option属性
组件实例配置
在实例化组件时可以传入http选项来进行配置
new vue({ http: { root: '/root', headers: { authorization: '' } } })
方法调用时配置
在调用vue-resource
请求方法是传入选项对象。
new vue({ ready: function() { // get 请求 this.$http.get({url: '', headers: { authorization: '' } }) .then(() => { // 请求成功回调 }, () => { // 请求失败回调 }); } });
headers配置
通过headers属性来配置请求头。
除了参数配置headers属性可以设置请求头外,在vue-resource中也提供了全局默认的headers配置
vue.http.headers键值可以是http方法名,common,custom,三种类型。这三种类型的配置会进行合并,优先级从低到高依次是common,custom,http方法名。
其中common对应的请求头会在所有请求中设置,custom对应的请求头在非跨域时设置,http方法名对应的请求头只有在请求的method匹配方法名时才会被设置。
基本http调用
基本http调用即普通的get,post等基本的http操作实际上执行增,删,改,查是前后端开发人员共同约定的并非通过http的请求方法如get表示获取数据,put代表写入数据,post表示更新数据。底层方法和便捷方法执行后返回一个promise对象,可以使用promise语法来注册成功,失败回调。
底层方法
全局的vue.http方法和vue组件的实例方法this.$http都属于底层方法,他们根据所传入option惨啊书的method属性来判断请求方式是get还是post,亦或是其它的http的合法方法。
全局调用
vue.http(option);
组件实例调用
this.$http(option)
全局调用和组件实例调用都是接收相同的option参数。都返回promise对象。不同的是,全局方式回调this指向window,而组建实例调用方式回调指向组件实例。
组件实例方式发送post请求
new vue({ ready: function () { // post请求 this.$http({ url: '', method: 'post', // 请求体重发送的数据 data: { cat: 1 }, // 设置请求头 headers: { 'content-type': 'x-www-from-urlencoded' } }).then(function () { // 请求成功回调 }, function () { // 请求失败回调 }); } });
便捷方法
不同于底层方法,便捷方法是对底层方法的封装,在调用时可以省去配置选项option中的method属性。
vue-resource 提供的便捷方法:
- get(url, [data], [options]);
- post(url, [data], [options]);
- put(url, [data], [options]);
- patch(url, [data], [options]);
- delete(url, [data], [options]);
- jsonp(url, [data], [options]);
都是接受三个参数:
- url(字符串),请求地址。可被options对象中url属性覆盖。
- data(可选,字符串或对象),要发送的数据,可被options对象中的data属性覆盖。
- options
便捷方法的post请求:
this.$http.post( 'http://example.com', // 请求体重发送数据给服务端 { cat: 1, name: 'newbook' },{ 'headers': { 'content-type': 'x-www-form-urlencoded' } }).then(function () { // 成功回调 }, function () { // 失败回调 });
请求选项对象
option对象的各属性及含义
参数 | 类型 | 描述 |
---|---|---|
url | string | 请求的url |
method | string | 请求的http方法,例如:'get', 'post'或其他http方法 |
body | object,formdatastring | request body |
params | object | 请求的url参数对象 |
headers | object | request header |
timeout | number | 单位为毫秒的请求超时时间 (0 表示无超时时间) |
before | function(request) | 请求发送前的处理函数,类似于jquery的beforesend函数 |
progress | function(event) | progressevent回调处理函数 |
credientials | boolean | 表示跨域请求时是否需要使用凭证 |
emulatehttp | boolean | 发送put, patch, delete请求时以http |
emulatejson | boolean | 将request body以application/x-www-form-urlencoded content type发送 |
url
url(字符串)请求的url地址
method
method(字符串)默认值为get,请求的http方法(get,post等)
data
data(对象或字符串)
默认值为:'',需要发送给服务端的数据。
data属性的值对method为post,put,delete等请求会作为请求体来传送,对于get,jsonp等方式的请求将会拼接在url查询参数中。
params
params(对象)
默认值为:{}用来替换url中的模板变量,模板变量中为匹配到的属性添加在url地址后边作为查询参数。
vue.http({ url: 'http://example.com/{book}', params: { book: 'vue', cat: 1 } });
最终url为: http//example.com/vue?cat=1
headers
headers(对象)
默认值为:{},设置http请求头
xhr
xhr(对象)默认值为null,该对象中属性都会应用到原生的xhr实例对象上。
upload
upload(对象)默认值为null,该对象的属性都会应用到原生的xhr实例对象的upload属性上。
jsonp
jsonp(字符串)
默认值为:callback,jsonp请求中回调函数的名字。
vue.http({ url: 'http://example.com/book', method: 'jsonp', jsonp: 'cb' });
最终的url地址为http://example.com/book?cb=xxx
xxx 为 vue-resource 生成的随机串。
tiemout
timeout(数值)
默认为:0,单位为 ms。表示请求超时时间。0表示没有超时限制。超市后,将会取消当前请求。
vue-resrouce内部通过拦截器注入超时取消逻辑。
if ( request.timeout ) { timeout = settimeout(function () { reqest.cancel(); }, request.timeout); } // 超时后,promise会被 reject,错误回调会被执行。
beforesend
beforesend(函数)默认值为:null,该函数接受请求选项对象作为参数。该函数在发送请求之前执行,vue-resource内部在拦截器最前端调用该方法。
emulatehttp
emulatehttp(布尔值)
默认值为:false,当值为true是,用http的post方式put,patch,delete等请求,并设置请求头字段http_method_override为原始请求方法。
如果web服务器无法处理put, patch和delete这种rest风格的请求,你可以启用enulatehttp现象。启用该选项后,请求会以普通的post方法发出,并且http头信息的x-http-method-override属性会设置为实际的http方法。
如果服务器无法处理put,patch和delete的请求。可以启用enulatehttp。
启用之后,请求会以普通的post方法发出,并且http头信息的x-http-method-override属性会设置为实例的http方法
vue.http.options.emulatehttp = true;
emulatejson
emulatejson(布尔值)
默认值为:false,当值为true并且data为对象时,设置请求头content-type的值为application/x-www-form-urlencoded
如果服务器无法处理编码为application/json的请求,可以启用emulatejson选项。启用之后,请求会以application/x-www-form-urlencoded为mime type,就像普通的html表单一样。
vue.http.options.emulatejson = true;
crossorigin
crossorigin(布尔值)
默认值为:null,表示是否跨域,如果没有设置该属性,vue-resource内部会判断浏览器当前url和请求url是否跨域。
if ( request.crossorgin === null ) { request.corssorigin = corssorigin(request); } if ( request.corssorigin ) { if ( !xhrcors ) { request.client = xdrclient; } request.enumlatehttp = false; }
如果最终crossorigin为true并且浏览器不支持cors,即不支持xmlhttprequest2时,则会使用xdomainrequest来请求。目前xdomainrequest 只有ie8,ie9 浏览器支持用来进行ajax跨域。
reqponse对象
response对象包含服务端的数据,以及http响应状态,响应头等信心。
- data (对象或字符串): 服务端返回的数据,已使用 json.parse 解析。
- ok(布尔值):当http响应状态码在200~299区间时该值为true,表示响应成功。
- status(数值): http响应状态码。
- statustext(字符串): http响应状态文本描述。
- headers(函数): 获取http响应头信息,不传参表示获取整个响应头,返回一个相应头对象。传参表示获取对应的响应头信息。
- request(对象)
restful调用
restful调用就是客户端通过http动词来表示增,删,改,查实现对服务端数据操作的一种架构模式。
vue-resource提供全局调用vue.resource或者在组件实例上调用this.$rsource。
resource(url ,[params], [actions], [options]);
url
url(字符串)请求地址,可以包含占位符,会被parms对象中的同名属性的值替换。
this.$resource('/books/{cat}', { cat: 1 }); // 解析的url为:/books/1
params
params(可选,对象)
参数对象,可用来提供url中的占位符,多出来的属性拼接url的查询参数。
actions
actions(可选,对象)
可以用来对已有的action进行配置,也可以用来定义新的action。
默认的aciton配置为:
resource.actions = { get: {method: 'get'}, save: {method: 'post'}, query: {method: 'get'}, update: {method: 'put'}, remove: {method: 'delete'}, delete: {method: 'delete'} }
修改默认值action配置
this.$resource( '/books/{cat}', { cat: 1 }, { charge: { method: 'post', params: { charge: true } } });
actions对象中的单个action如charge对象可以包含options中的所有属性,且有限即高于iotions对象
options
options(可选,对象)
resource方法执行后返回一个包含了所有action方法名的对象。其包含自定义的action方法
resource请求数据
var resouce = this.$resource('/books/{id}'); // 查询 // 第一个参数为params对象,优先级高于resource发方法的params参数 resoure.get({id: 1}).then(function ( response ) { this.$set('item', response.item); }); // 保存 // 第二个参数为要发送的数据 resource.seve({id: 1}, {item: this.item}).then(function () { // 请求成功回调 }, function () { // 请求失败回调 }); resource.delete({id: 1}).then(function () { // 请求成功回调 }, function () { // 请求失败回调 });
拦截器
可以全局进行拦截器设置。拦截器在发送请求前或响应返回时做一些特殊的处理。
拦截器的注册
vue.http.interceptors.push({ request: function ( request ) { // 更改请求类型为post request.method = 'post'; return request; }, response: function ( response ) { // 修改返回数据 response.data = [{ custom: 'custom' }]; return response; } });
工厂函数注册
vue.http.interceptors.push(function () { return { request: function ( request ) { return request; }, response: function ( response ) { return response; } } }); vue.http.interceptors.push(function ( request, next ) { // 请求发送前的处理逻辑 next(function () { // 请求发送后的处理逻辑 // 更具请求的状态, response参数会返回给 successcallback或errorcallback return response }); });
实现的功能:
ajax请求的loading界面
vue.http.interceptors.push((request, next) => { // 通过控制 组件的`v-show`值显示loading组件 loading.show = true; next((response) => { loading.show = false return response }); });
请求失败时的提示对话框
跨域ajax
vue-resource中用到的cors特性,和 xhmlhttprequest2的替代品 xdomainrequest
xdomain只支持get和post两种请求。如果要在vue-resource中使用其它方法请求,设置请求选项的emulatehttp为true。
xhmlhttprequest2 cors
xhmlhttprequest2提交ajax请求还是和普通的xmlhttprequset请求一样,只是增加了一些新特性。
在提交ajax跨域请求时,需要知道当前浏览器是支持xhmlhttprequest2, 判断方法使用 in操作符检测当前 xmlhttprequest实例对象是否包含 withcredentials属性,如果包含则支持cors
var xhrcors = 'withcredentials' in new xmlhttprequest();
在支持cors的情况下,还需啊哟服务端启用cors支持。
例如:
需要从http://example.com:8080提交到http://example.com/8088,需要在http://example.com添加响应头
access-control-allow-origin: *
xdomainrequest
如果vue0resource不支持xmlhttprequest2,则会降级使用用xdomainrequest
promise
vue.resource基本http调用和restful调用action方法执行后都会返回一个promise对象。该promise对象提供了then,catch,finally。
var promise - this.$http.post( 'http://example.com/book/cretae', // 请求体中要发送给服务端数据 { cat: '1', name: 'newbook' }, { headers: { 'content-type': 'x-www-form-urlencoded' } } ); promise.then(function ( response ) { // 成功回调 }, function ( response ) { // 失败回调 }); promise.catch(function ( response ) { // 失败回调 }); promise.finally(function () { // 执行完成或者失败回调后都会执行此逻辑。 }); // 所有回调函数的this都指向组件实例
url模板
vue-resource 使用url-template库来解析url模板.
在vue-resourece方法请求传参时 可以在url中放置花括号包围的占位符。vue-resouce内部会使用url0template将占位符用params对象中的属性进行替换。
question
如何发送jsonp请求
vue-resouce提供三种调用方式进行跨域
全局方法
vue.http({ url: 'http://example.com/books', // 参数部分,将会拼接在url之后 params: { cat: 1 }, method: 'jsonp' }) .then(function ( response ){ }, function () { //error });
实例底层方法
http.$http({ url: 'http://example.com/books', params: { cat: 1 }, method: 'jsonp' }) .then(function () { // this 指向当前组件实例 }, function () { });
实例便捷方法
this.$http.jsonp( 'http://www.example.com/books', { cat: 1 } ) .then(function () { }, function () { });
修改数据类型
如何修改发送给服务端的数据类型
在默认情况下,对于put,psot,patch,delete等请求,请求头中的content-type为appliaction/json即json类型。有时候需要将数据提交为指定类型如application/x-www-form-urlencoded,multipart/form-data,txt/plain等。
全局headers配置
vue.http.heaers.post['content-type'] = 'application/x-www-form-urlencoded'
实例配置
this.$http.post( 'http://example.com/books', // 成功回调 function ( data, status, request ) { if ( status == 200 ) { consl.dir(data); } }, // 配置请求头 headres: { 'content-type': 'multipart/form-data' } ); // 实例配置的优先级高于全局配置
跨域请求出错
跨域请求需要服务端开启cors支持
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。
上一篇: Vue之Watcher源码解析(1)