亲宝软件园·资讯

展开

SpringBoot自定义注解实现日志打印 Spring Boot怎样通过自定义注解实现日志打印详解

溪源的奇思妙想 人气:0
想了解Spring Boot怎样通过自定义注解实现日志打印详解的相关内容吗,溪源的奇思妙想在本文为您仔细讲解SpringBoot自定义注解实现日志打印的相关知识和一些Code实例,欢迎阅读和指正,我们先划重点:springboot自定义注解,springboot日志打印,springboot日志级别,下面大家一起来学习吧。

前言

在我们日常的开发过程中通过打印详细的日志信息能够帮助我们很好地去发现开发过程中可能出现的Bug,特别是在开发Controller层的接口时,我们一般会打印出Request请求参数和Response响应结果,但是如果这些打印日志的代码相对而言还是比较重复的,那么我们可以通过什么样的方式来简化日志打印的代码呢?

SpringBoot 通过自定义注解实现权限检查可参考我的博客:SpringBoot 通过自定义注解实现权限检查

正文

Spring AOP

Spring AOP 即面向切面,是对OOP面向对象的一种延伸。

AOP机制可以让开发者把业务流程中的通用功能抽取出来,单独编写功能代码。在业务流程执行过程中,Spring框架会根据业务流程要求,自动把独立编写的功能代码切入到流程的合适位置。

我们通过AOP机制可以实现:Authentication 权限检查、Caching 缓存、Context passing 内容传递、Error handling 错误处理、日志打印等功能,这里我们讲一下怎么用Spring AOP来实现日志打印。

SpringBoot通过自定义注解实现日志打印

Maven依赖

<!--lombok-->
<dependency>
 <groupId>org.projectlombok</groupId>
 <artifactId>lombok</artifactId>
 <version>1.18.2</version>
 <optional>true</optional>
</dependency>

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

ControllerMethodLog.class自定义注解

/**
* 自定义注解用于打印Controller层方式日志
*/
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
public @interface ControllerMethodLog {
}

这里特别讲一下@Retention,按生命周期来划分可分为3类:

这3个生命周期分别对应于:Java源文件(.java文件) —> .class文件 —> 内存中的字节码。

Spring AOP切面方法的执行顺序

这里简单介绍一下,切面的执行方法和其执行顺序:

这里以一个返回正常的情况为例:(异常替换最后一步即可)

ControllerMethodLogAspect.class:用于打印日志的切面定义类

注意要在启动类扫描这个class,并且添加 @EnableAspectJAutoProxy(proxyTargetClass = true)

@Slf4j
@Component
@Aspect
public class ControllerMethodLogAspect {

 @Pointcut("@annotation(com.xiyuan.demo.annotation.ControllerMethodLog)")
 public void pointCut() {
 }

 /**
 * 在切点运行前执行该方法
 */
 @Before("pointCut()")
 public void doBefore(JoinPoint joinPoint) {
 MethodSignature signature = (MethodSignature) joinPoint.getSignature();
 Method method = signature.getMethod();
 ControllerMethodLog annotation = method.getAnnotation(ControllerMethodLog.class);
 if (Objects.isNull(annotation)) {
  return;
 }
 String methodName = method.getDeclaringClass().getSimpleName() + "." + method.getName();
 log.info("start {}:入参:{}", methodName, JSON.toJSONString(joinPoint.getArgs()));
 }


 /**
 * 在切点运行后,无异常时执行该方法
 *
 * @param joinPoint
 * @param result
 */
 @AfterReturning(value = "pointCut()", returning = "result")
 public void afterReturn(JoinPoint joinPoint, Object result) {
 MethodSignature signature = (MethodSignature) joinPoint.getSignature();
 Method method = signature.getMethod();
 ControllerMethodLog annotation = method.getAnnotation(ControllerMethodLog.class);
 if (Objects.isNull(annotation)) {
  return;
 }
 String methodName = method.getDeclaringClass().getSimpleName() + "." + method.getName();
 log.info("end {}:响应:{}", methodName, JSON.toJSONString(result));
 }


}

验证

getUserById:根据id获取用户的信息

@GetMapping("/getUserById")
@ApiOperation(value = "根据用户id获取用户")
@ControllerMethodLog
public ResponseResult getUserById(@RequestParam(name = "id", required = true) String id) {
 UserInfoPojo userInfoPojo = userService.getUserById(id);
 return ResponseResult.success(userInfoPojo, ConstantsUtil.QUERY_SUCCESS);
}

Swagger接口信息如下:

IDEA控制台打印信息如下:

总结

加载全部内容

相关教程
猜你喜欢
用户评论