SpringBoot AOP+Slf4j+Logback代码侵入记录业务层日志

刺骨的言语ヽ痛彻心扉 2022-11-19 04:29 197阅读 0赞

# SpringBoot AOP+Slf4j+Logback代码侵入记录业务层日志 #

--------------------

### 文章目录 ###

*  SpringBoot AOP+Slf4j+Logback代码侵入记录业务层日志
 *  前言
 *  一、什么是AOP代码侵入？
 *  二、使用步骤
 *   *  1.引Maven入库
     *  2.AOP前置侵入、后置侵入、切面环绕
     *  3.利用切面拦截需要的参数进行记录
 *  总结

--------------------

# 前言 #

使用AOP切面，对路径包级别进行前置，后置，环绕添加想要的

--------------------

提示：以下是本篇文章正文内容，下面案例可供参考

# 一、什么是AOP代码侵入？ #

当你的代码引入了一个组件,导致其它代码或者设计,要做相应的更改以适应新组件.这样的情况我们就认为这个新组件具有侵入性

# 二、使用步骤 #

## 1.引Maven入库 ##

代码如下（示例）：

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

## 2.AOP前置侵入、后置侵入、切面环绕 ##

代码如下（示例）：

/** * @ClassName xxx.com.xxx.aop.LogAspect.java * @Author SongWei * @Version 1.0.0 * @Description Log日志Aop切面记录(logback-classic和slf4j-log4j12这两个jar包各有一个，因此，Spring boot是自动选择logback-classic) * @CreateTime 2021年04月12日 10:45:00 */
    @Aspect
    @Component
    @Slf4j
    public class LogAspect { 
    
        @Resource
        private LogAppInfo logAppInfo;
    
        /** * 以 controller.app 包下定义的所有请求为切入点 */
        @Pointcut("execution(public * com.xxx.controller.app.*.*(..))")
        public void appLog() { 
        }
    
        /** * 在切点APP包之前侵入 * * @param joinPoint */
        @Before("appLog()")
        public void doAppLogBefore(JoinPoint joinPoint) { 
            // 开始打印请求日志
            ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
            HttpServletRequest request = attributes.getRequest();
            logAppInfo.addAppLogInfo(joinPoint, request);
        }
    
        /** * 在切点APP包之后侵入 */
        @After("appLog()")
        public void doAppLogAfter() { 
            logAppInfo.addAppLogAfter();
        }
    
        /** * 切入APP包环绕 * * @param proceedingJoinPoint * @return */
        @Around("appLog()")
        public Object doAppLogAround(ProceedingJoinPoint proceedingJoinPoint) throws Throwable { 
            return logAppInfo.doAppLogAround(proceedingJoinPoint);
        }

## 3.利用切面拦截需要的参数进行记录 ##

/** * @ClassName xxx.com.xxx.service.log.app.LogAppInfoServiceImpl.java * @Author SongWei * @Version 1.0.0 * @Description * @CreateTime 2021年04月12日 13:40:00 */
 @Service
 @Slf4j
 public class LogAppInfo { 
 
 public Logger loggerApp = LoggerFactory.getLogger(LogAppInfo.class);
 /** * 环境标志 **/
 @Value("${spring.profiles.active}")
 private String active;
 /** * 进入方法时间戳 */
 private Long startTime;
 /** * 方法结束时间戳(计时) */
 private Long endTime;
 
 /** * AOP切面代码前侵入 * * @param joinPoint * @param request * @return void * @version 1.0.0 * @author SongWei * @date 2021/4/12 14:03 */
 public void addAppLogInfo(JoinPoint joinPoint, HttpServletRequest request) { 
 StringBuilder requestInfo = new StringBuilder();
 //打印请求的内容
 startTime = System.currentTimeMillis();
 // 打印请求相关参数
 log.info("==========================================APP Start ==========================================");
 if (Constants.ACTIVE_PROD.equals(active)) { 
 // 打印请求 url
 log.info("URL : {}", requestInfo.append(request.getRequestURL().toString().replace("http://127.0.0.1:8080/app", "")));
 } else { 
 // 打印请求 url
 log.info("URL : {}", requestInfo.append(request.getRequestURL().toString().replace("http://127.0.0.1:8080/app", "")));
 }
 // 打印 Http method
 log.info("HTTP 方法 : {}", request.getMethod());
 // 打印调用 controller 的全路径以及执行方法
 log.info("Class 方法 : {}.{}", joinPoint.getSignature().getDeclaringTypeName(), joinPoint.getSignature().getName());
 // 打印请求的 IP
 log.info("IP : {}", request.getRemoteAddr());
 // 打印请求入参
 log.info("Request 入参 : {}", JSON.toJSONString(joinPoint.getArgs()));
 }
 
 /** * AOP切面代码后侵入 * * @return void * @version 1.0.0 * @author SongWei * @date 2021/4/12 14:03 */
 public void addAppLogAfter() { 
 log.info("===========================================End ===========================================");
 // 每个请求之间空一行
 log.info("");
 }
 
 /** * AOP切面环绕代码侵入 * * @param proceedingJoinPoint * @return Object * @version 1.0.0 * @author SongWei * @date 2021/4/12 14:02 */
 public Object doAppLogAround(ProceedingJoinPoint proceedingJoinPoint) throws Throwable { 
 Object result = proceedingJoinPoint.proceed();
 // 打印出参
 log.info("Response 出参 : {}", JSON.toJSONString(result));
 // 执行耗时
 endTime = System.currentTimeMillis();
 log.info("请求耗时：{}", (endTime - startTime));
 return result;
 }

--------------------

# 总结 #

这篇文章可以配合我上一篇写到的[SpringBoot+Slf4j+Logback实现分包打印记录日志][SpringBoot_Slf4j_Logback]，一起使用

[SpringBoot_Slf4j_Logback]: https://blog.csdn.net/qq_20197983/article/details/115536974?spm=1001.2014.3001.5501