解析springboot集成AOP实现日志输出的方法
开发接口系统中主要的一环就是日志输出，如果系统出现问题，日志能帮我们去定位问题，最常见的日志是调用方 所调用的IP 接口地址 对应方法 参数值 以及接口方接收到请求 所返回的参数。如果这需要在每一个controller层去写的话代码过于重复，于是就使用AOP定义切面 对其接口调用前后进行拦截日志输出。
1、加入依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>2、定义切面组件
import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import io.swagger.annotations.ApiOperation;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.Signature;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestAttributes;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import javax.servlet.http.HttpServletRequest;
import java.util.Arrays;
@Aspect
@Component
public class LogAspect {
private final Logger logger = LoggerFactory.getLogger(LogAspect.class);
@Pointcut("execution(public * cn.com.antMap.tree.controller.*.*(..))")
public void controllerMethod() {}
@Before("controllerMethod()")
public void LogRequestInfo(JoinPoint joinPoint) {
RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
HttpServletRequest request = ((ServletRequestAttributes)requestAttributes).getRequest();
StringBuilder requestLog = new StringBuilder();
Signature signature = joinPoint.getSignature();
// 打印请求内容
logger.info("===============请求内容开始===============");
logger.info("请求地址:" + request.getRequestURL().toString());
logger.info("请求IP:" + request.getRemoteAddr());
logger.info("请求方式:" + request.getMethod());
logger.info("请求类方法:" + joinPoint.getSignature());
logger.info("请求类方法参数值:" + Arrays.toString(joinPoint.getArgs()));
// 处理请求参数
String[] paramNames = ((MethodSignature) signature).getParameterNames();
Object[] paramValues = joinPoint.getArgs();
int paramLength = null == paramNames ? 0 : paramNames.length;
if (paramLength == 0) {
requestLog.append("请求参数 = {} ");
} else {
requestLog.append("请求参数 = [");
for (int i = 0; i < paramLength - 1; i++) {
requestLog.append(paramNames[i]).append("=").append(JSONObject.toJSONString(paramValues[i])).append(",");
}
requestLog.append(paramNames[paramLength - 1]).append("=").append(JSONObject.toJSONString(paramValues[paramLength - 1])).append("]");
}
logger.info("请求参数明细:"+requestLog.toString());
logger.info("===============请求内容结束===============");
}
@AfterReturning(returning = "o", pointcut = "controllerMethod()")
public void logResultVOInfo(Object o){
logger.info("--------------返回内容开始----------------");
logger.info("Response内容:" + JSON.toJSONString(o));
logger.info("--------------返回内容结束----------------");
}
@AfterThrowing(pointcut = "controllerMethod()", throwing = "ex")
public void doAfterThrowing(JoinPoint joinPoint, Exception ex) {
String methodName = joinPoint.getSignature().getName();
List<Object> args = Arrays.asList(joinPoint.getArgs());
System.out.println("连接点方法为：" + methodName + ",参数为：" + args + ",异常为：" + ex);
}
}
其中spring.aop.auto属性默认是开启的，也就是说只要引入了AOP依赖后，默认已经增加了@EnableAspectJAutoProxy。
aop组件中用到了 @Pointcut(“execution(public * cn.com.antMap.tree.controller..(…))”)定义切面切入点 就是拦截这个包路径下的所有请求的方法
@Before(“controllerMethod()”) 切入点调用逻辑之前进行拦截
@AfterReturning(returning = “o”, pointcut = “controllerMethod()”) 切入点调用逻辑完成后进行拦截输出
@AfterThrowing(pointcut = “controllerMethod()”, throwing = “ex”) 切入点发生异常是进行拦截
到此这篇关于springboot集成AOP实现日志输出的文章就介绍到这了,更多相关springboot日志输出内容请搜索编程网以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程网！
免责声明：
① 本站未注明“稿件来源”的信息均来自网络整理。其文字、图片和音视频稿件的所属权归原作者所有。本站收集整理出于非商业性的教育和科研之目的，并不意味着本站赞同其观点或证实其内容的真实性。仅作为临时的测试数据，供内部测试之用。本站并未授权任何人以任何方式主动获取本站任何信息。
② 本站未注明“稿件来源”的临时测试数据将在测试完成后最终做删除处理。有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341
