完成操作日志的记录

src/main/java/cn/iocoder/dashboard/modules/system/controller/auth/SysAuthController.java

@@ -2,6 +2,7 @@ package cn.iocoder.dashboard.modules.system.controller.auth;
 
 import cn.iocoder.dashboard.common.enums.CommonStatusEnum;
 import cn.iocoder.dashboard.common.pojo.CommonResult;
+import cn.iocoder.dashboard.framework.logger.operatelog.core.annotations.OperateLog;
 import cn.iocoder.dashboard.modules.system.controller.auth.vo.SysAuthLoginReqVO;
 import cn.iocoder.dashboard.modules.system.controller.auth.vo.SysAuthLoginRespVO;
 import cn.iocoder.dashboard.modules.system.controller.auth.vo.SysAuthMenuRespVO;
@@ -28,7 +29,7 @@ import static cn.iocoder.dashboard.common.pojo.CommonResult.success;
 import static cn.iocoder.dashboard.framework.security.core.util.SecurityUtils.getLoginUserId;
 import static cn.iocoder.dashboard.framework.security.core.util.SecurityUtils.getLoginUserRoleIds;
 
-@Api(tags = "认证 API")
+@Api("认证 API")
 @RestController
 @RequestMapping("/")
 public class SysAuthController {
@@ -44,6 +45,7 @@ public class SysAuthController {
 
     @ApiOperation("使用账号密码登录")
     @PostMapping("/login")
+    @OperateLog(enable = false) // 避免 Post 请求被记录操作日志
     public CommonResult<SysAuthLoginRespVO> login(@RequestBody @Valid SysAuthLoginReqVO reqVO) {
         String token = authService.login(reqVO.getUsername(), reqVO.getPassword(), reqVO.getUuid(), reqVO.getCode());
         // 返回结果
@@ -52,6 +54,7 @@ public class SysAuthController {
 
     @ApiOperation("获取登陆用户的权限信息")
     @GetMapping("/get-permission-info")
+    @OperateLog
     public CommonResult<SysAuthPermissionInfoRespVO> getPermissionInfo() {
         // 获得用户信息
         SysUserDO user = userService.getUser(getLoginUserId());

src/main/java/cn/iocoder/dashboard/modules/system/controller/logger/package-info.java

@@ -0,0 +1 @@
+package cn.iocoder.dashboard.modules.system.controller.logger;

src/main/java/cn/iocoder/dashboard/modules/system/controller/logger/vo/SysOperateLogBaseVO.java

@@ -0,0 +1,79 @@
+package cn.iocoder.dashboard.modules.system.controller.logger.vo;
+
+import io.swagger.annotations.ApiModelProperty;
+import lombok.Data;
+
+import javax.validation.constraints.NotEmpty;
+import javax.validation.constraints.NotNull;
+import java.util.Date;
+import java.util.Map;
+
+/**
+ * 操作日志 Base VO，提供给添加、修改、详细的子 VO 使用
+ * 如果子 VO 存在差异的字段，请不要添加到这里，影响 Swagger 文档生成
+ */
+@Data
+public class SysOperateLogBaseVO {
+
+    @ApiModelProperty(value = "链路追踪编号", required = true, example = "89aca178-a370-411c-ae02-3f0d672be4ab")
+    @NotEmpty(message = "链路追踪编号不能为空")
+    private String traceId;
+
+    @ApiModelProperty(value = "用户编号", required = true, example = "1024")
+    @NotNull(message = "用户编号不能为空")
+    private Long userId;
+
+    @ApiModelProperty(value = "操作模块", required = true, example = "订单")
+    @NotEmpty(message = "操作模块不能为空")
+    private String module;
+
+    @ApiModelProperty(value = "操作名", required = true, example = "创建订单")
+    @NotEmpty(message = "操作名")
+    private String name;
+
+    @ApiModelProperty(value = "操作分类", required = true, example = "操作分类", notes = "参见 SysOperateLogTypeEnum 枚举类")
+    @NotNull(message = "操作分类不能为空")
+    private Integer type;
+
+    @ApiModelProperty(value = "请求方法名", required = true, example = "GET")
+    @NotEmpty(message = "请求方法名不能为空")
+    private String requestMethod;
+
+    @ApiModelProperty(value = "请求地址", required = true, example = "/xxx/yyy")
+    @NotEmpty(message = "请求地址不能为空")
+    private String requestUrl;
+
+    @ApiModelProperty(value = "用户 IP", required = true, example = "127.0.0.1")
+    @NotEmpty(message = "用户 IP 不能为空")
+    private String userIp;
+
+    @ApiModelProperty(value = "浏览器 UserAgent", required = true, example = "Mozilla/5.0")
+    @NotEmpty(message = "浏览器 UserAgent 不能为空")
+    private String userAgent;
+
+    @ApiModelProperty(value = "Java 方法名", required = true, example = "cn.iocoder.dashboard.UserController.save(...)")
+    @NotEmpty(message = "Java 方法名不能为空")
+    private String javaMethod;
+
+    @ApiModelProperty(value = "Java 方法的参数")
+    private Map<String, Object> javaMethodArgs;
+
+    @ApiModelProperty(value = "开始时间", required = true)
+    @NotNull(message = "开始时间不能为空")
+    private Date startTime;
+
+    @ApiModelProperty(value = "执行时长，单位：毫秒", required = true)
+    @NotNull(message = "执行时长不能为空")
+    private Integer duration;
+
+    @ApiModelProperty(value = "结果码", required = true)
+    @NotNull(message = "结果码不能为空")
+    private Integer resultCode;
+
+    @ApiModelProperty(value = "结果提示")
+    private String resultMsg;
+
+    @ApiModelProperty(value = "结果数据")
+    private String resultData;
+
+}

src/main/java/cn/iocoder/dashboard/modules/system/controller/logger/vo/SysOperateLogCreateReqVO.java

@@ -0,0 +1,13 @@
+package cn.iocoder.dashboard.modules.system.controller.logger.vo;
+
+import io.swagger.annotations.ApiModel;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.ToString;
+
+@ApiModel(value = "操作日志创建 Request VO", description = "暂时提供给前端，仅仅后端切面记录操作日志时，进行使用")
+@Data
+@EqualsAndHashCode(callSuper = true)
+@ToString(callSuper = true)
+public class SysOperateLogCreateReqVO extends SysOperateLogBaseVO {
+}

src/main/java/cn/iocoder/dashboard/modules/system/controller/logger/vo/package-info.java

@@ -0,0 +1 @@
+package cn.iocoder.dashboard.modules.system.controller.logger.vo;

src/main/java/cn/iocoder/dashboard/modules/system/convert/logger/SysOperateLogConvert.java

@@ -0,0 +1,15 @@
+package cn.iocoder.dashboard.modules.system.convert.logger;
+
+import cn.iocoder.dashboard.modules.system.controller.logger.vo.SysOperateLogCreateReqVO;
+import cn.iocoder.dashboard.modules.system.dal.mysql.dataobject.logger.SysOperateLogDO;
+import org.mapstruct.Mapper;
+import org.mapstruct.factory.Mappers;
+
+@Mapper
+public interface SysOperateLogConvert {
+
+    SysOperateLogConvert INSTANCE = Mappers.getMapper(SysOperateLogConvert.class);
+
+    SysOperateLogDO convert(SysOperateLogCreateReqVO bean);
+
+}

src/main/java/cn/iocoder/dashboard/modules/system/dal/mysql/dao/logger/SysOperateLogMapper.java

@@ -0,0 +1,9 @@
+package cn.iocoder.dashboard.modules.system.dal.mysql.dao.logger;
+
+import cn.iocoder.dashboard.modules.system.dal.mysql.dataobject.logger.SysOperateLogDO;
+import com.baomidou.mybatisplus.core.mapper.BaseMapper;
+import org.apache.ibatis.annotations.Mapper;
+
+@Mapper
+public interface SysOperateLogMapper extends BaseMapper<SysOperateLogDO> {
+}

src/main/java/cn/iocoder/dashboard/modules/system/dal/mysql/dataobject/logger/SysOperateLogDO.java

@@ -36,7 +36,7 @@ public class SysOperateLogDO extends BaseDO {
      */
     private String traceId;
     /**
-     * 操作人
+     * 用户编号
      *
      * {@link SysUserDO#getId()}
      */
@@ -69,7 +69,7 @@ public class SysOperateLogDO extends BaseDO {
      * TODO 预留字段
      */
     @TableField(typeHandler = FastjsonTypeHandler.class)
-    private Map<String, Object> ext;
+    private Map<String, Object> exts;
 
     /**
      * 请求方法名
@@ -79,11 +79,6 @@ public class SysOperateLogDO extends BaseDO {
      * 请求地址
      */
     private String requestUrl;
-    /**
-     * 请求参数
-     */
-    @TableField(typeHandler = FastjsonTypeHandler.class)
-    private Map<String, Object> requestParams;
     /**
      * 用户 IP
      */
@@ -97,6 +92,11 @@ public class SysOperateLogDO extends BaseDO {
      * Java 方法名
      */
     private String javaMethod;
+    /**
+     * Java 方法的参数
+     */
+    @TableField(typeHandler = FastjsonTypeHandler.class)
+    private Map<String, Object> javaMethodArgs;
     /**
      * 开始时间
      */
@@ -119,8 +119,9 @@ public class SysOperateLogDO extends BaseDO {
     private String resultMsg;
     /**
      * 结果数据
+     *
+     * 如果是对象，则使用 JSON 格式化
      */
-    @TableField(typeHandler = FastjsonTypeHandler.class)
-    private Map<String, Object> resultData;
+    private String resultData;
 
 }

src/main/java/cn/iocoder/dashboard/modules/system/enums/logger/SysOperateLogTypeEnum.java

@@ -1,5 +1,6 @@
 package cn.iocoder.dashboard.modules.system.enums.logger;
 
+import cn.iocoder.dashboard.framework.logger.operatelog.core.annotations.OperateLog;
 import lombok.AllArgsConstructor;
 import lombok.Getter;
 
@@ -12,26 +13,33 @@ import lombok.Getter;
 @AllArgsConstructor
 public enum SysOperateLogTypeEnum {
 
+    /**
+     * 查询
+     *
+     * 绝大多数情况下，不会记录查询动作，因为过于大量显得没有意义。
+     * 在有需要的时候，通过声明 {@link OperateLog} 注解来记录
+     */
+    GET(1),
     /**
      * 新增
      */
-    CREATE(1),
+    CREATE(2),
     /**
      * 修改
      */
-    UPDATE(2),
+    UPDATE(3),
     /**
      * 删除
      */
-    DELETE(3),
+    DELETE(4),
     /**
      * 导出
      */
-    EXPORT(4),
+    EXPORT(5),
     /**
      * 导入
      */
-    IMPORT(5),
+    IMPORT(6),
     /**
      * 其它
      *

src/main/java/cn/iocoder/dashboard/modules/system/service/logger/SysOperateLogService.java

@@ -0,0 +1,9 @@
+package cn.iocoder.dashboard.modules.system.service.logger;
+
+import cn.iocoder.dashboard.framework.logger.operatelog.core.service.OperateLogFrameworkService;
+
+/**
+ * 操作日志 Service 接口
+ */
+public interface SysOperateLogService extends OperateLogFrameworkService {
+}

src/main/java/cn/iocoder/dashboard/modules/system/service/logger/impl/SysOperateLogServiceImpl.java

@@ -0,0 +1,33 @@
+package cn.iocoder.dashboard.modules.system.service.logger.impl;
+
+import cn.iocoder.dashboard.modules.system.controller.logger.vo.SysOperateLogCreateReqVO;
+import cn.iocoder.dashboard.modules.system.convert.logger.SysOperateLogConvert;
+import cn.iocoder.dashboard.modules.system.dal.mysql.dao.logger.SysOperateLogMapper;
+import cn.iocoder.dashboard.modules.system.dal.mysql.dataobject.logger.SysOperateLogDO;
+import cn.iocoder.dashboard.modules.system.service.logger.SysOperateLogService;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.scheduling.annotation.Async;
+import org.springframework.stereotype.Service;
+
+import javax.annotation.Resource;
+
+@Service
+@Slf4j
+public class SysOperateLogServiceImpl implements SysOperateLogService {
+
+    @Resource
+    private SysOperateLogMapper operateLogMapper;
+
+    @Override
+    @Async
+    public void createOperateLogAsync(SysOperateLogCreateReqVO reqVO) {
+        SysOperateLogDO logDO = SysOperateLogConvert.INSTANCE.convert(reqVO);
+        try {
+            operateLogMapper.insert(logDO);
+        } catch (Throwable throwable) {
+            // 仅仅打印日志，不对外抛出。原因是，还是要保留现场数据。
+            log.error("[createOperateLogAsync][记录操作日志异常，日志为 ({})]", reqVO, throwable);
+        }
+    }
+
+}