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

2024-05-15 03:44

本文主要是介绍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

相关文章

Spring boot整合dubbo+zookeeper的详细过程

《Springboot整合dubbo+zookeeper的详细过程》本文讲解SpringBoot整合Dubbo与Zookeeper实现API、Provider、Consumer模式,包含依赖配置、... 目录Spring boot整合dubbo+zookeeper1.创建父工程2.父工程引入依赖3.创建ap

SpringBoot结合Docker进行容器化处理指南

《SpringBoot结合Docker进行容器化处理指南》在当今快速发展的软件工程领域,SpringBoot和Docker已经成为现代Java开发者的必备工具,本文将深入讲解如何将一个SpringBo... 目录前言一、为什么选择 Spring Bootjavascript + docker1. 快速部署与

Spring Boot spring-boot-maven-plugin 参数配置详解(最新推荐)

《SpringBootspring-boot-maven-plugin参数配置详解(最新推荐)》文章介绍了SpringBootMaven插件的5个核心目标(repackage、run、start... 目录一 spring-boot-maven-plugin 插件的5个Goals二 应用场景1 重新打包应用

SpringBoot+EasyExcel实现自定义复杂样式导入导出

《SpringBoot+EasyExcel实现自定义复杂样式导入导出》这篇文章主要为大家详细介绍了SpringBoot如何结果EasyExcel实现自定义复杂样式导入导出功能,文中的示例代码讲解详细,... 目录安装处理自定义导出复杂场景1、列不固定,动态列2、动态下拉3、自定义锁定行/列,添加密码4、合并

Spring Boot集成Druid实现数据源管理与监控的详细步骤

《SpringBoot集成Druid实现数据源管理与监控的详细步骤》本文介绍如何在SpringBoot项目中集成Druid数据库连接池,包括环境搭建、Maven依赖配置、SpringBoot配置文件... 目录1. 引言1.1 环境准备1.2 Druid介绍2. 配置Druid连接池3. 查看Druid监控

Java中读取YAML文件配置信息常见问题及解决方法

《Java中读取YAML文件配置信息常见问题及解决方法》:本文主要介绍Java中读取YAML文件配置信息常见问题及解决方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要... 目录1 使用Spring Boot的@ConfigurationProperties2. 使用@Valu

创建Java keystore文件的完整指南及详细步骤

《创建Javakeystore文件的完整指南及详细步骤》本文详解Java中keystore的创建与配置,涵盖私钥管理、自签名与CA证书生成、SSL/TLS应用,强调安全存储及验证机制,确保通信加密和... 目录1. 秘密键(私钥)的理解与管理私钥的定义与重要性私钥的管理策略私钥的生成与存储2. 证书的创建与

浅析Spring如何控制Bean的加载顺序

《浅析Spring如何控制Bean的加载顺序》在大多数情况下,我们不需要手动控制Bean的加载顺序,因为Spring的IoC容器足够智能,但在某些特殊场景下,这种隐式的依赖关系可能不存在,下面我们就来... 目录核心原则:依赖驱动加载手动控制 Bean 加载顺序的方法方法 1:使用@DependsOn(最直

SpringBoot中如何使用Assert进行断言校验

《SpringBoot中如何使用Assert进行断言校验》Java提供了内置的assert机制,而Spring框架也提供了更强大的Assert工具类来帮助开发者进行参数校验和状态检查,下... 目录前言一、Java 原生assert简介1.1 使用方式1.2 示例代码1.3 优缺点分析二、Spring Fr

java使用protobuf-maven-plugin的插件编译proto文件详解

《java使用protobuf-maven-plugin的插件编译proto文件详解》:本文主要介绍java使用protobuf-maven-plugin的插件编译proto文件,具有很好的参考价... 目录protobuf文件作为数据传输和存储的协议主要介绍在Java使用maven编译proto文件的插件