Spring Boot 整合Aop实现记录用户操作日志

1.新建数据表以及实体类

DROP TABLE IF EXISTS `t_sys_log`;
CREATE TABLE `t_sys_log`  (
  `log_id` varchar(36) CHARACTER SET utf8 COLLATE utf8_bin NOT NULL COMMENT '日志ID',
  `user_name` varchar(50) CHARACTER SET utf8 COLLATE utf8_bin NOT NULL COMMENT '用户名字',
  `user_ip` varchar(50) CHARACTER SET utf8 COLLATE utf8_bin NULL DEFAULT NULL COMMENT '用户IP',
  `request_method` varchar(200) CHARACTER SET utf8 COLLATE utf8_bin NULL DEFAULT NULL COMMENT '请求方法',
  `request_desc` varchar(50) CHARACTER SET utf8 COLLATE utf8_bin NULL DEFAULT NULL COMMENT '方法描述',
  `create_time` timestamp(0) NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP(0) COMMENT '记录时间',
  PRIMARY KEY (`log_id`) USING BTREE
) ENGINE = InnoDB CHARACTER SET = utf8 COLLATE = utf8_bin COMMENT = '日志表' ROW_FORMAT = Dynamic;

SET FOREIGN_KEY_CHECKS = 1;
复制代码

public class SysLog implements Serializable {

    private static final long serialVersionUID = 2713975405735052081L;

    private String logId;//日志ID
    private String userName;//用户名字
    private String userIp;//用户IP
    private String requestMethod;//请求方法
    private String requestDesc;//方法描述
    private String createTime;//记录日期
    
    //Getter & Setter 略
}
复制代码

2. 写好相关的Service和Mapper

    @Override
    public void saveLog(SysLog sysLog) {
        sysLog.setLogId(UUIDTool.getUUID());
        sysLogMapper.saveLog(sysLog);
    }
复制代码

3.新建annotation类

import java.lang.annotation.*;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.TYPE;
/**
 * Create By SINYA
 * Description:
 */
@Target({METHOD, TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface Operation {
    String value() default "";
}
复制代码

4.新建LogAspect切面类

import cn.hutool.system.SystemUtil;
import com.springboot.demo.entity.SysLog;
import com.springboot.demo.service.ISysLogService;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.stereotype.Component;
import javax.annotation.Resource;
import java.lang.reflect.Method;
/**
 * Create By SINYA
 * Description:
 */
@Aspect
@Component
public class SysAspect {

    @Resource
    private ISysLogService sysLogService;

    //定义切点 @Pointcut
    //在注解的位置切入代码
    @Pointcut("@annotation(com.springboot.demo.core.interceptor.aop.Operation)")
    public void logPointCut(){
    }

    @AfterReturning("logPointCut()")
    public void saveSysLog(JoinPoint joinPoint) {
        //保存日志
        SysLog sysLog = new SysLog();

        //从切面织入点处通过反射机制获取织入点处的方法
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        //获取切入点所在的方法
        Method method = signature.getMethod();


        //获取操作
        Operation operation = method.getAnnotation(Operation.class);
        if (operation != null) {
            String value = operation.value();
            sysLog.setRequestDesc(value);//保存获取的操作
        }

        //获取请求的类名
        String className = joinPoint.getTarget().getClass().getName();
        //获取请求的方法名
        String methodName = method.getName();

        //注入Syslog对象
        //username应从session里取出
        sysLog.setUserName("Sinya");
        
        //IP地址获取工具为HUtooljar包,自行添加依赖
        sysLog.setUserIp(SystemUtil.getHostInfo().getAddress());
        sysLog.setRequestMethod(className + "." + methodName);

        //调用service保存SysLog实体类到数据库
        sysLogService.saveLog(sysLog);
    }
}
复制代码

4.测试:在Controller或Service上加上自定义的Opeartion注解,并输入描述

    /**
     * 删除用户
     * @param user
     */
    @Operation(value = "删除用户")
    @RequestMapping(value = "/deleteUserByID",method = RequestMethod.POST)
    public void deleteUserByID(User user){
        userService.deleteUserByID(user);
    }
复制代码

5.在PostMan或IDEA自带的API测试工具里访问该路径,之后查看数据库

收工

转载于:https://juejin.im/post/5c908c155188256d853dab82