aop实现操作日志

最新推荐文章于 2025-01-13 14:32:39 发布

原创最新推荐文章于 2025-01-13 14:32:39 发布 · 10w+ 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#切面 #aop #操作日志

开发遇到的问题专栏收录该内容

4 篇文章

订阅专栏

前言
在平时开发当中，往往需要记录操作日志，我们可以封装一个service，操作结束的时候调用一下，但这样显得累赘不简洁，可以用切面配合注解使用起来更方便。

aop配合注解实现操作日志记录

首先声明一个注解@OperateLog

@Target(ElementType.METHOD)//表示该注解用于什么地方
@Retention(RetentionPolicy.RUNTIME)// 定义该注解的生命周期  RUNTIME 运行期也保留该注解
@Documented//表示是否将注解信息添加在java文档中
public @interface OperateLog {
    String operation() default "";
}

写切面

/**
 * Created by huangYi on 2018/8/14
 * 操作记录aspect
 * 在方法上加注解@OperateLog
 * 用法示例：@OperateLog(operation = "启用用户，姓名为#{#name}")
 * #{#name} 动态解析参数,需要取参数字段则这么写，当然参数也可以是对象
 * 如果不需要取获取参数里的值直接@OperateLog(operation = "启用用户")
 **/
@Aspect
@Component
public class OperateLogAspect {

    Logger logger = LoggerFactory.getLogger(this.getClass());

    @Pointcut("@annotation(cn.webapp.aop.annotation.OperateLog)")
    public void pointCut(){}

    @AfterReturning(value = "pointCut()")
    public void AfterReturning(JoinPoint joinPoint){
        /*joinPoint.getArgs()获取参数数组 参数可以是对象也可以是单个值
          只有方法参数列表存在参数才能获取到*/
        Method method = ((MethodSignature) joinPoint.getSignature()).getMethod();
        if(method!=null&&method.isAnnotationPresent(OperateLog.class)){
            OperateLog operateLog=method.getAnnotation(OperateLog.class);
            String operation=operateLog.operation();
            String action = executeTemplate(operation, joinPoint,method);
            //ThreadLocal中取值
            String operatorName= ServletContextHolder.getToken().getUsername();
            String ip=IpUtil.getIpAddress(ServletContextHolder.getRequest());
            // TODO: 2019/7/3  暂作logger打印，可建表存库
            logger.info("ip："+ip+",name："+operatorName+",action："+action+"----->"+method.getDeclaringClass().getName()+"类的"+method.getName()+"方法");

        }
    }
    /*解析注解中的描述信息*/
    private String executeTemplate(String template, JoinPoint joinPoint,Method method) {
        LocalVariableTableParameterNameDiscoverer parameterNameDiscoverer = new LocalVariableTableParameterNameDiscoverer();
        String[] parameterNames = parameterNameDiscoverer.getParameterNames(method);
        EvaluationContext context = new StandardEvaluationContext();
        ExpressionParser parser = new SpelExpressionParser();
        Object[] args = joinPoint.getArgs();
        if (args.length == parameterNames.length) {
            for (int i = 0, len = args.length; i < len; i++) {
                context.setVariable(parameterNames[i], args[i]);
            }
        }
        return parser.parseExpression(template, new TemplateParserContext()).getValue(context, String.class);
    }
}

注：注解里的对象operation即我们的操作的动作，我们还需要访问请求的ip,操作者的id和姓名，访问路由等等信息，这些数据通过过滤器拦截请求存入ThreadLocal当中（登陆时存和每次过滤器请求存，配合token获取需要的信息），这里取出最后入库存表即可。对于operation可以表达式取参数值或参数对象里的属性