在 Spring Boot 中，自定義注解為我們提供了一種靈活且強大的方式來簡化開發、增強代碼的可讀性和可維護性。通過自定義注解，我們可以實現諸如統一日志記錄、性能監控、權限驗證等功能，而無需在每個業務方法中重復編寫相同的代碼。本文將深入探討如何在 Spring Boot 3.0 中創建和使用自定義注解，并提供具體的代碼示例。

一、自定義注解的場景與優勢

1.1 場景

在開發過程中，我們常常需要在多個地方實現相同的功能，例如日志記錄、性能監控、權限驗證等。如果直接在每個業務方法中編寫這些功能的代碼，會導致代碼重復和難以維護。

1.2 優勢

使用自定義注解的優勢在于：

• 減少重復代碼 ：通過注解的方式，將公共邏輯集中到一個地方，避免在多個地方重復編寫相同的代碼。
• 增強代碼可讀性 ：注解能夠清晰地表達方法的用途和行為，使代碼更具可讀性。
• 便于維護和擴展 ：當需要修改或擴展功能時，只需修改注解的實現邏輯，而無需在多個地方進行修改。

二、創建自定義注解

2.1 定義注解

使用 @interface 關鍵字定義注解，并通過 @Retention、@Target 等元注解來指定注解的保留策略和適用目標。

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;@Target(ElementType.METHOD) // 指定注解適用的目標類型為方法
@Retention(RetentionPolicy.RUNTIME) // 指定注解的保留策略為運行時
@Documented
public @interface LogAnnotation {String module() default ""; // 模塊名稱String operation() default ""; // 操作描述
}

2.2 創建注解處理器

通過創建注解處理器（Aspect），利用 AOP（面向切面編程）來攔截帶有自定義注解的方法，并在方法執行前后添加自定義邏輯。

import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;@Aspect
@Component
@Order(1) // 指定切面的順序
public class LogAspect {private static final Logger logger = LoggerFactory.getLogger(LogAspect.class);@Pointcut("@annotation(LogAnnotation)") // 定義切點，匹配使用了 LogAnnotation 的方法public void logPointcut() {}@Before("logPointcut()")public void doBefore() {logger.info("方法執行前，添加日志記錄邏輯");}
}

三、使用自定義注解

3.1 在業務方法上使用注解

在需要記錄日志的業務方法上添加自定義注解，指定模塊名稱和操作描述。

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;@RestController
@RequestMapping("/api")
public class DemoController {@GetMapping("/test")@LogAnnotation(module = "測試模塊", operation = "測試方法執行")public String test() {return "Hello, World!";}
}

3.2 配置類加載注解

確保 Spring 能夠掃描到自定義注解和注解處理器，可以在主應用類或配置類上添加 @ComponentScan 注解，指定掃描的包路徑。

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.ComponentScan;@SpringBootApplication
@ComponentScan(basePackages = "your.package.name") // 指定掃描的包路徑
public class Application {public static void main(String[] args) {SpringApplication.run(Application.class, args);}
}

四、總結

在 Spring Boot 中創建和使用自定義注解，可以幫助我們實現代碼的復用、增強代碼的可讀性和可維護性。通過定義注解、創建注解處理器，并在業務方法上使用注解，可以輕松實現諸如日志記錄、性能監控、權限驗證等功能。希望本文的示例和講解能夠幫助你更好地理解和應用 Spring Boot 3.0 中的自定義注解。