spring boot学习系列之统一日志处理7

 3,551浏览     wenqyAdmin   

在安全审计方面或者日志分析中，很多时候都要记录用户的操作行为，特别是用户登录和特殊模块的操作。下面学习日志统一处理。将使用AOP、采用注解切点的方式做个横向的操作日志写入数据库操作。

定义AOP日志处理类，将自定义注解作为切点，目标方法执行后，构造日志，写入数据库。

  1. @Aspect
  2. @Component
  3. public class LogAopComponent {
  5.     private static final Logger logger = LoggerFactory.getLogger(LogAopComponent.class);
  7.     @Autowired
  8.     ExceptionLogExecutors executors;
  10.     /**
  11.      * 注解切点
  12.      * 
  13.      * @author wenqy
  14.      */
  15.     @Pointcut(“@annotation(com.wenqy.log.OperateLog)”)
  16.     private void pointCutMethod(){}
  18.     /**
  19.      * 基于切点
  20.      * @param joinPoint
  21.      * @author wenqy
  22.      * @throws ClassNotFoundException 
  23.      */
  24.     @After(“pointCutMethod()”)
  25.     public void recordOperateLog(JoinPoint joinPoint) throws ClassNotFoundException{
  26.         OperateLogVO operateLog = createOperateLog(joinPoint);
  27.         // 扔到线程池执行
  28.         this.executors.execute(new OperateLogThread(operateLog ));
  29.     }
  31.     /**
  32.      * 获取操作日志
  33.      * @param joinPoint
  34.      * @return
  35.      * @throws ClassNotFoundException
  36.      * @author wenqy
  37.      */
  38.     public OperateLogVO createOperateLog(JoinPoint joinPoint) throws ClassNotFoundException {
  39.         OperateLogVO operateLog = new OperateLogVO();
  40.         String clientIp = WebUtils.getClientIp();
  41.         operateLog.setHostIp(clientIp);
  42.         // TODO 取session
  43.         operateLog.setUserId(IdGenerator.randomLong());
  44.         operateLog.setOperateTime(new Date());
  45.         // 获取操作方法名
  46.         String methodName = joinPoint.getSignature().getName();
  47.         // 获取方法类名
  48.         String targetName = joinPoint.getTarget().getClass().getName();
  49.         Class<?> targetClass = Class.forName(targetName);
  50.         Method[] methods = targetClass.getMethods();
  51.         for (Method method : methods){
  52.             if(!method.getName().equals(methodName)){
  53.                 continue;
  54.             }
  55.             // 获取方法注解
  56.             OperateLog logAnnotation = method.getAnnotation(OperateLog.class);
  57.             operateLog.setAction(logAnnotation.action());
  58.             operateLog.setModule(logAnnotation.module());
  59.             operateLog.setRemark(logAnnotation.remark());
  60.             operateLog.setSubSystem(logAnnotation.subSystem());
  61.             break;
  62.         }
  63.         return operateLog;
  64.     }
  65. }

自定义切点注解，描述日志信息。

  1. /**
  2.  * 日志注解
  3.  * 
  4.  * @version V5.0
  5.  * @author wenqy
  6.  * @date   2018年2月14日
  7.  */
  8. @Retention(RetentionPolicy.RUNTIME)
  9. @Target(ElementType.METHOD) // 目标方法
  10. @Documented
  11. public @interface OperateLog {
  13.     /**
  14.      * 子系统
  15.      * @return
  16.      * @author wenqy
  17.      */
  18.     String subSystem() default “”;
  19.     /**
  20.      * 模块
  21.      * @return
  22.      * @author wenqy
  23.      */
  24.     String module() default “”;
  25.     /**
  26.      * 动作
  27.      * @return
  28.      * @author wenqy
  29.      */
  30.     String action() default “”;
  31.     /**
  32.      * 备注
  33.      * @return
  34.      * @author wenqy
  35.      */
  36.     String remark() default “”;
  37. }

根据注解信息和用户信息，定义操作日志VO类

  1. public class OperateLogVO  implements Serializable {
  2.     private Long id;
  3.     private String subSystem;
  4.     private String module;
  5.     private String action;
  6.     private String remark;
  8.     private String hostIp; // ip
  9.     private Date operateTime; // 操作时间
  10.     private Long userId; // 操作用户Id
  11. // 忽略setter getter
  12. }

定义保存操作日志线程

  1. /**
  2.  * 操作日志保存线程
  3.  * 
  4.  * @version V5.0
  5.  * @author wenqy
  6.  * @date   2018年2月14日
  7.  */
  8. public class OperateLogThread implements Runnable {
  10.     private OperateLogVO operateLogVO;
  12.     public OperateLogThread(OperateLogVO operateLogVO) {
  13.         this.operateLogVO = operateLogVO;
  14.     }
  16.     @Override
  17.     public void run() {
  18.         // 加载异常日志处理服务
  19.         OperateLogService logService = (OperateLogService) SpringAppContextHolder
  20.                 .getBean(OperateLogService.class);
  21.         logService.saveOperateLog(operateLogVO);
  22.     }
  24. }

控制层中要记录操作日志的方法定义引用

  1. @OperateLog(subSystem=“系统管理”, module=“系统登录”, action=“login”,remark=“用户登录”)
  2. @RequestMapping(value = “/doLogin”)
  3. @ResponseBody
  4. public Object doLogin(HttpServletRequest request) {
  5.        String email = request.getParameter(“email”);
  6.        String password = request.getParameter(“password”);
  7.        System.out.println(email + ” “ + password);
  8.        return “success”;
  9. }

启动应用，访问/doLogin URL链接，查看是否是否插库

operator_log

使用的线程池为上篇spring boot学习系列之统一异常处理6中定义的线程池，保存操作日志的Service和Mybatis Mapper也与上篇异常日志保存类似，代码就不贴了。也有采用父类定义操作日志方法或者利用拦截器的写法，这些都可以实现。

小二，再来一碟

赏

发表评论

电子邮件地址不会被公开。 必填项已用*标注

6 + 15 = ?