Java註解Annotation原理及自定義註解程式碼例項
什麼是註解？
對於很多初次接觸的開發者來說應該都有這個疑問？Annontation是Java5開始引入的新特徵，中文名稱叫註解。它提供了一種安全的類似註釋的機制，用來將任何的資訊或元資料（metadata）與程式元素（類、方法、成員變數等）進行關聯。為程式的元素（類、方法、成員變數）加上更直觀更明瞭的說明，這些說明資訊是與程式的業務邏輯無關，並且供指定的工具或框架使用。
Annontation像一種修飾符一樣，應用於包、型別、構造方法、方法、成員變數、引數及本地變數的宣告語句中。
Java註解是附加在程式碼中的一些元資訊，用於一些工具在編譯、執行時進行解析和使用，起到說明、配置的功能。註解不會也不能影響程式碼的實際邏輯，僅僅起到輔助性的作用。包含在 java.lang.annotation 包中。
註解的用處：
1、生成文件。這是最常見的，也是java 最早提供的註解。常用的有@param @return 等
2、跟蹤程式碼依賴性，實現替代配置檔案功能。比如Dagger 2 依賴注入，未來java 開發，將大量註解配置，具有很大用處;
3、在編譯時進行格式檢查。如@override 放在方法前，如果你這個方法並不是覆蓋了超類方法，則編譯時就能檢查出。
註解的原理：
註解本質是一個繼承了Annotation 的特殊介面，其具體實現類是Java 執行時生成的動態代理類。而我們通過反射獲取註解時，返回的是Java 執行時生成的動態代理物件$Proxy1。通過代理物件呼叫自定義註解（介面）的方法，會最終呼叫AnnotationInvocationHandler 的invoke 方法。該方法會從memberValues 這個Map 中索引出對應的值。而memberValues 的來源是Java 常量池。
元註解：
java.lang.annotation 提供了四種元註解，專門註解其他的註解（在自定義註解的時候，需要使用到元註解）：
- @Documented – 註解是否將包含在JavaDoc中
- @Retention – 什麼時候使用該註解
- @Target – 註解用於什麼地方
- @Inherited – 是否允許子類繼承該註解
1.）@Retention – 定義該註解的生命週期
● RetentionPolicy.SOURCE : 在編譯階段丟棄。這些註解在編譯結束之後就不再有任何意義，所以它們不會寫入位元組碼。@Override,@SuppressWarnings都屬於這類註解。
● RetentionPolicy.RUNTIME : 始終不會丟棄，執行期也保留該註解，因此可以使用反射機制讀取該註解的資訊。我們自定義的註解通常使用這種方式。
2.）Target – 表示該註解用於什麼地方。預設值為任何元素，表示該註解用於什麼地方。可用的ElementType 引數包括
● ElementType.CONSTRUCTOR: 用於描述構造器
● ElementType.FIELD: 成員變數、物件、屬性（包括enum例項）
● ElementType.LOCAL_VARIABLE: 用於描述區域性變數
● ElementType.METHOD: 用於描述方法
● ElementType.PACKAGE: 用於描述包
● ElementType.PARAMETER: 用於描述引數
● ElementType.TYPE: 用於描述類、介面(包括註解型別) 或enum宣告
3.)@Documented – 一個簡單的Annotations 標記註解，表示是否將註解資訊新增在java 文件中。
4.)@Inherited – 定義該註釋和子類的關係
@Inherited 元註解是一個標記註解，@Inherited 闡述了某個被標註的型別是被繼承的。如果一個使用了@Inherited 修飾的annotation 型別被用於一個class，則這個annotation 將被用於該class 的子類。
常見標準的Annotation：
1.）Override
java.lang.Override 是一個標記型別註解，它被用作標註方法。它說明了被標註的方法重寫了父類的方法，起到了斷言的作用。如果我們使用了這種註解在一個沒有覆蓋父類方法的方法時，java 編譯器將以一個編譯錯誤來警示。
2.）Deprecated
Deprecated 也是一種標記型別註解。當一個型別或者型別成員使用@Deprecated 修飾的話，編譯器將不鼓勵使用這個被標註的程式元素。所以使用這種修飾具有一定的“延續性”：如果我們在程式碼中通過繼承或者覆蓋的方式使用了這個過時的型別或者成員，雖然繼承或者覆蓋後的型別或者成員並不是被宣告為@Deprecated，但編譯器仍然要報警。
3.）SuppressWarnings
SuppressWarning 不是一個標記型別註解。它有一個型別為String[] 的成員，這個成員的值為被禁止的警告名。對於javac 編譯器來講，被-Xlint 選項有效的警告名也同樣對@SuppressWarings 有效，同時編譯器忽略掉無法識別的警告名。
@SuppressWarnings("unchecked")
自定義註解：
自定義註解類編寫的一些規則:
1. Annotation 型定義為@interface,所有的Annotation 會自動繼承java.lang.Annotation這一介面,並且不能再去繼承別的類或是介面.
2. 引數成員只能用public 或預設(default) 這兩個訪問權修飾
3. 引數成員只能用基本型別byte、short、char、int、long、float、double、boolean八種基本資料型別和String、Enum、Class、annotations等資料型別，以及這一些型別的陣列.
4. 要獲取類方法和欄位的註解資訊，必須通過Java的反射技術來獲取 Annotation 物件，因為你除此之外沒有別的獲取註解物件的方法
5. 註解也可以沒有定義成員,，不過這樣註解就沒啥用了
PS:自定義註解需要使用到元註解
自定義註解例項：
FruitName.java
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
/**
* 水果名稱註解
*/
@Target(FIELD)
@Retention(RUNTIME)
@Documented
public @interface FruitName {
String value() default "";
}
FruitColor.java
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
/**
* 水果顏色註解
*/
@Target(FIELD)
@Retention(RUNTIME)
@Documented
public @interface FruitColor {
/**
* 顏色列舉
*/
public enum Color{ BLUE,RED,GREEN};
/**
* 顏色屬性
*/
Color fruitColor() default Color.GREEN;
}
FruitProvider.java
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
/**
* 水果供應者註解
*/
@Target(FIELD)
@Retention(RUNTIME)
@Documented
public @interface FruitProvider {
/**
* 供應商編號
*/
public int id() default -1;
/**
* 供應商名稱
*/
public String name() default "";
/**
* 供應商地址
*/
public String address() default "";
}
FruitInfoUtil.java
import java.lang.reflect.Field;
/**
* 註解處理器
*/
public class FruitInfoUtil {
public static void getFruitInfo(Class<?> clazz){
String strFruitName=" 水果名稱：";
String strFruitColor=" 水果顏色：";
String strFruitProvicer="供應商資訊：";
Field[] fields = clazz.getDeclaredFields();
for(Field field :fields){
if(field.isAnnotationPresent(FruitName.class)){
FruitName fruitName = (FruitName) field.getAnnotation(FruitName.class);
strFruitName=strFruitName+fruitName.value();
System.out.println(strFruitName);
}
else if(field.isAnnotationPresent(FruitColor.class)){
FruitColor fruitColor= (FruitColor) field.getAnnotation(FruitColor.class);
strFruitColor=strFruitColor+fruitColor.fruitColor().toString();
System.out.println(strFruitColor);
}
else if(field.isAnnotationPresent(FruitProvider.class)){
FruitProvider fruitProvider= (FruitProvider) field.getAnnotation(FruitProvider.class);
strFruitProvicer=" 供應商編號："+fruitProvider.id()+" 供應商名稱："+fruitProvider.name()+" 供應商地址："+fruitProvider.address();
System.out.println(strFruitProvicer);
}
}
}
}
Apple.java
import test.FruitColor.Color;
/**
* 註解使用
*/
public class Apple {
@FruitName("Apple")
private String appleName;
@FruitColor(fruitColor=Color.RED)
private String appleColor;
@FruitProvider(id=1,name="陝西紅富士集團",address="陝西省西安市延安路89號紅富士大廈")
private String appleProvider;
public void setAppleColor(String appleColor) {
this.appleColor = appleColor;
}
public String getAppleColor() {
return appleColor;
}
public void setAppleName(String appleName) {
this.appleName = appleName;
}
public String getAppleName() {
return appleName;
}
public void setAppleProvider(String appleProvider) {
this.appleProvider = appleProvider;
}
public String getAppleProvider() {
return appleProvider;
}
public void displayName(){
System.out.println("水果的名字是：蘋果");
}
}
FruitRun.java
/**
* 輸出結果
*/
public class FruitRun {
public static void main(String[] args) {
FruitInfoUtil.getFruitInfo(Apple.class);
}
}
執行結果是：
水果名稱：Apple
水果顏色：RED
供應商編號：1 供應商名稱：陝西紅富士集團 供應商地址：陝西省西安市延安路89號紅富士大廈
以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支援我們。