使用spring boot通过自定义注解打印所需日志

 更新时间:2021年07月26日 15:00:24   作者:kin_wen  
这篇文章主要介绍了使用spring boot通过自定义注解打印所需日志的操作,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教

spring boot自定义注解打印日志

在实际项目中可能需要监控每个接口的请求时间以及请求参数等相关信息,那么此时我们想到的就是两种实现方式,一种是通过拦截器实现,另一种则通过AOP自定义注解实现。

本文介绍自定义注解实现方式

自定义注解,四个元注解这次就不解释了。

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface WebLog {
    /**
     * 日志信息描述
     */
    String description() default "";
}

AOP实现:

1.@Order注解用来定义切面的执行顺序,数值越小优先级越高。

2.@Around环绕通知,我们可以自定义在什么时候执行@Before以及@After。

3.ThreadLocal针对每个线程都单独的记录。

@Aspect
@Component
public class WebLogAspect {
    private static ThreadLocal<ProceedingJoinPoint> td = new ThreadLocal<>();
    @Pointcut("@annotation(com.example.demo.annotation.WebLog)")
    @Order(1)
    public void webLog(){}
    @Before("webLog()")
    public void doBefor(JoinPoint point){
        System.out.println("***********method before执行************");
        ServletRequestAttributes attributes = (ServletRequestAttributes)RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();
        System.out.println("请求URL:"+request.getRequestURL());
        System.out.println("请求参数:"+ Arrays.toString(point.getArgs()));
        System.out.println("***********method before结束************");
    }
    @Around("webLog()")
    public Object doAround(ProceedingJoinPoint point) throws Throwable {
        System.out.println("***********执行环绕方法开始************");
        td.set(point);
        long startTime = System.currentTimeMillis();
        ProceedingJoinPoint joinPoint = td.get();
        Object proceed = joinPoint.proceed();
        System.out.println("执行耗时毫秒:"+ (System.currentTimeMillis()-startTime));
        System.out.println("***********执行环绕方法结束************");
        return proceed;
    }
}

Controller

@RestController
public class LoginController {
    @PostMapping("/user/login")
    @WebLog(description = "用户登录接口")
    public UserForm login(@RequestBody UserForm user){
        return user;
    }
}

测试结果

在这里插入图片描述

通过自定义注解获取日志

1.定义一个注解

package com.hisense.demo02; 
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
 
/**
 * @author : sunkepeng  E-mail : sunkepengouc@163.com
 * @date : 2020/8/8 20:09
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Check {
}

2.写一个测试用类,并使用注解

package com.hisense.demo02;
 
/**
 * @author : sunkepeng  E-mail : sunkepengouc@163.com
 * @date : 2020/8/8 20:04
 */
public class Calculator {
    @Check
    public void add(){
        System.out.println("1+0=" + (1+0));
    }
    @Check
    public void sub(){
        System.out.println("1-0=" + (1-0));
    }
    @Check
    public void mul(){
        System.out.println("1*0=" + (1*0));
    }
    @Check
    public void div(){
        System.out.println("1/0=" + (1/0));
    }
    public void show(){
        System.out.println("永无bug");
    }
}

3.使用注解,在测试类中输出log

package com.hisense.demo02; 
import java.io.BufferedWriter;
import java.io.FileWriter;
import java.io.IOException;
import java.lang.reflect.Method;
 
/**
 * @author : sunkepeng  E-mail : sunkepengouc@163.com
 * @date : 2020/8/8 21:39
 */
public class TestCheck {
    public static void main(String[] args) throws IOException {
        Calculator calculator = new Calculator();
        Class calculatorClass = calculator.getClass();
        Method[] methods = calculatorClass.getMethods();
        int number =0;
        BufferedWriter bufferedWriter = new BufferedWriter(new FileWriter("bug.txt"));
        for (Method method : methods) {
            if (method.isAnnotationPresent(Check.class)){
                try {
                    method.invoke(calculator);
                } catch (Exception e) {
                    number++;
                    bufferedWriter.write(method.getName()+"出现异常");
                    bufferedWriter.newLine();
                    bufferedWriter.write("异常的名称:"+e.getCause().getClass().getSimpleName());
                    bufferedWriter.newLine();
                    bufferedWriter.write("异常的原因"+e.getCause().getMessage());
                    bufferedWriter.newLine();
                    bufferedWriter.write("-----------------");
                    bufferedWriter.newLine();
                }
            }
        }
        bufferedWriter.write("本次共出现:"+number+"次异常");
        bufferedWriter.flush();
        bufferedWriter.close();
    }
}

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • SpringBoot实现异步调用的方法示例

    SpringBoot实现异步调用的方法示例

    本文介绍了在Java的SpringBoot中实现异步请求和异步调用的几种方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2025-01-01
  • JavaPoet的使用指南小结

    JavaPoet的使用指南小结

    这篇文章主要介绍了JavaPoet的使用指南小结,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-10-10
  • Java8 Supplier接口和Consumer接口原理解析

    Java8 Supplier接口和Consumer接口原理解析

    这篇文章主要介绍了Java8 Supplier接口和Consumer接口原理解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-04-04
  • 一文带你掌握java8中的reduce操作

    一文带你掌握java8中的reduce操作

    reduce 操作是一种通用的归约操作,它可以实现从 Stream 中生成一个值,其生成的值不是随意的,而是根据指定的计算模型,下面我们就来深入了解下java8中的reduce操作吧
    2023-12-12
  • java正则表达式之Pattern与Matcher类详解

    java正则表达式之Pattern与Matcher类详解

    这篇文章主要给大家介绍了关于java正则表达式之Pattern与Matcher类的相关资料,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-09-09
  • SpringMVC @RequestBody出现400 Bad Request的解决

    SpringMVC @RequestBody出现400 Bad Request的解决

    这篇文章主要介绍了SpringMVC @RequestBody出现400 Bad Request的解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-04-04
  • Java将中文转化为拼音的简单代码示例

    Java将中文转化为拼音的简单代码示例

    在我们使用手机通讯录或各种APP的搜索功能时,既可以根据中文搜索,也可以根据拼音搜索,这种时候就使用到了中文转拼音的功能了,下面这篇文章主要给大家介绍了关于Java将中文转化为拼音的简单代码示例,需要的朋友可以参考下
    2024-03-03
  • SpringBoot 使用Prometheus采集自定义指标数据的方案

    SpringBoot 使用Prometheus采集自定义指标数据的方案

    这篇文章主要介绍了SpringBoot 使用Prometheus采集自定义指标数据,我们在k8s集群成功搭建了Prometheus服务,今天,我们将在springboot2.x中使用prometheus记录指标,需要的朋友可以参考下
    2022-10-10
  • springboot下添加日志模块和设置日志文件输出的方法

    springboot下添加日志模块和设置日志文件输出的方法

    日志的使用将通过SLF4J来使用,SLF4J是一个为Java应用提供简单日志记录的接口,在Spring框架中,SLF4J常常用于处理框架本身以及应用程序的日志记录,本文给大家介绍springboot下添加日志模块和设置日志文件输出的相关知识,感兴趣的朋友一起看看吧
    2023-12-12
  • Java实战之飞翔的小鸟小游戏

    Java实战之飞翔的小鸟小游戏

    这篇文章主要介绍了Java实战之飞翔的小鸟小游戏,文中有非常详细的代码示例,对正在学习java的小伙伴们有非常好的帮助,需要的朋友可以参考下
    2021-04-04

最新评论