From 50e57a1418f78df9abfdfc1926e07e5546972624 Mon Sep 17 00:00:00 2001
From: puhui999 <puhui999@163.com>
Date: Wed, 14 May 2025 14:44:44 +0800
Subject: [PATCH] =?UTF-8?q?feat:=20=E6=96=B0=E5=A2=9E=20ele=20infra=20ApiA?=
 =?UTF-8?q?ccessLog=20api=20=E8=AE=BF=E9=97=AE=E6=97=A5=E5=BF=97=E6=A8=A1?=
 =?UTF-8?q?=E5=9D=97?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .../src/views/infra/apiAccessLog/data.ts      | 173 ++++++++++++++++++
 .../src/views/infra/apiAccessLog/index.vue    | 110 +++++++++++
 .../infra/apiAccessLog/modules/detail.vue     | 106 +++++++++++
 3 files changed, 389 insertions(+)
 create mode 100644 apps/web-ele/src/views/infra/apiAccessLog/data.ts
 create mode 100644 apps/web-ele/src/views/infra/apiAccessLog/index.vue
 create mode 100644 apps/web-ele/src/views/infra/apiAccessLog/modules/detail.vue

diff --git a/apps/web-ele/src/views/infra/apiAccessLog/data.ts b/apps/web-ele/src/views/infra/apiAccessLog/data.ts
new file mode 100644
index 00000000..e924c247
--- /dev/null
+++ b/apps/web-ele/src/views/infra/apiAccessLog/data.ts
@@ -0,0 +1,173 @@
+import type { VbenFormSchema } from '#/adapter/form';
+import type { OnActionClickFn, VxeTableGridOptions } from '#/adapter/vxe-table';
+import type { InfraApiAccessLogApi } from '#/api/infra/api-access-log';
+
+import { useAccess } from '@vben/access';
+
+import { DICT_TYPE, getDictOptions, getRangePickerDefaultProps } from '#/utils';
+
+const { hasAccessByCodes } = useAccess();
+
+/** 列表的搜索表单 */
+export function useGridFormSchema(): VbenFormSchema[] {
+  return [
+    {
+      fieldName: 'userId',
+      label: '用户编号',
+      component: 'Input',
+      componentProps: {
+        allowClear: true,
+        placeholder: '请输入用户编号',
+      },
+    },
+    {
+      fieldName: 'userType',
+      label: '用户类型',
+      component: 'Select',
+      componentProps: {
+        options: getDictOptions(DICT_TYPE.USER_TYPE, 'number'),
+        allowClear: true,
+        placeholder: '请选择用户类型',
+      },
+    },
+    {
+      fieldName: 'applicationName',
+      label: '应用名',
+      component: 'Input',
+      componentProps: {
+        allowClear: true,
+        placeholder: '请输入应用名',
+      },
+    },
+    {
+      fieldName: 'beginTime',
+      label: '请求时间',
+      component: 'RangePicker',
+      componentProps: {
+        ...getRangePickerDefaultProps(),
+        allowClear: true,
+      },
+    },
+    {
+      fieldName: 'duration',
+      label: '执行时长',
+      component: 'Input',
+      componentProps: {
+        allowClear: true,
+        placeholder: '请输入执行时长',
+      },
+    },
+    {
+      fieldName: 'resultCode',
+      label: '结果码',
+      component: 'Input',
+      componentProps: {
+        allowClear: true,
+        placeholder: '请输入结果码',
+      },
+    },
+  ];
+}
+
+/** 列表的字段 */
+export function useGridColumns<T = InfraApiAccessLogApi.ApiAccessLog>(
+  onActionClick: OnActionClickFn<T>,
+): VxeTableGridOptions['columns'] {
+  return [
+    {
+      field: 'id',
+      title: '日志编号',
+      minWidth: 100,
+    },
+    {
+      field: 'userId',
+      title: '用户编号',
+      minWidth: 100,
+    },
+    {
+      field: 'userType',
+      title: '用户类型',
+      minWidth: 120,
+      cellRender: {
+        name: 'CellDict',
+        props: { type: DICT_TYPE.USER_TYPE },
+      },
+    },
+    {
+      field: 'applicationName',
+      title: '应用名',
+      minWidth: 150,
+    },
+    {
+      field: 'requestMethod',
+      title: '请求方法',
+      minWidth: 80,
+    },
+    {
+      field: 'requestUrl',
+      title: '请求地址',
+      minWidth: 300,
+    },
+    {
+      field: 'beginTime',
+      title: '请求时间',
+      minWidth: 180,
+      formatter: 'formatDateTime',
+    },
+    {
+      field: 'duration',
+      title: '执行时长',
+      minWidth: 120,
+      formatter: ({ row }) => `${row.duration} ms`,
+    },
+    {
+      field: 'resultCode',
+      title: '操作结果',
+      minWidth: 150,
+      formatter: ({ row }) => {
+        return row.resultCode === 0 ? '成功' : `失败(${row.resultMsg})`;
+      },
+    },
+    {
+      field: 'operateModule',
+      title: '操作模块',
+      minWidth: 150,
+    },
+    {
+      field: 'operateName',
+      title: '操作名',
+      minWidth: 220,
+    },
+    {
+      field: 'operateType',
+      title: '操作类型',
+      minWidth: 120,
+      cellRender: {
+        name: 'CellDict',
+        props: { type: DICT_TYPE.INFRA_OPERATE_TYPE },
+      },
+    },
+    {
+      field: 'operation',
+      title: '操作',
+      minWidth: 80,
+      align: 'center',
+      fixed: 'right',
+      cellRender: {
+        attrs: {
+          nameField: 'id',
+          nameTitle: 'API访问日志',
+          onClick: onActionClick,
+        },
+        name: 'CellOperation',
+        options: [
+          {
+            code: 'detail',
+            text: '详情',
+            show: hasAccessByCodes(['infra:api-access-log:query']),
+          },
+        ],
+      },
+    },
+  ];
+}
diff --git a/apps/web-ele/src/views/infra/apiAccessLog/index.vue b/apps/web-ele/src/views/infra/apiAccessLog/index.vue
new file mode 100644
index 00000000..37ae6ec4
--- /dev/null
+++ b/apps/web-ele/src/views/infra/apiAccessLog/index.vue
@@ -0,0 +1,110 @@
+<script lang="ts" setup>
+import type {
+  OnActionClickParams,
+  VxeTableGridOptions,
+} from '#/adapter/vxe-table';
+import type { InfraApiAccessLogApi } from '#/api/infra/api-access-log';
+
+import { Page, useVbenModal } from '@vben/common-ui';
+import { Download } from '@vben/icons';
+import { downloadFileFromBlobPart } from '@vben/utils';
+
+import { ElButton } from 'element-plus';
+
+import { useVbenVxeGrid } from '#/adapter/vxe-table';
+import {
+  exportApiAccessLog,
+  getApiAccessLogPage,
+} from '#/api/infra/api-access-log';
+import { DocAlert } from '#/components/doc-alert';
+import { $t } from '#/locales';
+
+import { useGridColumns, useGridFormSchema } from './data';
+import Detail from './modules/detail.vue';
+
+const [DetailModal, detailModalApi] = useVbenModal({
+  connectedComponent: Detail,
+  destroyOnClose: true,
+});
+
+/** 刷新表格 */
+function onRefresh() {
+  gridApi.query();
+}
+
+/** 导出表格 */
+async function onExport() {
+  const data = await exportApiAccessLog(await gridApi.formApi.getValues());
+  downloadFileFromBlobPart({ fileName: 'API 访问日志.xls', source: data });
+}
+
+/** 查看 API 访问日志详情 */
+function onDetail(row: InfraApiAccessLogApi.ApiAccessLog) {
+  detailModalApi.setData(row).open();
+}
+
+/** 表格操作按钮的回调函数 */
+function onActionClick({
+  code,
+  row,
+}: OnActionClickParams<InfraApiAccessLogApi.ApiAccessLog>) {
+  switch (code) {
+    case 'detail': {
+      onDetail(row);
+      break;
+    }
+  }
+}
+
+const [Grid, gridApi] = useVbenVxeGrid({
+  formOptions: {
+    schema: useGridFormSchema(),
+  },
+  gridOptions: {
+    columns: useGridColumns(onActionClick),
+    height: 'auto',
+    keepSource: true,
+    proxyConfig: {
+      ajax: {
+        query: async ({ page }, formValues) => {
+          return await getApiAccessLogPage({
+            pageNo: page.currentPage,
+            pageSize: page.pageSize,
+            ...formValues,
+          });
+        },
+      },
+    },
+    rowConfig: {
+      keyField: 'id',
+    },
+    toolbarConfig: {
+      refresh: { code: 'query' },
+      search: true,
+    },
+  } as VxeTableGridOptions<InfraApiAccessLogApi.ApiAccessLog>,
+});
+</script>
+
+<template>
+  <Page auto-content-height>
+    <template #doc>
+      <DocAlert title="系统日志" url="https://doc.iocoder.cn/system-log/" />
+    </template>
+
+    <DetailModal @success="onRefresh" />
+    <Grid table-title="API 访问日志列表">
+      <template #toolbar-tools>
+        <ElButton
+          type="primary"
+          class="ml-2"
+          @click="onExport"
+          v-access:code="['infra:api-access-log:export']"
+        >
+          <Download class="size-5" />
+          {{ $t('ui.actionTitle.export') }}
+        </ElButton>
+      </template>
+    </Grid>
+  </Page>
+</template>
diff --git a/apps/web-ele/src/views/infra/apiAccessLog/modules/detail.vue b/apps/web-ele/src/views/infra/apiAccessLog/modules/detail.vue
new file mode 100644
index 00000000..88e386bb
--- /dev/null
+++ b/apps/web-ele/src/views/infra/apiAccessLog/modules/detail.vue
@@ -0,0 +1,106 @@
+<script lang="ts" setup>
+import type { InfraApiAccessLogApi } from '#/api/infra/api-access-log';
+
+import { ref } from 'vue';
+
+import { useVbenModal } from '@vben/common-ui';
+import { formatDateTime } from '@vben/utils';
+
+import { ElDescriptions, ElDescriptionsItem } from 'element-plus';
+
+import { DictTag } from '#/components/dict-tag';
+import { DICT_TYPE } from '#/utils';
+
+const formData = ref<InfraApiAccessLogApi.ApiAccessLog>();
+
+const [Modal, modalApi] = useVbenModal({
+  async onOpenChange(isOpen: boolean) {
+    if (!isOpen) {
+      formData.value = undefined;
+      return;
+    }
+    // 加载数据
+    const data = modalApi.getData<InfraApiAccessLogApi.ApiAccessLog>();
+    if (!data || !data.id) {
+      return;
+    }
+    modalApi.lock();
+    try {
+      formData.value = data;
+    } finally {
+      modalApi.unlock();
+    }
+  },
+});
+</script>
+
+<template>
+  <Modal
+    title="API 访问日志详情"
+    class="w-1/2"
+    :show-cancel-button="false"
+    :show-confirm-button="false"
+  >
+    <ElDescriptions
+      border
+      :column="1"
+      size="default"
+      class="mx-4"
+      label-width="110px"
+    >
+      <ElDescriptionsItem label="日志编号">
+        {{ formData?.id }}
+      </ElDescriptionsItem>
+      <ElDescriptionsItem label="链路追踪">
+        {{ formData?.traceId }}
+      </ElDescriptionsItem>
+      <ElDescriptionsItem label="应用名">
+        {{ formData?.applicationName }}
+      </ElDescriptionsItem>
+      <ElDescriptionsItem label="用户信息">
+        {{ formData?.userId }}
+        <DictTag :type="DICT_TYPE.USER_TYPE" :value="formData?.userType" />
+      </ElDescriptionsItem>
+      <ElDescriptionsItem label="用户IP">
+        {{ formData?.userIp }}
+      </ElDescriptionsItem>
+      <ElDescriptionsItem label="用户UA">
+        {{ formData?.userAgent }}
+      </ElDescriptionsItem>
+      <ElDescriptionsItem label="请求信息">
+        {{ formData?.requestMethod }} {{ formData?.requestUrl }}
+      </ElDescriptionsItem>
+      <ElDescriptionsItem label="请求参数">
+        {{ formData?.requestParams }}
+      </ElDescriptionsItem>
+      <ElDescriptionsItem label="请求结果">
+        {{ formData?.responseBody }}
+      </ElDescriptionsItem>
+      <ElDescriptionsItem label="请求时间">
+        {{ formatDateTime(formData?.beginTime || '') }} ~
+        {{ formatDateTime(formData?.endTime || '') }}
+      </ElDescriptionsItem>
+      <ElDescriptionsItem label="请求耗时">
+        {{ formData?.duration }} ms
+      </ElDescriptionsItem>
+      <ElDescriptionsItem label="操作结果">
+        <div v-if="formData?.resultCode === 0">正常</div>
+        <div v-else-if="formData && formData?.resultCode > 0">
+          失败 | {{ formData?.resultCode }} | {{ formData?.resultMsg }}
+        </div>
+      </ElDescriptionsItem>
+      <ElDescriptionsItem label="操作模块">
+        {{ formData?.operateModule }}
+      </ElDescriptionsItem>
+      <ElDescriptionsItem label="操作名">
+        {{ formData?.operateName }}
+      </ElDescriptionsItem>
+      <ElDescriptionsItem label="操作类型">
+        <DictTag
+          :type="DICT_TYPE.INFRA_OPERATE_TYPE"
+          :value="formData?.operateType"
+        />
+      </ElDescriptionsItem>
+    </ElDescriptions>
+  </Modal>
+</template>