栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

Java Aop切面环绕通知记录操作日志

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

Java Aop切面环绕通知记录操作日志

1.需求:需要记录增删改操作日志,编辑操作时需要记录数据前后变化 2. 技术分析:
  1. 在数据库的表里存储需要记录数据变化的字段,以及字段对应的中文释义
  2. aop切面注解 aop切面方法
  3. 新增时获取入参即为新对象 ; 编辑时需要根据对应的主键从数据库获取原有对象 再根据需要记录的字段 一一比较新老对象身上的数据 ; 删除时在原有业务代码中将删除的对象名称返回,切面执行业务代码就能获得
3. 实现 3.1 数据库存储字段以及释义

部分字段如下:

3.2 代码实现 3.2.1切面注解中用到自定义的日志类型枚举类
import lombok.Getter;
@Getter
public enum LogTypeEnum {
    
    LOG_TYPE_UNKNOWN(0),
    LOG_TYPE_INSERT(1),
    LOG_TYPE_UPDATE(2),
    LOG_TYPE_QUERY(3),
    LOG_TYPE_DELETE(4),
    LOG_TYPE_LOGIN(5),
    LOG_TYPE_LOGIN_OUT(6),
    LOG_TYPE_FILE_UPLOAD(7),
    LOG_TYPE_FILE_DOWNLOAD(8),
    LOG_TYPE_REGIESTER(9),
    ;
    private int type;
    LogTypeEnum(int type) {
        this.type = type;
    }
}
3.2.2 切面注解
import com.ymob.saas.managerserver.enums.LogTypeEnum;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target({ElementType.METHOD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface VerifyLog {
    boolean required() default true;
    //是否需要记录该操作的日志
    boolean log() default false;
    //操作类型  根据业务代码自定义
    String operateType() default "";
    //日志操作类型  根据需求自定义  增删改等等  系列
    LogTypeEnum logType() default LogTypeEnum.LOG_TYPE_UNKNOWN;
    //此操作的目的
    String name() default "";
 	//方法操作的 对象类名,用于接受入参的java对象
    Class clazz()  default Object.class;
	//执行业务代码的service实现类
    Class implClazz() default Object.class;
	//根据主键获取原有对象的方法名
    String getOne() default "";
}
3.2.3 切面方法

工具类: 从spring容器中获取指定bean , 在以下切面时会用到

import org.springframework.beans.BeansException;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.stereotype.Component;

@Component
public class SpringUtil {
    
    private static ApplicationContext applicationContext;
    @Autowired
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        this.applicationContext = applicationContext;
    }

    
    public static ApplicationContext getApplicationContext() {
        return applicationContext;
    }

    
    public static Object getBean(String name){
        return getApplicationContext().getBean(name);
    }

    
    public static  T getBean(Class clazz){
        return getApplicationContext().getBean(clazz);
    }

    
    public static  T getBean(String name,Class clazz){
        return getApplicationContext().getBean(name, clazz);
    }
}

切面方法:

import com.alibaba.fastjson.JSON;
import com.ymob.saas.managerserver.annotion.VerifyLog;
import com.ymob.saas.managerserver.dto.sys.SysLogDto;
import com.ymob.saas.managerserver.enums.LogTypeEnum;
import com.ymob.saas.managerserver.service.sys.LogService;
import com.ymob.saas.managerserver.timer.SysLogFieldTimer;
import com.ymob.saas.managerserver.utils.SpringUtil;
import com.ymob.saas.managerserver.utils.TokenUtil;
import com.ymob.saas.managerserver.vo.common.Response;
import com.ymob.saas.managerserver.vo.sys.UserVO;
import com.ymob.utils.DateUtils;
import com.ymob.utils.HttpUtils;
import com.ymob.utils.StringUtils;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestAttributes;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.util.*;
import java.util.concurrent.ConcurrentHashMap;

@Slf4j
@Component
@Aspect
public class SysLogAspect {
    private final LogService logService;
    public SysLogAspect(LogService logService) {
        this.logService = logService;
    }
    @Pointcut("@annotation( com.ymob.saas.managerserver.annotion.VerifyLog)")
    public void logAspect(){
    }

    @Around(value = "logAspect()" )
    public Object doAround(ProceedingJoinPoint joinPoint ) throws Throwable {
    //获取切面注解信息,可以从该对象获取切面注解的属性
	VerifyLog verifyLog =  getVerifyLog(joinPoint);
	
	//从切点获取请求体
	HttpServletRequest request = getRequest(joinPoint);
	//从请求体中获取 请求接口路径
	String path = request.getRequestURI()
	//从切点获取入参
	String requestParam = getRequestParam(joinPoint);
	
	// java用于接收入参的对象    操作的 java对象类名
	Class clazz = verifyLog.clazz();
	//从该类中获取所有字段包括私有,可以遍历该数组 ,和数据库存储的对比 如果在数据库里 则代表该字段需要记录变化 
	Field[] fields = clazz.getDeclaredFields();
	//上边数组遍历出来的元素  field   从中获取字段名
	String FiledName = field.getName()

	//获取切入点方法的 业务实现类
 	Class implClazz = verifyLog.implClazz();
 	//从该实现类获取指定方法   (查出老对象的方法名,方法需要的参数类型)
 	//编辑时需要查出老对象  此举是获取老对象
    Method method = implClazz.getMethod(verifyLog.getOne(),String.class);
    //如上获取的实现类并不能获取该类需要注入的对象  ---比如 获取到实现类 实现类身上需要注入的mapper就为null
    //从spring上下文获取实现类对象,该工具类在上边已列出
     Object o = SpringUtil.getBean(implClazz);
     //由于一些老对象在获取时 需要多个id ,自定义方法  获取需要的ids
     //此处需要对一些特殊对象 特殊判断处理
     String id = getIds(requestParam);
     //执行目标方法   (方法所属的类对象,该方法需要的参数)
     //此处是执行查询老对象的方法   获取数据库的老对象  用于编辑时的数据比对
     Object oldObject = method.invoke(o,id);

	//执行目标方法
	//如果为新增操作   先执行目标业务方法  从中获取状态码 如果成功则记录日志
	//如果为编辑操作   先查出老对象  再执行目标业务方法  从中获取状态码  如果成功则记录数据修改记录  只有改动过的字段需要记录
	//入
	String result = joinPoint.proceed();

	

   private String getRequestParam(JoinPoint joinPoint) {
        // 构造参数组集合
        List argList = new ArrayList<>();
        for (Object arg : joinPoint.getArgs()) {
            if (!(arg instanceof HttpServletRequest) && !(arg instanceof HttpServletResponse)) {
                 argList.add(JSON.toJSON(arg));
            }
        }
        return StringUtils.join(argList, ",");
    }
	
    private VerifyLog getVerifyLog(JoinPoint joinPoint) throws ClassNotFoundException {
        String targetName = joinPoint.getTarget().getClass().getName();
        String methodName = joinPoint.getSignature().getName();
        Object[] arguments = joinPoint.getArgs();
        Class targetClass = Class.forName(targetName);
        Method[] method = targetClass.getMethods();
        for (Method m : method) {
            if (m.getName().equals(methodName)) {
                Class[] tmpCs = m.getParameterTypes();
                if (tmpCs.length == arguments.length) {
                    VerifyLog methodCache = m.getAnnotation(VerifyLog.class);
                    if (methodCache != null && methodCache.log()) {
                        return methodCache;
                    }
                    break;
                }
            }
        }
        return null;
    }

    
    private HttpServletRequest getRequest(JoinPoint point) {
        Object[] args = point.getArgs();
        for (Object obj : args) {
            if (obj instanceof HttpServletRequest) {
                return (HttpServletRequest) obj;
            }
        }
        RequestAttributes ra = RequestContextHolder.getRequestAttributes();
        ServletRequestAttributes sra = (ServletRequestAttributes) ra;
        return sra != null ? sra.getRequest() : null;
    }


    private Object getAttributeValue(String clazz, String filed) {
        try {
            Map map = JSON.parseObject(clazz, Map.class);
            if (map != null){
                Object result = map.get(filed);          
                return result;
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
        return null;
    }


}



转载请注明:文章转载自 www.mshxw.com
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号