springboot 集成aop 实现日志

已于 2024-05-07 17:38:35 修改
阅读量146 收藏
点赞数
分类专栏： java 文章标签： spring boot 后端 java
于 2021-03-05 16:46:32 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/sinat_34338162/article/details/114402251
版权

项目例子： https://github.com/nlxs0511/springmybatisplus.git

一、所有方法



import cn.hutool.core.util.StrUtil;
import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.serializer.SerializerFeature;
import com.eebbk.demo.dao.RequestLogMapper;
import com.eebbk.demo.pojo.RequestLogEntity;
import com.eebbk.demo.utils.PropertiesUtil;
import com.google.common.collect.Lists;
import org.apache.commons.lang3.StringUtils;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import org.springframework.validation.BindingResult;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.annotation.Resource;
import javax.servlet.ServletRequest;
import javax.servlet.http.HttpServletRequest;
import java.util.Collections;
import java.util.Date;
import java.util.Iterator;
import java.util.List;

/**
 * <p>ControllerLogAspect</p>
 */
@Aspect
@Component
public class ControllerLogAspect {

    @Resource
    private RequestLogMapper logMapper;

    private static final Logger LOGGER = LoggerFactory.getLogger(ControllerLogAspect.class);


    @Pointcut("execution (* com.eebbk.demo.controller..*.*(..))")
    public void controllerAspect(){

    }

    @Around("controllerAspect()")
    public Object doAround(ProceedingJoinPoint joinPoint) throws Throwable {
        String logtoDb = PropertiesUtil.findAppConfigByName("request.logtodb");
        if (!org.springframework.util.StringUtils.hasText(logtoDb)) {
            return joinPoint.proceed();
        }

        if(RequestContextHolder.getRequestAttributes() == null){
            return joinPoint.proceed();
        }
        HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
        Object[] o = joinPoint.getArgs();
        List<Object> args = o == null ? Collections.emptyList() : Lists.newArrayList(o);
        Iterator<Object> it = args.iterator();

        while (it.hasNext()) {
            Object arg = it.next();
            if (arg instanceof BindingResult) {
                it.remove();
            }
            if (arg instanceof ServletRequest) {
                it.remove();
            }
        }
        long timestamp = System.currentTimeMillis();
        String url = request.getRequestURI();
        String ip = request.getRemoteAddr();
//        由于文件上传日志打印太大，关闭此类接口日志输出
        if(StringUtils.isNoneBlank(url) && url.contains("/searchQuestionByImage")){
            return joinPoint.proceed();
        }
        String methodName = joinPoint.getSignature().toShortString();
        Object resp = joinPoint.proceed();
        long cast = System.currentTimeMillis() - timestamp;
        try {
//            String param = JSON.toJSONString(args,true);
            String param = JSON.toJSONString(args, SerializerFeature.IgnoreErrorGetter);
            RequestLogEntity log = new RequestLogEntity();
            log.setCreateTime(new Date());
            log.setRequestUrl(url);
            log.setParam(param);
            if("true".equalsIgnoreCase(logtoDb)){
                saveLog(log);
            }
            String responseLog = StrUtil.format("请求路径:{},方法:{},参数:{},耗时:{} ms",url,methodName, param,cast);
            LOGGER.info(responseLog);

        } catch (Exception e) {
            //ignore
        }
        return resp;
    }


    private void saveLog(RequestLogEntity log){
        if(log.getRequestUrl().contains("/healthy")){
            return;
        }
        logMapper.insert(log);
    }

}

1.pom.xml

 <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>

2.自定义log注解类

package com.test.mybatisplus.aop;
import java.lang.annotation.*;

/**
 * @Description 日志注解
 * @project
 * @author：hf
 * @date：
 * @company:人生有限公司
 */
@Target({ElementType.PARAMETER, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Log {
    /**
     * 要执行的操作类型比如：add操作
     **/
    public String operationType() default "";

    /**
     * 要执行的具体操作比如：添加用户
     **/
    public String operationName() default "";

}

3.SystemLogAspect 

package com.test.mybatisplus.aop;

import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;
import java.lang.reflect.Method;

/**
 * @Description〈
 * @project
 * @author：hf
 * @date：
 * @company:人生电子有限公司
 */
@Component
@Aspect
@Slf4j
public class SystemLogAspect {
    //正常 device : -->around-->before-->method-->after-->afterReturn
    //报错 device : -->around-->before-->method-->after-->afterthrowing
    @Pointcut("execution(* com.test.mybatisplus.controller.AopController.*(..))")
    public void controllerAspect() {
    }

    /**
     * 前置通知 用于拦截Controller层记录用户的操作
     *
     * @param joinPoint 切点
     */
    @Before("controllerAspect()")
    public void doBefore(JoinPoint joinPoint) {
        System.out.println("==========执行controller前置通知===============");
        if (log.isInfoEnabled()) {
            log.info("before " + joinPoint);
            log.info("before start");
            joinPoint.getArgs();//输入的参数列表
            joinPoint.getTarget().getClass().getName();///类全路径
            joinPoint.getSignature().getDeclaringTypeName();//接口全路径
            joinPoint.getSignature().getName();//调用的方法
            log.info("before end");
        }
    }
    /**
     * @Description:配置controller环绕通知,使用在方法aspect()上注册的切入点
     * @Return:
     * @Author: hf
     * @Time: 2021/3/5 15:32
     * @Company 人生有限公司
     */
    @Around("controllerAspect()")
    public Object  around (ProceedingJoinPoint pjp){
        log.info("==========开始执行controller环绕通知===============");
        long start = System.currentTimeMillis();
        Object object=null;
        try {
             object=    pjp.proceed();
            // ((ProceedingJoinPoint) joinPoint).proceed();
            long end = System.currentTimeMillis();
            //日志级别过滤
            if (log.isInfoEnabled()) {
                log.info("around " + pjp + "\tUse time : " + (end - start) + " ms!");
            }
            log.info("==========结束执行controller环绕通知===============");
        } catch (Throwable e) {
            long end = System.currentTimeMillis();
            if (log.isInfoEnabled()) {
                log.info("around " + pjp + "\tUse time : " + (end - start) + " ms with exception : " + e.getMessage());
            }
        }
        return object;
    }

      /**
       * @Description:
       * @Return:
       * @Author: hf
       * @Time: 2021/3/5 15:32
       * @Company 人生有限公司
       */
        @After("controllerAspect()")
        public void after (JoinPoint joinPoint){
            log.info("=====after=====");
        }
        /**
         * @Description:配置后置返回通知,使用在方法aspect()上注册的切入点
         * @Return:
         * @Author: hf
         * @Time: 2021/3/5 15:32
         * @Company 人生有限公司
         */
        @AfterReturning("controllerAspect()")
        public void afterReturn(JoinPoint joinPoint){
            ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.currentRequestAttributes();
            HttpServletRequest request =attributes.getRequest();
            //读取session中的用户
            HttpSession session = request.getSession();
            //请求的IP
            String ip = request.getRemoteAddr();
            try {
                String targetName = joinPoint.getTarget().getClass().getName();
                String methodName = joinPoint.getSignature().getName();
                Object[] arguments = joinPoint.getArgs();
                Class targetClass = Class.forName(targetName);
                Method[] methods = targetClass.getMethods();
                String operationType = "";
                String operationName = "";
                for (Method method : methods) {
                    if (method.getName().equals(methodName)) {
                        Class[] clazzs = method.getParameterTypes();
                        if (clazzs.length == arguments.length) {
                            operationType = method.getAnnotation(Log.class).operationType();
                            operationName = method.getAnnotation(Log.class).operationName();
                            break;
                        }
                    }
                }
                //*========控制台输出=========*//
                log.info("=====controller后置通知开始=====");
                log.info("请求方法:" + (joinPoint.getTarget().getClass().getName() + "." + joinPoint.getSignature().getName() + "()") + "." + operationType);
                log.info("方法描述:" + operationName);
                log.info("请求人:" + "xxx");
                log.info("请求IP:" + ip);
                //*========数据库日志=========*//
                log.info("=====controller后置通知结束=====");
            } catch (Exception e) {
                //记录本地异常日志
                log.error("==后置通知异常==");
                log.error("异常信息:{}", e.getMessage());
            }
        }

        /**
         * @Description:异常通知 用于拦截记录异常日志
         * @Return:
         * @Author: hf
         * @Time: 2021/3/5 15:32
         * @Company 人生有限公司
         */
        @AfterThrowing(pointcut = "controllerAspect()", throwing = "e")
        public void doAfterThrowing (JoinPoint joinPoint, Throwable e){
            ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.currentRequestAttributes();
            HttpServletRequest request = attributes.getRequest();
            //读取session中的用户
            HttpSession session = request.getSession();
            String ip = request.getRemoteAddr();
            String params = "";
            if (joinPoint.getArgs() != null && joinPoint.getArgs().length > 0) {
                for (int i = 0; i < joinPoint.getArgs().length; i++) {
                    //params += JsonUtil.getJsonStr(joinPoint.getArgs()[i]) + ";";
                }
            }
            try {
                String targetName = joinPoint.getTarget().getClass().getName();
                String methodName = joinPoint.getSignature().getName();
                Object[] arguments = joinPoint.getArgs();
                Class targetClass = Class.forName(targetName);
                Method[] methods = targetClass.getMethods();
                String operationType = "";
                String operationName = "";
                for (Method method : methods) {
                    if (method.getName().equals(methodName)) {
                        Class[] clazzs = method.getParameterTypes();
                        if (clazzs.length == arguments.length) {
                            operationType = method.getAnnotation(Log.class).operationType();
                            operationName = method.getAnnotation(Log.class).operationName();
                            break;
                        }
                    }
                }
                /*========控制台输出=========*/
                log.info("=====异常通知开始=====");
                log.info("异常代码:" + e.getClass().getName());
                log.info("异常信息:" + e.getMessage());
                log.info("异常方法:" + (joinPoint.getTarget().getClass().getName() + "." + joinPoint.getSignature().getName() + "()") + "." + operationType);
                log.info("方法描述:" + operationName);
                log.info("请求人:" + "xxx");
                log.info("请求IP:" + ip);
                log.info("请求参数:" + params);
                /*==========数据库日志=========*/
                //保存数据库
                log.info("=====异常通知结束=====");
            } catch (Exception ex) {
                //记录本地异常日志
                log.error("==异常通知异常==");
                log.error("异常信息:{}", ex.getMessage());
            }
            log.error("异常方法:{}异常代码:{}异常信息:{}参数:{}", joinPoint.getTarget().getClass().getName() + joinPoint.getSignature().getName());
        }
    }

4.AopController 

package com.test.mybatisplus.controller;

import com.test.mybatisplus.aop.Log;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * @Description aop测试类
 * @project
 * @author：hf
 * @date：
 * @company:人生有限公司
 */
@Api
@RestController
@RequestMapping("aopController")
@Slf4j
public class AopController {

    /**
     * @Description: 测试方法
     * @Author: hf
     * @Time: 2021/3/5 16:26
     * @Company 人生有限公司
     */
    @GetMapping("/testAOP")
    @ApiOperation(value = "testAOP",notes = "testAOP")
    @Log(operationType="testAOP",operationName="测试接口")
    public String testAOP() {
      /* String a=null;
       a.equals("");*/
       return "测试testAOP接口...";
    }

}

5.执行

6.日志输出

2021-03-05 16:38:40.023 [http-nio-8084-exec-10] INFO  com.test.mybatisplus.aop.SystemLogAspect - ==========开始执行controller环绕通知===============
==========执行controller前置通知===============
2021-03-05 16:38:40.026 [http-nio-8084-exec-10] INFO  com.test.mybatisplus.aop.SystemLogAspect - before execution(String com.test.mybatisplus.controller.AopController.testAOP())
2021-03-05 16:38:40.026 [http-nio-8084-exec-10] INFO  com.test.mybatisplus.aop.SystemLogAspect - before start
2021-03-05 16:38:40.027 [http-nio-8084-exec-10] INFO  com.test.mybatisplus.aop.SystemLogAspect - before end
2021-03-05 16:38:40.040 [http-nio-8084-exec-10] INFO  com.test.mybatisplus.aop.SystemLogAspect - =====controller后置通知开始=====
2021-03-05 16:38:40.040 [http-nio-8084-exec-10] INFO  com.test.mybatisplus.aop.SystemLogAspect - 请求方法:com.test.mybatisplus.controller.AopController.testAOP().testAOP
2021-03-05 16:38:40.040 [http-nio-8084-exec-10] INFO  com.test.mybatisplus.aop.SystemLogAspect - 方法描述:测试接口
2021-03-05 16:38:40.041 [http-nio-8084-exec-10] INFO  com.test.mybatisplus.aop.SystemLogAspect - 请求人:xxx
2021-03-05 16:38:40.041 [http-nio-8084-exec-10] INFO  com.test.mybatisplus.aop.SystemLogAspect - 请求IP:0:0:0:0:0:0:0:1
2021-03-05 16:38:40.042 [http-nio-8084-exec-10] INFO  com.test.mybatisplus.aop.SystemLogAspect - =====controller后置通知结束=====
2021-03-05 16:38:40.044 [http-nio-8084-exec-10] INFO  com.test.mybatisplus.aop.SystemLogAspect - =====after=====
2021-03-05 16:38:40.044 [http-nio-8084-exec-10] INFO  com.test.mybatisplus.aop.SystemLogAspect - around execution(String com.test.mybatisplus.controller.AopController.testAOP())	Use time : 21 ms!
2021-03-05 16:38:40.044 [http-nio-8084-exec-10] INFO  com.test.mybatisplus.aop.SystemLogAspect - ==========结束执行controller环绕通知===============

7.注意：使用AOP的@Around后无返回值

在@Around中执行并返回 object=    pjp.proceed();

  @Around("controllerAspect()")
    public Object  around (ProceedingJoinPoint pjp){
        log.info("==========开始执行controller环绕通知===============");
        long start = System.currentTimeMillis();
        Object object=null;
        try {
             object=    pjp.proceed();
            // ((ProceedingJoinPoint) joinPoint).proceed();
            long end = System.currentTimeMillis();
            //日志级别过滤
            if (log.isInfoEnabled()) {
                log.info("around " + pjp + "\tUse time : " + (end - start) + " ms!");
            }
            log.info("==========结束执行controller环绕通知===============");
        } catch (Throwable e) {
            long end = System.currentTimeMillis();
            if (log.isInfoEnabled()) {
                log.info("around " + pjp + "\tUse time : " + (end - start) + " ms with exception : " + e.getMessage());
            }
        }
        return object;
    }

千反田真的打不过我
关注
专栏目录
SpringBoot+AOP日志
04-24
在本项目中，"SpringBoot+AOP日志"是一个基于Spring Boot框架的日志管理系统，它利用了Spring Boot的便利性和AOP（面向切面编程）技术来实现对应用程序日志的高效、统一处理。让我们深入探讨一下这个项目的核心知识...
【Springboot】基于AOP实现操作日志记录
ASL2915的博客
07-02 1893
基于AOP实现springboot项目中中的操作日志记录功能
SpringBoot中使用AOP实现日志记录功能
customer08的博客
05-20 1463
日志记录在软件开发中是极其重要的，能够帮助开发人员快速定位问题、监控系统性能、提高系统安全性、跟踪业务流程等，是保障系统稳定运行和快速问题排查的重要手段
【SpringBoot】SpringBoot中使用AOP实现日志记录功能
qq_61024956的博客
05-18 4701
AOP的全称是Aspect-Oriented Programming，即面向切面编程（也称面向方面编程）。它是面向对象编程（OOP）的一种补充，目前已成为一种比较成熟的编程方式。在传统的业务处理代码中，通常都会进行事务处理、日志记录等操作。虽然使用OOP可以通过组合或者继承的方式来达到代码的重用，但如果要实现某个功能（如日志记录），同样的代码仍然会分散到各个方法中。这样，如果想要关闭某个功能，或者对其进行修改，就必须要修改所有的相关方法。这不但增加了开发人员的工作量，而且提高了代码的出错率。
spring-boot-plus后台快速开发脚手架之代码生成器使用
aati13890的博客
07-27 503
Generator 代码生成 _ _ _ _ (_) | | | | | | ___ _ __ _ __ _ _ __ __ ...
springboot中注解校验@Valid@Validated(亲测有效)
weixin_43401380的博客
09-01 5620
1.校验步骤说明 1.请求对象上添加注解@RequestBody @Vlid(源自javax.validation.Valid); 2,对象实体类中添加相关校验注解(源于javax.validation.constraints). 2.示例说明 1.请求类 package com.kawaxiaoyu.api.appointCourse.controller; import com.kawaxiaoyu.api.appointCourse.dto.ApplyInfoDto; import c
SpringBoot+AOP日志服务
12-13
SpringBoot+AOP日志服务是将流行的Java框架Spring Boot与面向切面编程（AOP）技术结合，用于实现高效、灵活的日志管理。在Spring Boot项目中，AOP可以帮助我们以非侵入式的方式记录应用运行时的行为，尤其是对于业务...
Springboot整合Aop.zip
03-10
- **事务管理**：SpringBoot 可以利用 AOP 实现声明式事务管理，无需在每个操作数据库的方法中手动管理事务，只需在相关类或方法上添加注解即可。 - **日志记录**：通过 AOP，可以在方法执行前后自动记录日志，...
基于SpringBoot 整合 AOP完整源码示例
最新发布
11-05
集成AOP的第一步是确保项目已经正确配置了Spring Boot和Maven。在`pom.xml`文件中，我们需要添加Spring Boot的父依赖和Spring AOP的相关依赖。Spring Boot父依赖提供了一组默认的配置和依赖管理，而Spring AOP依
SpringBoot 整合 AOP完整源码
02-16
集成AOP的第一步是确保项目已经正确配置了Spring Boot和Maven。在`pom.xml`文件中，我们需要添加Spring Boot的父依赖和Spring AOP的相关依赖。Spring Boot父依赖提供了一组默认的配置和依赖管理，而Spring AOP依赖则...
Spring mvc mybatis plus 实现AOP 切面日志系统
12-19
Spring mvc mybatis plus 实现AOP 切面日志系统，带有数据库。可以自行拓展
spring-boot-plus是易于使用，快速，高效，功能丰富，开源的spring boot 脚手架.
geekidea
11-03 1611
spring-boot-plus是一套集成spring boot常用开发组件的后台快速开发框架 Spring-Boot-Plus是易于使用，快速，高效，功能丰富，开源的spring boot 脚手架. 前后端分离,专注于后端服务 目标 每个人都可以独立、快速、高效地开发项目！ 版本库 GITHUB | GITEE 官网 springboot.plus 主要特性 集成spring b...
springboot整合AOP,实现log操作日志
liyu121的博客
01-28 6339
添加依赖 &lt;dependency&gt; &lt;groupId&gt;org.springframework.boot&lt;/groupId&gt; &lt;artifactId&gt;spring-boot-starter-aop&lt;/artifactId&gt; &lt;/dependency&g...
关于spring aop和spring事务各种配置和一些注意事项
outsider
04-06 3619
关于spring事务和spring aop1. spring 事务默认只有抛出unchecked Exception才会回滚              UncheckedException包括error和runtimeException派生出的所有子类2.     什么时候才用事务?对数据库的数据进行批量或连表操作时，为了保证数据的一致性和正确性，我们需要添加事务管理机制进行管理。当对数据库的数据...
SpringBoot+AOP（@Around）
舌尖上的蛋炒饭的博客
06-28 6053
SpringBoot+AOP（@Around） 虽然SpringBoot很方便，可以使我们不太懂原理的情况下都可以轻松的写出一个CRUD的项目，但是SpringBoot的控制反转和依赖注入我们时时刻刻在用，可面向切面编程我们却不常用，接下来我们来一次简单的面向切面编程实现日志增强的例子（AOP的主要功能就是将日志记录，性能统计，安全控制，事务处理，异常处理等代码从业务逻辑代码中划分出来） pom文件导入依赖 <dependency> <groupId
日志 aop 中 @Around(“execution(?)“)中路径的配置
热门推荐
CYY941027的博客
07-02 1万+
//环绕通知 首先是:包名 然后是: 类名 然后是方法名:方法名 括号内是:参数 @Around("execution(* com.sinosoft.*.controller.*.*(..))") public Object around(ProceedingJoinPoint point) throws Throwable{ //参数是目标方法 try { String typeName=""; String locat=""; Signature signature = po
狂野！利用Fastjson注入Spring内存马~
良月柒
11-16 456
程序员的成长之路互联网/程序员/技术/资料共享关注阅读本文大概需要 8.5 分钟。来自：网络。如侵，请联系删除此篇文章在于记录自己对spring内存马的实验研究。环境搭建搭建漏洞环境，利...
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值