From 3ba34ca8eeb1987643f714e9da8498a8b2ca78c5 Mon Sep 17 00:00:00 2001
From: hxr <1490493387@qq.com>
Date: Fri, 28 Jun 2024 08:06:26 +0800
Subject: [PATCH] =?UTF-8?q?feat:=20=E6=97=A5=E5=BF=97=E5=88=86=E9=A1=B5?=
 =?UTF-8?q?=E5=88=97=E8=A1=A8=E5=92=8C=E6=B7=BB=E5=8A=A0=E6=93=8D=E4=BD=9C?=
 =?UTF-8?q?=E6=97=A5=E5=BF=97=E8=AE=B0=E5=BD=95?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .../system/controller/SysDeptController.java  |  7 ++-
 .../system/controller/SysDictController.java  |  3 +
 .../system/controller/SysLogController.java   | 37 ++++++++++++
 .../system/controller/SysMenuController.java  |  3 +
 .../system/controller/SysRoleController.java  |  3 +
 .../system/controller/SysUserController.java  |  3 +
 .../system/converter/UserConverter.java       |  4 +-
 .../youlai/system/mapper/SysLogMapper.java    |  4 ++
 .../system/model/query/LogPageQuery.java      | 21 +++++++
 .../system/model/query/RolePageQuery.java     | 12 ++--
 .../com/youlai/system/model/vo/LogPageVO.java | 59 +++++++++++++++++++
 .../youlai/system/service/SysLogService.java  |  4 ++
 .../service/impl/SysLogServiceImpl.java       | 14 +++++
 .../service/impl/SysUserServiceImpl.java      |  2 +-
 src/main/resources/mapper/SysLogMapper.xml    | 36 +++++++----
 .../resources/templates/converter.java.vm     |  4 +-
 .../resources/templates/serviceImpl.java.vm   |  2 +-
 17 files changed, 192 insertions(+), 26 deletions(-)
 create mode 100644 src/main/java/com/youlai/system/controller/SysLogController.java
 create mode 100644 src/main/java/com/youlai/system/model/query/LogPageQuery.java
 create mode 100644 src/main/java/com/youlai/system/model/vo/LogPageVO.java

diff --git a/src/main/java/com/youlai/system/controller/SysDeptController.java b/src/main/java/com/youlai/system/controller/SysDeptController.java
index c24f0151..b7ac282a 100644
--- a/src/main/java/com/youlai/system/controller/SysDeptController.java
+++ b/src/main/java/com/youlai/system/controller/SysDeptController.java
@@ -1,11 +1,13 @@
 package com.youlai.system.controller;
 
+import com.youlai.system.enums.LogModuleEnum;
 import com.youlai.system.plugin.norepeat.annotation.PreventRepeatSubmit;
 import com.youlai.system.common.model.Option;
 import com.youlai.system.common.result.Result;
 import com.youlai.system.model.form.DeptForm;
 import com.youlai.system.model.query.DeptQuery;
 import com.youlai.system.model.vo.DeptVO;
+import com.youlai.system.plugin.syslog.annotation.LogAnnotation;
 import com.youlai.system.service.SysDeptService;
 import io.swagger.v3.oas.annotations.Parameter;
 import io.swagger.v3.oas.annotations.tags.Tag;
@@ -31,8 +33,9 @@ public class SysDeptController {
 
     private final SysDeptService deptService;
 
-    @Operation(summary = "获取部门列表")
+    @Operation(summary = "部门列表")
     @GetMapping
+    @LogAnnotation( value = "部门列表",module = LogModuleEnum.DEPT)
     public Result<List<DeptVO>> getDeptList(
              DeptQuery queryParams
     ) {
@@ -40,7 +43,7 @@ public class SysDeptController {
         return Result.success(list);
     }
 
-    @Operation(summary = "获取部门下拉列表")
+    @Operation(summary = "部门下拉列表")
     @GetMapping("/options")
     public Result<List<Option>> getDeptOptions() {
         List<Option> list = deptService.listDeptOptions();
diff --git a/src/main/java/com/youlai/system/controller/SysDictController.java b/src/main/java/com/youlai/system/controller/SysDictController.java
index caef2477..76cb83ec 100644
--- a/src/main/java/com/youlai/system/controller/SysDictController.java
+++ b/src/main/java/com/youlai/system/controller/SysDictController.java
@@ -4,10 +4,12 @@ import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
 import com.youlai.system.common.model.Option;
 import com.youlai.system.common.result.PageResult;
 import com.youlai.system.common.result.Result;
+import com.youlai.system.enums.LogModuleEnum;
 import com.youlai.system.model.vo.DictPageVO;
 import com.youlai.system.plugin.norepeat.annotation.PreventRepeatSubmit;
 import com.youlai.system.model.form.DictForm;
 import com.youlai.system.model.query.DictTypePageQuery;
+import com.youlai.system.plugin.syslog.annotation.LogAnnotation;
 import com.youlai.system.service.SysDictService;
 import io.swagger.v3.oas.annotations.Parameter;
 import io.swagger.v3.oas.annotations.tags.Tag;
@@ -34,6 +36,7 @@ public class SysDictController {
 
     @Operation(summary = "字典分页列表")
     @GetMapping("/page")
+    @LogAnnotation( value = "字典分页列表",module = LogModuleEnum.DICT)
     public PageResult<DictPageVO> getDictPage(
             DictTypePageQuery queryParams
     ) {
diff --git a/src/main/java/com/youlai/system/controller/SysLogController.java b/src/main/java/com/youlai/system/controller/SysLogController.java
new file mode 100644
index 00000000..bd2b2854
--- /dev/null
+++ b/src/main/java/com/youlai/system/controller/SysLogController.java
@@ -0,0 +1,37 @@
+package com.youlai.system.controller;
+
+import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
+import com.youlai.system.common.result.PageResult;
+import com.youlai.system.model.query.RolePageQuery;
+import com.youlai.system.model.vo.LogPageVO;
+import com.youlai.system.service.SysLogService;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
+import lombok.RequiredArgsConstructor;
+import org.springframework.web.bind.annotation.*;
+
+
+/**
+ * 日志控制层
+ *
+ * @author Ray
+ * @since 2022/10/16
+ */
+@Tag(name = "08.日志接口")
+@RestController
+@RequestMapping("/api/v1/logs")
+@RequiredArgsConstructor
+public class SysLogController {
+
+    private final SysLogService logService;
+
+    @Operation(summary = "日志分页列表")
+    @GetMapping("/page")
+    public PageResult<LogPageVO> listPagedLogs(
+             RolePageQuery queryParams
+    ) {
+        Page<LogPageVO> result = logService.listPagedLogs(queryParams);
+        return PageResult.success(result);
+    }
+
+}
diff --git a/src/main/java/com/youlai/system/controller/SysMenuController.java b/src/main/java/com/youlai/system/controller/SysMenuController.java
index eb927c2e..7251e368 100644
--- a/src/main/java/com/youlai/system/controller/SysMenuController.java
+++ b/src/main/java/com/youlai/system/controller/SysMenuController.java
@@ -1,12 +1,14 @@
 package com.youlai.system.controller;
 
 import com.youlai.system.common.result.Result;
+import com.youlai.system.enums.LogModuleEnum;
 import com.youlai.system.plugin.norepeat.annotation.PreventRepeatSubmit;
 import com.youlai.system.model.form.MenuForm;
 import com.youlai.system.model.query.MenuQuery;
 import com.youlai.system.model.vo.MenuVO;
 import com.youlai.system.common.model.Option;
 import com.youlai.system.model.vo.RouteVO;
+import com.youlai.system.plugin.syslog.annotation.LogAnnotation;
 import com.youlai.system.service.SysMenuService;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.Parameter;
@@ -35,6 +37,7 @@ public class SysMenuController {
 
     @Operation(summary = "菜单列表")
     @GetMapping
+    @LogAnnotation( value = "菜单列表",module = LogModuleEnum.MENU)
     public Result<List<MenuVO>> listMenus(MenuQuery queryParams) {
         List<MenuVO> menuList = menuService.listMenus(queryParams);
         return Result.success(menuList);
diff --git a/src/main/java/com/youlai/system/controller/SysRoleController.java b/src/main/java/com/youlai/system/controller/SysRoleController.java
index ea0e5785..0230f7bb 100644
--- a/src/main/java/com/youlai/system/controller/SysRoleController.java
+++ b/src/main/java/com/youlai/system/controller/SysRoleController.java
@@ -1,6 +1,7 @@
 package com.youlai.system.controller;
 
 import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
+import com.youlai.system.enums.LogModuleEnum;
 import com.youlai.system.plugin.norepeat.annotation.PreventRepeatSubmit;
 import com.youlai.system.common.model.Option;
 import com.youlai.system.common.result.PageResult;
@@ -8,6 +9,7 @@ import com.youlai.system.common.result.Result;
 import com.youlai.system.model.form.RoleForm;
 import com.youlai.system.model.query.RolePageQuery;
 import com.youlai.system.model.vo.RolePageVO;
+import com.youlai.system.plugin.syslog.annotation.LogAnnotation;
 import com.youlai.system.service.SysRoleService;
 import io.swagger.v3.oas.annotations.Parameter;
 import io.swagger.v3.oas.annotations.tags.Tag;
@@ -37,6 +39,7 @@ public class SysRoleController {
 
     @Operation(summary = "角色分页列表")
     @GetMapping("/page")
+    @LogAnnotation( value = "角色分页列表",module = LogModuleEnum.ROLE)
     public PageResult<RolePageVO> getRolePage(
              RolePageQuery queryParams
     ) {
diff --git a/src/main/java/com/youlai/system/controller/SysUserController.java b/src/main/java/com/youlai/system/controller/SysUserController.java
index f336d644..f4461ac2 100644
--- a/src/main/java/com/youlai/system/controller/SysUserController.java
+++ b/src/main/java/com/youlai/system/controller/SysUserController.java
@@ -7,6 +7,7 @@ import com.baomidou.mybatisplus.core.metadata.IPage;
 import com.youlai.system.common.result.PageResult;
 import com.youlai.system.common.result.Result;
 import com.youlai.system.common.util.ExcelUtils;
+import com.youlai.system.enums.LogModuleEnum;
 import com.youlai.system.model.dto.UserImportDTO;
 import com.youlai.system.plugin.norepeat.annotation.PreventRepeatSubmit;
 import com.youlai.system.plugin.easyexcel.UserImportListener;
@@ -16,6 +17,7 @@ import com.youlai.system.model.query.UserPageQuery;
 import com.youlai.system.model.dto.UserExportDTO;
 import com.youlai.system.model.vo.UserInfoVO;
 import com.youlai.system.model.vo.UserPageVO;
+import com.youlai.system.plugin.syslog.annotation.LogAnnotation;
 import com.youlai.system.service.SysUserService;
 import io.swagger.v3.oas.annotations.Parameter;
 import io.swagger.v3.oas.annotations.tags.Tag;
@@ -52,6 +54,7 @@ public class SysUserController {
 
     @Operation(summary = "用户分页列表")
     @GetMapping("/page")
+    @LogAnnotation( value = "用户分页列表",module = LogModuleEnum.USER)
     public PageResult<UserPageVO> listPagedUsers(
              UserPageQuery queryParams
     ) {
diff --git a/src/main/java/com/youlai/system/converter/UserConverter.java b/src/main/java/com/youlai/system/converter/UserConverter.java
index fed932f1..9eff1496 100644
--- a/src/main/java/com/youlai/system/converter/UserConverter.java
+++ b/src/main/java/com/youlai/system/converter/UserConverter.java
@@ -24,9 +24,9 @@ public interface UserConverter {
     @Mappings({
             @Mapping(target = "genderLabel", expression = "java(com.youlai.system.common.base.IBaseEnum.getLabelByValue(bo.getGender(), com.youlai.system.enums.GenderEnum.class))")
     })
-    UserPageVO bo2PageVo(UserBO bo);
+    UserPageVO toPageVo(UserBO bo);
 
-    Page<UserPageVO> bo2PageVo(Page<UserBO> bo);
+    Page<UserPageVO> toPageVo(Page<UserBO> bo);
 
     UserForm convertToForm(SysUser entity);
 
diff --git a/src/main/java/com/youlai/system/mapper/SysLogMapper.java b/src/main/java/com/youlai/system/mapper/SysLogMapper.java
index 42cf220d..980b4c89 100644
--- a/src/main/java/com/youlai/system/mapper/SysLogMapper.java
+++ b/src/main/java/com/youlai/system/mapper/SysLogMapper.java
@@ -1,7 +1,10 @@
 package com.youlai.system.mapper;
 
+import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
 import com.youlai.system.model.entity.SysLog;
 import com.baomidou.mybatisplus.core.mapper.BaseMapper;
+import com.youlai.system.model.query.RolePageQuery;
+import com.youlai.system.model.vo.LogPageVO;
 import org.apache.ibatis.annotations.Mapper;
 
 
@@ -14,6 +17,7 @@ import org.apache.ibatis.annotations.Mapper;
 @Mapper
 public interface SysLogMapper extends BaseMapper<SysLog> {
 
+    Page<LogPageVO> listPagedLogs(Page page, RolePageQuery queryParams);
 }
 
 
diff --git a/src/main/java/com/youlai/system/model/query/LogPageQuery.java b/src/main/java/com/youlai/system/model/query/LogPageQuery.java
new file mode 100644
index 00000000..28760476
--- /dev/null
+++ b/src/main/java/com/youlai/system/model/query/LogPageQuery.java
@@ -0,0 +1,21 @@
+package com.youlai.system.model.query;
+
+import com.youlai.system.common.base.BasePageQuery;
+import io.swagger.v3.oas.annotations.media.Schema;
+import lombok.Getter;
+import lombok.Setter;
+
+/**
+ * 日志分页查询对象
+ *
+ * @author Ray
+ * @since 2.10.0
+ */
+@Schema(description = "日志分页查询对象")
+@Getter
+@Setter
+public class LogPageQuery extends BasePageQuery {
+
+    @Schema(description="关键字(日志内容/请求路径/请求方法/地区/浏览器/终端系统)")
+    private String keywords;
+}
diff --git a/src/main/java/com/youlai/system/model/query/RolePageQuery.java b/src/main/java/com/youlai/system/model/query/RolePageQuery.java
index 0a0b6164..102f8df4 100644
--- a/src/main/java/com/youlai/system/model/query/RolePageQuery.java
+++ b/src/main/java/com/youlai/system/model/query/RolePageQuery.java
@@ -2,16 +2,18 @@ package com.youlai.system.model.query;
 
 import com.youlai.system.common.base.BasePageQuery;
 import io.swagger.v3.oas.annotations.media.Schema;
-import lombok.Data;
+import lombok.Getter;
+import lombok.Setter;
 
 /**
- * 角色分页查询实体
+ * 角色分页查询对象
  *
- * @author haoxr
+ * @author Ray
  * @since 2022/6/3
- *
  */
-@Data
+@Schema(description = "角色分页查询对象")
+@Getter
+@Setter
 public class RolePageQuery extends BasePageQuery {
 
     @Schema(description="关键字(角色名称/角色编码)")
diff --git a/src/main/java/com/youlai/system/model/vo/LogPageVO.java b/src/main/java/com/youlai/system/model/vo/LogPageVO.java
new file mode 100644
index 00000000..78898686
--- /dev/null
+++ b/src/main/java/com/youlai/system/model/vo/LogPageVO.java
@@ -0,0 +1,59 @@
+package com.youlai.system.model.vo;
+
+import com.fasterxml.jackson.annotation.JsonFormat;
+import com.youlai.system.enums.LogModuleEnum;
+import io.swagger.v3.oas.annotations.media.Schema;
+import lombok.Data;
+
+import java.io.Serializable;
+import java.time.LocalDateTime;
+
+/**
+ * 系统日志分页VO
+ *
+ * @author Ray
+ * @since 2.10.0
+ */
+@Data
+@Schema(description = "系统日志分页VO")
+public class LogPageVO implements Serializable {
+
+    @Schema(description = "主键")
+    private Long id;
+
+    @Schema(description = "日志模块")
+    private LogModuleEnum module;
+
+    @Schema(description = "日志内容")
+    private String content;
+
+    @Schema(description = "请求路径")
+    private String requestUri;
+
+    @Schema(description = "请求方法")
+    private String method;
+
+    @Schema(description = "IP 地址")
+    private String ip;
+
+    @Schema(description = "地区")
+    private String region;
+
+    @Schema(description = "浏览器")
+    private String browser;
+
+    @Schema(description = "终端系统")
+    private String os;
+
+    @Schema(description = "执行时间(毫秒)")
+    private Long executionTime;
+
+    @Schema(description = "创建人ID")
+    private Long createBy;
+
+    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
+    private LocalDateTime createTime;
+
+    @Schema(description = "操作人")
+    private String operator;
+}
\ No newline at end of file
diff --git a/src/main/java/com/youlai/system/service/SysLogService.java b/src/main/java/com/youlai/system/service/SysLogService.java
index 616cc86a..a6b017c4 100644
--- a/src/main/java/com/youlai/system/service/SysLogService.java
+++ b/src/main/java/com/youlai/system/service/SysLogService.java
@@ -1,7 +1,10 @@
 package com.youlai.system.service;
 
+import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
 import com.youlai.system.model.entity.SysLog;
 import com.baomidou.mybatisplus.extension.service.IService;
+import com.youlai.system.model.query.RolePageQuery;
+import com.youlai.system.model.vo.LogPageVO;
 
 /**
  * 系统日志 服务接口
@@ -11,4 +14,5 @@ import com.baomidou.mybatisplus.extension.service.IService;
  */
 public interface SysLogService extends IService<SysLog> {
 
+    Page<LogPageVO> listPagedLogs(RolePageQuery queryParams);
 }
diff --git a/src/main/java/com/youlai/system/service/impl/SysLogServiceImpl.java b/src/main/java/com/youlai/system/service/impl/SysLogServiceImpl.java
index 24c7a444..2045187b 100644
--- a/src/main/java/com/youlai/system/service/impl/SysLogServiceImpl.java
+++ b/src/main/java/com/youlai/system/service/impl/SysLogServiceImpl.java
@@ -1,7 +1,10 @@
 package com.youlai.system.service.impl;
 
+import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
 import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
 import com.youlai.system.model.entity.SysLog;
+import com.youlai.system.model.query.RolePageQuery;
+import com.youlai.system.model.vo.LogPageVO;
 import com.youlai.system.service.SysLogService;
 import com.youlai.system.mapper.SysLogMapper;
 import org.springframework.stereotype.Service;
@@ -16,6 +19,17 @@ import org.springframework.stereotype.Service;
 public class SysLogServiceImpl extends ServiceImpl<SysLogMapper, SysLog>
         implements SysLogService {
 
+    /**
+     * 获取日志分页列表
+     *
+     * @param queryParams 查询参数
+     * @return
+     */
+    @Override
+    public Page<LogPageVO> listPagedLogs(RolePageQuery queryParams) {
+        return this.baseMapper.listPagedLogs(new Page(queryParams.getPageNum(), queryParams.getPageSize()),
+                queryParams);
+    }
 }
 
 
diff --git a/src/main/java/com/youlai/system/service/impl/SysUserServiceImpl.java b/src/main/java/com/youlai/system/service/impl/SysUserServiceImpl.java
index 7ffc4cad..9a16d4d6 100644
--- a/src/main/java/com/youlai/system/service/impl/SysUserServiceImpl.java
+++ b/src/main/java/com/youlai/system/service/impl/SysUserServiceImpl.java
@@ -76,7 +76,7 @@ public class SysUserServiceImpl extends ServiceImpl<SysUserMapper, SysUser> impl
         Page<UserBO> userPage = this.baseMapper.listPagedUsers(page, queryParams);
 
         // 实体转换
-        return userConverter.bo2PageVo(userPage);
+        return userConverter.toPageVo(userPage);
     }
 
     /**
diff --git a/src/main/resources/mapper/SysLogMapper.xml b/src/main/resources/mapper/SysLogMapper.xml
index 3d72849c..765820ea 100644
--- a/src/main/resources/mapper/SysLogMapper.xml
+++ b/src/main/resources/mapper/SysLogMapper.xml
@@ -4,17 +4,27 @@
         "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
 <mapper namespace="com.youlai.system.mapper.SysLogMapper">
 
-    <resultMap id="BaseResultMap" type="com.youlai.system.model.entity.SysLog">
-            <id property="id" column="id" jdbcType="BIGINT"/>
-            <result property="createBy" column="create_by" jdbcType="BIGINT"/>
-            <result property="createTime" column="create_time" jdbcType="TIMESTAMP"/>
-            <result property="updateBy" column="update_by" jdbcType="BIGINT"/>
-            <result property="updateTime" column="update_time" jdbcType="TIMESTAMP"/>
-            <result property="isDeleted" column="is_deleted" jdbcType="TINYINT"/>
-    </resultMap>
-
-    <sql id="Base_Column_List">
-        id,create_by,create_time,
-        update_by,update_time,is_deleted
-    </sql>
+    <!-- 日志分页列表 -->
+    <select id="listPagedLogs" resultType="com.youlai.system.model.vo.LogPageVO">
+        SELECT
+            t1.*,
+            t2.nickname AS operator
+        FROM
+            sys_log t1
+            LEFT JOIN sys_user t2 ON t1.create_by = t2.id
+        <where>
+            t1.is_deleted = 0
+            <if test="queryParams.keywords != null and queryParams.keywords != ''">
+                AND (
+                    t1.content LIKE concat('%',#{queryParams.keywords},'%')
+                    OR
+                    t1.ip LIKE concat('%',#{queryParams.keywords},'%')
+                    OR
+                    t2.nickname LIKE concat('%',#{queryParams.keywords},'%')
+                )
+            </if>
+        </where>
+        ORDER BY
+            t1.create_time DESC
+    </select>
 </mapper>
diff --git a/src/test/resources/templates/converter.java.vm b/src/test/resources/templates/converter.java.vm
index 8d81764f..e414d62d 100644
--- a/src/test/resources/templates/converter.java.vm
+++ b/src/test/resources/templates/converter.java.vm
@@ -19,9 +19,9 @@ import ${package.Parent}.model.bo.${entity}BO;
 @Mapper(componentModel = "spring")
 public interface ${entity}Converter{
 
-    ${entity}PageVO bo2PageVo(${entity}BO bo);
+    ${entity}PageVO toPageVo(${entity}BO bo);
 
-    Page<${entity}PageVO> bo2PageVo(Page<${entity}BO> bo);
+    Page<${entity}PageVO> toPageVo(Page<${entity}BO> bo);
 
     ${entity}Form convertToForm(${entity} entity);
 
diff --git a/src/test/resources/templates/serviceImpl.java.vm b/src/test/resources/templates/serviceImpl.java.vm
index 226e3b2b..c759a106 100644
--- a/src/test/resources/templates/serviceImpl.java.vm
+++ b/src/test/resources/templates/serviceImpl.java.vm
@@ -56,7 +56,7 @@ public class ${table.serviceImplName} extends ${superServiceImplClass}<${table.m
         Page<${entity}BO> boPage = this.baseMapper.listPaged${entity}s(page, queryParams);
     
         // 实体转换
-        return ${firstCharLowerCaseEntity}Converter.bo2PageVo(boPage);
+        return ${firstCharLowerCaseEntity}Converter.toPageVo(boPage);
     }
     
     /**