vue_resource

约定不等于承诺〃 2022-06-08 10:19 100阅读 0赞

引入vue-resource：

基本语法  
　　引入vue-resource后，可以基于全局的Vue对象使用http，也可以基于某个Vue实例使用http。  
// 基于全局Vue对象使用:

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

在发送请求后，使用then方法来处理响应结果，then方法有两个参数，第一个参数是响应成功时的回调函数，第二个参数是响应失败时的回调函数。  
then方法的回调函数也有两种写法，第一种是传统的函数写法，第二种是更为简洁的ES 6的Lambda写法：

// 传统写法
    this.$http.get('/someUrl', [options]).then(function(response){    
        // 响应成功回调
    }, function(response){    
        // 响应错误回调
    });
    
    // Lambda写法
    this.$http.get('/someUrl', [options]).then((response) => {    
        // 响应成功回调
    }, (response) => {    
        // 响应错误回调
    });

支持的HTTP方法  
vue-resource的请求API是按照REST风格设计的，它提供了7种请求API：

*  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方法。当服务端使用REST API时，客户端的编码风格和服务端的编码风格近乎一致，这可以减少前端和后端开发人员的沟通成本。

<table> 
 <thead> 
  <tr> 
   <th>客户端请求方法</th> 
   <th style="text-align:center">服务端处理方法</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>this.$http.get(...)</code></td> 
   <td style="text-align:center"><code>Getxxx</code></td> 
  </tr> 
  <tr> 
   <td><code>this.$http.post(...)</code></td> 
   <td style="text-align:center"><code>Postxxx</code></td> 
  </tr> 
  <tr> 
   <td><code>this.$http.put(...)</code></td> 
   <td style="text-align:center"><code>Putxxx</code></td> 
  </tr> 
  <tr> 
   <td><code>this.$http.delete(...)</code></td> 
   <td style="text-align:center"><code>Deletexxx</code></td> 
  </tr> 
 </tbody> 
</table>

## 3.options对象 ##

发送请求时的options选项对象包含以下属性：

<table> 
 <thead> 
  <tr> 
   <th>参数</th> 
   <th style="text-align:center">类型</th> 
   <th style="text-align:center">描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>url</td> 
   <td style="text-align:center">string</td> 
   <td style="text-align:center">请求的URL</td> 
  </tr> 
  <tr> 
   <td>method</td> 
   <td style="text-align:center">string</td> 
   <td style="text-align:center">请求的HTTP方法，例如：'GET', 'POST'或其他HTTP方法</td> 
  </tr> 
  <tr> 
   <td>body</td> 
   <td style="text-align:center">Object, FormData string</td> 
   <td style="text-align:center">request body</td> 
  </tr> 
  <tr> 
   <td>params</td> 
   <td style="text-align:center">Object</td> 
   <td style="text-align:center">请求的URL参数对象</td> 
  </tr> 
  <tr> 
   <td>headers</td> 
   <td style="text-align:center">Object</td> 
   <td style="text-align:center">request header</td> 
  </tr> 
  <tr> 
   <td>timeout</td> 
   <td style="text-align:center">number</td> 
   <td style="text-align:center">单位为毫秒的请求超时时间 (0 表示无超时时间)</td> 
  </tr> 
  <tr> 
   <td>before</td> 
   <td style="text-align:center">function(request)</td> 
   <td style="text-align:center">请求发送前的处理函数，类似于jQuery的beforeSend函数</td> 
  </tr> 
  <tr> 
   <td>progress</td> 
   <td style="text-align:center">function(event)</td> 
   <td style="text-align:center">ProgressEvent回调处理函数</td> 
  </tr> 
  <tr> 
   <td>credientials</td> 
   <td style="text-align:center">boolean</td> 
   <td style="text-align:center">表示跨域请求时是否需要使用凭证</td> 
  </tr> 
  <tr> 
   <td>emulateHTTP</td> 
   <td style="text-align:center">boolean</td> 
   <td style="text-align:center">发送PUT, PATCH, DELETE请求时以HTTP POST的方式发送，并设置请求头的X-HTTP-Method-Override</td> 
  </tr> 
  <tr> 
   <td>emulateJSON</td> 
   <td style="text-align:center">boolean</td> 
   <td style="text-align:center">将request body以application/x-www-form-urlencoded content type发送</td> 
  </tr> 
 </tbody> 
</table>

**emulateHTTP的作用**  
　　如果Web服务器无法处理PUT, PATCH和DELETE这种REST风格的请求，你可以启用enulateHTTP选项。启用该选项后，请求会以普通的POST方法发出，并且HTTP头信息的`X-HTTP-Method-Override`属性会设置为实际的HTTP方法。`Vue.http.options.emulateHTTP = true`;  
**emulateJSON的作用**  
　　如果Web服务器无法处理编码为application/json的请求，你可以启用`emulateJSON`选项。启用该选项后，请求会以`application/x-www-form-urlencoded`作为MIME type，就像普通的HTML表单一样。`Vue.http.options.emulateJSON = true`;  
response对象包含以下属性：

<table> 
 <thead> 
  <tr> 
   <th>方法</th> 
   <th style="text-align:center">类型</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>text()</td> 
   <td style="text-align:center">string</td> 
   <td>以string形式返回response body</td> 
  </tr> 
  <tr> 
   <td>json()</td> 
   <td style="text-align:center">Object</td> 
   <td>以JSON对象形式返回response body</td> 
  </tr> 
  <tr> 
   <td>blob()</td> 
   <td style="text-align:center">Blob</td> 
   <td>以二进制形式返回response body</td> 
  </tr> 
  <tr> 
   <td>ok</td> 
   <td style="text-align:center">boolean</td> 
   <td>响应的HTTP状态码在200~299之间时，该属性为true</td> 
  </tr> 
  <tr> 
   <td>status</td> 
   <td style="text-align:center">number</td> 
   <td>响应的HTTP状态码</td> 
  </tr> 
  <tr> 
   <td>statusText</td> 
   <td style="text-align:center">string</td> 
   <td>响应的状态文本</td> 
  </tr> 
  <tr> 
   <td>headers</td> 
   <td style="text-align:center">Object</td> 
   <td>响应头</td> 
  </tr> 
 </tbody> 
</table>

注意：本文的`vue-resource`版本为`v0.9.3`，如果你使用的是`v0.9.0`以前的版本，`response`对象是没有`json()`, `blob()`, `text()`这些方法的。

## 4.CURD示例 ##

提示：以下示例仍然沿用上一篇的组件和WebAPI，组件的代码和页面HTML代码我就不再贴出来了。

#### 4.1GET请求 ####

var demo = new Vue({
        el: '#app',    
        data: {
                gridColumns: ['customerId', 'companyName', 'contactName', 'phone'],
                gridData: [],        
                apiUrl: 'http://211.149.193.19:8080/api/customers'
            },    
            ready: function() {        
                this.getCustomers()    
                },    
            methods: {        
                getCustomers: function() {
                this.$http.get(this.apiUrl)                
                .then((response) => {                    
                    this.$set('gridData', response.data)                
                    }).catch(function(response) {                    
                        console.log(response)                
                    })        
                }    
        }
    });

这段程序的then方法只提供了`successCallback`，而省略`了errorCallback`。catch方法用于捕捉程序的异常，catch方法和`errorCallback`是不同的，`errorCallback`只在响应失败时调用，而catch则是在整个请求到响应过程中，只要程序出错了就会被调用。  
在then方法的回调函数内，你也可以直接使用this，this仍然是指向Vue实例的：

getCustomers: function() {    
        this.$http.get(this.apiUrl)        
        .then((response) => {
            this.$set('gridData', response.data)    
        }).catch(function(response) {            
            console.log(response)        
        })
    }

\*\*为了减少作用域链的搜索，建议使用一个局部变量来接收this。

### 4.2JSONP请求 ###

getCustomers: function() {    
        this.$http.jsonp(this.apiUrl)
        .then(function(response){        
            this.$set('gridData', response.data)    
        })
    }

### 4.3POST请求 ###

var demo = new Vue({    
        el: '#app',    
        data: {        
            show: false,        
            gridColumns: [
                          {
                            name: 'customerId',            
                            isKey: true        
                          },
                          {name: 'companyName'}, 
                          {name: 'contactName'}, 
                          {name: 'phone'}
                          ],        
            gridData: [],        
            apiUrl: 'http://211.149.193.19:8080/api/customers',        
            item: {}
        },    
        ready: function() {        
                this.getCustomers()    },    
        methods: {        
            closeDialog: function() {
    
                this.show = false        
                },        
            getCustomers: function() {            
                var vm = this;
    
                vm.$http.get(vm.apiUrl)                
                .then((response) => {                    
                    vm.$set('gridData', response.data)                
                    })        
            },        
            createCustomer: function() {
                var vm = this            
                vm.$http.post(vm.apiUrl, vm.item)                
                .then((response) => {                    
                    vm.$set('item', {})                    
                    vm.getCustomers()                
                })            
                this.show = false        
            }
    
        }
    });

#### 4.4PUT请求 ####

updateCustomer: function() {    
        var vm = this    
        vm.$http.put(this.apiUrl + '/' + vm.item.customerId, vm.item)        
        .then((response) => {
    
            vm.getCustomers()
    
        })
    }

#### 4.5Delete请求 ####

deleteCustomer: function(customer){    
        var vm = this    
        vm.$http.delete(this.apiUrl + '/' + customer.customerId)        
        .then((response) => {            
            vm.getCustomers()    
    
        })
    }

## 3.使用resource服务 ##

`vue-resource`提供了另外一种方式访问`HTTP——resource`服务，`resource`服务包含以下几种默认的`action`：

get: {method: 'GET'},
    save: {method: 'POST'},
    query: {method: 'GET'},
    update: {method: 'PUT'},
    remove: {method: 'DELETE'},
    delete: {method: 'DELETE'}

## 4.resource对象也有两种访问方式 ##

### 4.1全局访问 ###

`Vue.resource` 实例访问：`this.$resource`可以结合URI `Template`一起使用，以下示例的`apiUrl`都设置为`{/id}`了：

apiUrl: 'http://211.149.193.19:8080/api/customers{/id}'

#### 4.1.1 GET请求 ####

使用get方法发送GET请求，下面这个请求没有指定\{/id\}。

getCustomers: function() {    
        var resource = this.$resource(this.apiUrl)        
        vm = this    resource.get()        
        .then((response) => {            
            vm.$set('gridData', response.data)        
        }).catch(function(response) {    
    
            console.log(response)
        })
    }

#### 4.1.2 POST请求 ####

使用save方法发送POST请求，下面这个请求没有指定\{/id\}。

createCustomer: function() {    
        var resource = this.$resource(this.apiUrl)        
        vm = this            
        resource.save(vm.apiUrl, vm.item)        
        .then((response) => {            
            vm.$set('item', {
    
            })            
            vm.getCustomers()        
        })    
        this.show = false
    }

#### 4.1.3 PUT请求 ####

使用update方法发送PUT请求，下面这个请求指定了\{/id\}。

updateCustomer: function() {    
        var resource = this.$resource(this.apiUrl)        
        vm = this            
        resource.update({ 
                id: vm.item.customerId
            }, vm.item)        
            .then((response) => {            
                vm.getCustomers()        
            })
    }

\{/id\}相当于一个占位符，当传入实际的参数时该占位符会被替换。例如，`{ id: vm.item.customerId}`中的`vm.item.customerId`为12，那么发送的请求URL为：`http://211.149.193.19:8080/api/customers/12`

#### 4.1.4 DELETE请求 ####

使用`remove`或`delete`方法发送`DELETE`请求，下面这个请求指定了`{/id}`。

deleteCustomer: function(customer){    
        var resource = this.$resource(this.apiUrl)        
        vm = this            
        resource.remove({ id: customer.customerId})        
        .then((response) => {            
            vm.getCustomers()        
        })
    }

### 4.2使用inteceptor ###

拦截器可以在请求发送前和发送请求后做一些处理。

![1240][]

image

基本用法

Vue.http.interceptors.push((request, next) => {
            // ...
            // 请求发送前的处理逻辑
            // ...
        next((response) => {
            // ...
            // 请求发送后的处理逻辑
            // ...
            // 根据请求的状态，response参数会返回给successCallback或errorCallback
            return response
        })
    })

在response返回给`successCallback`或`errorCallback`之前，你可以修改`response`中的内容，或做一些处理。例如，响应的状态码如果是404，你可以显示友好的404界面。  
如果不想使用`Lambda`函数写法，可以用平民写法：

Vue.http.interceptors.push(function(request, next) {
        // ...
        // 请求发送前的处理逻辑
        // ...
        next(function(response) {
            // ...
            // 请求发送后的处理逻辑
            // ...
            // 根据请求的状态，response参数会返回给successCallback或errorCallback
            return response
        })
    })

**示例1**  
之前的CURD示例有一处用户体验不太好，用户在使用一些功能的时候如果网络较慢，画面又没有给出反馈，用户是不知道他的操作是成功还是失败的，他也不知道是否该继续等待。  
通过`inteceptor`，我们可以为所有的请求处理加一个`loading`：请求发送前显示`loading`，接收响应后隐藏loading。  
具体步骤如下：  
**1.添加一个loading组件**

**2.将loading组件作为另外一个Vue实例的子组件**

var help = new Vue({
        el: '#help',
        data: {
            showLoading: false
        },
        components: {
            'loading': {
                template: '#loading-template',
            }
        }
    })

**3.将该Vue实例挂载到某个HTML元素**

**4.添加inteceptor**

Vue.http.interceptors.push((request, next) => {
        loading.show = true
        next((response) => {
            loading.show = false
            return response
        });
    });

![strip][]

View Demo  
**示例2**  
当用户在画面上停留时间太久时，画面数据可能已经不是最新的了，这时如果用户删除或修改某一条数据，如果这条数据已经被其他用户删除了，服务器会反馈一个404的错误，但由于我们的put和delete请求没有处理`errorCallback`，所以用户是不知道他的操作是成功还是失败了。  
你问我为什么不在每个请求里面处理`errorCallback`，这是因为我比较懒。这个问题，同样也可以通过`inteceptor`解决。  
**1. 继续沿用上面的loading组件，在\#help元素下加一个对话框**

<div id='help'>
        <loading v-show='showLoading' ></loading>
        <modal-dialog :show='showDialog'>
            <header class='dialog-header' slot='header'>
                <h3 class='dialog-title'>Server Error</h3>
            </header>
            <div class='dialog-body' slot='body'>
                <p class='error'>Oops,server has got some errors, error code: {
        {errorCode}}.</p>
            </div>
        </modal-dialog>
    </div>

**2.给help实例的data选项添加两个属性**

var help = new Vue({
            el: '#help',
            data: {
                showLoading: false,
                showDialog: false,
                errorCode: ''
            },
            components: {
                'loading': {
                    template: '#loading-template',
                }
            }
        })

**3.修改inteceptor**

Vue.http.interceptors.push((request, next) => {
        help.showLoading = true
        next((response) => {
            if(!response.ok){
                help.errorCode = response.status
                help.showDialog = true
            }
            help.showLoading = false
            return response
        });
    });

![strip 1][]

## 总结 ##

`vue-resource`是一个非常轻量的用于处理HTTP请求的插件，它提供了两种方式来处理HTTP请求：  
使用Vue.http或`this.$http` 使用`Vue.resource`或`this.$resource`这两种方式本质上没有什么区别，阅读`vue-resource`的源码，你可以发现第2种方式是基于第1种方式实现的。  
`inteceptor`可以在请求前和请求后附加一些行为，这意味着除了请求处理的过程，请求的其他环节都可以由我们来控制。

[1240]: /images/20220608/4987abd18c7e44698ffc340015db3e2e.png
[strip]: /images/20220608/1cf71d7fb3c246be9d4da8172222254a.png
[strip 1]: /images/20220608/2d9f11088b1b407799151f05bb3ed6ba.png

vue_resource

发表评论取消回复

还没有评论，来说两句吧...

相关阅读