SpinrgBoot AOP+Shiro 系统操作日志保存数据库（附源码）

末蓝、 2024-04-17 20:10 63阅读 0赞

# 前言 #

本篇是根据上篇[《Spring Boot 整合 Shiro（四）thymeleaf模板权限控制 附源码》][Spring Boot _ Shiro_thymeleaf_]进行修改，若有不明白的转上篇进行了解。

# 一、添加依赖 #

<dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-aop</artifactId>
            </dependency>
            <dependency>
            <dependency>
                <groupId>org.mybatis.spring.boot</groupId>
                <artifactId>mybatis-spring-boot-starter</artifactId>
                <version>1.3.2</version>
            </dependency>
    
            
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>5.1.46</version>
            </dependency>

# 二、添加拦截操作日志 #

package com.shiro.annotation;
    
    import com.shiro.enums.OperationType;
    import com.shiro.enums.OperationUnit;
    
    import java.lang.annotation.*;
    
    @Target({ElementType.PARAMETER, ElementType.METHOD})
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    public @interface Log {
        /**
         * 方法描述,可使用占位符获取参数:{
       {tel}}
         */
        String detail() default "";
    
        /**
         * 日志等级:自己定，此处分为1-9
         */
        int level() default 0;
    
        /**
         * 操作类型(enum):主要是select,insert,update,delete
         */
        OperationType operationType() default OperationType.UNKNOWN;
    
        /**
         * 被操作的对象(此处使用enum):可以是任何对象，如表名(user)，或者是工具(redis)
         */
        OperationUnit operationUnit() default OperationUnit.UNKNOWN;
    }

package com.shiro.aspectj;
    
    import com.alibaba.fastjson.JSONObject;
    import com.shiro.annotation.Log;
    import com.shiro.pojo.SystemLog;
    import com.shiro.pojo.SystemUser;
    import com.shiro.service.ISystemLogService;
    import org.apache.shiro.SecurityUtils;
    import org.aspectj.lang.JoinPoint;
    import org.aspectj.lang.ProceedingJoinPoint;
    import org.aspectj.lang.annotation.*;
    import org.aspectj.lang.reflect.MethodSignature;
    import org.springframework.stereotype.Component;
    
    import javax.annotation.Resource;
    import java.text.SimpleDateFormat;
    import java.util.Date;
    import java.util.HashMap;
    import java.util.Map;
    import java.util.UUID;
    
    /**
     * @author Unclue_liu
     * @organization 
     * @date 2019/8/30 0030 16:35
     * @desc TODO
     */
    @Aspect
    @Component
    public class LogAspect {
    
        @Resource
        private ISystemLogService logService;
        /**
         * 此处的切点是注解的方式，也可以用包名的方式达到相同的效果
         * '@Pointcut("execution(* com.wwj.springboot.service.impl.*.*(..))")'
         */
        @Pointcut("@annotation(com.shiro.annotation.Log)")
        public void operationLog(){}
    
    
        /**
         * 环绕增强，相当于MethodInterceptor
         */
        @Around("operationLog()")
        public Object doAround(ProceedingJoinPoint joinPoint) throws Throwable {
            Object res = null;
            long time = System.currentTimeMillis();
            try {
                res =  joinPoint.proceed();
                time = System.currentTimeMillis() - time;
                return res;
            } finally {
                try {
                    //方法执行完成后增加日志
                    addOperationLog(joinPoint,res,time);
                }catch (Exception e){
                    System.out.println("LogAspect 操作失败：" + e.getMessage());
                    e.printStackTrace();
                }
            }
        }
    
       private void addOperationLog(JoinPoint joinPoint, Object res, long time){
            //获得登录用户信息
            SystemUser systemUser = (SystemUser) SecurityUtils.getSubject().getPrincipal();
            MethodSignature signature = (MethodSignature)joinPoint.getSignature();
            SystemLog operationLog = new SystemLog();
            //获取内网地址IpUtils.intranetIp()
            //获取外网地址IpUtils.internetIp()
            operationLog.setIpAddress(IpUtils.intranetIp());
            operationLog.setRunTime(time);
            operationLog.setReturnValue(JSONObject.toJSONString(res));
            operationLog.setId(UUID.randomUUID().toString());
            operationLog.setArgs(JSONObject.toJSONString(joinPoint.getArgs()));
            operationLog.setCreateTime(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()));
            operationLog.setMethod(signature.getDeclaringTypeName() + "." + signature.getName());
            operationLog.setUserId(systemUser.getId()+"");
            operationLog.setUserName(systemUser.getUserName());
            Log annotation = signature.getMethod().getAnnotation(Log.class);
            if(annotation != null){
                operationLog.setLogLevel(annotation.level());
                operationLog.setLogDescribe(getDetail(((MethodSignature)joinPoint.getSignature()).getParameterNames(),joinPoint.getArgs(),annotation));
                operationLog.setOperationType(annotation.operationType().getValue());
                operationLog.setOperationUnit(annotation.operationUnit().getValue());
            }
            //TODO 这里保存日志
            System.out.println("记录日志:" + operationLog.toString());
            int i = logService.addLog(operationLog);
            System.out.println(i);
        }
    
        /**
         * 对当前登录用户和占位符处理
         * @param argNames 方法参数名称数组
         * @param args 方法参数数组
         * @param annotation 注解信息
         * @return 返回处理后的描述
         */
        private String getDetail(String[] argNames, Object[] args, Log annotation){
            //获得登录用户信息
            SystemUser systemUser = (SystemUser) SecurityUtils.getSubject().getPrincipal();
            Map<Object, Object> map = new HashMap<>(4);
            for(int i = 0;i < argNames.length;i++){
                map.put(argNames[i],args[i]);
            }
    
            String detail = annotation.detail();
            try {
                detail = "'" + systemUser.getUserName() + "'=》" + annotation.detail();
                for (Map.Entry<Object, Object> entry : map.entrySet()) {
                    Object k = entry.getKey();
                    Object v = entry.getValue();
                    detail = detail.replace("{
       {" + k + "}}", JSONObject.toJSONString(v));
                }
            }catch (Exception e){
                e.printStackTrace();
            }
            return detail;
        }
    
        @Before("operationLog()")
        public void doBeforeAdvice(JoinPoint joinPoint){
            System.out.println("进入方法前执行.....");
    
        }
    
        /**
         * 处理完请求，返回内容
         * @param ret
         */
        @AfterReturning(returning = "ret", pointcut = "operationLog()")
        public void doAfterReturning(Object ret) {
            System.out.println("方法的返回值 : " + ret);
        }
    
        /**
         * 后置异常通知
         */
        @AfterThrowing("operationLog()")
        public void throwss(JoinPoint jp){
            System.out.println("方法异常时执行.....");
        }
    
    
        /**
         * 后置最终通知,final增强，不管是抛出异常或者正常退出都会执行
         */
        @After("operationLog()")
        public void after(JoinPoint jp){
            System.out.println("方法最后执行.....");
        }
    }

package com.shiro.enums;
    
    public enum OperationType {
        /**
         * 操作类型
         */
        UNKNOWN("unknown"),
        DELETE("delete"),
        SELECT("select"),
        UPDATE("update"),
        INSERT("insert");
    
        private String value;
    
        public String getValue() {
            return value;
        }
    
        public void setValue(String value) {
            this.value = value;
        }
    
        OperationType(String s) {
            this.value = s;
        }
    }

package com.shiro.enums;
    
    public enum OperationUnit {
        /**
         * 被操作的单元
         */
        UNKNOWN("unknown"),
        USER("user"),
        DEVICE("device");
    
        private String value;
    
        OperationUnit(String value) {
            this.value = value;
        }
    
        public String getValue() {
            return value;
        }
    
        public void setValue(String value) {
            this.value = value;
        }
    }

# 三、修改CustomRealm #

/**
         * 身份认证
         * 这里可以注入userService,为了方便演示直接写死账户和密码
         * 获取即将需要认证的信息
         * @param authenticationToken
         * @return
         * @throws AuthenticationException
         */
        @Override
        protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken authenticationToken) throws AuthenticationException {
            System.out.println("-------身份认证方法--------");
            String account = (String) authenticationToken.getPrincipal();
            //String userPwd = new String((char[]) authenticationToken.getCredentials());
            //根据账户从数据库获取密码
            SystemUser systemUser = iSystemUserService.selectSystemUserByAccount(account);
            if(systemUser==null){
                throw new AccountException("用户名不正确");
            }
            //交给AuthenticatingRealm使用CredentialsMatcher进行密码匹配
            ByteSource salt = ByteSource.Util.bytes(account);
            //下面使用systemUser对象
            return new SimpleAuthenticationInfo(systemUser, systemUser.getPsd(), salt, getName());
            //获取登录信息方式为
    //        SystemUser systemUser = (SystemUser) SecurityUtils.getSubject().getPrincipal();
            //下面使用account参数
    //        return new SimpleAuthenticationInfo(account, systemUser.getPsd(), salt, getName());
            //获取登录信息方式为
    //        String account = (String) SecurityUtils.getSubject().getPrincipal();
        }

在登录方法上添加

@Log(detail = "登录提交",level = 1,operationUnit = OperationUnit.USER,operationType = OperationType.SELECT)

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMzY5OTQ0_size_16_color_FFFFFF_t_70][]

# 四、数据 #

整个项目结构：

![20190831111753854.png][]

数据库：

create table system_log(
    		id varchar(36) primary key comment'ID',
    		create_time TIMESTAMP default CURRENT_TIMESTAMP comment'创建时间',
    		log_level int comment'日志等级',
    		operation_unit varchar(36) not null comment'被操作的对象',
    		method varchar(200) not null comment'方法名',
    		args varchar(100) not null comment'参数',
    		user_id varchar(20) not null comment'操作人id',
    		user_name varchar(50) not null comment'操作人',
    		log_describe varchar(200) not null comment'日志描述',
    		operation_type varchar(20) not null comment'操作类型',
    		run_time int not null comment'方法运行时间',
    		return_value varchar(20) not null comment'方法返回值',
    		ip_address varchar(50) not null comment'IP地址'
    		)comment'日志'
    		
    		
    		
    		
    		create table system_user(
    		id int primary key auto_increment comment'ID',
    		user_name varchar(20) not null comment'用户名',
    		account varchar(16) not null comment'账户',
    		psd varchar(16) not null comment'密码'
    		)comment'用户'

SystemLog.java

package com.shiro.pojo;
    
    
    
    /**
     * @author Unclue_liu
     * @organization tyzn
     * @date 2019/8/30 0030 16:48
     * @desc TODO
     */
    public class SystemLog {
        private String id;
        /**
         * 创建时间
         */
        private String createTime;
        /**
         * 日志等级
         */
        private Integer logLevel;
        /**
         * 被操作的对象
         */
        private String operationUnit;
        /**
         * 方法名
         */
        private String method;
        /**
         * 参数
         */
        private String args;
        /**
         * 操作人id
         */
        private String userId;
        /**
         * 操作人
         */
        private String userName;
        /**
         * 日志描述
         */
        private String LogDescribe;
        /**
         * 操作类型
         */
        private String operationType;
        /**
         * 方法运行时间
         */
        private Long runTime;
        /**
         * 方法返回值
         */
        private String returnValue;
        /**
         * IP地址
         */
        private String ipAddress;
    
        public String getIpAddress() {
            return ipAddress;
        }
    
        public void setIpAddress(String ipAddress) {
            this.ipAddress = ipAddress;
        }
    
        public String getId() {
            return id;
        }
    
        public void setId(String id) {
            this.id = id;
        }
    
        public String getCreateTime() {
            return createTime;
        }
    
        public void setCreateTime(String createTime) {
            this.createTime = createTime;
        }
    
        public Integer getLogLevel() {
            return logLevel;
        }
    
        public void setLogLevel(Integer logLevel) {
            this.logLevel = logLevel;
        }
    
        public String getOperationUnit() {
            return operationUnit;
        }
    
        public void setOperationUnit(String operationUnit) {
            this.operationUnit = operationUnit;
        }
    
        public String getMethod() {
            return method;
        }
    
        public void setMethod(String method) {
            this.method = method;
        }
    
        public String getArgs() {
            return args;
        }
    
        public void setArgs(String args) {
            this.args = args;
        }
    
        public String getUserId() {
            return userId;
        }
    
        public void setUserId(String userId) {
            this.userId = userId;
        }
    
        public String getUserName() {
            return userName;
        }
    
        public void setUserName(String userName) {
            this.userName = userName;
        }
    
        public String getLogDescribe() {
            return LogDescribe;
        }
    
        public void setLogDescribe(String logDescribe) {
            LogDescribe = logDescribe;
        }
    
        public String getOperationType() {
            return operationType;
        }
    
        public void setOperationType(String operationType) {
            this.operationType = operationType;
        }
    
        public Long getRunTime() {
            return runTime;
        }
    
        public void setRunTime(Long runTime) {
            this.runTime = runTime;
        }
    
        public String getReturnValue() {
            return returnValue;
        }
    
        public void setReturnValue(String returnValue) {
            this.returnValue = returnValue;
        }
    
        @Override
        public String toString() {
            return "SystemLog{" +
                    "id='" + id + '\'' +
                    ", createTime='" + createTime + '\'' +
                    ", logLevel=" + logLevel +
                    ", operationUnit='" + operationUnit + '\'' +
                    ", method='" + method + '\'' +
                    ", args='" + args + '\'' +
                    ", userId='" + userId + '\'' +
                    ", userName='" + userName + '\'' +
                    ", LogDescribe='" + LogDescribe + '\'' +
                    ", operationType='" + operationType + '\'' +
                    ", runTime=" + runTime +
                    ", returnValue='" + returnValue + '\'' +
                    '}';
        }
    }

SystemUser.java

package com.shiro.pojo;
    
    
    /**
     * @author Unclue_liu
     * @organization tyzn
     * @date 2019/8/30 0030 17:28
     * @desc TODO
     */
    public class SystemUser {
        private int id;
        private String userName;
        private String account;
        private String psd;
    
        public int getId() {
            return id;
        }
    
        public void setId(int id) {
            this.id = id;
        }
    
        public String getUserName() {
            return userName;
        }
    
        public void setUserName(String userName) {
            this.userName = userName;
        }
    
        public String getAccount() {
            return account;
        }
    
        public void setAccount(String account) {
            this.account = account;
        }
    
        public String getPsd() {
            return psd;
        }
    
        public void setPsd(String psd) {
            this.psd = psd;
        }
    
        @Override
        public String toString() {
            return "SystemUser{" +
                    "id=" + id +
                    ", userName='" + userName + '\'' +
                    ", account='" + account + '\'' +
                    ", psd='" + psd + '\'' +
                    '}';
        }
    }

**SystemLogMapper.xml**

<?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
    <mapper namespace="com.shiro.mapper.SystemLogMapper">
    
        <insert id="addLog">
            INSERT INTO SYSTEM_LOG(id,log_level,operation_unit,method,args,user_id,user_name,log_describe,operation_type,run_time,return_value,ip_address)
              VALUE(#{id},#{logLevel},#{operationUnit},#{method},#{args},#{userId},#{userName},#{logDescribe},#{operationType},#{runTime},#{returnValue},#{ipAddress});
        </insert>
    
    </mapper>

**SystemUserMapper.xml**

<?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
    <mapper namespace="com.shiro.mapper.SystemUserMapper">
    
        <select id="selectSystemUserByAccount"  resultType="com.shiro.pojo.SystemUser">
            SELECT ID,USER_NAME,ACCOUNT,PSD FROM SYSTEM_USER WHERE account =#{account}
        </select>
    
    </mapper>

**测试结果：**

![20190831115610754.png][]

![20190831111929952.png][]

账户密码是通过工具类加密生成并保存的，注册用户时使用

/**
         * 账户密码加密
         * @param username
         * @param pwd
         * @return
         */
        public static String MD5Pwd(String username, String pwd) {
            String hashAlgorithmName = "MD5";//加密方式
            Object crdentials = pwd;//密码原值
            ByteSource salt = ByteSource.Util.bytes(username);//以账号作为盐值
            System.out.println(salt);
            int hashIterations = 1024;//加密1024次
            return new SimpleHash(hashAlgorithmName,crdentials,salt,hashIterations).toString();
    
        }
        public static void main(String[] args) {
            System.out.println(MD5Pwd("admin","123456"));
        }

# 五、源码 #

[源码下载][Link 1]

[Spring Boot _ Shiro_thymeleaf_]: https://blog.csdn.net/qq_40369944/article/details/100100743
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMzY5OTQ0_size_16_color_FFFFFF_t_70]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/b1de4614208943478b3693602a52210e.png
[20190831111753854.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/45f0bc928c1a4769bd540c3178cf4b11.png
[20190831115610754.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/9477cd50d8c647bfb9ff4d71c55e00e7.png
[20190831111929952.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/0383b690cbc1446992f6374e5ab59cb1.png
[Link 1]: https://github.com/Uncle-LiuY/shiro