refactor: 字典TypeScirpt类型约束补充

src/views/system/dict/components/Dict.vue

@@ -1,45 +1,51 @@
 <template>
   <div class="app-container">
     <!-- 搜索表单 -->
-    <el-form
+    <el-form ref="queryFormRef" :model="state.queryParams" :inline="true">
-        :model="state.queryParams"
-        ref="queryForm"
-        :inline="true"
-    >
       <el-form-item>
-        <el-button type="success" :icon="Plus" @click="handleAdd">新增</el-button>
+        <el-button type="success" :icon="Plus" @click="handleAdd"
-        <el-button type="danger" :icon="Delete" :disabled="state.multiple" @click="handleDelete">删除
+          >新增</el-button
+        >
+        <el-button
+          type="danger"
+          :icon="Delete"
+          :disabled="state.multiple"
+          @click="handleDelete"
+          >删除
         </el-button>
       </el-form-item>
 
       <el-form-item prop="name">
         <el-input
-            v-model="state.queryParams.name"
+          v-model="state.queryParams.name"
-            placeholder="字典名称"
+          placeholder="字典名称"
-            clearable
+          clearable
-            @keyup.enter.native="handleQuery"/>
+          @keyup.enter="handleQuery"
+        />
       </el-form-item>
       <el-form-item>
-        <el-button type="primary" :icon="Search" @click="handleQuery">搜索</el-button>
+        <el-button type="primary" :icon="Search" @click="handleQuery"
+          >搜索</el-button
+        >
         <el-button :icon="Refresh" @click="resetForm">重置</el-button>
       </el-form-item>
     </el-form>
 
     <!-- 数据表格 -->
     <el-table
-        highlight-current-row
+      highlight-current-row
-        :data="state.pageList"
+      :data="dictList"
-        v-loading="state.loading"
+      v-loading="loading"
-        @row-click="handleRowClick"
+      @row-click="handleRowClick"
-        @selection-change="handleSelectionChange"
+      @selection-change="handleSelectionChange"
-        border
+      border
     >
-      <el-table-column type="selection" width="55" align="center"/>
+      <el-table-column type="selection" width="55" align="center" />
-      <el-table-column label="字典名称" prop="name" width="120"/>
+      <el-table-column label="字典名称" prop="name" width="120" />
-      <el-table-column label="字典编码" prop="code"/>
+      <el-table-column label="字典编码" prop="code" />
       <el-table-column label="状态" align="center" width="80">
         <template #default="scope">
-          <el-tag v-if="scope.row.status===1" type="success" >启用</el-tag>
+          <el-tag v-if="scope.row.status === 1" type="success">启用</el-tag>
           <el-tag v-else type="info">禁用</el-tag>
         </template>
       </el-table-column>
@@ -47,56 +53,63 @@
       <el-table-column label="操作" align="center" width="150">
         <template #default="scope">
           <el-button
-              type="primary"
+            type="primary"
-              :icon="Edit"
+            :icon="Edit"
-              circle
+            circle
-              plain
+            plain
-              @click.stop="handleUpdate(scope.row)"
+            @click.stop="handleUpdate(scope.row)"
           />
           <el-button
-              type="danger"
+            type="danger"
-              :icon="Delete"
+            :icon="Delete"
-              circle
+            circle
-              plain
+            plain
-              @click.stop="handleDelete(scope.row)"
+            @click.stop="handleDelete(scope.row)"
           />
         </template>
       </el-table-column>
     </el-table>
 
     <pagination
-        v-show="state.total>0"
+      v-show="total > 0"
-        :total="state.total"
+      :total="total"
-        v-model:page="state.queryParams.pageNum"
+      v-model:page="queryParams.pageNum"
-        v-model:limit="state.queryParams.pageSize"
+      v-model:limit="queryParams.pageSize"
-        @pagination="handleQuery"
+      @pagination="handleQuery"
     />
 
     <!-- 弹窗表单 -->
     <el-dialog
-        :title="state.dialog.title"
+      :title="dialog.title"
-        v-model="state.dialog.visible"
+      v-model="dialog.visible"
-        width="500px"
+      width="500px"
-        @close="cancel">
+      @close="cancel"
+    >
       <el-form
-          ref="dataForm"
+        ref="dataFormRef"
-          :model="state.formData"
+        :model="formData"
-          :rules="state.rules"
+        :rules="rules"
-          label-width="80px">
+        label-width="80px"
+      >
         <el-form-item label="字典名称" prop="name">
-          <el-input v-model="state.formData.name" placeholder="请输入字典名称"/>
+          <el-input v-model="formData.name" placeholder="请输入字典名称" />
         </el-form-item>
         <el-form-item label="字典编码" prop="code">
-          <el-input v-model="state.formData.code" placeholder="请输入字典编码"/>
+          <el-input v-model="formData.code" placeholder="请输入字典编码" />
         </el-form-item>
         <el-form-item label="状态" prop="status">
-          <el-radio-group v-model="state.formData.status">
+          <el-radio-group v-model="formData.status">
             <el-radio :label="1">正常</el-radio>
             <el-radio :label="0">停用</el-radio>
           </el-radio-group>
         </el-form-item>
         <el-form-item label="备注" prop="remark">
-          <el-input v-model="state.formData.remark" type="textarea" placeholder="请输入内容"></el-input>
+          <el-input
+            v-model="formData.remark"
+            type="textarea"
+            placeholder="请输入内容"
+            :autosize="{ minRows: 2, maxRows: 4 }"
+          />
         </el-form-item>
       </el-form>
       <template #footer>
@@ -110,17 +123,28 @@
 </template>
 
 <script setup lang="ts">
-import {listDictWithPage, getDictDetail, addDict, updateDict, deleteDict} from "@/api/system/dict";
+import { onMounted, reactive, ref, toRefs } from "vue";
-import {Search, Plus, Edit, Refresh, Delete} from '@element-plus/icons-vue'
+import {
-import {onMounted, reactive, ref, unref} from 'vue'
+  listDictPages,
-import {ElForm, ElMessage, ElMessageBox} from "element-plus";
+  getDictFormDetail,
+  addDict,
+  updateDict,
+  deleteDict,
+} from "@/api/system/dict";
+import { Search, Plus, Edit, Refresh, Delete } from "@element-plus/icons-vue";
+import { ElForm, ElMessage, ElMessageBox } from "element-plus";
+import { Dialog, Dict, DictFormData, DictQueryParam } from "@/types";
+import { status } from "nprogress";
 
-const emit = defineEmits(['dictClick'])
+const queryFormRef = ref(ElForm);
+const dataFormRef = ref(ElForm);
+
+const emit = defineEmits(["dictClick"]);
 
 const state = reactive({
   loading: true,
   // 选中ID数组
-  ids: [],
+  ids: [] as number[],
   // 非单个禁用
   single: true,
   // 非多个禁用
@@ -128,138 +152,120 @@ const state = reactive({
   queryParams: {
     pageNum: 1,
     pageSize: 10,
-    name: undefined
+  } as DictQueryParam,
-  },
+  dictList: [] as Dict[],
-  pageList: [],
   total: 0,
-  dialog: {
+  dialog: {visible:false} as Dialog,
-    title: '',
-    visible: false
-  },
   formData: {
-    id: undefined,
+    status: 1,
-    name: undefined,
+  } as DictFormData,
-    code: undefined,
-    status: undefined,
-    remark: undefined
-  },
   rules: {
-    name: [
+    name: [{ required: true, message: "请输入字典名称", trigger: "blur" }],
-      {required: true, message: '请输入字典名称', trigger: 'blur'}
+    code: [{ required: true, message: "请输入字典编码", trigger: "blur" }],
-    ],
+  },
-    code: [
+});
-      {required: true, message: '请输入字典编码', trigger: 'blur'}
+
-    ]
+const {
-  }
+  total,
-})
+  dialog,
+  ids,
+  loading,
+  single,
+  multiple,
+  queryParams,
+  dictList,
+  formData,
+  rules,
+} = toRefs(state);
 
 function handleQuery() {
-  emit('dictClick',null)
+  emit("dictClick", null);
-  state.loading = true
+  state.loading = true;
-  listDictWithPage(state.queryParams).then(response => {
+  listDictPages(state.queryParams).then(({ data }) => {
-    const {data, total} = response as any
+    state.dictList = data.list;
-    state.pageList = data
+    state.total = data.total;
-    state.total = total
+    state.loading = false;
-    state.loading = false
+  });
-  })
 }
 
 function resetQuery() {
-  state.queryParams = {
+  queryFormRef.value.resetFields();
-    pageNum: 1,
+  handleQuery();
-    pageSize: 10,
-    name: undefined
-  }
-  handleQuery()
 }
 
-
 function handleSelectionChange(selection: any) {
-  state.ids = selection.map((item: any) => item.id)
+  state.ids = selection.map((item: any) => item.id);
-  state.single = selection.length !== 1
+  state.single = selection.length !== 1;
-  state.multiple = !selection.length
+  state.multiple = !selection.length;
 }
 
 function handleAdd() {
-  resetForm()
   state.dialog = {
-    title: '添加字典',
+    title: "添加字典",
     visible: true,
-  }
+  };
 }
 
 function handleUpdate(row: any) {
-  resetForm()
   state.dialog = {
-    title: '修改字典',
+    title: "修改字典",
-    visible: true
+    visible: true,
-  }
+  };
-  const id = row.id || state.ids
+  const id = row.id || state.ids;
-  getDictDetail(id).then(response => {
+  getDictFormDetail(id).then(({ data }) => {
-    state.formData = response.data
+    state.formData = data;
-  })
+  });
 }
 
-const dataForm = ref(ElForm)
-
 function submitForm() {
-  const form = unref(dataForm)
+  dataFormRef.value.validate((isValid: boolean) => {
-  form.validate((valid: any) => {
+    if (isValid) {
-    if (valid) {
       if (state.formData.id) {
-        updateDict(state.formData.id, state.formData).then(response => {
+        updateDict(state.formData.id, state.formData).then((response) => {
-          ElMessage.success('修改成功')
+          ElMessage.success("修改成功");
-          state.dialog.visible = false
+          state.dialog.visible = false;
-          handleQuery()
+          handleQuery();
-        })
+        });
       } else {
-        addDict(state.formData).then(response => {
+        addDict(state.formData).then((response) => {
-          ElMessage.success('新增成功')
+          ElMessage.success("新增成功");
-          state.dialog.visible = false
+          state.dialog.visible = false;
-          handleQuery()
+          handleQuery();
-        })
+        });
       }
     }
-  })
+  });
 }
 
-
 function resetForm() {
-  state.formData = {
+  dataFormRef.value.resetFields();
-    id: undefined,
-    name: undefined,
-    code: undefined,
-    status: undefined,
-    remark: undefined
-  }
 }
 
 function cancel() {
-  state.dialog.visible = false
+  state.dialog.visible = false;
 }
 
 function handleDelete(row: any) {
-  const ids = [row.id || state.ids].join(',')
+  const ids = [row.id || state.ids].join(",");
-  ElMessageBox.confirm('确认删除已选中的数据项?', '警告', {
+  ElMessageBox.confirm("确认删除已选中的数据项?", "警告", {
-    confirmButtonText: '确定',
+    confirmButtonText: "确定",
-    cancelButtonText: '取消',
+    cancelButtonText: "取消",
-    type: 'warning'
+    type: "warning",
-  }).then(() => {
+  })
-    deleteDict(ids).then(() => {
+    .then(() => {
-      ElMessage.success('删除成功')
+      deleteDict(ids).then(() => {
-      handleQuery()
+        ElMessage.success("删除成功");
+        handleQuery();
+      });
     })
-  }).catch(() =>
+    .catch(() => ElMessage.info("已取消删除"));
-      ElMessage.info('已取消删除')
-  )
 }
 
 function handleRowClick(row: any) {
-  emit('dictClick', row)
+  emit("dictClick", row);
 }
 
 onMounted(() => {
-  handleQuery()
+  handleQuery();
-})
+});
-
 </script>

src/views/system/dict/components/DictItem.vue

@@ -1,95 +1,113 @@
 <template>
   <div class="app-container">
     <!-- 搜索表单 -->
-    <el-form
+    <el-form ref="queryFormRef" :model="queryParams" :inline="true">
-        :model="state.queryParams"
-        ref="queryForm"
-        :inline="true"
-    >
       <el-form-item>
-        <el-button type="success" :icon="Plus" @click="handleAdd">新增</el-button>
+        <el-button type="success" :icon="Plus" @click="handleAdd"
-        <el-button type="danger" :icon="Delete" :disabled="state.multiple" @click="handleDelete">删除</el-button>
+          >新增</el-button
+        >
+        <el-button
+          type="danger"
+          :icon="Delete"
+          :disabled="multiple"
+          @click="handleDelete"
+          >删除</el-button
+        >
       </el-form-item>
       <el-form-item prop="name">
         <el-input
-            v-model="state.queryParams.name"
+          v-model="queryParams.name"
-            placeholder="数据项名称"
+          placeholder="数据项名称"
-            clearable/>
+          clearable
+        />
       </el-form-item>
       <el-form-item>
-        <el-button type="primary" :icon="Search" @click="handleQuery">搜索</el-button>
+        <el-button type="primary" :icon="Search" @click="handleQuery"
+          >搜索</el-button
+        >
         <el-button :icon="Refresh" @click="resetQuery">重置</el-button>
       </el-form-item>
     </el-form>
 
     <!-- 数据表格 -->
     <el-table
-        :data="state.pageList"
+      :data="dictItemList"
-        v-loading="state.loading"
+      v-loading="loading"
-        border
+      border
-        @selection-change="handleSelectionChange"
+      @selection-change="handleSelectionChange"
     >
-      <el-table-column type="selection" min-width="5%"/>
+      <el-table-column type="selection" min-width="5%" />
-      <el-table-column label="数据项名称" prop="name"/>
+      <el-table-column label="数据项名称" prop="name" />
-      <el-table-column label="数据项值" prop="value"/>
+      <el-table-column label="数据项值" prop="value" />
       <el-table-column label="状态" align="center">
         <template #default="scope">
-          <el-tag v-if="scope.row.status===1" type="success">启用</el-tag>
+          <el-tag v-if="scope.row.status === 1" type="success">启用</el-tag>
-          <el-tag v-else type="info" >禁用</el-tag>
+          <el-tag v-else type="info">禁用</el-tag>
         </template>
       </el-table-column>
       <el-table-column label="操作" align="center">
         <template #default="scope">
           <el-button
-              type="primary"
+            type="primary"
-              :icon="Edit"
+            :icon="Edit"
-              circle
+            circle
-              plain
+            plain
-              @click.stop="handleUpdate(scope.row)"
+            @click.stop="handleUpdate(scope.row)"
           />
           <el-button
-              type="danger"
+            type="danger"
-              :icon="Delete"
+            :icon="Delete"
-              circle
+            circle
-              plain
+            plain
-              @click.stop="handleDelete(scope.row)"
+            @click.stop="handleDelete(scope.row)"
           />
         </template>
       </el-table-column>
     </el-table>
 
     <pagination
-        v-show="state.total>0"
+      v-show="state.total > 0"
-        :total="state.total"
+      :total="state.total"
-        v-model:page="state.queryParams.pageNum"
+      v-model:page="state.queryParams.pageNum"
-        v-model:limit="state.queryParams.pageSize"
+      v-model:limit="state.queryParams.pageSize"
-        @pagination="handleQuery"
+      @pagination="handleQuery"
     />
 
     <!-- 表单弹窗 -->
     <el-dialog
-        :title="state.dialog.title"
+      :title="dialog.title"
-        v-model="state.dialog.visible"
+      v-model="dialog.visible"
-        width="500px"
+      width="500px"
-        @close="cancel"
+      @close="cancel"
     >
       <el-form
-          ref="dataForm"
+        ref="dataFormRef"
-          :model="state.formData"
+        :model="formData"
-          :rules="state.rules"
+        :rules="rules"
-          label-width="100px"
+        label-width="100px"
       >
         <el-form-item label="字典名称">
-          <el-input v-model="props.dictName" :disabled="true"/>
+          <el-input v-model="props.dictName" :disabled="true" />
         </el-form-item>
         <el-form-item label="字典项名称" prop="name">
-          <el-input v-model="state.formData.name" placeholder="请输入字典项名称"/>
+          <el-input
+            v-model="state.formData.name"
+            placeholder="请输入字典项名称"
+          />
         </el-form-item>
         <el-form-item label="字典项值" prop="value">
-          <el-input v-model="state.formData.value" placeholder="请输入字典项值"/>
+          <el-input
+            v-model="state.formData.value"
+            placeholder="请输入字典项值"
+          />
         </el-form-item>
         <el-form-item label="排序" prop="sort">
-          <el-input-number v-model="state.formData.sort" style="width: 80px;" controls-position="right" :min="0"/>
+          <el-input-number
+            v-model="state.formData.sort"
+            style="width: 80px"
+            controls-position="right"
+            :min="0"
+          />
         </el-form-item>
         <el-form-item label="状态" prop="status">
           <el-radio-group v-model="state.formData.status">
@@ -112,186 +130,177 @@
 </template>
 
 <script setup lang="ts">
+import { onMounted, reactive, ref, toRefs, unref, watch } from "vue";
+import { ElForm, ElMessage, ElMessageBox } from "element-plus";
 import {
-  listDictItemsWithPage,
+  Dialog,
+  DictItem,
+  DictItemFormData,
+  DictItemQueryParam,
+} from "@/types";
+import {
+  listDictItemPages,
   getDictItemDetail,
   addDictItem,
   updateDictItem,
-  deleteDictItem
+  deleteDictItem,
 } from "@/api/system/dict";
-import {Search, Plus, Edit, Refresh, Delete} from '@element-plus/icons-vue';
+import { Search, Plus, Edit, Refresh, Delete } from "@element-plus/icons-vue";
-import {onMounted, reactive, ref, unref, watch} from 'vue'
+
-import {ElForm, ElMessage, ElMessageBox} from "element-plus";
 
 const props = defineProps({
   dictCode: {
     type: String,
-    default: ''
+    default: "",
   },
   dictName: {
     type: String,
-    default: ''
+    default: "",
-  }
+  },
-})
+});
 
-watch(() => props.dictCode, (newVal, oldVal) => {
+watch(
-  state.queryParams.dictCode = newVal
+  () => props.dictCode,
-  handleQuery()
+  (value) => {
-})
+    state.queryParams.dictCode = value;
+    state.formData.dictCode = value;
+    handleQuery();
+  }
+);
+
+const queryFormRef = ref(ElForm);
+const dataFormRef = ref(ElForm);
 
 const state = reactive({
   loading: true,
   // 选中ID数组
-  ids: [],
+  ids: [] as number[],
   // 非单个禁用
   single: true,
   // 非多个禁用
   multiple: true,
-  queryParams: {
+  queryParams: { pageNum: 1, pageSize: 10 } as DictItemQueryParam,
-    pageNum: 1,
+  dictItemList: [] as DictItem[],
-    pageSize: 10,
-    name: undefined,
-    dictCode: ''
-  },
-  pageList: [],
   total: 0,
-  dialog: {
+  dialog: { visible: false } as Dialog,
-    title: '',
-    visible: false
-  },
   formData: {
-    id: undefined,
+    dictCode: props.dictCode,
-    name: undefined,
+    status: 1,
-    code: undefined,
+    sort: 1,
-    status: undefined,
+  } as DictItemFormData,
-    remark: undefined,
-    sort:undefined,
-    value:undefined
-  },
   rules: {
-    name: [
+    name: [{ required: true, message: "请输入字典项名称", trigger: "blur" }],
-      {required: true, message: '请输入字典项名称', trigger: 'blur'}
+    value: [{ required: true, message: "请输入字典项值", trigger: "blur" }],
-    ],
+  },
-    value: [
+});
-      {required: true, message: '请输入字典项值', trigger: 'blur'}
+
-    ]
+const {
-  }
+  loading,
-})
+  ids,
+  single,
+  multiple,
+  queryParams,
+  dictItemList,
+  total,
+  dialog,
+  formData,
+  rules,
+} = toRefs(state);
 
 function handleQuery() {
   if (state.queryParams.dictCode) {
-    state.loading = true
+    state.loading = true;
-    listDictItemsWithPage(state.queryParams).then(response => {
+    listDictItemPages(state.queryParams).then(({ data }) => {
-      const {data, total} = response as any
+      state.dictItemList = data.list;
-      state.pageList = data
+      state.total = data.total;
-      state.total = total
+      state.loading = false;
-      state.loading = false
+    });
-    })
   } else {
-    state.loading = false
+    state.dictItemList = [];
-    state.pageList = []
+    state.total = 0;
-    state.total = 0
+    state.queryParams.pageNum = 1;
-    state.queryParams.pageNum = 1
+    state.loading = false;
   }
 }
 
 function resetQuery() {
-  state.queryParams = {
+  queryFormRef.value.resetFields();
-    pageNum: 1,
+  handleQuery();
-    pageSize: 10,
-    name: undefined,
-    dictCode: ''
-  }
-  handleQuery()
 }
 
 function handleSelectionChange(selection: any) {
-  state.ids = selection.map((item: any) => item.id)
+  state.ids = selection.map((item: any) => item.id);
-  state.single = selection.length !== 1
+  state.single = selection.length !== 1;
-  state.multiple = !selection.length
+  state.multiple = !selection.length;
 }
 
 function handleAdd() {
-  resetForm()
+  if (!state.formData.dictCode) {
-  state.dialog = {
+    ElMessage.warning("请选择字典后添加数据项");
-    title: '添加字典项',
+    return;
-    visible: true,
   }
+  state.dialog = {
+    title: "添加字典项",
+    visible: true,
+  };
 }
 
 function handleUpdate(row: any) {
-  resetForm()
   state.dialog = {
-    title: '修改字典项',
+    title: "修改字典项",
-    visible: true
+    visible: true,
-  }
+  };
-  const id = row.id || state.ids
+  const id = row.id || state.ids;
-  getDictItemDetail(id).then(response => {
+  getDictItemDetail(id).then(({ data }) => {
-    state.formData = response.data
+    state.formData = data;
-  })
+  });
 }
 
-const dataForm = ref(ElForm)
-
 function submitForm() {
-  const form = unref(dataForm)
+  dataFormRef.value.validate((isValid: boolean) => {
-  form.validate((valid: any) => {
+    if (isValid) {
-    if (valid) {
       if (state.formData.id) {
-        updateDictItem(state.formData.id, state.formData).then(response => {
+        updateDictItem(state.formData.id, state.formData).then((response) => {
-          ElMessage.success('修改成功')
+          ElMessage.success("修改成功");
-          state.dialog.visible = false
+          state.dialog.visible = false;
-          handleQuery()
+          handleQuery();
-        })
+        });
       } else {
-        addDictItem(state.formData).then(response => {
+        addDictItem(state.formData).then((response) => {
-          ElMessage.success('新增成功')
+          ElMessage.success("新增成功");
-          state.dialog.visible = false
+          state.dialog.visible = false;
-          handleQuery()
+          handleQuery();
-        })
+        });
       }
     }
-  })
+  });
 }
 
-
 function resetForm() {
-  state.formData = {
+  dataFormRef.value.resetFields();
-    id: undefined,
-    name: undefined,
-    code: undefined,
-    status: undefined,
-    remark: undefined,
-    sort:undefined,
-    value:undefined
-  }
 }
 
 function cancel() {
-  state.dialog.visible = false
+  state.dialog.visible = false;
 }
 
 function handleDelete(row: any) {
-  const ids = [row.id || state.ids].join(',')
+  const ids = [row.id || state.ids].join(",");
-  ElMessageBox.confirm('确认删除已选中的数据项?', '警告', {
+  ElMessageBox.confirm("确认删除已选中的数据项?", "警告", {
-    confirmButtonText: '确定',
+    confirmButtonText: "确定",
-    cancelButtonText: '取消',
+    cancelButtonText: "取消",
-    type: 'warning'
+    type: "warning",
-  }).then(() => {
+  })
-    deleteDictItem(ids).then(() => {
+    .then(() => {
-      ElMessage.success('删除成功')
+      deleteDictItem(ids).then(() => {
-      handleQuery()
+        ElMessage.success("删除成功");
+        handleQuery();
+      });
     })
-  }).catch(() =>
+    .catch(() => ElMessage.info("已取消删除"));
-      ElMessage.info('已取消删除')
-  )
 }
 
 onMounted(() => {
-  handleQuery()
+  handleQuery();
-})
+});
 </script>
-
-<style scoped>
-
-</style>