java AOP环绕切面记录操作日志

2024-05-15 03:44
文章标签 java 日志 操作 记录 aop 切面 环绕

本文主要是介绍java AOP环绕切面记录操作日志，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

一.创建数据库日志表

CREATE TABLE `uc_system_log` (`id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT '主键ID',`user_code` varchar(64) DEFAULT NULL COMMENT '用户编码',`user_name` varchar(128) DEFAULT NULL COMMENT '用户名称',`is_login` tinyint(4) NOT NULL DEFAULT '0' COMMENT '是否登录',`client` varchar(32) DEFAULT NULL COMMENT '客户端（PC-网页、APP-移动应用、API-开放接口）',`module_code` varchar(32) DEFAULT NULL COMMENT '操作模块',`action_code` varchar(32) DEFAULT NULL COMMENT '操作类型/行为',`remark` text COMMENT '操作描述（失败原因）',`is_success` tinyint(4) NOT NULL DEFAULT '1' COMMENT '是否操作成功',`ip` varchar(32) DEFAULT NULL COMMENT 'IP地址',`user_dept_code` varchar(64) DEFAULT NULL COMMENT '用户操作时所在组织编码',`user_dept_name` varchar(128) DEFAULT NULL COMMENT '用户操作时所在组织名称',`gmt_create` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',`app_code` varchar(64) DEFAULT NULL,`app_name` varchar(128) DEFAULT NULL,`refer_app_code` varchar(64) DEFAULT NULL COMMENT '来源应用编码',`refer_app_name` varchar(128) DEFAULT NULL COMMENT '来源应用名称',PRIMARY KEY (`id`) USING BTREE,KEY `idx_user_code` (`user_code`) USING BTREE,KEY `idx_app_code` (`app_code`) USING BTREE
) ENGINE=InnoDB AUTO_INCREMENT=969269 DEFAULT CHARSET=utf8 ROW_FORMAT=DYNAMIC COMMENT='操作日志表';

java对象


import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import lombok.*;
import lombok.experimental.Accessors;import java.time.LocalDateTime;@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
@EqualsAndHashCode(callSuper = false)
@Accessors(chain = true)
@TableName("uc_system_log")
public class SystemLog{/*** 主键ID*/@TableId(value = "id", type = IdType.AUTO)private Long id;/*** 用户编码*/@TableField("user_code")private String userCode;/*** 用户编码*/@TableField("user_name")private String userName;/*** 是否登录* 0-失败，1-成功*/@TableField("is_login")private Boolean login;/*** 客户端* PC-网页、APP-移动应用、API-开放接口*/@TableField("client")private SystemLogClientEnum client;/*** 操作模块*/@TableField("module_code")private SystemLogModuleEnum module;/*** 操作类型（行为）*/@TableField("action_code")private SystemLogActionEnum action;/*** 操作描述* 失败时有值*/@TableField("remark")private String remark;/*** 操作结果* 0-失败，1-成功*/@TableField("is_success")private Boolean success;/*** IP地址*/@TableField("ip")private String ip;/*** 用户操作时所在组织编码*/@TableField("user_dept_code")private String userDeptCode;/*** 用户操作时所在组织名称*/@TableField("user_dept_name")private String userDeptName;/*** 创建时间*/@TableField("gmt_create")private LocalDateTime gmtCreate;/*** 应用编码*/@TableField("app_code")private String appCode;/*** 应用名称*/@TableField("app_name")private String appName;/*** 来源应用编码*/@TableField("refer_app_code")private String referAppCode;/*** 来源应用名称*/@TableField("refer_app_name")private String referAppName;}

 2.定义枚举


public interface BaseStringEnum {/*** 获取枚举值** @return*/String getCode();/*** 获取枚举文本** @return*/String getName();/*** 根据枚举值和type获取枚举*/static <T extends BaseStringEnum> T getEnum(Class<T> type, String value) {T[] objs = type.getEnumConstants();for (T em : objs) {if (em.getCode().equals(value)) {return em;}}return null;}
}

系统模块枚举 

import com.dcqc.summarize.service.BaseStringEnum;
import lombok.AllArgsConstructor;
import lombok.Getter;import java.util.Arrays;
/*** 系统模块枚举** @author ws* Create on 2023-06-09*/
@Getter
@AllArgsConstructor
public enum SystemLogModuleEnum  implements BaseStringEnum {LOGIN("登录/登出"),REGULAR_CONFIG("规则配置"),USER_MANAGE("用户管理"),MENU_MANAGE("菜单管理"),ROLE_MANAGE("角色管理"),RESOURCE_MANAGE("资源管理"),DEPT_MANAGE("组织管理"),APP_MANAGE("应用管理"),ATTACH_MANAGE("附件管理"),TASK_MANAGE("任务管理"),OTHER("其他"),AUTH_MANAGE("授权管理"),ORDER_MANAGE("工单管理"),;private String desc;@Overridepublic String getCode() {return name();}@Overridepublic String getName() {return desc;}public static SystemLogModuleEnum valueByCode(String code) {return Arrays.stream(SystemLogModuleEnum.values()).filter(item -> item.getCode().equals(code)).findFirst().orElse(null);}
}

 日志行为枚举类

import com.dcqc.summarize.service.BaseStringEnum;
import lombok.AllArgsConstructor;
import lombok.Getter;
import java.util.Arrays;/*** 日志行为枚举类** @author ws* 2023-06-19*/
@Getter
@AllArgsConstructor
public enum SystemLogActionEnum implements BaseStringEnum {QR_LOGIN("扫码登录"),ENABLE("启用"),REGISTER("注册"),DISABLE("禁用"),ADD("新增"),UPDATE("更新"),DELETE("删除"),OTHER("其他"),AUTH_CODE_LOGIN("授权码免登"),USER_CODE_LOGIN("用户编码免登"),IRS_TOKEN_LOGIN("IRS免登"),REFRESH_COOKIE("刷新COOKIE"),LOGOUT("退出登录"),INTER_LOGIN("聚合登录"),CHANGE_USER_DEPT("变更用户部门"),CHANGE_USER_ROLE("变更用户角色"),UPLOAD("上传"),DOWNLOAD("下载"),EXECUTE("执行"),// 免登包括了认证和授权SSO_LOGIN("SSO免登"),// 单纯的认证，不包括授权，只返回简单的用户信息SSO_AUTHENTICATION("SSO认证"),AGREE("同意"),REJECT("拒绝"),DELETE_USER("删除用户"),;private String desc;@Overridepublic String getCode() {return name();}@Overridepublic String getName() {return desc;}public static SystemLogActionEnum valueByCode(String code) {return Arrays.stream(SystemLogActionEnum.values()).filter(item -> item.getCode().equals(code)).findFirst().orElse(null);}}

日志客户端枚举 


import com.dcqc.summarize.service.BaseStringEnum;
import lombok.AllArgsConstructor;
import lombok.Getter;import java.util.Arrays;/*** 日志客户端枚举类** @author ws* Create on 2023-06-09*/
@Getter
@AllArgsConstructor
public enum SystemLogClientEnum implements BaseStringEnum {PC("网页"),APP("移动应用"),OPEN_API("开放接口"),API("接口"),OTHER("其他"),;private String desc;public static SystemLogClientEnum valueByCode(String code) {return Arrays.stream(SystemLogClientEnum.values()).filter(systemLogClientEnum -> systemLogClientEnum.name().equals(code)).findFirst().orElse(null);}@Overridepublic String getCode() {return name();}@Overridepublic String getName() {return desc;}}

三.记录日志注解

import com.dcqc.summarize.entity.SystemLogClientEnum;
import com.dcqc.summarize.entity.SystemLogModuleEnum;
import com.dcqc.summarize.entity.SystemLogActionEnum;import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface RecordLog {SystemLogModuleEnum module() default SystemLogModuleEnum.LOGIN;SystemLogActionEnum action() default SystemLogActionEnum.QR_LOGIN;SystemLogClientEnum client() default SystemLogClientEnum.OTHER;String appCode() default "";}

四.Controller方法添加@RecordLog注解

  @ApiOperation("用户登陆")@PostMapping("/login")@RecordLog(module = SystemLogModuleEnum.LOGIN, action = SystemLogActionEnum.QR_LOGIN, client = SystemLogClientEnum.PC)public Result login(@RequestBody LoginRO entity) {try {//登陆业务}catch (Exception e) {throw new UserLoginErrorException("userCode", "userName", e);}return Result.success();}

用户登陆异常类 

import lombok.Data;@Data
public class UserLoginErrorException extends RuntimeException {private String userCode;private String userName;public UserLoginErrorException(String userCode, String userName, Throwable cause) {super(userCode + ":" + userName, cause);this.userCode = userCode;this.userName = userName;}}

五.AOP切面

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.core.LocalVariableTableParameterNameDiscoverer;
import org.springframework.core.annotation.AnnotationUtils;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;import javax.servlet.http.HttpServletRequest;
import java.lang.annotation.Annotation;
import java.lang.reflect.Method;public class BaseAspect {public BaseAspect() {}protected Class<?> getClass(JoinPoint joinPoint) {return joinPoint.getTarget().getClass();}protected Method getMethod(JoinPoint joinPoint) {return ((MethodSignature)joinPoint.getSignature()).getMethod();}protected <T extends Annotation> T getAnn(JoinPoint joinPoint, Class<T> annClazz) {return this.getAnn(this.getMethod(joinPoint), annClazz);}protected <T extends Annotation> T getAnn(Method method, Class<T> annClazz) {return AnnotationUtils.findAnnotation(method, annClazz);}protected String[] getParamNames(Method method) {return (new LocalVariableTableParameterNameDiscoverer()).getParameterNames(method);}protected HttpServletRequest getRequest() {return ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();}
}


import cn.hutool.extra.servlet.ServletUtil;
import com.dcqc.summarize.entity.SystemLog;
import com.dcqc.summarize.entity.SystemLogClientEnum;
import com.dcqc.summarize.exception.UserLoginErrorException;
import com.dcqc.summarize.mapper.SystemLogMapper;
import com.dcqc.summarize.service.RecordLog;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import javax.servlet.http.HttpServletRequest;import java.util.Objects;
@Slf4j
@Aspect
@Component
public class RecordLogAspect extends BaseAspect {@Autowiredprivate SystemLogMapper systemLogMapper;/*** 处理日志注解** @param point 切点* @return 处理结果* @throws Throwable 处理异常*/@Around("@annotation(com.dcqc.summarize.service.RecordLog)")public Object recordLogAround(ProceedingJoinPoint point) throws Throwable {SystemLog systemLogDTO = new SystemLog();try {// 1，获取操作日志切面注解RecordLog recordLog = getAnn(point, RecordLog.class);if (Objects.isNull(recordLog)) {return point.proceed();}// 2，获取注解对应的请求的客户端IPHttpServletRequest httpRequest = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();String clientIP = ServletUtil.getClientIP(httpRequest);// 3，从header里取值String appCode = httpRequest.getHeader("appCode");if (StringUtils.isNotBlank(appCode)) {systemLogDTO.setAppCode(appCode);}// 获取客户端类型SystemLogClientEnum client = recordLog.client();if (SystemLogClientEnum.OTHER.equals(client)) {if (httpRequest.getRequestURI().contains("openapi")) {client = SystemLogClientEnum.OPEN_API;} else if (httpRequest.getRequestURI().contains("api")) {client = SystemLogClientEnum.API;} else {client = SystemLogClientEnum.PC;}}// 4，封装操作日志业务信息systemLogDTO.setIp(clientIP);systemLogDTO.setModule(recordLog.module());systemLogDTO.setAction(recordLog.action());systemLogDTO.setClient(client);} catch (Exception e) {log.error("操作日志解析异常", e);}// 6，执行切点并记录操作日志Object result = null;try {result = point.proceed();} catch (Exception e) {if (e instanceof UserLoginErrorException) {systemLogDTO.setUserCode(((UserLoginErrorException) e).getUserCode());systemLogDTO.setUserName(((UserLoginErrorException) e).getUserName());}// 6.1，执行失败，记录失败日志systemLogDTO.setRemark(e.getMessage());systemLogMapper.insert(systemLogDTO);throw e;}// 6.1，执行成功，记录成功日志systemLogMapper.insert(systemLogDTO);return result;}
}

调用方法，可以看到日志被记录 

这篇关于java AOP环绕切面记录操作日志的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/990716。

相关文章

Java实现字节字符转bcd编码

Java实现字节字符转bcd编码

《Java实现字节字符转bcd编码》BCD是一种将十进制数字编码为二进制的表示方式,常用于数字显示和存储,本文将介绍如何在Java中实现字节字符转BCD码的过程,需要的小伙伴可以了解下... 目录前言BCD码是什么Java实现字节转bcd编码方法补充总结前言BCD码（Binary-Coded Decima
阅读更多...
SpringBoot全局域名替换的实现

SpringBoot全局域名替换的实现

《SpringBoot全局域名替换的实现》本文主要介绍了SpringBoot全局域名替换的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一... 目录 项目结构⚙️ 配置文件application.yml️ 配置类AppProperties.Ja
阅读更多...
Java使用Javassist动态生成HelloWorld类

Java使用Javassist动态生成HelloWorld类

《Java使用Javassist动态生成HelloWorld类》Javassist是一个非常强大的字节码操作和定义库,它允许开发者在运行时创建新的类或者修改现有的类,本文将简单介绍如何使用Javass... 目录1. Javassist简介2. 环境准备3. 动态生成HelloWorld类3.1 创建CtC
阅读更多...
JavaScript中的高级调试方法全攻略指南

JavaScript中的高级调试方法全攻略指南

《JavaScript中的高级调试方法全攻略指南》什么是高级JavaScript调试技巧,它比console.log有何优势,如何使用断点调试定位问题,通过本文,我们将深入解答这些问题,带您从理论到实... 目录观点与案例结合观点1观点2观点3观点4观点5高级调试技巧详解实战案例断点调试：定位变量错误性能分
阅读更多...
Java实现将HTML文件与字符串转换为图片

Java实现将HTML文件与字符串转换为图片

《Java实现将HTML文件与字符串转换为图片》在Java开发中,我们经常会遇到将HTML内容转换为图片的需求,本文小编就来和大家详细讲讲如何使用FreeSpire.DocforJava库来实现这一功... 目录前言核心实现：html 转图片完整代码场景 1：转换本地 HTML 文件为图片场景 2：转换 H
阅读更多...
Java使用jar命令配置服务器端口的完整指南

Java使用jar命令配置服务器端口的完整指南

《Java使用jar命令配置服务器端口的完整指南》本文将详细介绍如何使用java-jar命令启动应用,并重点讲解如何配置服务器端口,同时提供一个实用的Web工具来简化这一过程,希望对大家有所帮助... 目录1. Java Jar文件简介1.1 什么是Jar文件1.2 创建可执行Jar文件2. 使用java
阅读更多...
SpringBoot实现不同接口指定上传文件大小的具体步骤

SpringBoot实现不同接口指定上传文件大小的具体步骤

《SpringBoot实现不同接口指定上传文件大小的具体步骤》：本文主要介绍在SpringBoot中通过自定义注解、AOP拦截和配置文件实现不同接口上传文件大小限制的方法,强调需设置全局阈值远大于... 目录一  springboot实现不同接口指定文件大小1.1 思路说明1.2 工程启动说明二 具体实施2
阅读更多...
Java实现在Word文档中添加文本水印和图片水印的操作指南

Java实现在Word文档中添加文本水印和图片水印的操作指南

《Java实现在Word文档中添加文本水印和图片水印的操作指南》在当今数字时代,文档的自动化处理与安全防护变得尤为重要,无论是为了保护版权、推广品牌,还是为了在文档中加入特定的标识,为Word文档添加... 目录引言Spire.Doc for Java：高效Word文档处理的利器代码实战：使用Java为Wo
阅读更多...
SpringBoot日志级别与日志分组详解

SpringBoot日志级别与日志分组详解

《SpringBoot日志级别与日志分组详解》文章介绍了日志级别（ALL至OFF）及其作用,说明SpringBoot默认日志级别为INFO,可通过application.properties调整全局或... 目录日志级别1、级别内容2、调整日志级别调整默认日志级别调整指定类的日志级别项目开发过程中，利用日志
阅读更多...
Java中的抽象类与abstract 关键字使用详解

Java中的抽象类与abstract 关键字使用详解

《Java中的抽象类与abstract关键字使用详解》：本文主要介绍Java中的抽象类与abstract关键字使用详解,本文通过实例代码给大家介绍的非常详细,感兴趣的朋友跟随小编一起看看吧... 目录一、抽象类的概念二、使用 abstract2.1 修饰类 => 抽象类2.2 修饰方法 => 抽象方法，没有
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2