Java注解Annotation原理及自定義注解代碼實例
什么是注解？
對于很多初次接觸的開發(fā)者來說應(yīng)該都有這個疑問？Annontation是Java5開始引入的新特征，中文名稱叫注解。它提供了一種安全的類似注釋的機制，用來將任何的信息或元數(shù)據(jù)（metadata）與程序元素（類、方法、成員變量等）進行關(guān)聯(lián)。為程序的元素（類、方法、成員變量）加上更直觀更明了的說明，這些說明信息是與程序的業(yè)務(wù)邏輯無關(guān)，并且供指定的工具或框架使用。
Annontation像一種修飾符一樣，應(yīng)用于包、類型、構(gòu)造方法、方法、成員變量、參數(shù)及本地變量的聲明語句中。
Java注解是附加在代碼中的一些元信息，用于一些工具在編譯、運行時進行解析和使用，起到說明、配置的功能。注解不會也不能影響代碼的實際邏輯，僅僅起到輔助性的作用。包含在 java.lang.annotation 包中。
注解的用處：
1、生成文檔。這是最常見的，也是java 最早提供的注解。常用的有@param @return 等
2、跟蹤代碼依賴性，實現(xiàn)替代配置文件功能。比如Dagger 2 依賴注入，未來java 開發(fā)，將大量注解配置，具有很大用處;
3、在編譯時進行格式檢查。如@override 放在方法前，如果你這個方法并不是覆蓋了超類方法，則編譯時就能檢查出。
注解的原理：
注解本質(zhì)是一個繼承了Annotation 的特殊接口，其具體實現(xiàn)類是Java 運行時生成的動態(tài)代理類。而我們通過反射獲取注解時，返回的是Java 運行時生成的動態(tài)代理對象$Proxy1。通過代理對象調(diào)用自定義注解（接口）的方法，會最終調(diào)用AnnotationInvocationHandler 的invoke 方法。該方法會從memberValues 這個Map 中索引出對應(yīng)的值。而memberValues 的來源是Java 常量池。
元注解：
java.lang.annotation 提供了四種元注解，專門注解其他的注解（在自定義注解的時候，需要使用到元注解）：
- @Documented – 注解是否將包含在JavaDoc中
- @Retention – 什么時候使用該注解
- @Target – 注解用于什么地方
- @Inherited – 是否允許子類繼承該注解
1.）@Retention – 定義該注解的生命周期
● RetentionPolicy.SOURCE : 在編譯階段丟棄。這些注解在編譯結(jié)束之后就不再有任何意義，所以它們不會寫入字節(jié)碼。@Override, @SuppressWarnings都屬于這類注解。
● RetentionPolicy.CLASS : 在類加載的時候丟棄。在字節(jié)碼文件的處理中有用。注解默認使用這種方式
● RetentionPolicy.RUNTIME : 始終不會丟棄，運行期也保留該注解，因此可以使用反射機制讀取該注解的信息。我們自定義的注解通常使用這種方式。
2.）Target – 表示該注解用于什么地方。默認值為任何元素，表示該注解用于什么地方。可用的ElementType 參數(shù)包括
● ElementType.CONSTRUCTOR: 用于描述構(gòu)造器
● ElementType.FIELD: 成員變量、對象、屬性（包括enum實例）
● ElementType.LOCAL_VARIABLE: 用于描述局部變量
● ElementType.METHOD: 用于描述方法
● ElementType.PACKAGE: 用于描述包
● ElementType.PARAMETER: 用于描述參數(shù)
● ElementType.TYPE: 用于描述類、接口(包括注解類型) 或enum聲明
3.)@Documented – 一個簡單的Annotations 標(biāo)記注解，表示是否將注解信息添加在java 文檔中。
4.)@Inherited – 定義該注釋和子類的關(guān)系
@Inherited 元注解是一個標(biāo)記注解，@Inherited 闡述了某個被標(biāo)注的類型是被繼承的。如果一個使用了@Inherited 修飾的annotation 類型被用于一個class，則這個annotation 將被用于該class 的子類。
常見標(biāo)準(zhǔn)的Annotation：
1.）Override
java.lang.Override 是一個標(biāo)記類型注解，它被用作標(biāo)注方法。它說明了被標(biāo)注的方法重寫了父類的方法，起到了斷言的作用。如果我們使用了這種注解在一個沒有覆蓋父類方法的方法時，java 編譯器將以一個編譯錯誤來警示。
2.）Deprecated
Deprecated 也是一種標(biāo)記類型注解。當(dāng)一個類型或者類型成員使用@Deprecated 修飾的話，編譯器將不鼓勵使用這個被標(biāo)注的程序元素。所以使用這種修飾具有一定的“延續(xù)性”：如果我們在代碼中通過繼承或者覆蓋的方式使用了這個過時的類型或者成員，雖然繼承或者覆蓋后的類型或者成員并不是被聲明為@Deprecated，但編譯器仍然要報警。
3.）SuppressWarnings
SuppressWarning 不是一個標(biāo)記類型注解。它有一個類型為String[] 的成員，這個成員的值為被禁止的警告名。對于javac 編譯器來講，被-Xlint 選項有效的警告名也同樣對@SuppressWarings 有效，同時編譯器忽略掉無法識別的警告名。
@SuppressWarnings("unchecked")
自定義注解：
自定義注解類編寫的一些規(guī)則:
1. Annotation 型定義為@interface, 所有的Annotation 會自動繼承java.lang.Annotation這一接口,并且不能再去繼承別的類或是接口.
2. 參數(shù)成員只能用public 或默認(default) 這兩個訪問權(quán)修飾
3. 參數(shù)成員只能用基本類型byte、short、char、int、long、float、double、boolean八種基本數(shù)據(jù)類型和String、Enum、Class、annotations等數(shù)據(jù)類型，以及這一些類型的數(shù)組.
4. 要獲取類方法和字段的注解信息，必須通過Java的反射技術(shù)來獲取 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;
/**
* 水果供應(yīng)者注解
*/
@Target(FIELD)
@Retention(RUNTIME)
@Documented
public @interface FruitProvider {
/**
* 供應(yīng)商編號
*/
public int id() default -1;
/**
* 供應(yīng)商名稱
*/
public String name() default "";
/**
* 供應(yīng)商地址
*/
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="供應(yīng)商信息：";
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=" 供應(yīng)商編號："+fruitProvider.id()+" 供應(yīng)商名稱："+fruitProvider.name()+" 供應(yīng)商地址："+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
/**
* 輸出結(jié)果
*/
public class FruitRun {
public static void main(String[] args) {
FruitInfoUtil.getFruitInfo(Apple.class);
}
}
運行結(jié)果是：
水果名稱：Apple
水果顏色：RED
供應(yīng)商編號：1 供應(yīng)商名稱：陜西紅富士集團 供應(yīng)商地址：陜西省西安市延安路89號紅富士大廈
以上就是本文的全部內(nèi)容，希望對大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。
相關(guān)文章
SpringBoot 并發(fā)登錄人數(shù)控制的實現(xiàn)方法
這篇文章主要介紹了SpringBoot 并發(fā)登錄人數(shù)控制的實現(xiàn)方法，文中通過示例代碼介紹的非常詳細，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2019-05-05
Elasticsearch 映射參數(shù)詳解 fields
這篇文章主要介紹了fields Elasticsearch 映射參數(shù)fields，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-07-07
這篇文章主要介紹了Mybatis和Mybatis-Plus時間范圍查詢方式，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-08-08
詳解springcloud之服務(wù)注冊與發(fā)現(xiàn)
本次分享的是關(guān)于springcloud服務(wù)注冊與發(fā)現(xiàn)的內(nèi)容，將通過分別搭建服務(wù)中心，服務(wù)注冊，服務(wù)發(fā)現(xiàn)來說明，非常具有實用價值，需要的朋友可以參考下2018-06-06
這篇文章主要介紹了ArrayBlockQueue源碼解析，文中通過示例代碼介紹的非常詳細，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2019-04-04
這篇文章主要介紹了淺談SpringBoot之事務(wù)處理機制，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2018-01-01
打開IDEA配置Spring項目時發(fā)現(xiàn)沒有選擇java?1.8的選項解決方案
這篇文章主要介紹了打開IDEA配置Spring項目時發(fā)現(xiàn)沒有選擇java?1.8的選項的解決方案,文中通過代碼介紹的非常詳細,對大家學(xué)習(xí)或者idea具有一定的參考借鑒價值,需要的朋友可以參考下2025-03-03
Springboot整合Java?DL4J實現(xiàn)交通標(biāo)志識別系統(tǒng)全過程
在自動駕駛系統(tǒng)中,交通標(biāo)志識別是實現(xiàn)車輛智能化的關(guān)鍵技術(shù)之一,本文介紹了利用SpringBoot和JavaDeeplearning4j構(gòu)建交通標(biāo)志識別系統(tǒng)的方法,文中通過代碼介紹的非常詳細,需要的朋友可以參考下2024-10-10
這篇文章介紹了eclipse啟動tomcat無法訪問的解決方法，有需要的朋友可以參考一下2013-10-10
這篇文章主要介紹了Java中的同步非阻塞IO模型詳解,同步非阻塞IO模型,我們能夠知道,用戶線程一直發(fā)送請求,內(nèi)核一直都能都夠返回 ,直到內(nèi)核完成準(zhǔn)備數(shù)據(jù)、數(shù)據(jù)拷貝的工作,并且返回成功的指示,在此過程中用戶線程不是阻塞的狀態(tài),需要的朋友可以參考下2024-01-01