refactor: 所有业务线的接口调用添加TypeScript类型声明描述

src/views/sms/advert/index.vue

@@ -1,77 +1,82 @@
 <template>
   <div class="app-container">
     <!-- 搜索表单 -->
-    <el-form
-        ref="queryForm"
-        :model="queryParams"
-        :inline="true"
-    >
+    <el-form ref="queryFormRef" :model="queryParams" :inline="true">
       <el-form-item>
-        <el-button type="success" :icon="Plus" @click="handleAdd">新增</el-button>
-        <el-button type="danger" :icon="Delete" :disabled="multiple" @click="handleDelete">删除</el-button>
+        <el-button type="success" :icon="Plus" @click="handleAdd"
+          >新增</el-button
+        >
+        <el-button
+          type="danger"
+          :icon="Delete"
+          :disabled="multiple"
+          @click="handleDelete"
+          >删除</el-button
+        >
       </el-form-item>
 
       <el-form-item>
         <el-input
-            v-model="queryParams.title"
-            placeholder="广告标题"
-            clearable
-            @keyup.enter.native="handleQuery"
+          v-model="queryParams.title"
+          placeholder="广告标题"
+          clearable
+          @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="resetQuery">重置</el-button>
       </el-form-item>
     </el-form>
 
     <el-table
-        ref="dataTable"
-        v-loading="loading"
-        :data="pageList"
-        @selection-change="handleSelectionChange"
-        border
+      v-loading="loading"
+      :data="advertList"
+      @selection-change="handleSelectionChange"
+      border
     >
-      <el-table-column type="selection" min-width="5" align="center"/>
-      <el-table-column type="index" label="序号" width="80" align="center"/>
+      <el-table-column type="selection" min-width="5" align="center" />
+      <el-table-column type="index" label="序号" width="80" align="center" />
       <el-table-column prop="title" min-width="100" label="广告标题" />
       <el-table-column label="广告图片" width="100">
         <template #default="scope">
-          <el-popover
-              placement="right"
-              :width="400"
-              trigger="hover">
-            <img :src="scope.row.picUrl" width="400" height="400"/>
+          <el-popover placement="right" :width="400" trigger="hover">
+            <img :src="scope.row.picUrl" width="400" height="400" />
             <template #reference>
-              <img :src="scope.row.picUrl" style="max-height: 60px;max-width: 60px"/>
+              <img
+                :src="scope.row.picUrl"
+                style="max-height: 60px; max-width: 60px"
+              />
             </template>
           </el-popover>
         </template>
       </el-table-column>
-      <el-table-column prop="beginTime" label="开始时间" width="150"/>
-      <el-table-column prop="endTime" label="结束时间" width="150"/>
+      <el-table-column prop="beginTime" label="开始时间" width="150" />
+      <el-table-column prop="endTime" label="结束时间" width="150" />
       <el-table-column prop="status" label="状态" width="100">
         <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>
-      <el-table-column prop="sort" label="排序" width="80"/>
+      <el-table-column prop="sort" label="排序" width="80" />
       <el-table-column label="操作" align="center" width="150">
         <template #default="scope">
           <el-button
-              type="primary"
-              :icon="Edit"
-              circle
-              plain
-              @click.stop="handleUpdate(scope.row)"
+            type="primary"
+            :icon="Edit"
+            circle
+            plain
+            @click.stop="handleUpdate(scope.row)"
           />
           <el-button
-              type="danger"
-              :icon="Delete"
-              circle
-              plain
-              @click.stop="handleDelete(scope.row)"
+            type="danger"
+            :icon="Delete"
+            circle
+            plain
+            @click.stop="handleDelete(scope.row)"
           />
         </template>
       </el-table-column>
@@ -79,49 +84,45 @@
 
     <!-- 分页工具条 -->
     <pagination
-        v-show="total>0"
-        :total="total"
-        v-model:page="queryParams.pageNum"
-        v-model:limit="queryParams.pageSize"
-        @pagination="handleQuery"
+      v-show="total > 0"
+      :total="total"
+      v-model:page="queryParams.pageNum"
+      v-model:limit="queryParams.pageSize"
+      @pagination="handleQuery"
     />
 
     <!-- 表单弹窗 -->
-    <el-dialog
-        :title="dialog.title"
-        v-model="dialog.visible"
-        width="700px"
-    >
+    <el-dialog :title="dialog.title" v-model="dialog.visible" width="700px">
       <el-form
-          ref="dataFormRef"
-          :model="formData"
-          :rules="rules"
-          label-width="100px"
+        ref="dataFormRef"
+        :model="formData"
+        :rules="rules"
+        label-width="100px"
       >
         <el-form-item label="广告标题" prop="title">
-          <el-input v-model="formData.title"/>
+          <el-input v-model="formData.title" />
         </el-form-item>
 
         <el-form-item label="有效期" prop="beginTime">
           <el-date-picker
-              v-model="formData.beginTime"
-              placeholder="开始时间"
-              value-format="YYYY-MM-DD"
+            v-model="formData.beginTime"
+            placeholder="开始时间"
+            value-format="YYYY-MM-DD"
           />
           ~
           <el-date-picker
-              v-model="formData.endTime"
-              placeholder="结束时间"
-              value-format="YYYY-MM-DD"
+            v-model="formData.endTime"
+            placeholder="结束时间"
+            value-format="YYYY-MM-DD"
           />
         </el-form-item>
 
         <el-form-item label="广告图片" prop="picUrl">
-          <single-upload v-model="formData.picUrl"/>
+          <single-upload v-model="formData.picUrl" />
         </el-form-item>
 
         <el-form-item label="排序" prop="sort">
-          <el-input v-model="formData.sort" style="width: 200px"/>
+          <el-input v-model="formData.sort" style="width: 200px" />
         </el-form-item>
 
         <el-form-item label="状态" prop="status">
@@ -132,11 +133,11 @@
         </el-form-item>
 
         <el-form-item label="跳转链接" prop="url">
-          <el-input v-model="formData.url"/>
+          <el-input v-model="formData.url" />
         </el-form-item>
 
         <el-form-item label="备注" prop="remark">
-          <el-input type="textarea" v-model="formData.remark"/>
+          <el-input type="textarea" v-model="formData.remark" />
         </el-form-item>
       </el-form>
 
@@ -146,19 +147,26 @@
           <el-button @click="cancel">取 消</el-button>
         </div>
       </template>
-
     </el-dialog>
   </div>
 </template>
 
 <script setup lang="ts">
-import {listAdvertsWithPage, getAdvertDetail, updateAdvert, addAdvert, deleteAdverts} from '@/api/sms/advert'
+import { onMounted, reactive, ref, toRefs, unref } from "vue";
+import { ElForm, ElMessage, ElMessageBox } from "element-plus";
+import { Search, Plus, Edit, Refresh, Delete } from "@element-plus/icons-vue";
 import SingleUpload from "@/components/Upload/SingleUpload.vue";
-import {onMounted, reactive, ref, toRefs, unref} from "vue";
-import {ElForm, ElMessage, ElMessageBox} from "element-plus";
-import {Search, Plus, Edit, Refresh, Delete} from '@element-plus/icons-vue'
+import {
+  listAdvertPages,
+  getAdvertFormDetail,
+  updateAdvert,
+  addAdvert,
+  deleteAdverts,
+} from "@/api/sms/advert";
+import { AdvertFormData, AdvertItem, AdvertQueryParam, Dialog } from "@/types";
 
-const dataFormRef = ref(ElForm)  // 属性名必须和元素的ref属性值一致
+const queryFormRef = ref(ElForm); // 属性名必须和元素的ref属性值一致
+const dataFormRef = ref(ElForm); // 属性名必须和元素的ref属性值一致
 
 const state = reactive({
   loading: true,
@@ -168,150 +176,124 @@ const state = reactive({
   single: true,
   // 非多个禁用
   multiple: true,
-  queryParams: {
-    pageNum: 1,
-    pageSize: 10,
-    title: undefined
-  },
-  pageList: [],
+  queryParams: { pageNum: 1, pageSize: 10 } as AdvertQueryParam,
+  advertList: [] as AdvertItem[],
   total: 0,
-  dialog: {
-    title: '',
-    visible: false
-  },
+  dialog: {} as Dialog,
   formData: {
-    id: undefined,
-    title: '',
-    picUrl: '',
-    beginTime: undefined,
-    endTime: undefined,
     status: 1,
     sort: 100,
-    url: undefined,
-    remark: undefined
-  },
+  } as AdvertFormData,
   rules: {
-    title: [
-      {required: true, message: '请输入广告名称', trigger: 'blur'}
-    ],
-    beginTime: [
-      {required: true, message: '请填写开始时间', trigger: 'blur'}
-    ],
-    endTime: [
-      {required: true, message: '请填写结束时间', trigger: 'blur'}
-    ],
-    picUrl: [
-      {required: true, message: '请上传广告图片', trigger: 'blur'}
-    ]
-  }
-})
+    title: [{ required: true, message: "请输入广告名称", trigger: "blur" }],
+    beginTime: [{ required: true, message: "请填写开始时间", trigger: "blur" }],
+    endTime: [{ required: true, message: "请填写结束时间", trigger: "blur" }],
+    picUrl: [{ required: true, message: "请上传广告图片", trigger: "blur" }],
+  },
+});
 
-const {loading, single, multiple, queryParams, pageList, total, dialog, formData, rules} = toRefs(state)
+const {
+  loading,
+  single,
+  multiple,
+  queryParams,
+  advertList,
+  total,
+  dialog,
+  formData,
+  rules,
+} = toRefs(state);
 
 function handleQuery() {
-  state.loading = true
-  listAdvertsWithPage(state.queryParams).then(response => {
-    const {data, total} = response as any
-    state.pageList = data
-    state.total = total
-    state.loading = false
-  })
+  state.loading = true;
+  listAdvertPages(state.queryParams).then(({data}) => {
+    state.advertList = data.list;
+    state.total = data.total;
+    state.loading = false;
+  });
 }
 
 function resetQuery() {
-  state.queryParams = {
-    pageNum: 1,
-    pageSize: 10,
-    title: undefined
-  }
-  handleQuery()
+  queryFormRef.value.resetFields();
+  handleQuery();
 }
 
 function handleSelectionChange(selection: any) {
-  state.ids = selection.map((item: any) => item.id)
-  state.single = selection.length !== 1
-  state.multiple = !selection.length
+  state.ids = selection.map((item: any) => item.id);
+  state.single = selection.length !== 1;
+  state.multiple = !selection.length;
 }
 
 function handleAdd() {
-  resetForm()
+  resetForm();
   state.dialog = {
-    title: '添加广告',
-    visible: true
-  }
+    title: "添加广告",
+    visible: true,
+  };
 }
 
 function handleUpdate(row: any) {
-  resetForm()
   state.dialog = {
-    title: '修改广告',
+    title: "修改广告",
     visible: true,
-  }
-  const advertId = row.id || state.ids
-  getAdvertDetail(advertId).then((response) => {
-    state.formData = response.data
-  })
+  };
+  const advertId = row.id || state.ids;
+  getAdvertFormDetail(advertId).then((response) => {
+    state.formData = response.data;
+  });
 }
 
 function submitForm() {
-  const dataForm = unref(dataFormRef)
-  dataForm.validate((valid: any) => {
+  dataFormRef.value.validate((valid: any) => {
     if (valid) {
-      const avertId = state.formData.id
+      const avertId = state.formData.id;
       if (avertId) {
-        updateAdvert(avertId, state.formData).then(response => {
-          ElMessage.success('修改成功')
-          state.dialog.visible = false
-          handleQuery()
-        })
+        updateAdvert(avertId, state.formData).then((response) => {
+          ElMessage.success("修改成功");
+          cancel();
+          handleQuery();
+        });
       } else {
-        addAdvert(state.formData).then(response => {
-          ElMessage.success('新增成功')
-          state.dialog.visible = false
-          handleQuery()
-        })
+        addAdvert(state.formData).then((response) => {
+          ElMessage.success("新增成功");
+          cancel();
+          handleQuery();
+        });
       }
     }
-  })
+  });
 }
 
+/**
+ * 重置表单
+ */
 function resetForm() {
-  state.formData = {
-    id: undefined,
-    title: '',
-    picUrl: '',
-    beginTime: undefined,
-    endTime: undefined,
-    status: 1,
-    sort: 100,
-    url: undefined,
-    remark: undefined
-  }
+  state.formData.id = undefined;
+  dataFormRef.value.resetFields();
 }
 
 function cancel() {
-  resetForm()
-  state.dialog.visible = false
+  resetForm();
+  state.dialog.visible = false;
 }
 
 function handleDelete(row: any) {
-  const ids = [row.id || state.ids].join(',')
-  ElMessageBox.confirm('确认删除已选中的数据项?', '警告', {
-    confirmButtonText: '确定',
-    cancelButtonText: '取消',
-    type: 'warning'
-  }).then(() => {
-    deleteAdverts(ids).then(() => {
-      ElMessage.success('删除成功')
-      handleQuery()
+  const ids = [row.id || state.ids].join(",");
+  ElMessageBox.confirm("确认删除已选中的数据项?", "警告", {
+    confirmButtonText: "确定",
+    cancelButtonText: "取消",
+    type: "warning",
+  })
+    .then(() => {
+      deleteAdverts(ids).then(() => {
+        ElMessage.success("删除成功");
+        handleQuery();
+      });
     })
-  }).catch(() =>
-      ElMessage.info('已取消删除')
-  )
+    .catch(() => ElMessage.info("已取消删除"));
 }
 
 onMounted(() => {
-  handleQuery()
-})
-
+  handleQuery();
+});
 </script>