自定义注解 实现用户操作日志

背景：最近做了一个关于中台to b的商品项目，原本下游各个系统的商品信息全部到我们项目中处理。其他下游没有入口对商品进行修改和新增。目前整个项目的用户基本有人要就给开了，这就出现一个非常大的隐患，如果某个人把商品误操作了，锅都找不到，还没法复原。因此记录操作商品有关的记录就显得很重要了。

 

方案：大概做法有两种：

          1.首先很好想的就是在每个接口中，进行入库操作。实现很简单，同时弊端也非常明显就是代码重复太多。因此选择放弃这种做法。

          2.利用注解的方式实现。网上有很多类似的例子，这里我不多做描述，主要说一下自己的几个疑问。

 

实现：

         首先定义一个注解UserLog，在所需方法上使用便可。

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface UserLog {
}

     有了注解之后，注解要做什么怎么做要在哪里定义？毫无疑问需要在增加一个增强类

@Aspect
@Component
public class LogAspect {
    @Autowired
    private UserOperateLogMapper userOperateLogMapper;

    // Controller层切点
    @Pointcut("execution(* com..server.controller.*.*(..)) && @annotation(com.server.anno.UserLog)")
    public void controllerAspect() {

    }

    /**
     * 在目标方法正常完成后拦截记录Controller层用户的操作
     * @param joinPoint
     */
    @AfterReturning(value="controllerAspect()",returning="result")
    public void doBefore(JoinPoint joinPoint,Object result)  {
        UserOperateLog userOperateLog = new UserOperateLog();
        //入参
        Object [] parms = joinPoint.getArgs();
        userOperateLog.setInput(FastJsonUtils.beanToJson(parms));
        //返回值
        userOperateLog.setOutput(FastJsonUtils.beanToJson(result));
        userOperateLogMapper.insertSelective(userOperateLog);

    }

    /**
     * 目标方法异常后不入库
     */
    @AfterThrowing(value="controllerAspect()")
    public void doBeforeException(){

    }

}

其中用户名代码这个删除了，大致做法是在拦截器中获取到用户名然后保存在ThreaLocal中，在这里直接调用即可。方法如果异常则进入@AfterThrowing方法中。至此整个功能已经实现。

 

问题：接下面说说自己遇到的几个困惑以及解决方法。

    1.如何在增强类中获取controller层的返回值？

      首先很容易想到利用HttpServletResponse,但是发现这个类并没有直接获取body的方法。利用这个类获取对象也可以，但是非常麻烦。大家可以自行百度。其次当时想在拦截器的postHandle方法中获取返回值。然后保存在ThreadLocal中，在增强类中直接调用即可。但是随之而来有一个问题。在增强类被@AfterReturnning修饰的方法和拦截器中的postHandle的方法，哪个先执行。如果是拦截器中的先执行那么这种做法显然不行。最后自己在两个方法中各打断点发现确实如此，被@AfterReturnning修饰的方法先于postHandle执行。至此第一种方法破灭。

     接下来自己参考到同事的代码在增强类中使用ProceedingJoinPoint.proceed()。该方法会执行当前方法，并返回controller的返回值。但是需要注意的时，该参数需要在@Around注解修饰下使用，不能用于@AfterReturnning，或者@Before之类的注解。事实证明这种方法确实可以有效。但是又遇到一个新的问题。在前端页面中，调用被@UserLog修饰的方法，会一直加载，而且接口没有返回值。类似这样，Preview没有值，但是当你刷新之后会发现这个方法执行成功了，并且数据成功入库。还麻烦前端大佬去检查了一下nigix配置。这个问题很奇怪，至今没有想明白，还望有大佬指导。

   ok，现在这个方法肯定也是不行的，再继续想别的方法了。百度了一番，终于找到一个在@AfterReturnning注解的value值可以获取到返回值。但是在被@AfterReturnning修饰的方法的形参中必须有一样的参数，否则会报错。类似这样。

     这个问题困扰了好久，最后在spring官方文档中找到答案。

到这里，功能已经实现，自己测试后没有问题。如有需要可以参考，或者交流讨论。但是至今上面的疑惑，还望有大佬赐教。