如何自定义springboot-starter日志组件供各个服务使用(系统日志优化)

 更新时间:2025年01月09日 11:11:08   作者:想寄给你一封情书  
文章介绍了如何将各个微服务的接口调用日志逻辑优化为一个可共享的Spring Boot Starter,通过自定义注解和自动装配机制实现,本文给大家介绍的非常详细,感兴趣的朋友跟随小编一起看看吧

在优化项目时发现各个微服务都有各自的接口调用日志逻辑,比如每个服务都定义一个aop类拦截,十分冗余,其实是可以做成starter被各个服务引用使用,前提要先了解一下springboot自动装配原理
创建springboot工程,如果是jdk8,下面的地址换成阿里的才能选

pom依赖

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.ming</groupId>
    <artifactId>log</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>customlog-spring-boot-starter</name>
    <description>customlog-spring-boot-starter</description>
    <properties>
        <java.version>1.8</java.version>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <spring-boot.version>2.6.13</spring-boot.version>
        <lombok.version>1.18.26</lombok.version>
    </properties>
    <dependencies>
        <!--aop-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>
        <!--写application.yml时会有提示,即当我输入custom时,会提示custom.log.serviceName-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>${lombok.version}</version>
        </dependency>
    </dependencies>
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>${spring-boot.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                    <encoding>UTF-8</encoding>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

项目结构很简单

注解

package com.ming.log.module.annotation;
import java.lang.annotation.*;
/**
 * 日志注解
 * @author ming
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface CustomLogAnnotation {
}

切面逻辑

package com.ming.log.module.aop;
import com.ming.log.module.config.CustomLogProperties;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.Signature;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.reflect.MethodSignature;
import java.lang.reflect.Method;
import java.util.Arrays;
/**
 * aop统一拦截
 * @author ming
 */
@Slf4j
@Aspect
public class CustomLogAspect {
    private CustomLogProperties customLogProperties;
    /**
     * 当一个bean没有无参构造器时,spring创建bean时,对于构造器参数会从容器中取,
     * 这里其实是省略了@Autowired,该注解可以用在方法参数上
     * @param customLogProperties
     */
    public CustomLogAspect(CustomLogProperties customLogProperties) {
        this.customLogProperties = customLogProperties;
    }
    @Around("@annotation(com.ming.log.module.annotation.CustomLogAnnotation)")
    public Object logInvoke(ProceedingJoinPoint joinPoint) throws Throwable {
        String serviceName = customLogProperties.getServiceName();
        //获取方法名称
        Signature sig = joinPoint.getSignature();
        MethodSignature mSig = (MethodSignature)sig;
        Method method = mSig.getMethod();
        String methodName = method.getName();
        Object obj = joinPoint.proceed();
        log.error("服务名:{}",serviceName);
        log.error("方法名:{}",methodName);
        log.error("方法参数:{}",Arrays.toString(joinPoint.getArgs()));
        log.error("方法返回值:{}",obj.toString());
        return obj;
    }
}

熟悉配置类

package com.ming.log.module.config;
import org.springframework.boot.context.properties.ConfigurationProperties;
import javax.annotation.PostConstruct;
//让配置文件中的属性根据前缀来注入对应的属性
@ConfigurationProperties(value ="custom.log")
public class CustomLogProperties {
    //日志服务名,会自动找配置文件中customLog.serviceName
    private String serviceName;
    public String getServiceName() {
        return serviceName;
    }
    public void setServiceName(String serviceName) {
        this.serviceName = serviceName;
    }
}

启用配置

package com.ming.log.module.config;
import com.ming.log.module.aop.CustomLogAspect;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
//将CustomLogProperties注入Spring容器
@EnableConfigurationProperties(CustomLogProperties.class)
public class CustomLogAutoConfiguration {
    @Bean
    public CustomLogAspect customLogAspect(CustomLogProperties customLogProperties){
        return new CustomLogAspect(customLogProperties);
    }
}

在resources下创建一个META-INF文件夹,然后在创建一个文件:spring.factories文件加入启用配置类的路径,springboot2.7之后有所不同,但是也兼容之前的版本写法

打包上传到maven私服(没搭建的直接install安装到本地maven仓库也可)

在别的工程引入,能这样看到基本就成功了

直接在方法上加@CustomLogAnnotation注解测试一下

到此为止已经成功,想做得好再好点的可以再把日志starter做成动态可插拔

到此这篇关于如何自定义springboot-starter日志组件供各个服务使用(系统日志优化)的文章就介绍到这了,更多相关springboot starter日志组件内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • java绘制国际象棋与中国象棋棋盘

    java绘制国际象棋与中国象棋棋盘

    这篇文章主要为大家详细介绍了java绘制国际象棋与中国象棋棋盘,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2019-05-05
  • HttpServletRequest对象常用功能_动力节点Java学院整理

    HttpServletRequest对象常用功能_动力节点Java学院整理

    这篇文章主要为大家详细介绍了HttpServletRequest对象常用功能的相关资料,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-07-07
  • Java基础之面向对象机制(多态、继承)底层实现

    Java基础之面向对象机制(多态、继承)底层实现

    这篇文章主要介绍了Java基础之面向对象机制(多态、继承)底层实现,文中有非常详细的代码示例,对正在学习java的小伙伴们有非常好的帮助,需要的朋友可以参考下
    2021-04-04
  • JAVA通过HttpURLConnection 上传和下载文件的方法

    JAVA通过HttpURLConnection 上传和下载文件的方法

    这篇文章主要介绍了JAVA通过HttpURLConnection 上传和下载文件的方法,非常具有实用价值,需要的朋友可以参考下
    2017-09-09
  • Java 常见的几种内存溢出异常的原因及解决

    Java 常见的几种内存溢出异常的原因及解决

    这篇文章主要介绍了Java 常见的几种内存溢出异常及解决,帮助大家更好的理解和学习使用Java,感兴趣的朋友可以了解下
    2021-04-04
  • Mybatis批量插入更新xml方式和注解方式的方法实例

    Mybatis批量插入更新xml方式和注解方式的方法实例

    这篇文章主要给大家介绍了关于Mybatis批量插入更新xml方式和注解方式的相关资料,文中通过示例代码介绍的非常详细,对大家学习或者使用Mybatis具有一定的参考学习价值,需要的朋友们下面来一起学习学习吧
    2019-12-12
  • 一文彻底搞懂Java和JDK的版本命名问题

    一文彻底搞懂Java和JDK的版本命名问题

    今天通过本文给大家分享我对Java的版本号以及JDK的命名的了解,通过实例图文展示给大家介绍的非常详细,需要的朋友跟随小编一起看看吧
    2021-06-06
  • SpringBoo项目打war包的多种方式

    SpringBoo项目打war包的多种方式

    在idea中,经常会对web项目进行打jar包或者war包,jar包在Java环境中运行,war包在Tomcat服务器中跑,对于打war包有多种方式,一下介绍3钟方式,需要的朋友可以参考下
    2024-06-06
  • Java 定时任务技术趋势详情

    Java 定时任务技术趋势详情

    这篇文章主要介绍了Java 定时任务技术趋势详情,定时任务是每个业务常见的需求,比如每分钟扫描超时支付的订单,每小时清理一次数据库历史数据,每天统计前一天的数据并生成报表等,下文更多相关资料,需要的小伙伴可以参考一下
    2022-05-05
  • Java利用TreeUtils工具类实现列表转树

    Java利用TreeUtils工具类实现列表转树

    在开发过程中,总有列表转树的需求,几乎是项目的标配,有没有一种通用且跨项目的解决方式呢?本文将基于Java8的Lambda 表达式和Stream等知识,使用TreeUtils工具类实现一行代码完成列表转树这一通用型需求,需要的可以参考一下
    2022-11-11

最新评论