!48 访问日志重构

Merge pull request !48 from oldBaby/dev

src/api/infra/apiAccessLog/index.ts

@@ -18,33 +18,12 @@ export interface ApiAccessLogVO {
   resultMsg: string
   createTime: Date
 }
-
-export interface ApiAccessLogPageReqVO extends PageParam {
-  userId?: number
-  userType?: number
-  applicationName?: string
-  requestUrl?: string
-  beginTime?: Date[]
-  duration?: number
-  resultCode?: number
-}
-
-export interface ApiAccessLogExportReqVO {
-  userId?: number
-  userType?: number
-  applicationName?: string
-  requestUrl?: string
-  beginTime?: Date[]
-  duration?: number
-  resultCode?: number
-}
-
 // 查询列表API 访问日志
-export const getApiAccessLogPageApi = (params: ApiAccessLogPageReqVO) => {
+export const getApiAccessLogPage = (params: PageParam) => {
   return request.get({ url: '/infra/api-access-log/page', params })
 }
 
 // 导出API 访问日志
-export const exportApiAccessLogApi = (params: ApiAccessLogExportReqVO) => {
+export const exportApiAccessLog = (params) => {
   return request.download({ url: '/infra/api-access-log/export-excel', params })
 }

src/views/infra/apiAccessLog/ApiAccessLogDetail.vue

@@ -0,0 +1,66 @@
+<template>
+  <Dialog
+    title="API 访问日志详细"
+    v-model="modelVisible"
+    :scroll="true"
+    :max-height="500"
+    width="800"
+  >
+    <el-descriptions border :column="1">
+      <el-descriptions-item label="日志主键" min-width="120">
+        {{ detailData.id }}
+      </el-descriptions-item>
+      <el-descriptions-item label="链路追踪">
+        {{ detailData.traceId }}
+      </el-descriptions-item>
+      <el-descriptions-item label="应用名">
+        {{ detailData.applicationName }}
+      </el-descriptions-item>
+      <el-descriptions-item label="用户信息">
+        {{ detailData.userId }} |
+        <dict-tag :type="DICT_TYPE.USER_TYPE" :value="detailData.userType" />
+        | {{ detailData.userIp }} | {{ detailData.userAgent }}
+      </el-descriptions-item>
+      <el-descriptions-item label="请求信息">
+        {{ detailData.requestMethod }} | {{ detailData.requestUrl }}
+      </el-descriptions-item>
+      <el-descriptions-item label="请求参数">
+        {{ detailData.requestParams }}
+      </el-descriptions-item>
+      <el-descriptions-item label="开始时间">
+        {{ formatDate(detailData.beginTime, 'YYYY-MM-DD HH:mm:ss') }} ~
+        {{ formatDate(detailData.endTime, 'YYYY-MM-DD HH:mm:ss') }} | {{ detailData.duration }} ms
+      </el-descriptions-item>
+      <el-descriptions-item label="操作结果">
+        <div v-if="detailData.resultCode === 0">正常</div>
+        <div v-else-if="detailData.resultCode > 0"
+          >失败 | {{ detailData.resultCode }} | {{ detailData.resultMsg }}</div
+        >
+      </el-descriptions-item>
+    </el-descriptions>
+  </Dialog>
+</template>
+
+<script setup lang="ts">
+import { DICT_TYPE } from '@/utils/dict'
+import { formatDate } from '@/utils/formatTime'
+import * as ApiAccessLog from '@/api/infra/apiAccessLog'
+
+const modelVisible = ref(false) // 弹窗的是否展示
+const detailLoading = ref(false) // 表单地加载中
+const detailData = ref() // 详情数据
+
+/** 打开弹窗 */
+const openModal = async (data: ApiAccessLog.ApiAccessLogVO) => {
+  modelVisible.value = true
+  // 设置数据
+  detailLoading.value = true
+  try {
+    detailData.value = data
+  } finally {
+    detailLoading.value = false
+  }
+}
+
+defineExpose({ openModal }) // 提供 openModal 方法，用于打开弹窗
+</script>

src/views/infra/apiAccessLog/apiAccessLog.data.ts

@@ -1,74 +0,0 @@
-import type { VxeCrudSchema } from '@/hooks/web/useVxeCrudSchemas'
-
-// CrudSchema
-const crudSchemas = reactive<VxeCrudSchema>({
-  primaryKey: 'id',
-  primaryType: 'id',
-  primaryTitle: '日志编号',
-  action: true,
-  actionWidth: '80px',
-  columns: [
-    {
-      title: '链路追踪',
-      field: 'traceId',
-      isTable: false
-    },
-    {
-      title: '用户编号',
-      field: 'userId',
-      isSearch: true
-    },
-    {
-      title: '用户类型',
-      field: 'userType',
-      dictType: DICT_TYPE.USER_TYPE,
-      dictClass: 'number',
-      isSearch: true
-    },
-    {
-      title: '应用名',
-      field: 'applicationName',
-      isSearch: true
-    },
-    {
-      title: '请求方法名',
-      field: 'requestMethod'
-    },
-    {
-      title: '请求地址',
-      field: 'requestUrl',
-      isSearch: true
-    },
-    {
-      title: '请求时间',
-      field: 'beginTime',
-      formatter: 'formatDate',
-      search: {
-        show: true,
-        itemRender: {
-          name: 'XDataTimePicker'
-        }
-      }
-    },
-    {
-      title: '执行时长',
-      field: 'duration',
-      table: {
-        slots: {
-          default: 'duration_default'
-        }
-      }
-    },
-    {
-      title: '操作结果',
-      field: 'resultCode',
-      isSearch: true,
-      table: {
-        slots: {
-          default: 'resultCode_default'
-        }
-      }
-    }
-  ]
-})
-export const { allSchemas } = useVxeCrudSchemas(crudSchemas)

src/views/infra/apiAccessLog/index.vue

@@ -1,62 +1,221 @@
 <template>
-  <ContentWrap>
+  <content-wrap>
-    <!-- 列表 -->
+    <!-- 搜索工作栏 -->
-    <XTable @register="registerTable">
+    <el-form
-      <template #duration_default="{ row }">
+      class="-mb-15px"
-        <span>{{ row.duration + 'ms' }}</span>
+      :model="queryParams"
-      </template>
+      ref="queryFormRef"
-      <template #resultCode_default="{ row }">
+      :inline="true"
-        <span>{{ row.resultCode === 0 ? '成功' : '失败(' + row.resultMsg + ')' }}</span>
+      label-width="68px"
-      </template>
+    >
-      <template #actionbtns_default="{ row }">
+      <el-form-item label="用户编号" prop="userId">
-        <!-- 操作：详情 -->
+        <el-input
-        <XTextButton
+          v-model="queryParams.userId"
-          preIcon="ep:view"
+          placeholder="请输入用户编号"
-          :title="t('action.detail')"
+          clearable
-          v-hasPermi="['infra:api-access-log:query']"
+          @keyup.enter="handleQuery"
-          @click="handleDetail(row)"
+          class="!w-240px"
         />
+      </el-form-item>
+      <el-form-item label="用户类型" prop="userType">
+        <el-select
+          v-model="queryParams.userType"
+          placeholder="请选择用户类型"
+          clearable
+          class="!w-240px"
+        >
+          <el-option
+            v-for="dict in getDictOptions(DICT_TYPE.USER_TYPE)"
+            :key="parseInt(dict.value)"
+            :label="dict.label"
+            :value="parseInt(dict.value)"
+          />
+        </el-select>
+      </el-form-item>
+      <el-form-item label="应用名" prop="applicationName">
+        <el-input
+          v-model="queryParams.applicationName"
+          placeholder="请输入应用名"
+          clearable
+          @keyup.enter="handleQuery"
+          class="!w-240px"
+        />
+      </el-form-item>
+      <el-form-item label="请求时间" prop="beginTime">
+        <el-date-picker
+          v-model="queryParams.beginTime"
+          value-format="yyyy-MM-dd HH:mm:ss"
+          type="daterange"
+          start-placeholder="开始日期"
+          end-placeholder="结束日期"
+          :default-time="[new Date('1 00:00:00'), new Date('1 23:59:59')]"
+          class="!w-240px"
+        />
+      </el-form-item>
+      <el-form-item label="执行时长" prop="duration">
+        <el-input
+          v-model="queryParams.duration"
+          placeholder="请输入执行时长"
+          clearable
+          @keyup.enter="handleQuery"
+          class="!w-240px"
+        />
+      </el-form-item>
+      <el-form-item label="结果码" prop="resultCode">
+        <el-input
+          v-model="queryParams.resultCode"
+          placeholder="请输入结果码"
+          clearable
+          @keyup.enter="handleQuery"
+          class="!w-240px"
+        />
+      </el-form-item>
+      <el-form-item>
+        <el-button @click="handleQuery"><Icon icon="ep:search" class="mr-5px" /> 搜索</el-button>
+        <el-button @click="resetQuery"><Icon icon="ep:refresh" class="mr-5px" /> 重置</el-button>
+        <el-button
+          type="success"
+          plain
+          @click="handleExport"
+          :loading="exportLoading"
+          v-hasPermi="['infra:api-error-log:export']"
+        >
+          <Icon icon="ep:download" class="mr-5px" /> 导出
+        </el-button>
+      </el-form-item>
+    </el-form>
+  </content-wrap>
+  <!-- 列表 -->
+  <content-wrap>
+    <el-table v-loading="loading" :data="list">
+      <el-table-column label="日志编号" align="center" prop="id" />
+      <el-table-column label="用户编号" align="center" prop="userId" />
+      <el-table-column label="用户类型" align="center" prop="userType">
+        <template #default="scope">
+          <dict-tag :type="DICT_TYPE.USER_TYPE" :value="scope.row.userType" />
         </template>
-    </XTable>
+      </el-table-column>
-  </ContentWrap>
+      <el-table-column label="应用名" align="center" prop="applicationName" />
-  <XModal v-model="dialogVisible" :title="dialogTitle">
+      <el-table-column label="请求方法名" align="center" prop="requestMethod" />
-    <!-- 对话框(详情) -->
+      <el-table-column label="请求地址" align="center" prop="requestUrl" width="250" />
-    <Descriptions :schema="allSchemas.detailSchema" :data="detailData">
+      <el-table-column label="请求时间" align="center" prop="beginTime" width="180">
-      <template #duration="{ row }">
+        <template #default="scope">
-        <span>{{ row.duration + 'ms' }}</span>
+          <span>{{ formatDate(scope.row.beginTime, 'YYYY-MM-DD HH:mm:ss') }}</span>
         </template>
-      <template #resultCode="{ row }">
+      </el-table-column>
-        <span>{{ row.resultCode === 0 ? '成功' : '失败(' + row.resultMsg + ')' }}</span>
+      <el-table-column label="执行时长" align="center" prop="duration" width="180">
+        <template #default="scope">
+          <span>{{ scope.row.duration }} ms</span>
         </template>
-    </Descriptions>
+      </el-table-column>
-    <!-- 操作按钮 -->
+      <el-table-column label="操作结果" align="center" prop="status">
-    <template #footer>
+        <template #default="scope">
-      <XButton :title="t('dialog.close')" @click="dialogVisible = false" />
+          <span>{{
+            scope.row.resultCode === 0 ? '成功' : '失败(' + scope.row.resultMsg + ')'
+          }}</span>
         </template>
-  </XModal>
+      </el-table-column>
+      <el-table-column label="操作" align="center">
+        <template #default="scope">
+          <el-button
+            link
+            type="primary"
+            @click="openDetail(scope.row)"
+            v-hasPermi="['infra:api-access-log:query']"
+          >
+            详细
+          </el-button>
+        </template>
+      </el-table-column>
+    </el-table>
+
+    <!-- 分页组件 -->
+    <Pagination
+      :total="total"
+      v-model:page="queryParams.pageNo"
+      v-model:limit="queryParams.pageSize"
+      @pagination="getList"
+    />
+  </content-wrap>
+
+  <!-- 表单弹窗：详情 -->
+  <ApiAccessLogDetail ref="detailRef" />
 </template>
+
 <script setup lang="ts" name="ApiAccessLog">
-import { allSchemas } from './apiAccessLog.data'
+import { DICT_TYPE, getDictOptions } from '@/utils/dict'
+import download from '@/utils/download'
+import { formatDate } from '@/utils/formatTime'
 import * as ApiAccessLogApi from '@/api/infra/apiAccessLog'
+import ApiAccessLogDetail from './ApiAccessLogDetail.vue'
 
-const { t } = useI18n() // 国际化
+const message = useMessage() // 消息弹窗
 
-// 列表相关的变量
+const loading = ref(true) // 列表的加载中
-const [registerTable] = useXTable({
+const total = ref(0) // 列表的总页数
-  allSchemas: allSchemas,
+const list = ref([]) // 列表的数据
-  topActionSlots: false,
+
-  getListApi: ApiAccessLogApi.getApiAccessLogPageApi
+const queryParams = reactive({
+  pageNo: 1,
+  pageSize: 10,
+  userId: null,
+  userType: null,
+  applicationName: null,
+  requestUrl: null,
+  duration: null,
+  resultCode: null,
+  beginTime: []
 })
-// ========== 详情相关 ==========
+const queryFormRef = ref() // 搜索的表单
-const detailData = ref() // 详情 Ref
+const exportLoading = ref(false) // 导出的加载中
-const dialogVisible = ref(false) // 是否显示弹出层
-const dialogTitle = ref('') // 弹出层标题
 
-// 详情操作
+/** 查询参数列表 */
-const handleDetail = (row: ApiAccessLogApi.ApiAccessLogVO) => {
+const getList = async () => {
-  // 设置数据
+  loading.value = true
-  detailData.value = row
+  try {
-  dialogTitle.value = t('action.detail')
+    const data = await ApiAccessLogApi.getApiAccessLogPage(queryParams)
-  dialogVisible.value = true
+    list.value = data.list
+    total.value = data.total
+  } finally {
+    loading.value = false
+  }
 }
+
+/** 搜索按钮操作 */
+const handleQuery = () => {
+  queryParams.pageNo = 1
+  getList()
+}
+
+/** 重置按钮操作 */
+const resetQuery = () => {
+  queryFormRef.value.resetFields()
+  handleQuery()
+}
+
+/** 详情操作 */
+const detailRef = ref()
+const openDetail = (data: ApiAccessLogApi.ApiAccessLogVO) => {
+  detailRef.value.open(data)
+}
+
+/** 导出按钮操作 */
+const handleExport = async () => {
+  try {
+    // 导出的二次确认
+    await message.exportConfirm()
+    // 发起导出
+    exportLoading.value = true
+    const data = await ApiAccessLogApi.exportApiAccessLog(queryParams)
+    download.excel(data, 'API 访问日志.xls')
+  } catch {
+  } finally {
+    exportLoading.value = false
+  }
+}
+
+/** 初始化 **/
+onMounted(() => {
+  getList()
+})
 </script>

src/views/infra/apiErrorLog/index.vue

@@ -118,7 +118,7 @@
             link
             type="primary"
             @click="openDetail(scope.row)"
-            v-hasPermi="['infra:api-access-log:query']"
+            v-hasPermi="['infra:api-error-log:query']"
           >
             详细
           </el-button>