如何自定義springboot-starter日志組件供各個服務使用(系統日志優(yōu)化)
在優(yōu)化項目時發(fā)現各個微服務都有各自的接口調用日志邏輯,比如每個服務都定義一個aop類攔截,十分冗余,其實是可以做成starter被各個服務引用使用,前提要先了解一下springboot自動裝配原理
創(chuàng)建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創(chuàng)建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下創(chuàng)建一個META-INF文件夾,然后在創(chuàng)建一個文件:spring.factories文件加入啟用配置類的路徑,springboot2.7之后有所不同,但是也兼容之前的版本寫法

打包上傳到maven私服(沒搭建的直接install安裝到本地maven倉庫也可)

在別的工程引入,能這樣看到基本就成功了


直接在方法上加@CustomLogAnnotation注解測試一下

到此為止已經成功,想做得好再好點的可以再把日志starter做成動態(tài)可插拔
到此這篇關于如何自定義springboot-starter日志組件供各個服務使用(系統日志優(yōu)化)的文章就介紹到這了,更多相關springboot starter日志組件內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家!
相關文章
淺談Ribbon、Feign和OpenFeign的區(qū)別
這篇文章主要介紹了淺談Ribbon、Feign和OpenFeign的區(qū)別。具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2021-06-06
spring中FactoryBean中的getObject()方法實例解析
這篇文章主要介紹了spring中FactoryBean中的getObject()方法實例解析,分享了相關代碼示例,小編覺得還是挺不錯的,具有一定借鑒價值,需要的朋友可以參考下2018-02-02
SpringBoot集成WebServlet出現自定義servlet請求失敗的問題解決方案
SpringBoot中以Bean方式注冊Servlet時遇到的問題,通過了解DispatcherServlet的原理,發(fā)現默認路徑沖突是主要原因,本文介紹SpringBoot集成WebServlet出現自定義servlet請求失敗的問題解決方案,感興趣的朋友一起看看吧2025-03-03

