test-version22
/
MeterSphere
mirror of https://gitee.com/fit2cloud-feizhiyun/MeterSphere.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

refactor(系统): 日志相关优化

This commit is contained in:
WangXu10 2024-04-15 20:19:04 +08:00 committed by Craftsman
parent 627a63c511
commit 53f2c736f7
13 changed files with 105 additions and 69 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
backend/services/project-management/src/main/java/io/metersphere/project/controller/ProjectLogController.java
View File

@ -4,18 +4,19 @@ package io.metersphere.project.controller;
import com.github.pagehelper.Page;
import com.github.pagehelper.PageHelper;
import io.metersphere.sdk.constants.PermissionConstants;
import io.metersphere.sdk.util.BeanUtils;
import io.metersphere.system.domain.User;
import io.metersphere.system.log.service.OperationLogService;
import io.metersphere.system.log.vo.OperationLogRequest;
import io.metersphere.system.log.vo.OperationLogResponse;
import io.metersphere.system.log.vo.ProOperationLogRequest;
import io.metersphere.system.log.vo.SystemOperationLogRequest;
import io.metersphere.system.service.UserService;
import io.metersphere.system.utils.PageUtils;
import io.metersphere.system.utils.Pager;
import io.metersphere.system.utils.SessionUtils;
import io.metersphere.system.domain.User;
import io.metersphere.system.service.UserService;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.tags.Tag;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang3.StringUtils;
import org.apache.shiro.authz.annotation.RequiresPermissions;
import org.springframework.beans.factory.annotation.Autowired;
@ -47,21 +48,20 @@ public class ProjectLogController {
public List<User> getUserList(@PathVariable(value = "projectId") String projectId,
@Schema(description = "查询关键字，根据邮箱和用户名查询")
@RequestParam(value = "keyword", required = false) String keyword) {
return userService.getUserListByOrgId(StringUtils.defaultIfBlank(projectId,SessionUtils.getCurrentProjectId()), keyword);
return userService.getUserListByOrgId(StringUtils.defaultIfBlank(projectId, SessionUtils.getCurrentProjectId()), keyword);
}
@PostMapping("/list")
@Operation(summary = "项目管理-日志--操作日志列表查询")
@RequiresPermissions(PermissionConstants.PROJECT_LOG_READ)
public Pager<List<OperationLogResponse>> projectLogList(@Validated @RequestBody OperationLogRequest request) {
public Pager<List<OperationLogResponse>> projectLogList(@Validated @RequestBody ProOperationLogRequest request) {
Page<Object> page = PageHelper.startPage(request.getCurrent(), request.getPageSize(),
StringUtils.isNotBlank(request.getSortString()) ? request.getSortString() : "create_time desc");
if (CollectionUtils.isEmpty(request.getProjectIds())) {
//未传项目id 获取登录用户当前项目id
request.setProjectIds(Arrays.asList(SessionUtils.getCurrentProjectId()));
}
return PageUtils.setPageInfo(page, operationLogService.list(request));
SystemOperationLogRequest operationLogRequest = new SystemOperationLogRequest();
BeanUtils.copyBean(operationLogRequest, request);
operationLogRequest.setProjectIds(Arrays.asList(SessionUtils.getCurrentProjectId()));
return PageUtils.setPageInfo(page, operationLogService.list(operationLogRequest));
}
}

12
backend/services/project-management/src/test/java/io/metersphere/project/controller/ProjectLogControllerTests.java
View File

@ -3,7 +3,7 @@ package io.metersphere.project.controller;
import io.metersphere.sdk.constants.PermissionConstants;
import io.metersphere.system.base.BaseTest;
import io.metersphere.system.log.vo.OperationLogRequest;
import io.metersphere.system.log.vo.ProOperationLogRequest;
import org.junit.jupiter.api.MethodOrderer;
import org.junit.jupiter.api.Order;
import org.junit.jupiter.api.Test;
@ -11,10 +11,9 @@ import org.junit.jupiter.api.TestMethodOrder;
import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
import org.springframework.boot.test.context.SpringBootTest;
import java.util.Arrays;
import java.util.HashMap;
@SpringBootTest(webEnvironment= SpringBootTest.WebEnvironment.RANDOM_PORT)
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
@TestMethodOrder(MethodOrderer.OrderAnnotation.class)
@AutoConfigureMockMvc
public class ProjectLogControllerTests extends BaseTest {
@ -34,7 +33,7 @@ public class ProjectLogControllerTests extends BaseTest {
@Test
@Order(3)
public void testProjectLogList() throws Exception {
OperationLogRequest request = buildParam(PROJECT);
ProOperationLogRequest request = buildParam(PROJECT);
//项目级别 全部
this.requestPostWithOkAndReturn(PROJECT_LOG_LIST, request);
@ -43,7 +42,6 @@ public class ProjectLogControllerTests extends BaseTest {
request.setType("add");
request.setModule("SYSTEM_PARAMETER_SETTING");
request.setContent("认证配置");
request.setProjectIds(Arrays.asList("project_id_001", "project_id_002"));
request.setSort(new HashMap<>() {{
put("createTime", "desc");
}});
@ -54,8 +52,8 @@ public class ProjectLogControllerTests extends BaseTest {
}
private OperationLogRequest buildParam(String level) {
OperationLogRequest request = new OperationLogRequest();
private ProOperationLogRequest buildParam(String level) {
ProOperationLogRequest request = new ProOperationLogRequest();
request.setCurrent(1);
request.setPageSize(10);
request.setStartTime(1689131059000l);

4
backend/services/system-setting/src/main/java/io/metersphere/system/controller/OperationLogController.java
View File

@ -5,7 +5,7 @@ import com.github.pagehelper.Page;
import com.github.pagehelper.PageHelper;
import io.metersphere.sdk.constants.PermissionConstants;
import io.metersphere.system.log.service.OperationLogService;
import io.metersphere.system.log.vo.OperationLogRequest;
import io.metersphere.system.log.vo.SystemOperationLogRequest;
import io.metersphere.system.log.vo.OperationLogResponse;
import io.metersphere.system.utils.PageUtils;
import io.metersphere.system.utils.Pager;
@ -65,7 +65,7 @@ public class OperationLogController {
@PostMapping("/list")
@Operation(summary = "系统设置-系统-日志-系统操作日志列表查询")
@RequiresPermissions(PermissionConstants.SYSTEM_LOG_READ)
public Pager<List<OperationLogResponse>> list(@Validated @RequestBody OperationLogRequest request) {
public Pager<List<OperationLogResponse>> list(@Validated @RequestBody SystemOperationLogRequest request) {
Page<Object> page = PageHelper.startPage(request.getCurrent(), request.getPageSize(),
StringUtils.isNotBlank(request.getSortString()) ? request.getSortString() : "create_time desc");
return PageUtils.setPageInfo(page, operationLogService.list(request));

28
backend/services/system-setting/src/main/java/io/metersphere/system/controller/OrganizationLogController.java
View File

@ -4,22 +4,23 @@ package io.metersphere.system.controller;
import com.github.pagehelper.Page;
import com.github.pagehelper.PageHelper;
import io.metersphere.sdk.constants.PermissionConstants;
import io.metersphere.system.log.service.OperationLogService;
import io.metersphere.system.log.vo.OperationLogRequest;
import io.metersphere.system.log.vo.OperationLogResponse;
import io.metersphere.system.utils.PageUtils;
import io.metersphere.system.utils.Pager;
import io.metersphere.system.utils.SessionUtils;
import io.metersphere.sdk.util.BeanUtils;
import io.metersphere.system.domain.User;
import io.metersphere.system.dto.OrganizationProjectOptionsDTO;
import io.metersphere.system.dto.response.OrganizationProjectOptionsResponse;
import io.metersphere.system.log.service.OperationLogService;
import io.metersphere.system.log.vo.OperationLogResponse;
import io.metersphere.system.log.vo.OrgOperationLogRequest;
import io.metersphere.system.log.vo.SystemOperationLogRequest;
import io.metersphere.system.service.SystemProjectService;
import io.metersphere.system.service.UserService;
import io.metersphere.system.utils.PageUtils;
import io.metersphere.system.utils.Pager;
import io.metersphere.system.utils.SessionUtils;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.tags.Tag;
import jakarta.annotation.Resource;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang3.StringUtils;
import org.apache.shiro.authz.annotation.RequiresPermissions;
import org.springframework.validation.annotation.Validated;
@ -66,21 +67,20 @@ public class OrganizationLogController {
public List<User> getLogUserList(@PathVariable(value = "organizationId") String organizationId,
@Schema(description = "查询关键字，根据邮箱和用户名查询")
@RequestParam(value = "keyword", required = false) String keyword) {
return userService.getUserListByOrgId(organizationId,keyword);
return userService.getUserListByOrgId(organizationId, keyword);
}
@PostMapping("/list")
@Operation(summary = "系统设置-组织-日志-组织菜单下操作日志列表查询")
@RequiresPermissions(PermissionConstants.ORGANIZATION_LOG_READ)
public Pager<List<OperationLogResponse>> organizationLogList(@Validated @RequestBody OperationLogRequest request) {
public Pager<List<OperationLogResponse>> organizationLogList(@Validated @RequestBody OrgOperationLogRequest request) {
Page<Object> page = PageHelper.startPage(request.getCurrent(), request.getPageSize(),
StringUtils.isNotBlank(request.getSortString()) ? request.getSortString() : "create_time desc");
if (CollectionUtils.isEmpty(request.getOrganizationIds())) {
//未传组织id 获取登录用户当前组织id
request.setOrganizationIds(Arrays.asList(SessionUtils.getCurrentOrganizationId()));
}
return PageUtils.setPageInfo(page, operationLogService.list(request));
SystemOperationLogRequest operationLogRequest = new SystemOperationLogRequest();
BeanUtils.copyBean(operationLogRequest, request);
operationLogRequest.setOrganizationIds(Arrays.asList(SessionUtils.getCurrentOrganizationId()));
return PageUtils.setPageInfo(page, operationLogService.list(operationLogRequest));
}
}

4
backend/services/system-setting/src/main/java/io/metersphere/system/log/service/OperationLogService.java
View File

@ -12,7 +12,7 @@ import io.metersphere.system.domain.OperationHistoryExample;
import io.metersphere.system.domain.Organization;
import io.metersphere.system.dto.sdk.OptionDTO;
import io.metersphere.system.log.dto.LogDTO;
import io.metersphere.system.log.vo.OperationLogRequest;
import io.metersphere.system.log.vo.SystemOperationLogRequest;
import io.metersphere.system.log.vo.OperationLogResponse;
import io.metersphere.system.mapper.*;
import jakarta.annotation.Resource;
@ -90,7 +90,7 @@ public class OperationLogService {
operationLogBlobMapper.insert(getBlob(log));
}
public List<OperationLogResponse> list(OperationLogRequest request) {
public List<OperationLogResponse> list(SystemOperationLogRequest request) {
int compare = Long.compare(request.getStartTime(), request.getEndTime());
if (compare > 0) {
throw new MSException(Translator.get("startTime_must_be_less_than_endTime"));

23
backend/services/system-setting/src/main/java/io/metersphere/system/log/vo/OperationLogRequest.java → backend/services/system-setting/src/main/java/io/metersphere/system/log/vo/BaseOperationLogRequest.java
View File

@ -14,36 +14,29 @@ import java.util.List;
@Data
@EqualsAndHashCode(callSuper = false)
public class OperationLogRequest extends BasePageRequest {
public class BaseOperationLogRequest extends BasePageRequest {
@Schema(description = "操作人")
@Schema(description = "操作人")
private String operUser;
@Schema(description = "开始日期")
@Schema(description = "开始日期")
@NotNull(message = "{start_time_is_null}")
private Long startTime;
@Schema(description = "结束日期")
@Schema(description = "结束日期")
@NotNull(message = "{end_time_is_null}")
private Long endTime;
@Schema(description = "项目id")
private List<String> projectIds;
@Schema(description = "组织id")
private List<String> organizationIds;
@Schema(description = "操作类型")
@Schema(description = "操作类型")
private String type;
@Schema(description = "操作对象")
@Schema(description = "操作对象")
private String module;
@Schema(description = "名称")
@Schema(description = "名称")
private String content;
@Schema(description = "级别 系统|组织|项目")
@Schema(description = "级别 系统|组织|项目")
@EnumValue(enumClass = UserRoleType.class, groups = {Created.class, Updated.class})
private String level;

16
backend/services/system-setting/src/main/java/io/metersphere/system/log/vo/OrgOperationLogRequest.java Normal file
View File

@ -0,0 +1,16 @@
package io.metersphere.system.log.vo;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
import lombok.EqualsAndHashCode;
import java.util.List;
@Data
@EqualsAndHashCode(callSuper = false)
public class OrgOperationLogRequest extends BaseOperationLogRequest {
@Schema(description = "项目id")
private List<String> projectIds;
}

11
backend/services/system-setting/src/main/java/io/metersphere/system/log/vo/ProOperationLogRequest.java Normal file
View File

@ -0,0 +1,11 @@
package io.metersphere.system.log.vo;
import lombok.Data;
import lombok.EqualsAndHashCode;
@Data
@EqualsAndHashCode(callSuper = false)
public class ProOperationLogRequest extends BaseOperationLogRequest {
}

19
backend/services/system-setting/src/main/java/io/metersphere/system/log/vo/SystemOperationLogRequest.java Normal file
View File

@ -0,0 +1,19 @@
package io.metersphere.system.log.vo;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
import lombok.EqualsAndHashCode;
import java.util.List;
@Data
@EqualsAndHashCode(callSuper = false)
public class SystemOperationLogRequest extends BaseOperationLogRequest {
@Schema(description = "项目id")
private List<String> projectIds;
@Schema(description = "组织id")
private List<String> organizationIds;
}

4
backend/services/system-setting/src/main/java/io/metersphere/system/mapper/BaseOperationLogMapper.java
View File

@ -1,7 +1,7 @@
package io.metersphere.system.mapper;
import io.metersphere.system.log.vo.OperationLogRequest;
import io.metersphere.system.log.vo.SystemOperationLogRequest;
import io.metersphere.system.log.vo.OperationLogResponse;
import org.apache.ibatis.annotations.Param;
@ -9,7 +9,7 @@ import java.util.List;
public interface BaseOperationLogMapper {
List<OperationLogResponse> list(@Param("request") OperationLogRequest request);
List<OperationLogResponse> list(@Param("request") SystemOperationLogRequest request);
void deleteByTime(@Param("timestamp") long timestamp);

2
backend/services/system-setting/src/main/java/io/metersphere/system/mapper/BaseOperationLogMapper.xml
View File

@ -2,7 +2,7 @@
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="io.metersphere.system.mapper.BaseOperationLogMapper">
<select id="list" parameterType="io.metersphere.system.log.vo.OperationLogRequest" resultType="io.metersphere.system.log.vo.OperationLogResponse">
<select id="list" parameterType="io.metersphere.system.log.vo.SystemOperationLogRequest" resultType="io.metersphere.system.log.vo.OperationLogResponse">
SELECT
t.project_id,
t.organization_id,

14
backend/services/system-setting/src/test/java/io/metersphere/system/controller/OperationLogControllerTests.java
View File

@ -4,7 +4,7 @@ import io.metersphere.system.base.BaseTest;
import io.metersphere.sdk.constants.PermissionConstants;
import io.metersphere.system.log.dto.LogDTO;
import io.metersphere.system.log.service.OperationLogService;
import io.metersphere.system.log.vo.OperationLogRequest;
import io.metersphere.system.log.vo.SystemOperationLogRequest;
import io.metersphere.system.controller.param.OperationLogRequestDefinition;
import jakarta.annotation.Resource;
import org.junit.jupiter.api.MethodOrderer;
@ -54,7 +54,7 @@ public class OperationLogControllerTests extends BaseTest {
executionPhase = Sql.ExecutionPhase.BEFORE_TEST_METHOD)
public void testSystemOperationLogList() throws Exception {
//系统级别 全部
OperationLogRequest request = buildParam(SYSTEM);
SystemOperationLogRequest request = buildParam(SYSTEM);
this.requestPostWithOkAndReturn(OPERATION_LOG_LIST, request);
//其他查询条件
@ -80,7 +80,7 @@ public class OperationLogControllerTests extends BaseTest {
@Test
@Order(4)
public void testOrganizationOperationLogList() throws Exception {
OperationLogRequest request = buildParam(ORGANIZATION);
SystemOperationLogRequest request = buildParam(ORGANIZATION);
//组织级别 全部
this.requestPostWithOkAndReturn(OPERATION_LOG_LIST, request);
@ -111,7 +111,7 @@ public class OperationLogControllerTests extends BaseTest {
@Test
@Order(5)
public void testProjectOperationLogList() throws Exception {
OperationLogRequest request = buildParam(PROJECT);
SystemOperationLogRequest request = buildParam(PROJECT);
//项目级别 全部
this.requestPostWithOkAndReturn(OPERATION_LOG_LIST, request);
@ -155,7 +155,7 @@ public class OperationLogControllerTests extends BaseTest {
@Test
@Order(6)
public void testGetOperationLogParamsError() throws Exception {
OperationLogRequest request = buildParam(SYSTEM);
SystemOperationLogRequest request = buildParam(SYSTEM);
request.setStartTime(1689149059000l);
request.setEndTime(1689131059000l);
ResultActions resultActions = this.requestPost(OPERATION_LOG_LIST, request);
@ -163,8 +163,8 @@ public class OperationLogControllerTests extends BaseTest {
}
private OperationLogRequest buildParam(String level) {
OperationLogRequest request = new OperationLogRequest();
private SystemOperationLogRequest buildParam(String level) {
SystemOperationLogRequest request = new SystemOperationLogRequest();
request.setCurrent(1);
request.setPageSize(10);
request.setStartTime(1689131059000l);

15
backend/services/system-setting/src/test/java/io/metersphere/system/controller/OrganizationLogControllerTests.java
View File

@ -1,9 +1,9 @@
package io.metersphere.system.controller;
import io.metersphere.system.base.BaseTest;
import io.metersphere.sdk.constants.PermissionConstants;
import io.metersphere.system.log.vo.OperationLogRequest;
import io.metersphere.system.base.BaseTest;
import io.metersphere.system.controller.param.OperationLogRequestDefinition;
import io.metersphere.system.log.vo.OrgOperationLogRequest;
import org.junit.jupiter.api.MethodOrderer;
import org.junit.jupiter.api.Order;
import org.junit.jupiter.api.Test;
@ -14,7 +14,7 @@ import org.springframework.boot.test.context.SpringBootTest;
import java.util.Arrays;
import java.util.HashMap;
@SpringBootTest(webEnvironment= SpringBootTest.WebEnvironment.RANDOM_PORT)
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
@AutoConfigureMockMvc
@TestMethodOrder(MethodOrderer.OrderAnnotation.class)
public class OrganizationLogControllerTests extends BaseTest {
@ -41,14 +41,14 @@ public class OrganizationLogControllerTests extends BaseTest {
@Order(2)
public void testOrganizationUserList() throws Exception {
String keyword = "o";
this.requestGetWithOkAndReturn(ORGANIZATION_USER_LIST+ "/organization_id_001" + "?keyword=" + keyword);
this.requestGetWithOkAndReturn(ORGANIZATION_USER_LIST + "/organization_id_001" + "?keyword=" + keyword);
}
@Test
@Order(3)
public void testOrganizationLogList() throws Exception {
OperationLogRequest request = buildParam(ORGANIZATION);
OrgOperationLogRequest request = buildParam(ORGANIZATION);
//项目级别 全部
this.requestPostWithOkAndReturn(ORGANIZATION_LOG_LIST, request);
@ -57,7 +57,6 @@ public class OrganizationLogControllerTests extends BaseTest {
request.setType("add");
request.setModule("SYSTEM_PARAMETER_SETTING");
request.setContent("认证配置");
request.setOrganizationIds(Arrays.asList("organization_id_001", "organization_id_002"));
this.requestPostWithOkAndReturn(ORGANIZATION_LOG_LIST, request);
//项目级别 指定项目查询
@ -74,8 +73,8 @@ public class OrganizationLogControllerTests extends BaseTest {
}
private OperationLogRequest buildParam(String level) {
OperationLogRequest request = new OperationLogRequest();
private OrgOperationLogRequest buildParam(String level) {
OrgOperationLogRequest request = new OrgOperationLogRequest();
request.setCurrent(1);
request.setPageSize(10);
request.setStartTime(1689131059000l);