用户操作系统日志 记录用户操作记录日志持久化 springAOP切点实现方式 可以填加用户的任何类型的日志 正常+异常记录

springAOP实现操作日志记录，并记录请求参数与编辑前后字段的具体改变
原文
参考

说明：

直接上效果图

列表效果展示
系统日志列表

一个成熟的系统，应对用户的某些增删改操作，特别是管理员的增删改操作进行日志持久化处理。这些功能基本包括了用户的操作日志。那么我们要对一个完整的操作记录，其单位就是方法。通过AOP的环绕通知可以把切点的记录在内，得到日志并持久化处理。那么就不废话直接上设计了。

pojo

  1. import lombok.Data;
  2. import javax.persistence.*;
  3. import javax.validation.constraints.NotNull;
  4. import javax.validation.constraints.Size;
  5. import java.util.Date;
  6.  
  7. /**
  8.  * 系统日志实体定义
  9.  *
  10.  */
  11. @Entity
  12. @Table(name = "ABC_SYSTEM_LOG")
  13. @Data
  14. public class SystemLog
  15. {
  16.     public static final int STATUS_NORMAL = 0;
  17.     public static final int STATUS_PAUSE = 1;
  18.  
  19.     public static final String DEFAULT_OWNER_TYPE = "SYS";
  20.     public static final String DEFAULT_OWNER = "0";
  21.  
  22.     /**
  23.      * 标识
  24.      */
  25.     @Id
  26.     @GeneratedValue(strategy = GenerationType.AUTO)
  27.     private int id;
  28.     /**
  29.      * 应用端
  30.      */
  31.     @Column(name = "app_name")
  32.     @Size(max = 255)
  33.     private String appName;
  34.     /**
  35.      * 日志类型：0为操作日志，1为异常日志
  36.      */
  37.     @Column(name = "log_type")
  38.     private int logType;
  39.     /**
  40.      * 访问者/请求者
  41.      */
  42.     @Column(name = "user")
  43.     @Size(max = 255)
  44.     private String user;
  45.     /**
  46.      * 账号类型
  47.      */
  48.     @Column(name = "user_type")
  49.     @Size(max = 255)
  50.     private String userType;
  51.     /**
  52.      * 方法名称
  53.      */
  54.     @Column(name = "method_name")
  55.     @Size(max = 255)
  56.     private String methodName;
  57.     /**
  58.      * 请求参数
  59.      */
  60.     @Lob
  61.     @Column(name = "request_params")
  62.     private String requestParams;
  63.     /**
  64.      * 方法描述
  65.      */
  66.     @Column(name="method_description")
  67.     @Size(max = 255)
  68.     private String methodDescription;
  69.     /**
  70.      * 访问ip
  71.      */
  72.     @Column(name="request_ip")
  73.     @Size(max = 255)
  74.     private String requestIp;
  75.     /**
  76.      * 请求URL
  77.      */
  78.     @Column(name="request_uri")
  79.     @Size(max = 255)
  80.     private String requestUri;
  81.     /**
  82.      * 请求PATH
  83.      */
  84.     @Column(name="request_path")
  85.     @Size(max = 255)
  86.     private String requestPath;
  87.     /**
  88.      * 异常码
  89.      */
  90.     @Column(name="exception_code")
  91.     @Size(max = 255)
  92.     private String exceptionCode;
  93.     /**
  94.      * 异常描述
  95.      */
  96.     @Column(name="exception_detail")
  97.     @Size(max = 255)
  98.     private String exceptionDetail;
  99.     /**
  100.      * d
  101.      */
  102.     @Column(name="request_status")
  103.     private int requestStatus;
  104.     /**
  105.      * 备注
  106.      */
  107.     @Lob
  108.     @Column(name = "remark")
  109.     private String remark;
  110.     /**
  111.      * 状态
  112.      */
  113.     @Column(name = "status")
  114.     private int status = STATUS_NORMAL;
  115.     /**
  116.      * 所有者
  117.      */
  118.     @NotNull
  119.     @Size(max = 32)
  120.     @Column(name = "owner", updatable = false)
  121.     private String owner = DEFAULT_OWNER;
  122.     /**
  123.      * 所有者类型
  124.      */
  125.     @Size(max = 32)
  126.     @Column(name = "owner_type", updatable = false)
  127.     private String ownerType = DEFAULT_OWNER_TYPE;
  128.     /**
  129.      * 创建人/时间，更新人/时间
  130.      */
  131.     @Column(name = "creator", nullable = false, updatable = false)
  132.     private String creator;
  133.     @Temporal(TemporalType.TIMESTAMP)
  134.     @Column(name = "create_date", nullable = false, updatable = false)
  135.     private Date creationDate = new Date();
  136.     @Column(name = "modifier", insertable = false, updatable = true)
  137.     private String modifier;
  138.     @Temporal(TemporalType.TIMESTAMP)
  139.     @Column(name = "modify_date", insertable = false, updatable = true)
  140.     private Date modifyDate;
  141.  
  142. }

注解

  1. import java.lang.annotation.*;
  2.  
  3.  
  4. /**
  5.  *自定义注解 拦截Controller
  6.  */
  7. @Target({ElementType.PARAMETER, ElementType.METHOD})
  8. @Retention(RetentionPolicy.RUNTIME)
  9. @Documented
  10. public @interface SystemControllerLog {
  11.     String description() default "";
  12. }

切点

  1. import com.geek.abc.core.systemLog.SystemLog;
  2. import com.geek.abc.core.systemLog.SystemLogManager;
  3. import com.geek.abc.core.util.DateHelper;
  4. import com.jade.bss.organization.account.AdminAccount;
  5. import com.jade.bss.organization.customer.Customer;
  6. import com.jade.framework.base.context.ApplicationContextUtils;
  7. import lombok.extern.slf4j.Slf4j;
  8. import net.sf.json.JSONObject;
  9. import org.apache.shiro.SecurityUtils;
  10. import org.aspectj.lang.JoinPoint;
  11. import org.aspectj.lang.ProceedingJoinPoint;
  12. import org.aspectj.lang.annotation.*;
  13. import org.springframework.stereotype.Component;
  14. import org.springframework.web.context.request.RequestContextHolder;
  15. import org.springframework.web.context.request.ServletRequestAttributes;
  16. import javax.servlet.http.HttpServletRequest;
  17. import java.lang.reflect.Method;
  18.  
  19. /**
  20.  * 系统日志 切面
  21.  * optimized by_liaoqian 20191212
  22.  */
  23. @Aspect
  24. @Component
  25. @SuppressAjWarnings("all")
  26. @Slf4j
  27. public class SystemLogAspect {
  28.  
  29.     private SystemLogManager getSystemLogManager() {
  30.         return ApplicationContextUtils.getBean("bss_systemLog_manager");
  31.     }
  32.  
  33.  
  34.  
  35.     /**
  36.      * Service层切点
  37.      */
  38.     @Pointcut("@annotation(com.geek.abc.core.systemLog.aopHandle.SystemServiceLog)")
  39.     public void serviceAspect() {
  40.     }
  41.  
  42.  
  43.  
  44.     /**
  45.      * Controller层切点
  46.      */
  47.     @Pointcut("@annotation(com.geek.abc.core.systemLog.aopHandle.SystemControllerLog)")
  48.     public void controllerAspect() {
  49.     }
  50.  
  51.  
  52.  
  53.     /**
  54.      * 环绕通知 用于拦截controller层记录用户的操作
  55.      * @param proceeding 切点
  56.      */
  57.     @Around("controllerAspect()")
  58.     @SuppressAjWarnings("all")
  59.     public Object aroundAdvice(ProceedingJoinPoint proceeding) throws Exception {
  60.         Object[] args=proceeding.getArgs();
  61.         Object result=null;
  62.         String userName = "未识别";
  63.         String userType = "未识别";
  64.         String appName = "";
  65.         HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
  66.         if (SecurityUtils.getSubject() != null) {
  67.             if (SecurityUtils.getSubject().getPrincipal() != null) {
  68.                 String userClassStr = SecurityUtils.getSubject().getPrincipal().toString();
  69.                 if (userClassStr.contains("com.jade.bss.organization.account.AdminAccount")) {
  70.                     AdminAccount adminAccount = (AdminAccount) SecurityUtils.getSubject().getPrincipal();
  71.                     userName = adminAccount.getName();
  72.                     userType = adminAccount.getType();
  73.                 } else if (SecurityUtils.getSubject().getPrincipal().toString().contains("com.jade.bss.organization.customer.Customer")) {
  74.                     Customer customer = (Customer) SecurityUtils.getSubject().getPrincipal();
  75.                     userName = customer.getName();
  76.                     userType = customer.getOwnerType();
  77.                 }
  78.             }
  79.  
  80.         }
  81.         if (userType.equals("MEMBER")) {
  82.             appName = "client";
  83.         } else {
  84.             appName = "web";
  85.         }
  86.         String params = "";
  87.         System.out.println(proceeding.getArgs());
  88.         if (proceeding.getArgs() != null && proceeding.getArgs().length > 0) {
  89.             for (int i = 0; i < proceeding.getArgs().length; i++) {
  90.                 if (proceeding.getArgs()[i] != null) {
  91.                     params += proceeding.getArgs()[i].toString() + ";";
  92.                     if (proceeding.getArgs()[i].toString().contains("com.geek") || proceeding.getArgs()[i].toString().contains("com.jade.abc")) {
  93.                         Object object = proceeding.getArgs()[i];
  94.                         JSONObject json = JSONObject.fromObject(object);
  95.                         params += json.toString();
  96.                     }
  97.                 }
  98.             }
  99.         }
  100.  
  101.         SystemLog systemLog = new SystemLog();
  102.         try {
  103.             log.info("=====前置通知开始=====");
  104.             System.out.println("请求方法:" + (proceeding.getTarget().getClass().getName() + "." + proceeding.getSignature().getName() + "()"));
  105.             System.out.println("方法描述:" + getControllerMethodDescription(proceeding));
  106.             System.out.println("请求路径:" + request.getRequestURI());
  107.             System.out.println("请求参数:" + request.getQueryString());
  108.             System.out.println("请求人:" + userName);
  109.             System.out.println("请求人类型:" + userType);
  110.             System.out.println("请求IP:" + request.getRemoteAddr());
  111.             System.out.println("日期:" + DateHelper.getCurDateTime());
  112.  
  113.             // tip:执行连接点的方法 获取返回值 必不可少!!!
  114.             result=proceeding.proceed(args);
  115.  
  116.             systemLog.setAppName(appName);
  117.             systemLog.setCreator(userName);
  118.             systemLog.setLogType(0);
  119.             systemLog.setUser(userName);
  120.             systemLog.setUserType(userType);
  121.             systemLog.setMethodDescription(getControllerMethodDescription(proceeding));
  122.             systemLog.setMethodName(proceeding.getTarget().getClass().getName() + "." + proceeding.getSignature().getName() + "()");
  123.             systemLog.setExceptionCode(null);
  124.             systemLog.setExceptionDetail(null);
  125.             systemLog.setRequestIp(request.getRemoteAddr());
  126.             systemLog.setRequestParams(request.getQueryString());
  127.             systemLog.setRequestPath(request.getServletPath());
  128.             systemLog.setRequestUri(request.getRequestURI());
  129.             systemLog.setRequestStatus(200);
  130.             systemLog.setRemark(params);
  131.  
  132.             // 初次登录，无法识别，所以通过截取参数获取，保留
  133.             if ("用户登录".equals(systemLog.getMethodDescription())
  134.                     && "未识别".equals(userName) && "未识别".equals(userType)) {
  135.                 String name = request.getQueryString().split("=")[2];
  136.                 systemLog.setAppName("client");
  137.                 systemLog.setCreator(name);
  138.                 systemLog.setUser(name);
  139.                 systemLog.setUserType("MEMBER");
  140.             }
  141.  
  142.             log.info("=====后置通知结束=====");
  143.         } catch (Throwable e) {
  144.             log.error("=====异常通知开始=====");
  145.             systemLog.setAppName(appName);
  146.             systemLog.setCreator(userName);
  147.             systemLog.setLogType(1);
  148.             systemLog.setUser(userName);
  149.             systemLog.setUserType(userType);
  150.             systemLog.setMethodDescription(getControllerMethodDescription(proceeding));
  151.             systemLog.setMethodName(proceeding.getTarget().getClass().getName() + "." + proceeding.getSignature().getName() + "()");
  152.             systemLog.setExceptionCode(e.getClass().getName());
  153.             systemLog.setExceptionDetail(e.getMessage());
  154.             systemLog.setRequestIp(request.getRemoteAddr());
  155.             systemLog.setRequestParams(request.getQueryString());
  156.             systemLog.setRequestPath(request.getServletPath());
  157.             systemLog.setRequestUri(request.getRequestURI());
  158.             systemLog.setRequestStatus(500);
  159.             systemLog.setRemark(params);
  160.             log.error("=====异常通知结束=====");
  161.         } finally {
  162.             log.info("=====最终通知开始=====");
  163.             getSystemLogManager().addSystemLog(systemLog);
  164.         }
  165.         return result;
  166.     }
  167.  
  168.  
  169.  
  170.     /**
  171.      * 获取注解中对方法的描述信息 用于service层注解
  172.      *
  173.      * @param joinPoint 切点
  174.      * @return 方法描述
  175.      * @throws Exception
  176.      */
  177.  
  178.     public static String getServiceMthodDescription(JoinPoint joinPoint)
  179.             throws Exception {
  180.         String targetName = joinPoint.getTarget().getClass().getName();
  181.         String methodName = joinPoint.getSignature().getName();
  182.         Object[] arguments = joinPoint.getArgs();
  183.         Class targetClass = Class.forName(targetName);
  184.         Method[] methods = targetClass.getMethods();
  185.         String description = "";
  186.         for (Method method : methods) {
  187.             if (method.getName().equals(methodName)) {
  188.                 Class[] clazzs = method.getParameterTypes();
  189.                 if (clazzs.length == arguments.length) {
  190.                     description = method.getAnnotation(SystemServiceLog.class).description();
  191.                     break;
  192.                 }
  193.             }
  194.         }
  195.         return description;
  196.     }
  197.  
  198.     /**
  199.      * 获取注解中对方法的描述信息 用于Controller层注解
  200.      *
  201.      * @param joinPoint 切点
  202.      * @return 方法描述
  203.      * @throws Exception
  204.      */
  205.     public static String getControllerMethodDescription(JoinPoint joinPoint) throws Exception {
  206.         String targetName = joinPoint.getTarget().getClass().getName();
  207.         String methodName = joinPoint.getSignature().getName();
  208.         Object[] arguments = joinPoint.getArgs();
  209.         Class targetClass = Class.forName(targetName);
  210.         Method[] methods = targetClass.getMethods();
  211.         String description = "";
  212.         for (Method method : methods) {
  213.             if (method.getName().equals(methodName)) {
  214.                 Class[] clazzs = method.getParameterTypes();
  215.                 if (clazzs.length == arguments.length) {
  216.                     description = method.getAnnotation(SystemControllerLog.class).description();
  217.                     break;
  218.                 }
  219.             }
  220.         }
  221.         return description;
  222.     }
  223. }

重点在于切点的环绕通知写法，在切点的aroundAdvice方法内，由于采用的是远古的ssh项目，一些非必要的dao层和service层就没有写出来，那么controller的实现方式也特别简单。

事例

  1.      /**
  2.      * 删除会员
  3.      * @param id
  4.      * @param response
  5.      * @throws Exception
  6.      */
  7.     @RequestMapping(value = "/remove")
  8.     @RequiresAuthentication
  9.     @CheckPermission(permission = "member_remove")
  10.     @SystemControllerLog(description = "删除会员信息")
  11.     public void removeMember(@RequestParam(value = "id") long[] id, HttpServletResponse response) throws Exception {
  12.         try {
  13.             getMemberManager().removeMember( id );
  14.             ResponseUtil.writeSuccessResult( response );
  15.         } catch (BssException e) {
  16.             e.printStackTrace();
  17.             ResponseUtil.writeErrorResult( response, STATUS_ERROR, e.getMessage() );
  18.         }
  19.     }

就是一个简单的注解开发

@SystemControllerLog(description = "方法描述")

那么看一下实际运行图

操作正常下：

正常
标题

操作异常：

异常
标题

日志列表:

日志
标题

 

posted @ 2020-11-11 15:32  edda_huang  阅读(565)  评论(0)    收藏  举报