Vue使用v-model封裝el-pagination組件的全過程

更新時間：2021年07月07日 08:37:03 作者：阿拉伯1999

通過封裝el-pagination組件開發(fā)自定義分頁組件的類似文章網(wǎng)上已經(jīng)有很多了，但看了一圈，總是不如意，于是決定還是自己動手搞一個，對v-model封裝el-pagination組件相關(guān)知識感興趣的朋友一起看看吧

使用v-model綁定分頁信息對象，分頁信息對象包括3個核心屬性參數(shù)，分頁事件直接綁定查詢數(shù)據(jù)的方法，消除父組件的handleSizeChange和handleCurrentChange的綁定事件方法。

1、前言

通過封裝el-pagination組件開發(fā)自定義分頁組件的類似文章網(wǎng)上已經(jīng)有很多了，但看了一圈，總是不如意，于是決定還是自己動手搞一個。

2、背景

2.1、常規(guī)分頁處理方法

利用el-pagination組件的常規(guī)做法如下：

模板部分：

 <el-pagination @size-change="handleSizeChange"
            @current-change="handleCurrentChange" :current-page="pageInfo.pagenum"
            :page-sizes="[5, 10, 15, 20]" :page-size="pageInfo.pagesize"
            layout="total, sizes, prev, pager, next, jumper" :total="pageInfo.total"
            background>
        </el-pagination>

腳本部分：

export default {
  data() {
    return {
      formData : {
        //查詢信息
        queryInfo:{
          userType  : 0,
          deleteFlag: 2,  //表示所有類型
          pagenum   : 1,
          pagesize  : 10      
        },

        // 用戶類型選擇框當前選中顯示標簽值
        userTypeLabel : "所有類型",

        // 用戶狀態(tài)選擇框當前選中顯示標簽值
        userStatusLabel : "所有類型"
      },
        
      // 分頁信息
      pageInfo:{
        pagenum   : 1,
        pagesize  : 10,
        total     : 0
      }
    }
  },
  methods: {
    // 查詢用戶信息列表
    queryUsers(){
      let _this = this;
      //console.log(this.pageInfo);

      this.formData.queryInfo.pagenum = this.pageInfo.pagenum;
      this.formData.queryInfo.pagesize = this.pageInfo.pagesize;

      this.instance.queryUsers(
        this.$baseUrl,this.formData.queryInfo
      ).then(res => {
        //console.log(res.data);
        if (res.data.code == this.global.SucessRequstCode){
          //如果查詢成功
          _this.pageInfo.total = res.data.data.length;
          _this.userInfoList = res.data.data;
        }else{
          alert(res.data.message);
        }
      }).catch(error => {
        alert('查詢失敗！');            
        console.log(error);
      });
    },    
    // 每頁條數(shù)改變
    handleSizeChange(newSize) {
        this.pageInfo.pagesize = newSize;
        this.queryUsers();
    },
    // 當前頁碼改變
    handleCurrentChange(newPage) {
        this.pageInfo.pagenum = newPage;
        this.queryUsers();
    }
  }

2.2、問題分析

每個分頁查詢，都需要這么來一套，有點簡單重復(fù)，又略有不同，即查詢數(shù)據(jù)的方法會不同。

對于有強迫癥的程序猿來說，簡單重復(fù)的代碼無疑非常令人不爽。因此，需要將之組件化。

分析el-pagination分頁組件：

有三個核心屬性參數(shù)，分別是：當前頁碼（current-page）、每頁條數(shù)（page-size）、總記錄條數(shù)（total）。核心屬性參數(shù)通過綁定父組件頁面數(shù)據(jù)，實行雙向聯(lián)動。其中當前頁碼和每頁條數(shù)一般通過操作分頁子組件來改變，總記錄條數(shù)通過查詢數(shù)據(jù)后由父組件進行設(shè)置。
有兩個事件：分別是：@size-change（每頁條數(shù)改變事件）、@current-change（當前頁碼改變事件）。這兩個事件，分別綁定父組件的對應(yīng)事件處理方法handleSizeChange和handleCurrentChange，兩者均調(diào)用查詢數(shù)據(jù)的方法，查詢數(shù)據(jù)的方法中，得到結(jié)果集后，設(shè)置總記錄條數(shù)。

自定義分頁組件的開發(fā)目標：消除父組件的handleSizeChange和handleCurrentChange的綁定事件方法。

思路：使用v-model綁定分頁信息對象，分頁信息對象包括3個核心屬性參數(shù)，即上述的pageInfo。然后分頁事件直接綁定查詢數(shù)據(jù)的方法。

3、方案實施

3.1、自定義分頁組件

編寫一個自定義分頁組件代碼，文件為/src/Pagination.vue。代碼如下：

<template lang="html">
  <div class="pagination">
    <el-pagination 
      @size-change="handleSizeChange" 
      @current-change="handleCurrentChange"
      :current-page.sync="pageInfo.pagenum"  
      :page-size="pageInfo.pagesize" 
      :page-sizes="pageSizes"
      :total="pageInfo.total"
      layout="total, sizes, prev, pager, next, jumper"
      background >
    </el-pagination>
  </div>   
</template>

<script>
  export default {
    name  : "pagination",
    model : {
        prop    : 'pageInfo',
        event   : 'change'
    },
    props : {
      // 每頁條數(shù)選擇項
      pageSizes: {
        type: Array,
        default() {
          return [5, 10, 15, 20];
        }
      },
      // v-model綁定的數(shù)據(jù)對象
      pageInfo: {
        type: Object,
        reuqired:true
      }
    },
    data(){
      return {            
      }
    },
    methods: {
      handleSizeChange(newSize) {
        var newValue={
					pagesize : newSize,
					pagenum : newSize <= this.total  ?  1  :  this.pageInfo['pagenum'] 
				};
        this.$emit('change',Object.assign(this.pageInfo,newValue));
        this.$emit('pagination');
      },
      handleCurrentChange(newPage) {
        this.$emit('change',Object.assign(this.pageInfo,{pagenum : newPage}));
        this.$emit('pagination');
      }
    }    
  }
</script>

<style lang="css" scoped>
.pagination {
    padding: 10px 0;
    text-align: center;
}
</style>

自定義分頁組件，名稱為pagination，其使用v-model，實現(xiàn)雙向數(shù)據(jù)通信。當頁碼或每頁條數(shù)改變時，觸發(fā)分頁事件@pagination，提供與父組件方法綁定。

此處約定了pageInfo的字段結(jié)構(gòu)如下：

  pageInfo:{
        pagenum   : 1,	//Number
        pagesize  : 10,	//Number
        total     : 0	//Number
      }

父組件必須提供相同結(jié)構(gòu)的數(shù)據(jù)對象來綁定組件內(nèi)部的pageInfo對象。

3.2、注冊分頁組件

然后注冊此分頁組件，在main.js中加入下列代碼：

import pagination  from '@/components/Pagination.vue'

// 注冊分頁插件
Vue.component('pagination', pagination)

3.3、父組件調(diào)用方法

用pagination組件修改前面第二章的代碼。

模板部分：

  <!-- 分頁區(qū)域 -->
        <pagination v-model="pageInfo" @pagination="queryUsers"></pagination>

腳本部分：

export default { 
  data() {
    return {
      formData : {
        //查詢信息
        queryInfo:{
          userType  : 0,
          deleteFlag: 2,  //表示所有類型
          pagenum   : 1,
          pagesize  : 10      
        },

        // 用戶類型選擇框當前選中顯示標簽值
        userTypeLabel : "所有類型",

        // 用戶狀態(tài)選擇框當前選中顯示標簽值
        userStatusLabel : "所有類型"
      },
        
      // 分頁信息
      pageInfo:{
        pagenum   : 1,
        pagesize  : 10,
        total     : 0
      }
    }
  },
  methods: {
    // 查詢用戶信息列表
    queryUsers(){
      let _this = this;
      //console.log(this.pageInfo);

      this.formData.queryInfo.pagenum = this.pageInfo.pagenum;
      this.formData.queryInfo.pagesize = this.pageInfo.pagesize;

      this.instance.queryUsers(
        this.$baseUrl,this.formData.queryInfo
      ).then(res => {
        //console.log(res.data);
        if (res.data.code == this.global.SucessRequstCode){
          //如果查詢成功
          _this.pageInfo.total = res.data.data.length;
          _this.userInfoList = res.data.data;
        }else{
          alert(res.data.message);
        }
      }).catch(error => {
        alert('查詢失敗！');            
        console.log(error);
      });
    }
  }

這樣，就去掉了handleSizeChange和handleCurrentChange事件響應(yīng)方法了。分頁信息發(fā)生改變時，觸發(fā)綁定的queryUsers方法。

另外，如需調(diào)整pageSizes，則在模板處類似如下設(shè)置：