Spring Boot AOP记录用户操作日志

傷城~ 2023-06-08 03:05 43阅读 0赞

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

<dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-aop</artifactId>
            </dependency>
    
    
    		
    		<dependency>
    			<groupId>com.oracle</groupId>
    			<artifactId>ojdbc6</artifactId>
    			<version>11.2.0.4</version>
    		</dependency>
    
    		
    		<dependency>
    		   <groupId>com.alibaba</groupId>
    		   <artifactId>druid-spring-boot-starter</artifactId>
    		   <version>1.1.6</version>
    		</dependency>

## application.yml ##

server:
      context-path: /web
      port: 7002
    
    spring:
      datasource:
        druid:
          # 数据库访问配置, 使用druid数据源 
          type: com.alibaba.druid.pool.DruidDataSource
          driver-class-name: oracle.jdbc.driver.OracleDriver
          url: jdbc:oracle:thin:@localhost:49161:XE
          username: boot
          password: 123456   
          # 连接池配置
          initial-size: 5
          min-idle: 5
          max-active: 20
          # 连接等待超时时间
          max-wait: 30000
          # 配置检测可以关闭的空闲连接间隔时间
          time-between-eviction-runs-millis: 60000
          # 配置连接在池中的最小生存时间
          min-evictable-idle-time-millis: 300000
          validation-query: select '1' from dual
          test-while-idle: true
          test-on-borrow: false
          test-on-return: false
          # 打开PSCache，并且指定每个连接上PSCache的大小
          pool-prepared-statements: true
          max-open-prepared-statements: 20
          max-pool-prepared-statement-per-connection-size: 20
          # 配置监控统计拦截的filters, 去掉后监控界面sql无法统计, 'wall'用于防火墙
          filters: stat,wall
          # Spring监控AOP切入点，如x.y.z.service.*,配置多个英文逗号分隔
          aop-patterns: com.springboot.servie.*
          
        
          # WebStatFilter配置
          web-stat-filter:
            enabled: true
            # 添加过滤规则
            url-pattern: /*
            # 忽略过滤的格式
            exclusions: '*.js,*.gif,*.jpg,*.png,*.css,*.ico,/druid/*'
          
          # StatViewServlet配置 
          stat-view-servlet:
            enabled: true
            # 访问路径为/druid时，跳转到StatViewServlet
            url-pattern: /druid/*
            # 是否能够重置数据
            reset-enable: false
            # 需要账号密码才能访问控制台
            login-username: druid
            login-password: druid123
            # IP白名单
            # allow: 127.0.0.1
            #　IP黑名单（共同存在时，deny优先于allow）
            # deny: 192.168.1.218
          
          # 配置StatFilter
          filter: 
            stat: 
              log-slow-sql: true

## 自定义注解 ##

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

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

## 创建库表和实体 ##

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

CREATE TABLE "SCOTT"."SYS_LOG" (
       "ID" NUMBER(20) NOT NULL ,
       "USERNAME" VARCHAR2(50 BYTE) NULL ,
       "OPERATION" VARCHAR2(50 BYTE) NULL ,
       "TIME" NUMBER(11) NULL ,
       "METHOD" VARCHAR2(200 BYTE) NULL ,
       "PARAMS" VARCHAR2(500 BYTE) NULL ,
       "IP" VARCHAR2(64 BYTE) NULL ,
       "CREATE_TIME" DATE NULL 
    );
    
    COMMENT ON COLUMN "SCOTT"."SYS_LOG"."USERNAME" IS '用户名';
    COMMENT ON COLUMN "SCOTT"."SYS_LOG"."OPERATION" IS '用户操作';
    COMMENT ON COLUMN "SCOTT"."SYS_LOG"."TIME" IS '响应时间';
    COMMENT ON COLUMN "SCOTT"."SYS_LOG"."METHOD" IS '请求方法';
    COMMENT ON COLUMN "SCOTT"."SYS_LOG"."PARAMS" IS '请求参数';
    COMMENT ON COLUMN "SCOTT"."SYS_LOG"."IP" IS 'IP地址';
    COMMENT ON COLUMN "SCOTT"."SYS_LOG"."CREATE_TIME" IS '创建时间';
    
    CREATE SEQUENCE seq_sys_log START WITH 1 INCREMENT BY 1;

库表对应的实体：

public class SysLog implements Serializable{
    
        private static final long serialVersionUID = -6309732882044872298L;
        
        private Integer id;
        private String username;
        private String operation;
        private Integer time;
        private String method;
        private String params;
        private String ip;
        private Date createTime;
        // get,set略
    }

## 保存日志的方法 ##

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

public interface SysLogDao {
        void saveSysLog(SysLog syslog);
    }

@Repository
    public class SysLogDaoImp implements SysLogDao {
    
        @Autowired
        private JdbcTemplate jdbcTemplate;
        
        @Override
        public void saveSysLog(SysLog syslog) {
            StringBuffer sql = new StringBuffer("insert into sys_log ");
            sql.append("(id,username,operation,time,method,params,ip,create_time) ");
            sql.append("values(seq_sys_log.nextval,:username,:operation,:time,:method,");
            sql.append(":params,:ip,:createTime)");
            
            NamedParameterJdbcTemplate npjt = new NamedParameterJdbcTemplate(this.jdbcTemplate.getDataSource());
            npjt.update(sql.toString(), new BeanPropertySqlParameterSource(syslog));
        }
    }

## 切面和切点 ##

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

@Aspect
    @Component
    public class LogAspect {
    
        @Autowired
        private SysLogDao sysLogDao;
        
        @Pointcut("@annotation(com.springboot.annotation.Log)")
        public void pointcut() { }
    
        @Around("pointcut()")
        public Object around(ProceedingJoinPoint point) {
            Object result = null;
            long beginTime = System.currentTimeMillis();
            try {
                // 执行方法
                result = point.proceed();
            } catch (Throwable e) {
                e.printStackTrace();
            }
            // 执行时长(毫秒)
            long time = System.currentTimeMillis() - beginTime;
            // 保存日志
            saveLog(point, time);
            return result;
        }
    
    	private void saveLog(ProceedingJoinPoint joinPoint, long time) {
            MethodSignature signature = (MethodSignature) joinPoint.getSignature();
            Method method = signature.getMethod();
            SysLog sysLog = new SysLog();
            Log logAnnotation = method.getAnnotation(Log.class);
            if (logAnnotation != null) {
                // 注解上的描述
                sysLog.setOperation(logAnnotation.value());
            }
            // 请求的方法名
            String className = joinPoint.getTarget().getClass().getName();
            String methodName = signature.getName();
            sysLog.setMethod(className + "." + methodName + "()");
            // 请求的方法参数值
            Object[] args = joinPoint.getArgs();
            // 请求的方法参数名称
            LocalVariableTableParameterNameDiscoverer u = new LocalVariableTableParameterNameDiscoverer();
            String[] paramNames = u.getParameterNames(method);
            if (args != null && paramNames != null) {
                String params = "";
                for (int i = 0; i < args.length; i++) {
                    params += "  " + paramNames[i] + ": " + args[i];
                }
                sysLog.setParams(params);
            }
            // 获取request
            HttpServletRequest request = HttpContextUtils.getHttpServletRequest();
            // 设置IP地址
            sysLog.setIp(IPUtils.getIpAddr(request));
            // 模拟一个用户名
            sysLog.setUsername("mrbird");
            sysLog.setTime((int) time);
            sysLog.setCreateTime(new Date());
            // 保存系统日志
            sysLogDao.saveSysLog(sysLog);
        }
    }

## 测试 ##

TestController：

@RestController
    public class TestController {
    
        @Log("执行方法一")
        @GetMapping("/one")
        public void methodOne(String name) { }
        
        @Log("执行方法二")
        @GetMapping("/two")
        public void methodTwo() throws InterruptedException {
            Thread.sleep(2000);
        }
        
        @Log("执行方法三")
        @GetMapping("/three")
        public void methodThree(String name, String age) { }
    }

启动项目，分别访问：

*  [http://localhost:8080/web/one?name=KangKang][http_localhost_8080_web_one_name_KangKang]
 *  [http://localhost:8080/web/two][http_localhost_8080_web_two]
 *  查询数据库：

![20191015174837419.png][]

[Spring Boot]: https://mrbird.cc/%E5%BC%80%E5%90%AFSpring-Boot.html
[http_localhost_8080_web_one_name_KangKang]: http://localhost:8080/web/one?name=KangKang
[http_localhost_8080_web_two]: http://localhost:8080/web/two
[20191015174837419.png]: /images/20230601/b867eda6c207438abbb709e9083592ae.png