使用Vue3+ts 開發ProTable原始碼教學範例

2022-07-18 22:01:37

前臺實現

實現效果

技術棧

vue3 + typescript + element-plus

使用方法

<template>
  <el-tabs type="border-card" v-model="activeName">
    <el-tab-pane
    :label="item.label"
    v-for="(item, index) in templateConfig"
    :key="index" :name="item.name"
    lazy
    >
    <!--所有的 slot內容都在表格內部處理好， columnsType進行區分-->
    <pro-table
      :columns="item.columns"
      :type="item.name"
      :request-url="requestUrl"
    >
    </pro-table>
    </el-tab-pane>
  </el-tabs>
</template>
<script lang="ts" setup>
import { ref } from 'vue'
import ProTable from './components/ProTable/index.vue'
import { ColumnProps, RequestUrl } from './components/ProTable/types'
import { projectConfig, projectConfigBatchDelete } from './service/api'
const activeName = ref('user')
interface TemplateConfig {
  name: string
  label: string
  columns: ColumnProps[],
}
const requestUrl: RequestUrl = {
  create: projectConfig,
  list: projectConfig,
  update: projectConfig,
  destroy: projectConfig,
  batchDelete: projectConfigBatchDelete
}
const templateConfig = ref<TemplateConfig[]>([
  {
    label: 'ProTable',
    name: 'user',
    columns: [
      {
        key: 'userName',
        title: '使用者名稱',
        searchType: 'el-input'
      },
      {
        key: 'password',
        title: '密碼',
        searchType: 'el-input'
      },
      {
        key: 'email',
        title: '郵箱',
        searchType: 'el-input'
      },
      {
        key: 'phone',
        title: '手機號',
        searchType: 'el-input'
      },
      {
        key: 'role',
        title: '角色',
        searchType: 'z-select',
        attrs: {
          options: [
            {
              label: '管理員',
              value: 'admin'
            },
            {
              label: '普通使用者',
              value: 'user'
            }
          ]
        }
      },
      {
        key: 'status',
        title: '狀態',
        searchType: 'z-select',
        attrs: {
          options: [
            {
              label: '啟用',
              value: 1
            },
            {
              label: '禁用',
              value: 0
            }
          ]
        },
        columnType: 'status'
      },
      {
        key: 'hasUseArray',
        title: '是否使用陣列引數?',
        search: false,
        searchType: 'useExpandField',
        show: false,
        add: false
      },
      {
        key: 'arrayParams',
        title: '陣列引數',
        searchType: 'z-array',
        search: false,
        width: 120,
        add: false,
        show: false
      },
      {
        key: 'hasUseArray',
        title: '是否使用JSON引數?',
        search: false,
        searchType: 'useExpandField',
        show: false,
        add: false
      },
      {
        key: 'jsonParams',
        title: 'JSON引數',
        searchType: 'z-json',
        search: false,
        width: 120,
        add: false,
        show: false
      },
      {
        key: 'createdAt',
        title: '建立時間',
        width: 180,
        searchType: 'el-date-picker',
        add: false
      },
      {
        key: 'updatedAt',
        title: '更新時間',
        width: 180,
        searchType: 'el-date-picker',
        add: false
      },
      {
        key: 'action',
        title: '操作',
        search: false,
        add: false,
        width: 150
      }
    ]
  }
])
</script>
<style lang="less">
</style>

ProTable 設計思路

頁面整體分為5個區域，

表單搜尋區域
表格功能按鈕區域
表格右上角操作區域
表格主題區域
表格分頁區域

要考慮的問題？

那些區域是要支援傳入slot的？
表格原有的slot是否要交給使用者來傳遞,還是在內部進行封裝？如colum是狀態的時候需要對映成tag，是陣列型別的時候對映成表格，是json的時候需要點選檢視詳情？假設每個表格都要處理的的話就太麻煩，我們希望通過一個欄位來控制它。
有column的某一列是否需要複製的功能？
列欄位需要編輯的功能？

實現的過程中有哪些細節？

表格的高度，把可表格可視區域的大小交給使用者自己來控制，把批次操作按鈕放在最下面(fixed定位)。這樣使用者可以在最大區域內看到表格的內容。

編碼風格

元件上面屬性如果超過三個，就換行
eslint使用的是standard風格。

css 小知識

<div class='box'>
  <div class='z'></div>
</div>

*{
  box-sizing: border-box;
}
.box{
  display: inline-block;
    vertical-align: top;
}
.z{
  height: 32px;
  border: 1px solid;
  width: 100px;
  display: inline-block;
}

如果把盒子變成了行內元素之後，若其內部還是行內元素，那麼就會產生間隙，就會導致其高度與父元素高度不同。如下。

解決方法也很簡單，則需要設定其子元素的vertical-align屬性，或者設定font-size: 0，其根本原因是因為中間的文字元素也佔位置。再或者不使用inline-block,換做inline-flex屬性完全沒有問題，因為在element-plus元件庫中也大量的使用了這個屬性，相容性也很nice。

這個幾個解決方法很早就知道了，就是關於vertical-algin這個，以及與line-height的關係還是有點模糊，一直也沒去深究。

放兩篇文章

CSS vertical-align 屬性

還有聯想到baseline這個東西在flex,align-items屬性：交叉軸上的一個屬性很像。

flex佈局語法教學詳解

表格操作

新增資料之後，重新獲取資料的時候pageIndex要重置為1，刪除資料的時候也是一樣。
編輯資料的時候，pageIndex不變，還是當前頁碼。
總結下來，就是當資料條數會發生改變的時候，都會重置pageIndex為1。當用戶操作不會影響資料總條數的時候，pageSize還維持當前不變。

小結

使用了一個庫，可以監聽dom元素大小的變化，resize-observer-polyfill。
在 3.x 中，如果一個元素同時定義了 v-bind="object" 和一個相同的獨立 attribute。開發者可以自己選擇要保留哪一個。

檔案地址# v-bind 合併行為

參考文章

JavaScript API——ResizeObserver 的使用

後期功能擴充套件

欄位之間有關聯關係情況的處理，暫時還沒想好。
擴充套件一下slot
等等。。

迭代中....

後臺實現

資料庫 mysql

我這裡使用的是 xampp安裝的，我們來檢視一下版本。這是什麼版本？假的吧，真的到10了嗎？先不管了，能用就行。

建表

CREATE TABLE `project_config`  (
  `id` int NOT NULL AUTO_INCREMENT COMMENT '主鍵',
  `type` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NOT NULL COMMENT '設定型別',
  `value` text CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NOT NULL COMMENT '設定的json字串',
  `created_at` datetime NOT NULL,
  `updated_at` datetime NOT NULL DEFAULT '0000-00-00 00:00:00' ON UPDATE CURRENT_TIMESTAMP,
  PRIMARY KEY (`id`) USING BTREE
) ENGINE = InnoDB AUTO_INCREMENT = 65 CHARACTER SET = utf8mb4 COLLATE = utf8mb4_general_ci ROW_FORMAT = COMPACT;

新建專案

npm init egg --type=simple

專案目錄大致如下所示，

RESTful 風格的 URL 定義

Sequelize

npm install --save egg-sequelize mysql2

在 config/plugin.js 中引入 egg-sequelize 外掛，這裡我們引入了一個庫egg-cors來幫我們實現cors。

'use strict';
/** @type Egg.EggPlugin */
exports.sequelize = {
  enable: true,
  package: 'egg-sequelize',
};
exports.cors = {
  enable: true,
  package: 'egg-cors',
};

在 config/config.default.js 中編寫 sequelize 設定

/* eslint valid-jsdoc: "off" */
'use strict';
/**
 * @param {Egg.EggAppInfo} appInfo app info
 */
module.exports = appInfo =&gt; {
  /**
   * built-in config
   * @type {Egg.EggAppConfig}
   **/
  const config = exports = {};
  // use for cookie sign key, should change to your own and keep security
  config.keys = appInfo.name + '_1655529530112_7627';
  // add your middleware config here
  config.middleware = [];
  config.security = {
    csrf: {
      enable: false,
      ignoreJSON: true,
    },
  };
  config.cors = {
    origin: '*',
    allowMethods: 'GET,HEAD,PUT,POST,DELETE,PATCH',
  };
  // add your user config here
  const userConfig = {
    // myAppName: 'egg',
  };
  // sequelize
  const sequelize = {
    dialect: 'mysql',
    host: '127.0.0.1',
    port: 3306,
    username: 'root',
    password: '123456',
    database: 'test_database',
    timezone: '+08:00',
    dialectOptions: {
      dateStrings: true,
      typeCast: true,
    },
    define: {
      freezeTableName: true, // 模型名強制和表明一致
      underscored: true, // 欄位以下劃線（_）來分割（預設是駝峰命名風格）
    },
  };
  return {
    ...config,
    ...userConfig,
    sequelize,
  };
};

1、時間格式化

型別需要採用：Sequelize.DATE

初始化Sequelize的時候傳入dialectOptions引數，及timezone

timezone: '+08:00',  // 改為標準時區
dialectOptions: {
  dateStrings: true,
  typeCast: true,
},

下面就開始編寫

controller

對這塊需要安裝lodash，懂的都懂。

controller/ProjectConfig.js

'use strict';
const { success } = require('../utils/res');
const { omit, pick } = require('lodash');
const Controller = require('egg').Controller;
class ProjectConfigController extends Controller {
  async index() {
    const { ctx } = this;
    const { pageSize, pageIndex } = ctx.query;
    const { Op, fn, col, where, literal } = this.app.Sequelize;
    // 固定的查詢引數
    const stableQuery = pick(ctx.query, [ 'type', 'createdAt', 'updatedAt' ]);
    const stableQueryArgs = Object.keys(stableQuery)
      .filter(key => Boolean(stableQuery[key]))
      .map(key => {
        return {
          [key]: stableQuery[key],
        };
      });
    const whereCondition = omit(ctx.query, [ 'pageIndex', 'pageSize', 'type', 'createdAt', 'updatedAt' ]);
    // 需要模糊查詢的引數
    const whereArgs = Object.keys(whereCondition)
      .filter(key => Boolean(whereCondition[key]))
      .map(key => {
        return where(fn('json_extract', col('value'), literal(`'$.${key}'`)), {
          [Op.like]: `%${whereCondition[key]}%`,
        });
      });
    const query = {
      where: {
        [Op.and]: [
          ...stableQueryArgs,
          ...whereArgs,
        ],
      },
      order: [
        [ 'createdAt', 'DESC' ],
      ],
      limit: Number(pageSize), // 每頁顯示數量
      offset: (pageIndex - 1) * pageSize, // 當前頁數
    };
    const data = await ctx.model.ProjectConfig.findAndCountAll(query);
    ctx.body = success(data);
  }
  async create() {
    const { ctx } = this;
    const { type, value } = ctx.request.body;
    const data = await ctx.model.ProjectConfig.create({ type, value });
    ctx.body = success(data);
  }
  async update() {
    const { ctx } = this;
    const { type, value } = ctx.request.body;
    const { id } = ctx.params;
    const data = await ctx.model.ProjectConfig.update({ type, value }, { where: { id } });
    ctx.body = success(data);
  }
  async destroy() {
    const { ctx } = this;
    const { id } = ctx.params;
    console.log(id);
    const data = await ctx.model.ProjectConfig.destroy({ where: { id } });
    ctx.body = success(data);
  }
  async batchDestroy() {
    const { ctx } = this;
    const { ids } = ctx.request.body;
    console.log(ids);
    const { Op } = this.app.Sequelize;
    const data = await ctx.model.ProjectConfig.destroy({
      where: {
        id: {
          [Op.in]: ids,
        },
      },
    });
    ctx.body = success(data);
  }
}
module.exports = ProjectConfigController;

模糊查詢

SELECT json_extract(欄位名,'$.json結構') FROM 表名;

sequelize高階查詢

Post.findAll({
  where: sequelize.where(sequelize.fn('char_length', sequelize.col('content')), 7)
});
// SELECT ... FROM "posts" AS "post" WHERE char_length("content") = 7

中文檔案，英文看的吃力，看中文的也無妨，不寒磣。^_^

model

model/project_config.js

'use strict';
module.exports = app => {
  const { STRING, INTEGER, TEXT, DATE } = app.Sequelize;
  const ProjectConfig = app.model.define('project_config', {
    id: { type: INTEGER, primaryKey: true, autoIncrement: true },
    type: { type: STRING },
    value: {
      type: TEXT,
      get() {
        return this.getDataValue('value') ? JSON.parse(this.getDataValue('value')) : null;
      },
      set(value) {
        this.setDataValue('value', JSON.stringify(value));
      },
    },
    createdAt: { type: DATE },
    updatedAt: { type: DATE },
  });
  return ProjectConfig;
};

router.js

'use strict';
/**
 * @param {Egg.Application} app - egg application
 */
module.exports = app => {
  const { router, controller } = app;
  router.get('/api/projectConfig', controller.projectConfig.index);
  router.post('/api/projectConfig', controller.projectConfig.create);
  router.put('/api/projectConfig/:id', controller.projectConfig.update);
  router.delete('/api/projectConfig/:id', controller.projectConfig.destroy);
  router.post('/api/projectConfig/batchDelete', controller.projectConfig.batchDestroy);
};

API 檔案 Apifox

先快速測試一把，然後去對前端程式碼。

ts用到的一些

在型別別名（type alias）的宣告中可以使用 keyof、typeof、in 等關鍵字來進行一些強大的型別操作

interface A {
  x: number;
  y: string;
}
// 拿到 A 型別的 key 字面量列舉型別，相當於 type B = 'x' | 'y'
type B = keyof A;
const json = { foo: 1, bar: 'hi' };
// 根據 ts 的型別推論生成一個型別。此時 C 的型別為 { foo: number; bar: string; }
type C = typeof json;
// 根據已有型別生成相關新型別，此處將 A 型別的所有成員變成了可選項，相當於 type D = { x?: number; y?: string; };
type D = {
  [T in keyof A]?: A[T];
};

在比如用一個聯合型別來約束物件的key，用interface我就沒實現，貌似.

export type FormItemType = 'el-input' | 'z-select' | 'el-date-picker'
// 目前發現 interface 的key 只能是三種 string number symbol   keyof any
type IPlaceholderMapping = {
  [key in FormItemType]: string
}
export const placeholderMapping: IPlaceholderMapping = {
  'el-input': '請輸入',
  'z-select': '請選擇',
  'el-date-picker': '請選擇日期'
}

倉庫地址

ProTable前端程式碼地址

以上就是使用Vue3+ts 開發ProTable原始碼教學範例的詳細內容，更多關於Vue3+ts 開發ProTable的資料請關注it145.com其它相關文章！