在Spring框架中，使用AOP配合自定义注解可以方便的实现用户操作的监控。首先搭建一个基本的Spring Boot Web环境开启Spring Boot，然后引入必要依赖：

  1. <dependency>
  2.     <groupId>org.springframework.boot</groupId>
  3.     <artifactId>spring-boot-starter-jdbc</artifactId>
  4. </dependency>
  6. <!-- aop依赖 -->
  7. <dependency>
  8.     <groupId>org.springframework.boot</groupId>
  9.     <artifactId>spring-boot-starter-aop</artifactId>
  10. </dependency>
  12. <!-- oracle驱动 -->
  13. <dependency>
  14.    <groupId>com.oracle</groupId>
  15.    <artifactId>ojdbc6</artifactId>
  16.    <version>6.0</version>
  17. </dependency>
  19. <!-- druid数据源驱动 -->
  20. <dependency>
  21.    <groupId>com.alibaba</groupId>
  22.    <artifactId>druid-spring-boot-starter</artifactId>
  23.    <version>1.1.6</version>
  24. </dependency>

自定义注解

定义一个方法级别的@Log注解，用于标注需要监控的方法：

  1. @Target(ElementType.METHOD)
  2. @Retention(RetentionPolicy.RUNTIME)
  3. public @interface Log {
  4.     String value() default "";
  5. }

创建库表和实体

在数据库中创建一张sys_log表，用于保存用户的操作日志，数据库采用oracle 11g：

  1. CREATE TABLE "SCOTT"."SYS_LOG" (
  2.    "ID" NUMBER(20) NOT NULL ,
  3.    "USERNAME" VARCHAR2(50 BYTE) NULL ,
  4.    "OPERATION" VARCHAR2(50 BYTE) NULL ,
  5.    "TIME" NUMBER(11) NULL ,
  6.    "METHOD" VARCHAR2(200 BYTE) NULL ,
  7.    "PARAMS" VARCHAR2(500 BYTE) NULL ,
  8.    "IP" VARCHAR2(64 BYTE) NULL ,
  9.    "CREATE_TIME" DATE NULL 
  10. );
  12. COMMENT ON COLUMN "SCOTT"."SYS_LOG"."USERNAME" IS '用户名';
  13. COMMENT ON COLUMN "SCOTT"."SYS_LOG"."OPERATION" IS '用户操作';
  14. COMMENT ON COLUMN "SCOTT"."SYS_LOG"."TIME" IS '响应时间';
  15. COMMENT ON COLUMN "SCOTT"."SYS_LOG"."METHOD" IS '请求方法';
  16. COMMENT ON COLUMN "SCOTT"."SYS_LOG"."PARAMS" IS '请求参数';
  17. COMMENT ON COLUMN "SCOTT"."SYS_LOG"."IP" IS 'IP地址';
  18. COMMENT ON COLUMN "SCOTT"."SYS_LOG"."CREATE_TIME" IS '创建时间';
  20. CREATE SEQUENCE seq_sys_log START WITH 1 INCREMENT BY 1;

库表对应的实体：

  1. public class SysLog implements Serializable{
  3.     private static final long serialVersionUID = -6309732882044872298L;
  5.     private Integer id;
  6.     private String username;
  7.     private String operation;
  8.     private Integer time;
  9.     private String method;
  10.     private String params;
  11.     private String ip;
  12.     private Date createTime;
  13.     // get,set略
  14. }

保存日志的方法

为了方便，这里直接使用Spring JdbcTemplate来操作数据库。定义一个SysLogDao接口，包含一个保存操作日志的抽象方法：

  1. public interface SysLogDao {
  2.     void saveSysLog(SysLog syslog);
  3. }

其实现方法：

  1. @Repository
  2. public class SysLogDaoImp implements SysLogDao {
  4.     @Autowired
  5.     private JdbcTemplate jdbcTemplate;
  7.     @Override
  8.     public void saveSysLog(SysLog syslog) {
  9.         StringBuffer sql = new StringBuffer("insert into sys_log ");
  10.         sql.append("(id,username,operation,time,method,params,ip,create_time) ");
  11.         sql.append("values(seq_sys_log.nextval,:username,:operation,:time,:method,");
  12.         sql.append(":params,:ip,:createTime)");
  14.         NamedParameterJdbcTemplate npjt = new NamedParameterJdbcTemplate(this.jdbcTemplate.getDataSource());
  15.         npjt.update(sql.toString(), new BeanPropertySqlParameterSource(syslog));
  16.     }
  17. }

这里采用MySQL数据库，由于MySQL没有自增序列，采用自建自增序列表：

  1. #序列表
  2. CREATE TABLE sequence (
  3.   seq_name varchar(50) NOT NULL, -- 序列名称
  4.   current_val int(11) NOT NULL, -- 当前值
  5.   increment_val int(11) NOT NULL, -- 跨度
  6.   PRIMARY KEY (seq_name)
  7. ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
  9. set global log_bin_trust_function_creators=TRUE;
  11. #获取当前值的函数
  12. CREATE FUNCTION currval (v_seq_name VARCHAR(50)) RETURNS INTEGER
  13. BEGIN
  14. DECLARE current INTEGER;
  15. SET current = 0;
  16. SELECT
  17.     current_val INTO current
  18. FROM
  19.     sequence
  20. WHERE
  21.     seq_name = v_seq_name;
  22. RETURN current;
  23. END;
  25. #获取下一个值的函数
  26. CREATE FUNCTION nextval (v_seq_name VARCHAR(50)) RETURNS INTEGER
  27. BEGIN
  28. DECLARE current INTEGER;
  29. SET current = 0;
  30. SELECT
  31.     current_val + increment_val INTO current
  32. FROM
  33.     sequence
  34. WHERE
  35.     seq_name = v_seq_name FOR UPDATE;
  36. UPDATE sequence
  37. SET current_val = current
  38. WHERE
  39.     seq_name = v_seq_name;
  40. RETURN current;
  41. END;
  43. INSERT INTO sequence (`seq_name`, `current_val`, `increment_val`) VALUES ('seq_sys_log', '1', '1');
  1. @Override
  2.     public void saveSysLog(SysLog syslog) {
  3.         String sql_seq = "SELECT nextval('seq_sys_log')";
  4.         Integer seq = this.jdbcTemplate.queryForList(sql_seq,Integer.class).get(0);
  6.         StringBuffer sql = new StringBuffer("insert into sys_log ");
  7.         sql.append("(id,username,operation,time,method,params,ip,create_time) ");
  8.         sql.append("values(:seq,:username,:operation,:time,:method,");
  9.         sql.append(":params,:ip,:createTime)");
  10.         MapSqlParameterSource map = new MapSqlParameterSource();
  11.         map.addValue("seq", seq);
  12.         map.addValue("username", syslog.getUsername());
  13.         map.addValue("operation", syslog.getOperation());
  14.         map.addValue("time", syslog.getTime());
  15.         map.addValue("method", syslog.getMethod());
  16.         map.addValue("params", syslog.getParams());
  17.         map.addValue("ip", syslog.getIp());
  18.         map.addValue("createTime", syslog.getCreateTime());
  19.         NamedParameterJdbcTemplate npjt = new NamedParameterJdbcTemplate(this.jdbcTemplate.getDataSource());
  20.         npjt.update(sql.toString(), map);
  21.     }

切面和切点

定义一个LogAspect类，使用@Aspect标注让其成为一个切面，切点为使用@Log注解标注的方法，使用@Around环绕通知：

  1. @Aspect
  2. @Component
  3. public class LogAspect {
  5.     @Autowired
  6.     private SysLogDao sysLogDao;
  8.     @Pointcut("@annotation(com.springboot.annotation.Log)")
  9.     public void pointcut() { }
  11.     @Around("pointcut()")
  12.     public Object around(ProceedingJoinPoint point) {
  13.         Object result = null;
  14.         long beginTime = System.currentTimeMillis();
  15.         try {
  16.             // 执行方法
  17.             result = point.proceed();
  18.         } catch (Throwable e) {
  19.             e.printStackTrace();
  20.         }
  21.         // 执行时长(毫秒)
  22.         long time = System.currentTimeMillis() - beginTime;
  23.         // 保存日志
  24.         saveLog(point, time);
  25.         return result;
  26.     }
  28.     private void saveLog(ProceedingJoinPoint joinPoint, long time) {
  29.         MethodSignature signature = (MethodSignature) joinPoint.getSignature();
  30.         Method method = signature.getMethod();
  31.         SysLog sysLog = new SysLog();
  32.         Log logAnnotation = method.getAnnotation(Log.class);
  33.         if (logAnnotation != null) {
  34.             // 注解上的描述
  35.             sysLog.setOperation(logAnnotation.value());
  36.         }
  37.         // 请求的方法名
  38.         String className = joinPoint.getTarget().getClass().getName();
  39.         String methodName = signature.getName();
  40.         sysLog.setMethod(className + "." + methodName + "()");
  41.         // 请求的方法参数值
  42.         Object[] args = joinPoint.getArgs();
  43.         // 请求的方法参数名称
  44.         LocalVariableTableParameterNameDiscoverer u = new LocalVariableTableParameterNameDiscoverer();
  45.         String[] paramNames = u.getParameterNames(method);
  46.         if (args != null && paramNames != null) {
  47.             String params = "";
  48.             for (int i = 0; i < args.length; i++) {
  49.                 params += "  " + paramNames[i] + ": " + args[i];
  50.             }
  51.             sysLog.setParams(params);
  52.         }
  53.         // 获取request
  54.         HttpServletRequest request = HttpContextUtils.getHttpServletRequest();
  55.         // 设置IP地址
  56.         sysLog.setIp(IPUtils.getIpAddr(request));
  57.         // 模拟一个用户名
  58.         sysLog.setUsername("mrbird");
  59.         sysLog.setTime((int) time);
  60.         sysLog.setCreateTime(new Date());
  61.         // 保存系统日志
  62.         sysLogDao.saveSysLog(sysLog);
  63.     }
  64. }

测试

TestController：

  1. @RestController
  2. public class TestController {
  4.     @Log("执行方法一")
  5.     @GetMapping("/one")
  6.     public void methodOne(String name) { }
  8.     @Log("执行方法二")
  9.     @GetMapping("/two")
  10.     public void methodTwo() throws InterruptedException {
  11.         Thread.sleep(2000);
  12.     }
  14.     @Log("执行方法三")
  15.     @GetMapping("/three")
  16.     public void methodThree(String name, String age) { }
  17. }

最终项目目录如下图所示：

Spring Boot AOP记录用户操作日志 - 图1

启动项目，分别访问：

查询数据库：

  1. SQL> select * from sys_log order by id;
  3.         ID USERNAME   OPERATION        TIME METHOD                         PARAMS                         IP         CREATE_TIME
  4. ---------- ---------- ---------- ---------- ------------------------------ ------------------------------ ---------- --------------
  5.         11 mrbird     执行方法一          6 com.springboot.controller.Test  name: KangKang                127.0.0.1  08-12月-17
  6.                                             Controller.methodOne()
  8.         12 mrbird     执行方法二       2000 com.springboot.controller.Test                                127.0.0.1  08-12月-17
  9.                                             Controller.methodTwo()
  11.         13 mrbird     执行方法三          0 com.springboot.controller.Test  name: Mike age: 25            127.0.0.1  08-12月-17
  12.                                             Controller.methodThree()