springboot配置aop切面日志打印过程解析
这篇文章主要介绍了springboot配置aop切面日志打印过程解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
一、SpringBootAop说明
1.Aop
AOP(Aspect-OrientedProgramming，面向切面编程)，它利用一种”横切”的技术，将那些多个类的共同行为封装到一个可重用的模块。便于减少系统的重复代码，降低模块之间的耦合度，并有利于未来的可操作性和可维护性。
2.AOP相关概念：
Aspect（切面）：声明类似于Java中的类声明，在Aspect中会包含一些Pointcut及相应的Advice。
Jointpoint（连接点）：表示在程序中明确定义的点。包括方法的调用、对类成员的访问等。
Pointcut（切入点）：表示一个组Jointpoint，如方法名、参数类型、返回类型等等。
Advice（通知）：Advice定义了在Pointcut里面定义的程序点具体要做的操作，它通过(before、around、after(return、throw)、finally来区别实在每个Jointpoint之前、之后还是执行前后要调用的代码。
Before：在执行方法前调用Advice，比如请求接口之前的登录验证。
Around：在执行方法前后调用Advice，这是最常用的方法。
After：在执行方法后调用Advice，after、return是方法正常返回后调用，after\throw是方法抛出异常后调用。
Finally：方法调用后执行Advice，无论是否抛出异常还是正常返回。
AOPproxy：AOPproxy也是Java对象，是由AOP框架创建，用来完成上述动作，AOP对象通常可以通过JDKdynamicproxy完成，或者使用CGLIb完成。
Weaving：实现上述切面编程的代码织入，可以在编译时刻，也可以在运行时刻，Spring和其它大多数Java框架都是在运行时刻生成代理。
二、代码示例
1.POM引入
org.springframework.boot spring-boot-starter-web org.springframework.boot spring-boot-starter-aop eu.bitwalker UserAgentUtils 1.21 org.projectlombok lombok 1.18.10
2、切面：WebLogAspect代码
/**
*添加aop日志打印
*
*@author马振全2020/1/1314:42
*/
@Aspect
@Component
@Slf4j
publicclassWebLogAspect{
/**
*进入方法时间戳
*/
privateLongstartTime;
/**
*方法结束时间戳(计时)
*/
privateLongendTime;
publicWebLogAspect(){
}
/**
*定义请求日志切入点，其切入点表达式有多种匹配方式,这里是指定路径
*/
@Pointcut("execution(public*com.soyoung.ad.engine.controller.*.*(..))")
publicvoidwebLogPointcut(){
}
/**
*前置通知：
*1.在执行目标方法之前执行，比如请求接口之前的登录验证;
*2.在前置通知中设置请求日志信息，如开始时间，请求参数，注解内容等
*
*@paramjoinPoint
*@throwsThrowable
*/
@Before("webLogPointcut()")
publicvoiddoBefore(JoinPointjoinPoint){
//接收到请求，记录请求内容
ServletRequestAttributesattributes=(ServletRequestAttributes)RequestContextHolder.getRequestAttributes();
HttpServletRequestrequest=attributes.getRequest();
//获取请求头中的User-Agent
UserAgentuserAgent=UserAgent.parseUserAgentString(request.getHeader("User-Agent"));
//打印请求的内容
startTime=System.currentTimeMillis();
log.info("请求开始时间：{}",LocalDateTime.now());
log.info("请求Url:{}",request.getRequestURL().toString());
log.info("请求方式:{}",request.getMethod());
log.info("请求ip:{}",request.getRemoteAddr());
log.info("请求方法:",joinPoint.getSignature().getDeclaringTypeName()+"."+joinPoint.getSignature().getName());
log.info("请求参数:{}",Arrays.toString(joinPoint.getArgs()));
//系统信息
log.info("浏览器：{}",userAgent.getBrowser().toString());
log.info("浏览器版本：{}",userAgent.getBrowserVersion());
log.info("操作系统:{}",userAgent.getOperatingSystem().toString());
}
/**
*返回通知：
*1.在目标方法正常结束之后执行
*1.在返回通知中补充请求日志信息，如返回时间，方法耗时，返回值，并且保存日志信息
*
*@paramret
*@throwsThrowable
*/
@AfterReturning(returning="ret",pointcut="webLogPointcut()")
publicvoiddoAfterReturning(Objectret)throwsThrowable{
endTime=System.currentTimeMillis();
log.info("请求结束时间：{}",LocalDateTime.now());
log.info("请求耗时：{}",(endTime-startTime));
//处理完请求，返回内容
log.info("请求返回:{}",ret);
}
/**
*异常通知：
*1.在目标方法非正常结束，发生异常或者抛出异常时执行
*1.在异常通知中设置异常信息，并将其保存
*
*@paramthrowable
*/
@AfterThrowing(value="webLogPointcut()",throwing="throwable")
publicvoiddoAfterThrowing(Throwablethrowable){
//保存异常日志记录
log.error("发生异常时间：{}",LocalDateTime.now());
log.error("抛出异常：{}",throwable.getMessage());
}
}
3、@Before和@AfterReturning部分也可使用以下代码替代
/**
*在执行方法前后调用Advice，这是最常用的方法，相当于@Before和@AfterReturning全部做的事儿
*@parampjp
*@return
*@throwsThrowable
*/
@Around("webLogPointcut()")
publicObjectdoAround(ProceedingJoinPointpjp)throwsThrowable{
//接收到请求，记录请求内容
ServletRequestAttributesattributes=(ServletRequestAttributes)RequestContextHolder.getRequestAttributes();
HttpServletRequestrequest=attributes.getRequest();
//获取请求头中的User-Agent
UserAgentuserAgent=UserAgent.parseUserAgentString(request.getHeader("User-Agent"));
//打印请求的内容
startTime=System.currentTimeMillis();
log.info("请求Url:{}",request.getRequestURL().toString());
log.info("请求方式:{}",request.getMethod());
log.info("请求ip:{}",request.getRemoteAddr());
log.info("请求方法:",pjp.getSignature().getDeclaringTypeName(),".",pjp.getSignature().getName());
log.info("请求参数:{}",Arrays.toString(pjp.getArgs()));
//系统信息
log.info("浏览器：{}",userAgent.getBrowser().toString());
log.info("浏览器版本：{}",userAgent.getBrowserVersion());
log.info("操作系统:{}",userAgent.getOperatingSystem().toString());
//pjp.proceed()：当我们执行完切面代码之后，还有继续处理业务相关的代码。proceed()方法会继续执行业务代码，并且其返回值，就是业务处理完成之后的返回值。
Objectret=pjp.proceed();
log.info("请求结束时间："+LocalDateTime.now());
log.info("请求耗时：{}",(System.currentTimeMillis()-startTime));
//处理完请求，返回内容
log.info("请求返回:",ret);
returnret;
}
4、测试结果
2020-01-1315:18:21.309INFOxxx.WebLogAspect:请求开始时间：2020-01-13T15:18:21.309
2020-01-1315:18:21.309INFOxxx.WebLogAspect:请求Url:http://localhost:8020/api/v1/hourlyStat/findHourlyStatReportList
2020-01-1315:18:21.320INFOxxx.WebLogAspect:请求方式:POST
2020-01-1315:18:21.321INFOxxx.WebLogAspect:请求ip:0:0:0:0:0:0:0:1
2020-01-1315:18:21.322INFOxxx.WebLogAspect:请求方法:
2020-01-1315:18:21.325INFOxxx.WebLogAspect:请求参数:[HourlyStat{subStrategyId=null}]
2020-01-1315:18:21.326INFOxxx.WebLogAspect:浏览器：CHROME
2020-01-1315:18:21.327INFOxxx.WebLogAspect:浏览器版本：78.0.3904.108
2020-01-1315:18:21.333INFOxxx.WebLogAspect:操作系统:WINDOWS_10
2020-01-1315:18:21.403INFOxxx.WebLogAspect:请求结束时间：2020-01-13T15:18:21.403
2020-01-1315:18:21.405INFOxxx.WebLogAspect:请求耗时：94
2020-01-1315:18:21.405INFOxxx.WebLogAspect:请求返回:com.soyoung.ad.engine.common.Result@2f935d03
2020-01-1315:18:21.492INFOxxx.WebLogAspect:请求结束时间：2020-01-13T15:18:21.492
2020-01-1315:18:21.493INFOxxx.WebLogAspect:请求耗时：183
2020-01-1315:18:21.494INFOxxx.WebLogAspect:请求返回:com.soyoung.ad.engine.common.Result@7199e922
2020-01-1315:18:42.859INFOxxx.WebLogAspect:请求开始时间：2020-01-13T15:18:42.859
2020-01-1315:18:42.860INFOxxx.WebLogAspect:请求Url:http://localhost:8020/api/v1/hourlyStat/findHourlyStatReportList
2020-01-1315:18:42.860INFOxxx.WebLogAspect:请求方式:POST
2020-01-1315:18:42.861INFOxxx.WebLogAspect:请求ip:0:0:0:0:0:0:0:1
2020-01-1315:18:42.861INFOxxx.WebLogAspect:请求方法:
2020-01-1315:18:42.862INFOxxx.WebLogAspect:请求参数:[HourlyStat{subStrategyId=1003}]
2020-01-1315:18:42.862INFOxxx.WebLogAspect:浏览器：CHROME
2020-01-1315:18:42.863INFOxxx.WebLogAspect:浏览器版本：78.0.3904.108
2020-01-1315:18:42.864INFOxxx.WebLogAspect:操作系统:WINDOWS_10
2020-01-1315:18:42.909INFOxxx.WebLogAspect:请求结束时间：2020-01-13T15:18:42.909
2020-01-1315:18:42.910INFOxxx.WebLogAspect:请求耗时：50
2020-01-1315:18:42.910INFOxxx.WebLogAspect:请求返回:com.soyoung.ad.engine.common.Result@7d494cbd
以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持毛票票。
声明：本文内容来源于网络，版权归原作者所有，内容由互联网用户自发贡献自行上传，本网站不拥有所有权，未作人工编辑处理，也不承担相关法律责任。如果您发现有涉嫌版权的内容，欢迎发送邮件至：czq8825#qq.com（发邮件时，请将#更换为@）进行举报，并提供相关证据，一经查实，本站将立刻删除涉嫌侵权内容。