zayac/zayac-admin
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

优化：聚合日志相关 API，封装 date-range-picker 组件并优化部分细节

Browse Source
This commit is contained in:
Charles7c 2023-01-20 14:44:03 +08:00
parent d8debf5481
commit 8cf15fd4a8
14 changed files with 236 additions and 290 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
continew-admin-ui/config/plugin/styleImport.ts
View File

@ -45,6 +45,8 @@ export default function configStyleImportPlugin() {
'option',
'optgroup',
'icon',
'dsubmenu',
'dgroup',
];
// List of components that need to map imported styles
// 需要映射引入样式的组件列表

99
continew-admin-ui/src/api/monitor/log.ts Normal file
View File

@ -0,0 +1,99 @@
import axios from 'axios';
import qs from 'query-string';
export interface LogRecord {
logId: string;
clientIp: string;
location: string;
browser: string;
createTime: string;
}
export interface LoginLogRecord extends LogRecord {
description: string;
status: number;
errorMsg: string;
createUserString: string;
}
export interface OperationLogRecord extends LogRecord {
description: string;
status: number;
errorMsg: string;
createUserString: string;
}
export interface SystemLogRecord extends LogRecord {
statusCode: number;
requestMethod: string;
requestUrl: string;
elapsedTime: number;
exceptionDetail?: string;
}
export interface SystemLogDetailRecord extends SystemLogRecord {
requestHeaders: string;
requestBody: string;
responseHeaders: string;
responseBody: string;
}
export interface LoginLogParams extends Partial<LoginLogRecord> {
page: number;
size: number;
sort: Array<string>;
}
export interface LoginLogListRes {
list: LoginLogRecord[];
total: number;
}
export function queryLoginLogList(params: LoginLogParams) {
return axios.get<LoginLogListRes>('/monitor/log/login', {
params,
paramsSerializer: (obj) => {
return qs.stringify(obj);
},
});
}
export interface OperationLogParams extends Partial<OperationLogRecord> {
page: number;
size: number;
sort: Array<string>;
uid?: string;
}
export interface OperationLogListRes {
list: OperationLogRecord[];
total: number;
}
export function queryOperationLogList(params: OperationLogParams) {
return axios.get<OperationLogListRes>('/monitor/log/operation', {
params,
paramsSerializer: (obj) => {
return qs.stringify(obj);
},
});
}
export interface SystemLogParams extends Partial<SystemLogRecord> {
page: number;
size: number;
sort: Array<string>;
}
export interface SystemLogListRes {
list: SystemLogRecord[];
total: number;
}
export function querySystemLogList(params: SystemLogParams) {
return axios.get<SystemLogListRes>('/monitor/log/system', {
params,
paramsSerializer: (obj) => {
return qs.stringify(obj);
},
});
}
export function querySystemLogDetail(logId: string) {
return axios.get<SystemLogDetailRecord>(`/monitor/log/system/${logId}`);
}

33
continew-admin-ui/src/api/monitor/login-log.ts
View File

@ -1,33 +0,0 @@
import axios from 'axios';
import qs from 'query-string';
export interface LoginLogRecord {
logId: string;
status: number;
clientIp: string;
location: string;
browser: string;
errorMsg: string;
createUserString: string;
createTime: string;
}
export interface LoginLogParams extends Partial<LoginLogRecord> {
page: number;
size: number;
sort: Array<string>;
}
export interface LoginLogListRes {
list: LoginLogRecord[];
total: number;
}
export function queryLoginLogList(params: LoginLogParams) {
return axios.get<LoginLogListRes>('/monitor/log/login', {
params,
paramsSerializer: (obj) => {
return qs.stringify(obj);
},
});
}

35
continew-admin-ui/src/api/monitor/operation-log.ts
View File

@ -1,35 +0,0 @@
import axios from 'axios';
import qs from 'query-string';
export interface OperationLogRecord {
logId: string;
description: string;
status: number;
clientIp: string;
location: string;
browser: string;
errorMsg: string;
createUserString: string;
createTime: string;
}
export interface OperationLogParams extends Partial<OperationLogRecord> {
page: number;
size: number;
sort: Array<string>;
uid?: string;
}
export interface OperationLogListRes {
list: OperationLogRecord[];
total: number;
}
export function queryOperationLogList(params: OperationLogParams) {
return axios.get<OperationLogListRes>('/monitor/log/operation', {
params,
paramsSerializer: (obj) => {
return qs.stringify(obj);
},
});
}

59
continew-admin-ui/src/api/monitor/system-log.ts
View File

@ -1,59 +0,0 @@
import axios from 'axios';
import qs from 'query-string';
export interface SystemLogRecord {
logId: string;
statusCode: number;
requestMethod: string;
requestUrl: string;
elapsedTime: number;
clientIp: string;
location: string;
browser: string;
errorMsg: string;
exceptionDetail?: string;
createUserString: string;
createTime: string;
}
export interface SystemLogParams extends Partial<SystemLogRecord> {
page: number;
size: number;
sort: Array<string>;
}
export interface SystemLogListRes {
list: SystemLogRecord[];
total: number;
}
export function querySystemLogList(params: SystemLogParams) {
return axios.get<SystemLogListRes>('/monitor/log/system', {
params,
paramsSerializer: (obj) => {
return qs.stringify(obj);
},
});
}
export interface SystemLogDetailRecord {
logId: string;
description: string;
requestUrl: string;
requestMethod: string;
requestHeaders: string;
requestBody: string;
statusCode: number;
responseHeaders: string;
responseBody: string;
elapsedTime: number;
clientIp: string;
location: string;
browser: string;
createUserString: string;
createTime: string;
}
export function querySystemLogDetail(logId: string) {
return axios.get<SystemLogDetailRecord>(`/monitor/log/system/${logId}`);
}

79
continew-admin-ui/src/components/date-range-picker/index.vue Normal file
View File

@ -0,0 +1,79 @@
<template>
<a-range-picker
style="width: 100%"
:shortcuts="shortcuts"
shortcuts-position="left"
:format="format"
:show-time="showTime"
:placeholder="placeholder"
/>
</template>
<script lang="ts" setup>
import { computed, PropType } from 'vue';
import { ShortcutType } from '@arco-design/web-vue';
import dayjs from 'dayjs';
defineProps({
format: {
type: String,
default: 'YYYY-MM-DD HH:mm:ss',
},
showTime: {
type: Boolean,
default: true,
},
placeholder: {
type: Array as PropType<string[]>,
default: (): string[] => ['开始时间', '结束时间'],
},
});
const shortcuts = computed<ShortcutType[]>(() => {
return [
{
label: '今天',
value: (): Date[] => [
dayjs().startOf('day').toDate(),
dayjs().toDate()
]
},
{
label: '昨天',
value: (): Date[] => [
dayjs().subtract(1, 'day').startOf('day').toDate(),
dayjs().subtract(1, 'day').endOf('day').toDate()
]
},
{
label: '本周',
value: (): Date[] => [
dayjs().startOf('week').add(1, 'day').toDate(),
dayjs().toDate()
]
},
{
label: '本月',
value: (): Date[] => [
dayjs().startOf('month').toDate(),
dayjs().toDate()
]
},
{
label: '本年',
value: (): Date[] => [
dayjs().startOf('year').toDate(),
dayjs().toDate()
]
}
];
});
</script>
<script lang="ts">
export default {
name: 'DateRangePicker',
};
</script>
<style scoped lang="less"></style>

2
continew-admin-ui/src/components/index.ts
View File

@ -11,6 +11,7 @@ import {
} from 'echarts/components';
import Chart from './chart/index.vue';
import Breadcrumb from './breadcrumb/index.vue';
import DateRangePicker from './date-range-picker/index.vue';
// Manually introduce ECharts modules to reduce packing size
@ -31,5 +32,6 @@ export default {
install(Vue: App) {
Vue.component('Chart', Chart);
Vue.component('Breadcrumb', Breadcrumb);
Vue.component('DateRangePicker', DateRangePicker);
},
};

14
continew-admin-ui/src/views/monitor/log/login/index.vue
View File

@ -25,12 +25,7 @@
field="createTime"
hide-label
>
<a-range-picker
v-model="queryFormData.createTime"
format="YYYY-MM-DD HH:mm:ss"
show-time
style="width: 100%"
/>
<date-range-picker v-model="queryFormData.createTime" />
</a-form-item>
<a-button type="primary" @click="toQuery">
<template #icon>
@ -85,7 +80,7 @@
<script lang="ts" setup>
import { computed, ref, reactive } from 'vue';
import useLoading from '@/hooks/loading';
import { queryLoginLogList, LoginLogRecord, LoginLogParams } from '@/api/monitor/login-log';
import { queryLoginLogList, LoginLogRecord, LoginLogParams } from '@/api/monitor/log';
import { Pagination } from '@/types/global';
import type { SelectOptionData } from '@arco-design/web-vue/es/select/interface';
import type { TableColumnData } from '@arco-design/web-vue/es/table/interface';
@ -135,6 +130,7 @@
title: '登录状态',
dataIndex: 'status',
slotName: 'status',
align: 'center',
},
{
title: '登录 IP',
@ -153,6 +149,8 @@
dataIndex: 'createTime',
},
]);
// 查询列表
const fetchData = async (
params: LoginLogParams = { page: 1, size: 10, sort: ['createTime,desc'] }
) => {
@ -162,8 +160,6 @@
renderData.value = data.list;
pagination.current = params.page;
pagination.total = data.total;
} catch (err) {
// you can report use errorHandler or other
} finally {
setLoading(false);
}

14
continew-admin-ui/src/views/monitor/log/operation/index.vue
View File

@ -37,12 +37,7 @@
field="createTime"
hide-label
>
<a-range-picker
v-model="queryFormData.createTime"
format="YYYY-MM-DD HH:mm:ss"
show-time
style="width: 100%"
/>
<date-range-picker v-model="queryFormData.createTime" />
</a-form-item>
<a-button type="primary" @click="toQuery">
<template #icon>
@ -97,7 +92,7 @@
<script lang="ts" setup>
import { computed, ref, reactive } from 'vue';
import useLoading from '@/hooks/loading';
import { queryOperationLogList, OperationLogRecord, OperationLogParams } from '@/api/monitor/operation-log';
import { queryOperationLogList, OperationLogRecord, OperationLogParams } from '@/api/monitor/log';
import { Pagination } from '@/types/global';
import type { SelectOptionData } from '@arco-design/web-vue/es/select/interface';
import type { TableColumnData } from '@arco-design/web-vue/es/table/interface';
@ -152,6 +147,7 @@
title: '操作状态',
dataIndex: 'status',
slotName: 'status',
align: 'center',
},
{
title: '操作 IP',
@ -166,6 +162,8 @@
dataIndex: 'browser',
},
]);
// 查询列表
const fetchData = async (
params: OperationLogParams = { page: 1, size: 10, sort: ['createTime,desc'] }
) => {
@ -175,8 +173,6 @@
renderData.value = data.list;
pagination.current = params.page;
pagination.total = data.total;
} catch (err) {
// you can report use errorHandler or other
} finally {
setLoading(false);
}

16
continew-admin-ui/src/views/monitor/log/system/index.vue
View File

@ -7,12 +7,7 @@
<a-col :span="24">
<a-form ref="queryFormRef" :model="queryFormData" layout="inline">
<a-form-item field="createTime" hide-label>
<a-range-picker
v-model="queryFormData.createTime"
format="YYYY-MM-DD HH:mm:ss"
show-time
style="width: 100%"
/>
<date-range-picker v-model="queryFormData.createTime" />
</a-form-item>
<a-button type="primary" @click="toQuery">
<template #icon>
@ -201,7 +196,6 @@
<a-space v-else>
<VueJsonPretty
v-if="renderDetailData.requestHeaders"
:path="'res'"
:data="JSON.parse(renderDetailData.requestHeaders)"
:show-length="true" />
<span v-else>无</span>
@ -237,7 +231,7 @@
querySystemLogList,
SystemLogRecord,
SystemLogParams,
} from '@/api/monitor/system-log';
} from '@/api/monitor/log';
import { Pagination } from '@/types/global';
import type { TableColumnData } from '@arco-design/web-vue/es/table/interface';
import { FormInstance } from '@arco-design/web-vue/es/form';
@ -253,7 +247,6 @@
const renderData = ref<SystemLogRecord[]>([]);
const renderDetailData = ref<SystemLogDetailRecord>({
logId: '',
description: '',
requestUrl: '',
requestMethod: '',
requestHeaders: '',
@ -265,7 +258,6 @@
clientIp: '',
location: '',
browser: '',
createUserString: '',
createTime: '',
});
@ -290,10 +282,12 @@
title: '状态码',
dataIndex: 'statusCode',
slotName: 'statusCode',
align: 'center',
},
{
title: '请求方式',
dataIndex: 'requestMethod',
align: 'center',
},
{
title: '请求 URI',
@ -316,6 +310,7 @@
title: '请求耗时',
dataIndex: 'elapsedTime',
slotName: 'elapsedTime',
align: 'center',
},
{
title: '创建时间',
@ -324,6 +319,7 @@
{
title: '操作',
slotName: 'operations',
align: 'center',
},
]);

5
continew-admin-ui/src/views/system/user/center/components/operation-log.vue
View File

@ -42,10 +42,10 @@
</template>
<script lang="ts" setup>
import { computed, ref, reactive } from "vue";
import { computed, ref, reactive } from 'vue';
import { useLoginStore } from '@/store';
import useLoading from '@/hooks/loading';
import { queryOperationLogList, OperationLogRecord, OperationLogParams } from '@/api/monitor/operation-log';
import { queryOperationLogList, OperationLogRecord, OperationLogParams } from '@/api/monitor/log';
import { Pagination } from '@/types/global';
import type { TableColumnData } from '@arco-design/web-vue/es/table/interface';
@ -78,6 +78,7 @@
title: '操作状态',
dataIndex: 'status',
slotName: 'status',
align: 'center',
},
{
title: '操作 IP',

34
continew-admin-webapi/src/main/java/top/charles7c/cnadmin/webapi/controller/monitor/SystemLogController.java → continew-admin-webapi/src/main/java/top/charles7c/cnadmin/webapi/controller/monitor/LogController.java
View File

@ -31,35 +31,53 @@ import org.springframework.web.bind.annotation.RestController;
import top.charles7c.cnadmin.common.model.query.PageQuery;
import top.charles7c.cnadmin.common.model.vo.PageInfo;
import top.charles7c.cnadmin.common.model.vo.R;
import top.charles7c.cnadmin.monitor.model.query.LoginLogQuery;
import top.charles7c.cnadmin.monitor.model.query.OperationLogQuery;
import top.charles7c.cnadmin.monitor.model.query.SystemLogQuery;
import top.charles7c.cnadmin.monitor.model.vo.LoginLogVO;
import top.charles7c.cnadmin.monitor.model.vo.OperationLogVO;
import top.charles7c.cnadmin.monitor.model.vo.SystemLogDetailVO;
import top.charles7c.cnadmin.monitor.model.vo.SystemLogVO;
import top.charles7c.cnadmin.monitor.service.LogService;
/**
* 系统日志 API
* 日志管理 API
*
* @author Charles7c
* @since 2023/1/17 23:27
* @since 2023/1/18 23:55
*/
@Tag(name = "操作日志 API")
@Tag(name = "日志管理 API")
@Validated
@RestController
@RequiredArgsConstructor
@RequestMapping(value = "/monitor/log/system", produces = MediaType.APPLICATION_JSON_VALUE)
public class SystemLogController {
@RequestMapping(value = "/monitor/log", produces = MediaType.APPLICATION_JSON_VALUE)
public class LogController {
private final LogService logService;
@Operation(summary = "分页查询登录日志列表")
@GetMapping("/login")
public R<PageInfo<LoginLogVO>> list(@Validated LoginLogQuery query, @Validated PageQuery pageQuery) {
PageInfo<LoginLogVO> pageInfo = logService.list(query, pageQuery);
return R.ok(pageInfo);
}
@Operation(summary = "分页查询操作日志列表")
@GetMapping("/operation")
public R<PageInfo<OperationLogVO>> list(@Validated OperationLogQuery query, @Validated PageQuery pageQuery) {
PageInfo<OperationLogVO> pageInfo = logService.list(query, pageQuery);
return R.ok(pageInfo);
}
@Operation(summary = "分页查询系统日志列表")
@GetMapping
@GetMapping("/system")
public R<PageInfo<SystemLogVO>> list(@Validated SystemLogQuery query, @Validated PageQuery pageQuery) {
PageInfo<SystemLogVO> pageInfo = logService.list(query, pageQuery);
return R.ok(pageInfo);
}
@Operation(summary = "系统日志列表")
@GetMapping("/{logId}")
@Operation(summary = "查看系统日志详情")
@GetMapping("/system/{logId}")
public R<SystemLogDetailVO> detail(@PathVariable Long logId) {
SystemLogDetailVO detailVO = logService.detail(logId);
return R.ok(detailVO);

58
continew-admin-webapi/src/main/java/top/charles7c/cnadmin/webapi/controller/monitor/LoginLogController.java
View File

@ -1,58 +0,0 @@
/*
* Copyright (c) 2022-present Charles7c Authors. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package top.charles7c.cnadmin.webapi.controller.monitor;
import lombok.RequiredArgsConstructor;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import org.springframework.http.MediaType;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import top.charles7c.cnadmin.common.model.query.PageQuery;
import top.charles7c.cnadmin.common.model.vo.PageInfo;
import top.charles7c.cnadmin.common.model.vo.R;
import top.charles7c.cnadmin.monitor.model.query.LoginLogQuery;
import top.charles7c.cnadmin.monitor.model.vo.LoginLogVO;
import top.charles7c.cnadmin.monitor.service.LogService;
/**
* 登录日志 API
*
* @author Charles7c
* @since 2023/1/16 23:17
*/
@Tag(name = "登录日志 API")
@Validated
@RestController
@RequiredArgsConstructor
@RequestMapping(value = "/monitor/log/login", produces = MediaType.APPLICATION_JSON_VALUE)
public class LoginLogController {
private final LogService logService;
@Operation(summary = "分页查询登录日志列表")
@GetMapping
public R<PageInfo<LoginLogVO>> list(@Validated LoginLogQuery query, @Validated PageQuery pageQuery) {
PageInfo<LoginLogVO> pageInfo = logService.list(query, pageQuery);
return R.ok(pageInfo);
}
}

58
continew-admin-webapi/src/main/java/top/charles7c/cnadmin/webapi/controller/monitor/OperationLogController.java
View File

@ -1,58 +0,0 @@
/*
* Copyright (c) 2022-present Charles7c Authors. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package top.charles7c.cnadmin.webapi.controller.monitor;
import lombok.RequiredArgsConstructor;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import org.springframework.http.MediaType;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import top.charles7c.cnadmin.common.model.query.PageQuery;
import top.charles7c.cnadmin.common.model.vo.PageInfo;
import top.charles7c.cnadmin.common.model.vo.R;
import top.charles7c.cnadmin.monitor.model.query.OperationLogQuery;
import top.charles7c.cnadmin.monitor.model.vo.OperationLogVO;
import top.charles7c.cnadmin.monitor.service.LogService;
/**
* 操作日志 API
*
* @author Charles7c
* @since 2023/1/14 18:09
*/
@Tag(name = "操作日志 API")
@Validated
@RestController
@RequiredArgsConstructor
@RequestMapping(value = "/monitor/log/operation", produces = MediaType.APPLICATION_JSON_VALUE)
public class OperationLogController {
private final LogService logService;
@Operation(summary = "分页查询操作日志列表")
@GetMapping
public R<PageInfo<OperationLogVO>> list(@Validated OperationLogQuery query, @Validated PageQuery pageQuery) {
PageInfo<OperationLogVO> pageInfo = logService.list(query, pageQuery);
return R.ok(pageInfo);
}
}