系统日志优化---自定义springboot-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.serviceNameprivate 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 {@Beanpublic CustomLogAspect customLogAspect(CustomLogProperties customLogProperties){return new CustomLogAspect(customLogProperties);}}

在resources下创建一个META-INF文件夹，然后在创建一个文件：spring.factories文件加入启用配置类的路径，springboot2.7之后有所不同，但是也兼容之前的版本写法
在这里插入图片描述
打包上传到maven私服(没搭建的直接install安装到本地maven仓库也可)

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