SpringBoot中使用自定义注解，AOP统一处理打印日志
简述
打印日志这块，基本上每个程序都需要，有了日志的记录和输出，方便攻城狮们更好的监控项目和排查错误
通常日志这块，会用AOP写个切面，来进行一个统一处理，但是问题点是这样是锁定在controller层，不够灵活，如果只是单独的想让一个借口输出日志的话，就。。。。。。
最近在用SpringBoot框架，经常看一些这方面的博客，偶然间看到一篇利用注解来完成日志的统一处理问题，实现效果，只要把想输出日志的接口上加上注解就OK了，自己实现了一遍，完全OK，下面是自己实现的过程代码，
实现效果
有图可见，我只把登录接口上面加了日志注解
日志效果
实现步骤
1、确认pom.xml中有AOP的依赖
<!-- aop 依赖 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>
<!-- 日志打印格式 -->
<dependency>
<groupId>com.google.code.gson</groupId>
<artifactId>gson</artifactId>
<version>2.8.5</version>
</dependency>
2、自定义一个日志注解
package com.prereadweb.aspect.logs;
import java.lang.annotation.*;
/**
* @Description: 日志注解
* @author: Yangxf
* @date: 2019/5/9 17:57
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface WebLog {
/**
* @Function: 日志描述
* @author: YangXueFeng
* @Date: 2019/5/9 17:59
*/
String description() default "";
}
3、定义日志AOP切面
/**
* WebLogAspect.java
* com.prereadweb.aspect.logs
* Copyright (c) 2019, 北京链天下科技有限公司版权所有.
*/
package com.prereadweb.aspect.logs;
import com.google.gson.Gson;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.annotation.Profile;
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 java.lang.reflect.Method;
/**
* @Description: 日志切面类
* @author: Yangxf
* @date: 2019/5/9 18:01
*/
@Aspect
@Component
@Profile("dev")
public class WebLogAspect {
/* slf4j */
private final static Logger logger = LoggerFactory.getLogger(WebLogAspect.class);
/** 换行符 */
private static final String LINE_SEPARATOR = System.lineSeparator();
/**
* @Function: 切点
* <p>
* 以自定义注解@WebLog为切点
* </p>
* @author: YangXueFeng
* @Date: 2019/5/9 18:06
*/
@Pointcut("@annotation(com.prereadweb.aspect.logs.WebLog)")
public void webLog() {}
/**
* @Function: 在切点之前植入
* @author: YangXueFeng
* @Date: 2019/5/9 18:15
* @param: joinPoint
* @return: Throwable
*/
@Before("webLog()")
public void doBefore(JoinPoint joinPoint) throws Throwable {
// 开始打印请求日志
ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
HttpServletRequest request = attributes.getRequest();
// 获取 @WebLog 注解的描述信息
String methodDescription = getAspectLogDescription(joinPoint);
// 打印请求相关参数
logger.info("========================================== Start ==========================================");
// 打印请求 url
logger.info("URL : {}", request.getRequestURL().toString());
// 打印描述信息
logger.info("Description : {}", methodDescription);
// 打印 Http method
logger.info("HTTP Method : {}", request.getMethod());
// 打印调用 controller 的全路径以及执行方法
logger.info("Class Method : {}.{}", joinPoint.getSignature().getDeclaringTypeName(), joinPoint.getSignature().getName());
// 打印请求的 IP
logger.info("IP : {}", request.getRemoteAddr());
// 打印请求入参
logger.info("Request Args : {}", new Gson().toJson(joinPoint.getArgs()));
}
/**
* @Function: 在切点之后植入
* @author: YangXueFeng
* @Date: 2019/5/9 18:16
* @return: Throwable
*/
@After("webLog()")
public void doAfter() throws Throwable {
// 接口结束后换行，方便分割查看
logger.info("=========================================== End ===========================================" + LINE_SEPARATOR);
}
/**
* @Function: 环绕通知
* @author: YangXueFeng
* @Date: 2019/5/9 18:16
* @param: proceedingJoinPoint
* @return: Throwable
*/
@Around("webLog()")
public Object doAround(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
long startTime = System.currentTimeMillis();
Object result = proceedingJoinPoint.proceed();
// 打印出参
logger.info("Response Args : {}", new Gson().toJson(result));
// 执行耗时
logger.info("Time-Consuming : {} ms", System.currentTimeMillis() - startTime);
return result;
}
/**
* @Function: 获取切面注解的描述
* @author: YangXueFeng
* @Date: 2019/5/9 18:18
* @param: joinPoint切点
* @return: 描述信息
*/
public String getAspectLogDescription(JoinPoint joinPoint)
throws Exception {
String targetName = joinPoint.getTarget().getClass().getName();
String methodName = joinPoint.getSignature().getName();
Object[] arguments = joinPoint.getArgs();
Class targetClass = Class.forName(targetName);
Method[] methods = targetClass.getMethods();
StringBuilder description = new StringBuilder("");
for (Method method : methods) {
if (method.getName().equals(methodName)) {
Class[] clazzs = method.getParameterTypes();
if (clazzs.length == arguments.length) {
description.append(method.getAnnotation(WebLog.class).description());
break;
}
}
}
return description.toString();
}
}
到此就OK了，简介方便，这篇写的没有内涵，只是看大神技术博客自己实现了一下，证明好用
使用
直接在需要打印日志的接口上加上@WebLog注解即可
@RequestMapping("/getnewslist")
@WebLog(description = "请求了广场快讯list接口")
public Object newsList(@Param("..") NewsQueryForm queryForm) {
return newsViewService.newsList(queryForm);
}