一、關於註解
1.1 簡介
Java 註解（Annotation）是一種特殊的語法結構，可以在程式碼中嵌入後設資料。它們不直接影響程式碼的執行，但可以透過工具和框架提供額外的資訊，幫助在編譯、部署或執行時進行處理。
初學者可以這樣理解註解：想像程式碼具有生命，註解就是對於程式碼中某些鮮活個體的貼上去的一張標籤。簡化來講，註解如同一張標籤。
1.2 發展
Java註解的發展可以追溯到Java 5.0的釋出，引入了註解這一特性，為開發者提供了一種新的後設資料形式，允許在程式碼中新增型別資訊而不改變程式的邏輯。以下是Java註解發展的一些關鍵里程碑：
- Java 5.0 (2004) : 引入了註解的概念，包括
@Override,@Deprecated,@SuppressWarnings等內建註解。 - Java 6.0 (2006) : 增加了對註解的元註解支援，例如
@Retention,@Target,@Documented，這些元註解可以用來定義其他註解的後設資料。 - Java 7.0 (2011) : 引入了
@SafeVarargs和@FunctionalInterface註解，用於提供關於可變引數和函式式介面的編譯時檢查。 - Java 8.0 (2014) : 引入了
@Repeatable註解，允許在一個元素上使用同一個註解型別多次。同時，Java 8也是Spring框架開始廣泛使用註解的時期，例如@Autowired,@RestController等。 - Java 11.0 (2018) : 在這個版本中，Java模組系統（Jigsaw專案）正式成為Java的一部分，引入了
@Module,@Requires,@Exports等模組相關的註解。 - Spring框架的發展: 從Spring 1.x的
@Transactional和@ManagedResource開始，Spring框架逐漸引入了更多的註解來簡化配置和提高開發效率。到了Spring 3.x，引入了@Configuration,@ComponentScan,@EnableAutoConfiguration等註解，進一步推動了註解程式設計的普及。 - Spring 4.x (2013) : 引入了
@Conditional註解，允許基於條件建立Bean，這是Spring Boot中自動配置的核心。 - Spring 5.x (2017) : 引入了
@Indexed註解，用於提高註解驅動的元件掃描效能。
Java註解的發展不僅提高了程式碼的可讀性和可維護性，也為框架和庫的開發者提供了強大的工具，使得他們能夠建立更加靈活和強大的API。隨著Java語言和相關框架的不斷進步，註解將繼續在軟體開發中扮演重要角色。
1.3 特點
Java註解是一種強大的工具，它使得程式碼更加清晰、模組化，並且可以與編譯器、開發工具和執行時環境緊密協作，提高開發效率和程式碼質量。
優點
-
增強程式碼可讀性
- 註解提供了清晰的後設資料，使程式碼更易於理解，特別是在使用框架時，可以減少對 XML 配置的依賴。
-
減少樣板程式碼
- 使用註解可以減少大量的樣板程式碼，簡化配置。例如，在 Spring 框架中，可以透過註解來代替繁瑣的 XML 配置。
-
編譯時檢查
- 透過註解處理器，可以在編譯時檢查註解的使用，幫助開發者及早發現問題，提升程式碼質量。
-
靈活性
- 註解可以與各種程式設計正規化結合使用，如物件導向程式設計、面向切面程式設計等，為開發者提供了靈活的程式設計方式。
-
支援超程式設計
- 註解與反射機制結合，可以在執行時動態地處理後設資料，適用於許多框架和庫的設計，如 ORM 和依賴注入。
-
自定義能力
- 開發者可以根據需要建立自定義註解，靈活地定義後設資料，滿足特定的需求。
缺點
-
效能開銷
- 使用反射機制讀取註解可能會帶來效能開銷，尤其是在大規模應用中，頻繁的反射呼叫會影響執行效率。
-
除錯困難
- 註解的使用可能使得除錯過程變得複雜，尤其是在錯誤資訊中不明確標識出注解的影響，可能導致追蹤問題時的困惑。
-
學習曲線
- 對於初學者而言，理解註解及其用法可能需要一定的學習成本，特別是在註解與反射結合使用時。
-
過度使用
- 過度使用註解可能導致程式碼難以維護和理解，尤其是當多個註解疊加在同一元素上時，可能使得邏輯變得複雜。
-
編譯器支援
- 並非所有的 IDE 和工具都完全支援註解的編寫和使用，可能會導致一些相容性問題。
-
不適用於所有場景
- 在一些簡單的場景中，使用註解可能顯得過於複雜，反而增加了開發和維護的成本。
1.4 使用場景
Java 註解在很多場景下都有應用，例如：
- 程式碼分析工具：例如使用
@Deprecated 標記方法過時，幫助開發者識別風險和改進程式碼。 - 編譯時處理：例如透過自定義註解，在編譯時生成輔助程式碼，如 Lombok 庫。
- 執行時處理：透過反射機制，可以在執行時獲取和處理註解資訊，實現動態的行為。
二、基本語法
Java 註解的語法主要包括定義註解、使用註解以及元註解。以下是具體的語法示例和解釋：
2.1 定義註解
使用 @interface 關鍵字定義一個註解。可以定義元素（屬性）和預設值。
public @interface MyAnnotation {
// 定義一個字串型別的元素，帶有預設值
String value() default "default value";
// 定義一個整型元素，帶有預設值
int count() default 0;
}
2.2 註解的元註解
元註解是用來註解其他註解的註解。Java 提供了以下元註解：
- @Retention：定義註解的生命週期。
- @Target：定義註解可以應用於哪些 Java 元素（類、方法、欄位等）。
- @Documented：表示該註解應該被 javadoc 工具記錄。
- @Inherited：表示該註解可以被子類繼承。
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Retention(RetentionPolicy.RUNTIME) // 註解在執行時可用
@Target(ElementType.METHOD) // 註解可以用於方法
public @interface MyMethodAnnotation {
String description();
}
2.3 使用註解
使用自定義註解時，直接在需要的元素上加上註解即可。
public class MyClass {
@MyMethodAnnotation(description = "This is a custom method annotation")
public void myAnnotatedMethod() {
// 方法實現
}
}
2.4 訪問註解
使用反射機制在執行時訪問註解資訊。
import java.lang.reflect.Method;
public class AnnotationExample {
public static void main(String[] args) throws Exception {
Method method = MyClass.class.getMethod("myAnnotatedMethod");
if (method.isAnnotationPresent(MyMethodAnnotation.class)) {
MyMethodAnnotation annotation = method.getAnnotation(MyMethodAnnotation.class);
System.out.println("Description: " + annotation.description());
}
}
}
2.5 組合註解
可以將多個註解組合在一起使用。
@MyAnnotation
@AnotherAnnotation
public class AnotherClass {
// 類實現
}
三、Java 預置的註解
Java 提供了一些預置的註解，這些註解在 Java 開發中非常常用。以下是一些主要的預置註解及其用途：
1. @Override
-
用途：用於指示一個方法重寫了超類的方法。
-
示例：
@Override public String toString() { return "This is my object"; }
2. @Deprecated
-
用途：標記一個元素（類、方法或欄位）為不推薦使用，可能在將來的版本中被刪除。
-
示例：
@Deprecated public void oldMethod() { // 不推薦使用 }
3. @SuppressWarnings
-
用途：抑制編譯器發出的特定警告。可以指定警告型別，如未使用的變數、未檢查的轉換等。
-
示例：
@SuppressWarnings("unchecked") public void myMethod() { List list = new ArrayList(); // 編譯器可能會發出未檢查的轉換警告 }
4. @FunctionalInterface
-
用途：用於指示一個介面是函式式介面，即該介面只包含一個抽象方法。
-
示例：
@FunctionalInterface public interface MyFunctionalInterface { void execute(); }
5. @SafeVarargs
-
用途：用於指示可變引數方法是型別安全的，適用於不可變的泛型。
-
示例：
@SafeVarargs public static <T> void safeMethod(T... elements) { // 處理元素 }
6. @Native
-
用途：標記一個欄位為本地常量，通常用於與 C/C++ 程式碼互動。
-
示例：
@Native public static final int NATIVE_CONSTANT = 100;
四、示例
示例1—使用註解（標記過時的方法）
在 Java 中，使用 @Deprecated 註解可以標記一個方法或類已經過時，鼓勵開發者使用新的實現或方法。
class DeprecatedExample {
@Deprecated
public void oldMethod() {
System.out.println("This method is deprecated.");
}
public void newMethod() {
System.out.println("This is the new method.");
}
public static void main(String[] args) {
DeprecatedExample obj = new DeprecatedExample();
// 呼叫過時的方法
obj.oldMethod();
// 呼叫新方法
obj.newMethod();
}
}
在這個示例中，oldMethod 被標記為過時的，當我們呼叫它時會得到編譯器警告，提醒我們不要繼續使用這個方法。
示例2—自定義註解
1.定義註解
//自定義註解必須的元註解target，指明註解的作用域（此處指明的是在類和方法上起作用）
@Target({ElementType.TYPE, ElementType.METHOD})
//元註解retention宣告該註解在何時起作用（此處指明的是在執行時起作用）
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
//註解中需宣告引數，格式為：引數型別 + 引數名();
String value() default "";
}
2.使用註解
public class CustomAnnotation {
@MyAnnotation(value = "這是一個測試方法")
public void test() {
System.out.println("執行 test 方法");
}
}
3.獲取和使用註解資訊
public class AnnotationDemo {
public static void main(String[] args) {
try {
// 獲取 CustomAnnotation 類的 Class 物件
Class<CustomAnnotation> clazz = CustomAnnotation.class;
// 獲取 test 方法
Method method = clazz.getMethod("test");
// 檢查該方法是否有 MyAnnotation 註解
if (method.isAnnotationPresent(MyAnnotation.class)) {
// 獲取 MyAnnotation 註解
MyAnnotation annotation = method.getAnnotation(MyAnnotation.class);
// 列印註解的 value 值
System.out.println("註解的值: " + annotation.value());
}
// 呼叫 test 方法
CustomAnnotation customAnnotation = new CustomAnnotation();
customAnnotation.test();
} catch (NoSuchMethodException e) {
throw new RuntimeException(e);
}
}
}