自定義 Spring 通用日誌註解 1. 註解@Metrics @Retention(RetentionPolicy.RUNTIME) @Target({ElementType.METHOD, ElementType.TYPE}) public @interface Metrics { /** * ...
目錄
自定義 Spring 通用日誌註解
1. 註解@Metrics
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.TYPE})
public @interface Metrics {
/**
* 在方法成功執行後打點，記錄方法的執行時間發送到指標系統，預設開啟
*/
boolean recordSuccessMetrics() default true;
/**
* 在方法成功失敗後打點，記錄方法的執行時間發送到指標系統，預設開啟
*/
boolean recordFailMetrics() default true;
/**
* 通過日誌記錄請求參數，預設開啟
*/
boolean logParameters() default true;
/**
* 通過日誌記錄方法返回值，預設開啟
*/
boolean logReturn() default true;
/**
* 出現異常後通過日誌記錄異常信息，預設開啟
*/
boolean logException() default true;
/**
* 出現異常後忽略異常返回預設值，預設關閉
*/
boolean ignoreException() default false;
2. 切麵MetricsAspect
@Aspect
@Slf4j
@Order(Ordered.HIGHEST_PRECEDENCE)
public class MetricsAspect {
/**
* 讓Spring幫我們註入ObjectMapper，以方便通過JSON序列化來記錄方法入參和出參
*/
@Resource
private ObjectMapper objectMapper;
/**
* 實現一個返回Java基本類型預設值的工具。其實，你也可以逐一寫很多if-else判斷類型，然後手動設置其預設值。
* 這裡為了減少代碼量用了一個小技巧，即通過初始化一個具有1個元素的數組，然後通過獲取這個數組的值來獲取基本類型預設值
*/
private static final Map<Class<?>, Object> DEFAULT_VALUES = Stream
.of(boolean.class, byte.class, char.class, double.class, float.class, int.class, long.class, short.class)
.collect(toMap(clazz -> clazz, clazz -> Array.get(Array.newInstance(clazz, 1), 0)));
public static <T> T getDefaultValue(Class<T> clazz) {
//noinspection unchecked
return (T) DEFAULT_VALUES.get(clazz);
}
/**
* 標記了Metrics註解的方法進行匹配
*/
@Pointcut("@annotation(com.common.config.metrics.annotation.Metrics)")
public void withMetricsAnnotationMethod() {
}
/**
* within指示器實現了匹配那些類型上標記了@RestController註解的方法
* 註意這裡使用了@，標識了對註解標註的目標進行切入
*/
@Pointcut("within(@org.springframework.web.bind.annotation.RestController *)")
public void controllerBean() {
}
@Pointcut("@within(com.common.config.metrics.annotation.Metrics)")
public void withMetricsAnnotationClass() {
}
@Around("controllerBean() || withMetricsAnnotationMethod() || withMetricsAnnotationClass()")
public Object metrics(ProceedingJoinPoint pjp) throws Throwable {
// 通過連接點獲取方法簽名和方法上Metrics註解，並根據方法簽名生成日誌中要輸出的方法定義描述
MethodSignature signature = (MethodSignature) pjp.getSignature();
Metrics metrics = signature.getMethod().getAnnotation(Metrics.class);
String name = String.format("【%s】【%s】", signature.getDeclaringType().toString(), signature.toLongString());
if (metrics == null) {
@Metrics
final class InnerClass {
}
metrics = InnerClass.class.getAnnotation(Metrics.class);
}
// 嘗試從請求上下文獲得請求URL
RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
if (requestAttributes != null) {
HttpServletRequest request = ((ServletRequestAttributes) requestAttributes).getRequest();
name += String.format("【%s】", request.getRequestURL().toString());
}
// 入參的日誌輸出
if (metrics.logParameters()) {
log.info(String.format("【入參日誌】調用 %s 的參數是：【%s】", name, objectMapper.writeValueAsString(pjp.getArgs())));
}
// 連接點方法的執行，以及成功失敗的打點，出現異常的時候記錄日誌
Object returnValue;
Instant start = Instant.now();
try {
returnValue = pjp.proceed();
if (metrics.recordSuccessMetrics()) {
// 在生產級代碼中，應考慮使用類似Micrometer的指標框架，把打點信息記錄到時間序列資料庫中，實現通過圖表來查看方法的調用次數和執行時間，
log.info(String.format("【成功打點】調用 %s 成功，耗時：%d ms", name, Duration.between(start, Instant.now()).toMillis()));
}
} catch (Exception ex) {
if (metrics.recordFailMetrics()) {
log.info(String.format("【失敗打點】調用 %s 失敗，耗時：%d ms", name, Duration.between(start, Instant.now()).toMillis()));
}
if (metrics.logException()) {
log.error(String.format("【異常日誌】調用 %s 出現異常！", name), ex);
}
if (metrics.ignoreException()) {
returnValue = getDefaultValue(signature.getReturnType());
} else {
throw ex;
}
}
// 返回值輸出
if (metrics.logReturn()) {
log.info(String.format("【出參日誌】調用 %s 的返回是：【%s】", name, returnValue));
}
return returnValue;
}
3. 自動註入AutoConfiguration
@AutoConfiguration
@Slf4j
@EnableConfigurationProperties(MetricsProperties.class)
@ConditionalOnProperty(prefix = "common.metrics", name = {"keep-alive"}, havingValue = "true", matchIfMissing = true)
public class AspectAutoConfiguration {
public AspectAutoConfiguration() {
log.info("AspectAutoConfiguration initialize.");
}
@Bean
public MetricsAspect metricsAspect() {
return new MetricsAspect();
}
}
4. 配置文件MetricsProperties
@ConfigurationProperties(prefix = "common.metrics")
public class MetricsProperties {
public Boolean getKeepAlive() {
return keepAlive;
}
public void setKeepAlive(Boolean keepAlive) {
this.keepAlive = keepAlive;
}
private Boolean keepAlive = true;
}
5. 其它配置
配置自動註入
配置resource.META-INF.spring.org.springframework.boot.autoconfigure.AutoConfiguration.imports文件，增加RunsOnProfilesAutoConfiguration類路徑。
配置文件提示
{
"groups": [],
"properties": [
{
"name": "common.metrics.keepAlive",
"type": "java.lang.Boolean",
"sourceType": "com.common.config.metrics.properties.MetricsProperties"
}
]
}
