spring boot 使用AOP+自定义注解+反射实现操作日志记录修改前数据和修改后对比数据，并保存至日志表

2022-10-30 13:38:24

效果图

在这里插入图片描述

一、添加aop starter依赖

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-aop</artifactId></dependency>

二：自定义字段翻译注解。（修改功能时，需要显示如某字段修改前为张三，修改后为李四，name字段对应的中文注释）

package com.test.common.annotation;import java.lang.annotation.*;/**
 * 写入日志表时，字段对应的中文注释
 */@Retention(RetentionPolicy.RUNTIME)// 注解会在class字节码文件中存在，在运行时可以通过反射获取到@Target({ElementType.FIELD,ElementType.METHOD})//定义注解的作用目标**作用范围字段、枚举的常量/方法@Documented//说明该注解将被包含在javadoc中public @interfaceFieldMeta{/**
     * 汉字全称
     * @return
     */
    Stringvalue();}

使用FieldMeta自定义注解,看个人业务自行觉得是否需要重新定义实体

package com.test.customer.domain;import java.math.BigDecimal;import java.util.Date;import java.util.List;import java.util.Map;import com.test.common.annotation.FieldMeta;import org.apache.commons.lang3.builder.ToStringBuilder;import org.apache.commons.lang3.builder.ToStringStyle;import com.test.common.core.domain.BaseEntity;publicclassTestDangAnDetailextendsBaseEntity{privatestaticfinallong serialVersionUID=1L;/**
     * 次数
     */@FieldMeta("总次数")private Long CountNum;}

三：定义AOP切面

注意：如不返回操作是否成功状态可能会导致前端出现警告，JSON为空不能被解析

import com.test.common.annotation.FieldMeta;import com.test.common.core.domain.entity.SysUser;import com.test.common.enums.BusinessStatus;import com.test.common.enums.OperatorType;import com.test.common.utils.*;import com.test.customer.domain.UserDataOperationLogs;import com.test.customer.service.IUserDataOperationLogsService;import com.test.framework.service.OperateLog;import com.test.common.enums.BusinessType;import com.test.framework.service.ContentParser;import com.test.system.domain.SysOperLog;import com.test.system.service.ISysOperLogService;import lombok.extern.slf4j.Slf4j;import com.alibaba.fastjson.JSON;import com.fasterxml.jackson.databind.DeserializationFeature;import com.fasterxml.jackson.databind.ObjectMapper;import com.fasterxml.jackson.databind.SerializationFeature;import org.aspectj.lang.ProceedingJoinPoint;import org.aspectj.lang.annotation.Around;import org.aspectj.lang.annotation.Aspect;import org.aspectj.lang.reflect.MethodSignature;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.context.ApplicationContext;import org.springframework.stereotype.Component;import org.springframework.web.bind.annotation.RequestMethod;import org.springframework.web.context.request.RequestContextHolder;import org.springframework.web.context.request.ServletRequestAttributes;import javax.servlet.http.HttpServletRequest;import java.lang.reflect.Field;import java.lang.reflect.Method;import java.util.Date;import java.util.HashMap;import java.util.Map;/**
 * 拦截@EnableGameleyLog注解的方法
 * 将具体修改存储到数据库中
 */@Aspect@Component@Slf4jpublicclassOperateAspect{@Autowiredprivate IUserDataOperationLogsService iUserDataOperationLogsService;@Autowiredprivate DefaultContentParse defaultContentParse;@Autowiredprivate ApplicationContext applicationContext;// 环绕通知@Around("@annotation(operateLog)")public Objectaround(ProceedingJoinPoint joinPoint, OperateLog operateLog)throws Throwable{
        Map<String, Object> oldMap=newHashMap<>();
        UserDataOperationLogs lg=newUserDataOperationLogs();
        ServletRequestAttributes attributes=(ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request= attributes.getRequest();// 当不传默认operateType时 根据Method类型自动匹配setAnnotationType(request, operateLog);// fixme 1.0.9开始不再提供自动存入username功能,请在存储实现类中自行存储// 从切面织入点处通过反射机制获取织入点处的方法
        MethodSignature signature=(MethodSignature) joinPoint.getSignature();

        Object[] args=joinPoint.getArgs();// 请求参数// 获取当前的用户
        SysUser currentUser= ShiroUtils.getSysUser();

        lg.setCreateBy(currentUser.getLoginName());
        lg.setStatus(0l);
        lg.setUpdateTime(newDate());if(OperateType.UPDATE.equals(operateLog.operateType())){try{
               ContentParser contentParser=(ContentParser) applicationContext.getBean(operateLog.parseclass());
                Object oldObject= contentParser.getResult(joinPoint, operateLog);if(operateLog.needDefaultCompare()){
                    oldMap=(Map<String, Object>)objectToMap(oldObject);// 存储修改前的对象
                    lg.setStoreId((Long) oldMap.get("storeId"));
                    lg.setItemId((Long) oldMap.get("itemId"));}}catch(Exception e){
               e.printStackTrace();
                log.error("service加载失败:", e);}}// joinPoint.proceed()执行前是前置通知，执行后是后置通知
        Object object=joinPoint.proceed();if(OperateType.UPDATE.equals(operateLog.operateType())){
            ContentParser contentParser;try{
               String responseParams=JSON.toJSONString(object);
               contentParser=(ContentParser) applicationContext.getBean(operateLog.parseclass());
                object= contentParser.getResult(joinPoint, operateLog);}catch(Exception e){
               log.error("service加载失败:", e);}// 默认不进行比较，可以自己在logService中自定义实现，降低对性能的影响if(operateLog.needDefaultCompare()){
               lg.setContent(defaultDealUpdate(object, oldMap));}// 如果使用默认缓存 则需要更新到最新的数据if(operateLog.defaultCache()&& operateLog.parseclass().equals(DefaultContentParse.class)){
                defaultContentParse.updateCache(joinPoint, operateLog,object);}}else{
           String responseParams=JSON.toJSONString(object);}//保存当前日志到数据库中int logs= iUserDataOperationLogsService.insertUserDataOperationLogs(lg);
        log.info("新增用户操作数据日志成功");//返回用户的操作是否成功
        AjaxResult ajaxResult= logs>0?success():error();return ajaxResult;}private StringdefaultDealUpdate(Object newObject, Map<String, Object> oldMap){try{
            Map<String, Object> newMap=(Map<String, Object>)objectToMap(newObject);
            StringBuilder str=newStringBuilder();
            Object finalNewObject= newObject;
            oldMap.forEach((k, v)->{
                Object newResult= newMap.get(k);if(null!=v&&!v.equals(newResult)){
                    Field field= ReflectionUtils.getAccessibleField(finalNewObject, k);
                    FieldMeta dataName= field.getAnnotation(FieldMeta.class);
                    SysUser currentUser= ShiroUtils.getSysUser();if(null!=dataName){
                        str.append("【"+currentUser.getLoginName()+"】").append("修改了【").append(dataName.value()+"】").append("将【").append(v).append("】").append(" 改为：【").append(newResult).append("】。\n");}}});return str.toString();}catch(Exception e){
            log.error("比较异常", e);thrownewRuntimeException("比较异常",e);}}private Map<?,?>objectToMap(Object obj){if(obj== null){return null;}
        ObjectMapper mapper=newObjectMapper();
        mapper.disable(SerializationFeature.FAIL_ON_EMPTY_BEANS);
        mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES,false);// 如果使用JPA请自己打开这条配置// mapper.addMixIn(Object.class, IgnoreHibernatePropertiesInJackson.class);
        Map<?,?> mappedObject= mapper.convertValue(obj, Map.class);return mappedObject;}privatevoidsetAnnotationType(HttpServletRequest request,OperateLog modifyLog){if(!modifyLog.operateType().equals(OperateType.NONE)){return;}
        String method=request.getMethod();if(RequestMethod.GET.name().equalsIgnoreCase(method)){
            ReflectAnnotationUtil.updateValue(modifyLog,"operateType", OperateType.SELECT);}elseif(RequestMethod.POST.name().equalsIgnoreCase(method)){
            ReflectAnnotationUtil.updateValue(modifyLog,"operateType", OperateType.ADD);}elseif(RequestMethod.PUT.name().equalsIgnoreCase(method)){
            ReflectAnnotationUtil.updateValue(modifyLog,"operateType", OperateType.UPDATE);}elseif(RequestMethod.DELETE.name().equalsIgnoreCase(method)){
            ReflectAnnotationUtil.updateValue(modifyLog,"operateType", OperateType.DELETE);}}}

四：自定义日志注解

package com.test.framework.service;import com.test.common.utils.IService;import com.test.common.utils.OperateType;import com.test.framework.service.impl.DefaultContentParse;import java.lang.annotation.Documented;import java.lang.annotation.ElementType;import java.lang.annotation.Retention;import java.lang.annotation.RetentionPolicy;import java.lang.annotation.Target;/**
 * 记录编辑详细信息的标注
 * @author 
 */@Documented@Retention(RetentionPolicy.RUNTIME)@Target({ElementType.METHOD})public @interfaceOperateLog{// 模块名称
   StringmoduleCode()default"";// 操作的类型 可以直接调用OperateType 不传时根据METHOD自动确定
   OperateTypeoperateType()default OperateType.NONE;// 获取编辑信息的解析类，目前为使用id获取，复杂的解析需要自己实现，默认不填写则使用默认解析类
    Classparseclass()default DefaultContentParse.class;// 查询数据库所调用的class文件
    Classserviceclass()default IService.class;// 具体业务操作名称
    StringhandleName()default"";// 是否需要默认的改动比较booleanneedDefaultCompare()defaultfalse;// id的类型
    ClassidType()default Long.class;// 是否使用默认本地缓存booleandefaultCache()defaultfalse;}

五、@OperateLog注解使用

/**
 * 修改记录详情
 * @OperateLog:AOP自定义日志注解
 */@PostMapping("/editSave")@OperateLog(moduleCode="editSave", operateType= OperateType.UPDATE, handleName="修改档案信息", needDefaultCompare=true)@ResponseBodypublic AjaxResulteditSave(TCustomerItemRecDetail tCustomerItemRecDetail){returntoAjax(testDangAnDetailService.updateTestDangAnDetail(tCustomerItemRecDetail));}

修改功能时，需要实现我们自定义的IService接口，并重写 selectById 方法，在修改前我们需要根据主键id去数据库查询对应的信息，然后在和修改后的值进行比较。
在这里插入图片描述

六：IService接口

/**
 * 修改时需要记录修改前后的值时，需要根据主键id去查询修改前的值时需要
 * @author zhang
 */publicinterfaceIService<T, S>{
    TselectById(S id);}

由于博主使用的是若依框架未分离版所以才会出现这个错误，其他框架可以根据情况执行决定
在这里插入图片描述

为防止出现textStatus == "parsererror" || textStatus == "error"错误，主要是parsererror解析错误，在around方法最好加上AjaxResult ajaxResult = logs> 0 ? success() : error();并返回ajaxResult

原文出处：https://www.91mszl.com/zhangwuji/article/details/1221

  • 作者：一汐渔樵画
  • 原文链接：https://blog.csdn.net/m0_46598549/article/details/126305806
    更新时间：2022-10-30 13:38:24