vue 数据代理帮助类 ux-data-proxy
最近利用lodash实现了一个请求数据的代理类,主要用于列表分页查询,灵感来至于ExtJs中的Ext.data.Store,相关配置作用也是一样的。
git地址:https://github.com/jy02534655/data-proxy
安装代理模块
npm install ux-data-proxy
使用
假如后端返回数据格式如下
{ "code": 1, "msg": "查询成功", "data": { "records": [{ "id": 119, "name": "的鹅鹅鹅饿鹅", "telephone": "18888888888" }, { "id": 118, "name": "未命名", "telephone": "18899999999" }], "total": 62 } }
使用axios请求数据并不做任何处理
vue代码如下(ts写法)
table :data="tableList.data" > pagination @size-change="onSizeChange" @current-change="onCurrentChange" :current-page="tableList.pagination.curr" :page-sizes="[5, 10, 20 ,30]" :page-size="tableList.pagination.limit" :total="tableList.pagination.total" layout="total, sizes, prev, pager, next, jumper" >
可用配置
const defaultProxy = { // 代理类型,默认为经典代理 type: 'promise.classic', // 每次加载几条数据,默认为10 pageSize: 10, // 当前页码,默认为1 page: 1, // 分页每页显示条数字段名称,默认为limit,此参数传递到服务端 limitParam: 'limit', // 分页页码字段名称,默认为page,此参数传递到服务端 pageParam: 'page', // 当前分页配置节点名称,默认为page paginationParam: 'pagination', // 初始化后是否自动加载数据 autoLoad: false, // 扩展,请求失败后执行函数 failure: null, // 扩展,请求数据前处理请求参数函数 writerTransform: null, // 扩展,请求数据成功后处理数据结果函数 readerTransform: null, // 扩展 处理单个数据对象的函数 disposeItem: null, // 读取数据相关配置 reader: { // 数据根节点名称 rootProperty: "data", // 判断请求是否成功的节点名称 successProperty: "success", // 数据总数节点名称 totalProperty: "total", // 请求失败后失败消息节点名称 messageProperty: 'message' } };
二次扩展
import proxy from "ux-data-proxy"; import { defaultsDeep, mixin } from "lodash"; import { Message } from 'element-ui'; // 默认配置1 const currentProxy = { limitParam: 'pageSize', pageParam: "current", // 显示错误消息 isErrorMessage: true, // 初始化后自动加载数据 autoLoad: true, // 读取数据相关配置 reader: { // 数据根节点 rootProperty: "data.data.records", successProperty: "data.code", totalProperty: "data.data.total", messageProperty: 'data.data.msg' } }; // 默认配置2 const defaultProxy = { limitParam: 'pageSize', pageParam: 'currentPage', autoLoad: true, // 读取数据相关配置 reader: { // 数据根节点 rootProperty: "data.records", successProperty: "code", totalProperty: "data.total", messageProperty: 'data.msg' } }; // 扩展数据请求代理 export default { /** * 初始化 * * @param {*} store,数据源对象 */ init(store: any) { // 根据配置类型读取不同的默认配置 switch (store.proxy.configType) { case 'current': store.proxy = defaultsDeep(store.proxy, currentProxy); break; default: store.proxy = defaultsDeep(store.proxy, defaultProxy); break; } console.log('newStore.init'); proxy.init(store); // 将当前代理对象的方法挂载到数据源对象,代理对象的方法会覆盖代理对象原有的方法 // 如果放在 proxy.init(store);之后执行 // 它本身的方法会覆盖代理对象的方法,放在前面则相反 mixin(store, this); }, // 扩展,请求失败后执行函数 failure(res: any) { const me = this as any; if (me.proxy.isErrorMessage) { // 显示错误提示 Message({ // duration:0, message: res.message, type: "error", customClass: "zZindex" }); } }, // 扩展,请求数据成功后处理数据结果函数 readerTransform(res: any) { console.log('readerTransform') return res; }, // 扩展,请求数据前处理请求参数函数 writerTransform(params: any) { console.log('writerTransform') return params; } }