在springboot中使用AOP进行全局日志记录

目录

• 前言
• 1、 spring AOP 是什么？
• 2、spring AOP 能做什么？
• 3、spring AOP 我能用 AOP 解决什么问题？
• 一、引入依赖，增加自定义注解
• 1、引入 maven 依赖
• 2、增加自定义注解 OperationLog
• 二、为自定义注解编写切面实现
• 三、使用自定义日志注解

前言

此前项目上需要对用户的操作进行日志记录，以便后续追踪问题，所以就学习了使用 spring AOP 来进行日志记录。

1、 spring AOP 是什么？

spring 的两大核心就是 IOC 和 AOP，AOP 是 spring 框架面向切面的编程思想，AOP是横切性的技术，将涉及多业务流程的通用功能抽取并单独封装，形成独立的切面，再将这些切面横向切入到业务流程指定的位置中。

2、spring AOP 能做什么？

AOP 主要是从切面入手，将日志记录、安全控制、事务处理、全局异常处理等全局功能从我们的业务逻辑代码中划分出来。

3、spring AOP 我能用 AOP 解决什么问题？

正好我这边需要做一个全局的日志，如果每个方法都去写日志记录，这样代码量非常大，而且代码繁琐冗余，全局记录的话，只需要在方法上增加一个注解就可以实现日志记录。

好了，不多bb，直接上代码实现

一、引入依赖，增加自定义注解

1、引入 maven 依赖

        <!--利用 AOP 做操作日志记录-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>

2、增加自定义注解 OperationLog

@Target(ElementType.METHOD) //注解放置的目标位置,METHOD是可注解在方法级别上
@Retention(RetentionPolicy.RUNTIME) //注解执行阶段
@Documented
public @interface OperationLog {
    String operDesc() default "";  // 操作说明
}

二、为自定义注解编写切面实现

@Aspect //标识一个切面类
@Component
public class OperationLogAspect {
    private static final Logger logger = LoggerFactory.getLogger(OperationLogAspect.class);
    @Autowired
    private OperatelogsService OperatelogsService;
    @Autowired
    private SysUserService userService;
    /**
     * 设置操作日志切入点 记录操作日志 在注解的位置切入代码
     */
    @Pointcut("@annotation(com.wxw.annotation.OperationLog)")
    public void operLogPoinCut() {
    }
    /**
     * 正常返回通知，拦截用户操作日志，连接点正常执行完成后执行， 如果连接点抛出异常，则不会执行
     *
     * @param joinPoint 切入点
     * @param keys      返回结果
     */
    @AfterReturning(value = "operLogPoinCut()", returning = "keys")
    public void saveOperLog(JoinPoint joinPoint, Object keys) {
        // 获取RequestAttributes
        RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
        // 从获取RequestAttributes中获取HttpServletRequest的信息
        HttpServletRequest request = (HttpServletRequest) requestAttributes
                .resolveReference(RequestAttributes.REFERENCE_REQUEST);
        Operatelogs operlog = new Operatelogs();
        try {
            // 从切面织入点处通过反射机制获取织入点处的方法
            MethodSignature signature = (MethodSignature) joinPoint.getSignature();
            // 获取切入点所在的方法
            Method method = signature.getMethod();
            // 获取操作
            OperationLog opLog = method.getAnnotation(OperationLog.class);
            if (opLog != null) {
                String operDesc = opLog.operDesc();
                operlog.setfDescript(operDesc); // 操作描述
            }
            // 获取请求的类名
            String className = joinPoint.getTarget().getClass().getName();
            // 获取请求的方法名
            String methodName = method.getName();
            methodName = className + "." + methodName;
            operlog.setfRequestMethod(methodName); // 请求方法
            // 请求的参数
            Object[] arguments = joinPoint.getArgs();
            //判断参数数组是否为空
            Stream<?> stream = ArrayUtils.isEmpty(arguments) ? Stream.empty() :  Arrays.asList(arguments).stream();
            //过滤 joinPoint.getArgs()返回的数组中携带有Request或者Response对象
            List<Object> logArgs = stream
                    .filter(arg -> (!(arg instanceof HttpServletRequest) && !(arg instanceof HttpServletResponse)))
                    .collect(Collectors.toList());
            // 先将参数所在的list 转换成json 数组
            JSONArray jsonArray = JSONArray.parseArray(JSON.toJSONString(logArgs));
            //再转 json 字符串
            String params = jsonArray.toJSONString();
            operlog.setfRequestData(params); // 请求参数
            operlog.setfResponseData(JSON.toJSONString(keys)); // 返回结果
            SysUser user = getUser();
            operlog.setfOptby(user != null ? user.getfUserid() : 0); // 请求用户ID
            operlog.setfOptname(user != null ? user.getfUsercode() : "admin"); // 请求用户名称
            operlog.setfOpton(new Date()); // 创建时间
            operlog.setfIp(getIp()); // 请求IP
            operlog.setfRequestUrl(request.getRequestURI()); // 请求URI
            OperatelogsService.save(operlog);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
    /**
     * 异常返回通知，用于拦截异常日志信息 连接点抛出异常后执行
     *
     * @param joinPoint 切入点
     * @param e         异常信息
     */
    @AfterThrowing(pointcut = "operLogPoinCut()", throwing = "e")
    public void saveExceptionLog(JoinPoint joinPoint, Throwable e) {
        // 获取RequestAttributes
        RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
        // 从获取RequestAttributes中获取HttpServletRequest的信息
        HttpServletRequest request = (HttpServletRequest) requestAttributes
                .resolveReference(RequestAttributes.REFERENCE_REQUEST);
        Operatelogs operlog = new Operatelogs();
        try {
            // 从切面织入点处通过反射机制获取织入点处的方法
            MethodSignature signature = (MethodSignature) joinPoint.getSignature();
            // 获取切入点所在的方法
            Method method = signature.getMethod();
            // 获取请求的类名
            String className = joinPoint.getTarget().getClass().getName();
            // 获取请求的方法名
            String methodName = method.getName();
            methodName = className + "." + methodName;
            // 请求的参数
            Object[] arguments = joinPoint.getArgs();
             //判断参数数组是否为空
            Stream<?> stream = ArrayUtils.isEmpty(arguments) ? Stream.empty() :  Arrays.asList(arguments).stream();
            //过滤 joinPoint.getArgs()返回的数组中携带有Request或者Response对象
            List<Object> logArgs = stream
                    .filter(arg -> (!(arg instanceof HttpServletRequest) && !(arg instanceof HttpServletResponse)))
                    .collect(Collectors.toList());
            // 先将参数所在的list 转换成json 数组
            JSONArray jsonArray = JSONArray.parseArray(JSON.toJSONString(logArgs));
            //再转 json 字符串
            String params = jsonArray.toJSONString();
            operlog.setfRequestData(params); // 请求参数
            operlog.setfRequestMethod(methodName); // 请求方法名
            operlog.setfExceptionName(e.getClass().getName()); // 异常名称
            operlog.setfResponseData(stackTraceToString(e.getClass().getName(), e.getMessage(), e.getStackTrace())); // 异常信息
            SysUser user = getUser();
            operlog.setfOptby(user != null ? user.getfUserid() : 0); // 请求用户ID
            operlog.setfOptname(user != null ? user.getfUsercode() : "admin"); // 请求用户名称
            operlog.setfOpton(new Date()); // 创建时间
            operlog.setfRequestUrl(request.getRequestURI()); // 请求URI
            operlog.setfIp(getIp()); // 请求IP
            operatelogsService.save(operlog);
        } catch (Exception e2) {
            e2.printStackTrace();
        }
    }
    /**
     * 获取用户信息,由于我这边 token 是使用 jwt 生成，所以可以从中获取用户id，再根据id获取用户数据
     *
     * @return
     */
    public SysUser getUser() {
        HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
        SysUser sysUser = null;
        String token = request.getHeader("token");// 从 http 请求头中取出 token
        if(token != null){
            // 获取 token 中的 user id
            String userId = JWT.decode(token).getAudience().get(0);
            sysUser = userService.getOne(new QueryWrapper<SysUser>().lambda().eq(SysUser::getfUserid,
                    userId));
        }
        return sysUser;
    }
    /**
     * 获取ip
     *
     * @return
     */
    public String getIp() {
        //获得本机的ip和名称
        InetAddress addr = null;
        try {
            addr = InetAddress.getLocalHost();
        } catch (UnknownHostException e) {
            throw new CustomException(500,e.getMessage());
        }
        String ip = addr.getHostAddress();
//      String hostname = addr.getHostName();
        return ip;
    }
    /**
     * 转换异常信息为字符串
     *
     * @param exceptionName    异常名称
     * @param exceptionMessage 异常信息
     * @param elements         堆栈信息
     */
    public String stackTraceToString(String exceptionName, String exceptionMessage, StackTraceElement[] elements) {
        StringBuffer strbuff = new StringBuffer();
        for (StackTraceElement stet : elements) {
            strbuff.append(stet + "\n");
        }
        String message = exceptionName + ":" + exceptionMessage + "\n\t" + strbuff.toString();
        return message;
    }
}

三、使用自定义日志注解

将自定义注解加在方法上，请求方法之后，就可以将方法的日志记录到自己的数据库里面了。

以上为个人经验，希望能给大家一个参考，也希望大家多多支持我们。