详解SpringBoot Start组件开发之记录接口日志信息

 更新时间:2023年04月28日 10:00:18   作者:Anoxia1  
这篇文章主要为大家介绍了SpringBoot-Start组件开发之记录接口日志信息详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪

前言

不积跬步无以至千里,不积小流,无以成江海

在公司一般来说,都只会接触一些CRUD的业务,很多时候可能你想设计很多的代码结构,但是时间不允许。近期接到一个项目,领导说要扩展、要兼容、等等等。然后我就想着那我就花点时间把代码结构设计一下,然后给出排期,当领导看到我的排期时间的时候,他跟我说,我们要小步快跑,我觉得他在CPU我,明明上一次还再说要扩展要兼容的。 自己去完成一些springboot-start的功能实现, 我觉得是一个很锻炼人的方式,一是可以让自己多去思考自己的代码改怎么组织,再一个是springboot-start一般都是抽出一些公共的逻辑,所以这对我们理解项目的能力也有一定的要求。springboot 存在很多的start组件,他们可以很方便的帮我们注入一些我们需要的功能,不需要的时候,直接删除依赖就可以了,开发出来的组件 可以拔插式的接入项目。

目标

基于 AOP 实现系统监控,主要是通过aop切面功能来增强方法,实现监控。

设计

项目结构

cn-anoxia-start-log
└── src
    ├── main
    │   └── java
    │       ├── cn.anoxia.log
    │       │   ├── annotation
    │       │   │   └── LogCheck.java
    │       │   ├── config
    │       │   │   └── LogAutoConfigure.java
    │       │   └── LogCheckJoinPoint.java
    │       └── resources
    │           └── META-INF 
    │               └── spring.factories
    └── test
        └── java
            └── cn.anoxia.log.test
                └── ApiTest.java

实现过程主要是通过AOP拦截注解,然后对方法进行处理

  • LogCheck 自定义注解,主要作用就是添加到需要监控的方法上。
  • LogAutoConfigure 配置类,对一些类做初始化操作。
  • LogCheckJoinPoint 核心类,负责对拦截的方法做逻辑处理。
  • spring.factories spring-boot 自动注入的配置文件。

springboot 在启动的时候 读取spring.factories里面的内容,然后把配置类添加到spring容器中。 使用 springboot的自动注入的功能完成配置的加载。

org.springframework.boot.autoconfigure.EnableAutoConfiguration=cn.anoxia.log.config.LogAutoConfigure

自定义拦截注解LogCheck

/**
 * @description: 方法耗时检测注解
 * @author:huangle
 * @date: 2022/7/22
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE,ElementType.METHOD})
public @interface LogCheck {
    String key() default "";
    String desc() default "";
}

AOP 处理类, 定义切点为 注解,然后使用 环绕处理 对方法进行增强。

/**
 * @description: aop拦截注解,进行方法增强
 * @author:huangle
 * @date: 2022/7/22
 */
@Aspect
@Component
public class LogCheckJoinPoint {
    private final Logger logger = LoggerFactory.getLogger(LogCheckJoinPoint.class);
    @Pointcut("@annotation(cn.anoxia.log.annotation.LogCheck)")
    public void aopPoint(){
        // 定义切点
    }
    @Around("aopPoint() && @annotation(logCheck)")
    public void doCheck(ProceedingJoinPoint joinPoint, LogCheck logCheck) throws Throwable {
        // 执行前增强
        logger.info("当前执行的类:{}",joinPoint.getClass());
        Method method = getMethod(joinPoint);
        Long start = System.currentTimeMillis();
        try {
            // 执行目标方法
            joinPoint.proceed();
        }finally {
            System.out.println("监控 - Begin By AOP");
            System.out.println("监控索引:" + logCheck.key());
            System.out.println("监控描述:" + logCheck.desc());
            System.out.println("方法名称:" + method.getName());
            System.out.println("方法耗时:" + (System.currentTimeMillis() - start) + "ms");
            System.out.println("监控 - End\r\n");
        }
    }
    private Method getMethod(JoinPoint jp) throws NoSuchMethodException {
        Signature sig = jp.getSignature();
        MethodSignature methodSignature = (MethodSignature) sig;
        return jp.getTarget().getClass().getMethod(methodSignature.getName(), methodSignature.getParameterTypes());
    }
}

配置类里面的内容, 对核心类进行初始化,并且添加到spring容器

@Configuration
public class LogAutoConfigure implements EnvironmentAware {
    private final Logger logger = LoggerFactory.getLogger(LogAutoConfigure.class);
    private final Map<String,Object> logConfigMap = new HashMap<>();
    @Bean
    @ConditionalOnMissingBean
    public LogCheckJoinPoint point(){
        return new LogCheckJoinPoint();
    }
}

测试

创建一个项目,然后导入我们创建的start

<dependency>
            <groupId>cn.anoxia</groupId>
            <artifactId>anoxia-spring-start-log</artifactId>
            <version>1.0.0-SNAPSHOT</version>
        </dependency>

添加注解,拦截方法

@LogCheck(key = "cn.anoxia.demo.controller.TestController",desc = "获取用户信息")
    @RequestMapping("/v1/info")
    public String testController(){
        return "hello";
    }

测试结果,可以获取到执行方法的一些信息,并且对方法进行增强。

总结

在我们开发组件的时候,主要是添加一个配置文件 spring.factories让spring-boot在启动的时候,把我们添加的类注入进去,然后直接就在项目中使用。

以上就是SpringBoot-Start组件开发之记录接口日志信息的详细内容,更多关于SpringBoot-Start组件开发之记录接口日志信息的资料请关注脚本之家其它相关文章!

相关文章

  • IDEA一致卡在build时间过长问题解决

    IDEA一致卡在build时间过长问题解决

    有很多小伙伴在起项目的时候巨慢,特别影响开发效率,本文主要介绍了IDEA一致卡在build时间过长问题解决,具有一定的参考价值,感兴趣的可以了解一下
    2024-06-06
  • 基于SpringBoot实现自定义插件的流程详解

    基于SpringBoot实现自定义插件的流程详解

    在SpringBoot中,插件是一种扩展机制,它可以帮助我们在应用程序中快速地添加一些额外的功能,在本文中,我们将介绍如何使用 SpringBoot实现自定义插件,需要的朋友可以参考下
    2023-06-06
  • 最新版Spring Security中的路径匹配方案

    最新版Spring Security中的路径匹配方案

    在 Spring Security 中,路径匹配是权限控制的核心部分,它决定了哪些请求可以访问特定的资源,本文将详细介绍 Spring Security 中的路径匹配策略,并提供相应的代码示例,需要的朋友可以参考下
    2024-04-04
  • JavaWeb实现简单用户发送邮件

    JavaWeb实现简单用户发送邮件

    这篇文章主要为大家详细介绍了JavaWeb实现简单用户发送邮件,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-08-08
  • java对xml节点属性的增删改查实现方法

    java对xml节点属性的增删改查实现方法

    下面小编就为大家带来一篇java对xml节点属性的增删改查实现方法。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2016-10-10
  • SpringbootJPA分页 PageRequest过时的替代方法

    SpringbootJPA分页 PageRequest过时的替代方法

    这篇文章主要介绍了SpringbootJPA分页 PageRequest过时的替代方法,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-06-06
  • Java字符串操作和C#字符串操作的不同小结

    Java字符串操作和C#字符串操作的不同小结

    在JAVA语言中,字符串数据实际上由String类所实现的。下面这篇文章主要给大家介绍了关于Java字符串操作和C#字符串操作的不同的相关资料,文中通过示例代码介绍的非常详细,需要的朋友可以参考下
    2018-12-12
  • 详解Spring Security中权限注解的使用

    详解Spring Security中权限注解的使用

    这篇文章主要为大家详细介绍一下Spring Security中权限注解的使用方法,文中的示例代码讲解详细,对我们学习或工作有一定参考价值,需要的可以参考一下
    2022-05-05
  • idea更改默认缓存位置的步骤详解

    idea更改默认缓存位置的步骤详解

    在idea使用中,会产生大量的缓存,一般默认存放在C盘里面,会加大C盘的储存负担,如果C盘足够大,可以不考虑更改idea的缓存位置,所以本文小编给如何更改idea默认缓存位置,文中通过图文结合介绍的非常详细,需要的朋友可以参考下
    2023-12-12
  • 原来Java接口多实现还可以这样玩

    原来Java接口多实现还可以这样玩

    JAVA中类不直接支持多继承,因为会出现调用的不确定性,所以JAVA将多继承机制进行改良,在JAVA中变成了多实现,这篇文章主要给大家介绍了关于Java接口多实现的相关资料,需要的朋友可以参考下
    2021-09-09

最新评论