JAVA annotation入門
一. 最常見的annotation
- @Override:用在方法之上,用來告訴別人這一個(gè)方法是改寫父類的
- @Deprecated:建議別人不要使用舊的API的時(shí)候用的,編譯的時(shí)候會(huì)用產(chǎn)生警告信息,可以設(shè)定在程序里的所有的元素上.
- @SuppressWarnings:暫時(shí)把一些警告信息消息關(guān)閉
- @Entity:表示該類是可持久化的類
二. 設(shè)計(jì)一個(gè)自己的Annotation
先看代碼再講話
1. 只有一個(gè)參數(shù)的Annotation實(shí)現(xiàn)
- package chb.test.annotation;
- 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.TYPE)
- @Retention(RetentionPolicy.RUNTIME)
- @Documented
- public @interface MyAnnotation1 {
- String value();
- }
2. 有兩個(gè)參數(shù)的Annotation實(shí)現(xiàn)
- package chb.test.annotation;
- 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 MyAnnotation2 {
- String description();
- boolean isAnnotation();
- }
3. Annotation實(shí)驗(yàn)類
- package chb.test.annotation;
- @MyAnnotation1("this is annotation1")
- public class AnnotationDemo {
- @MyAnnotation2(description="this is annotation2",isAnnotation=true)
- public void sayHello(){
- System.out.println("hello world!");
- }
- }
4.Annotation測試說明類
- package chb.test.annotation;
- import java.lang.reflect.Method;
- import org.junit.Test;
- public class TestAnnotation {
- @Test
- public void test() throws ClassNotFoundException, SecurityException, NoSuchMethodException{
- Class<?> cls = Class.forName("chb.test.annotation.AnnotationDemo");
- boolean flag = cls.isAnnotationPresent(MyAnnotation1.class);
- if(flag){
- System.out.println("判斷類是annotation");
- MyAnnotation1 annotation1 = cls.getAnnotation(MyAnnotation1.class);
- System.out.println(annotation1.value());
- }
-
- Method method = cls.getMethod("sayHello");
- flag = method.isAnnotationPresent(MyAnnotation2.class) ;
- if(flag){
- System.out.println("判斷方法也是annotation");
- MyAnnotation2 annotation2 = method.getAnnotation(MyAnnotation2.class);
- System.out.println(annotation2.description()+"\t"+annotation2.isAnnotation());
- }
- }
-
- }
實(shí)驗(yàn)結(jié)果,控制臺(tái)打出如下信息:
判斷類是annotation
this is annotation1
判斷方法也是annotation
this is annotation2 true
三.簡介及說明
1. MyAnnotation1中的@Target(ElementType.TYPE)
@Target里面的ElementType是用來指定Annotation類型可以用在哪些元素上的.例如:
TYPE(類型)、FIELD(屬性)、METHOD(方法)、PARAMETER(參數(shù))、CONSTRUCTOR(構(gòu)造函數(shù))、LOCAL_VARIABLE(局部變量),、PACKAGE(包),其中的TYPE(類型)是指可以用在Class,Interface,Enum和Annotation類型上。
2. MyAnnotation1中的@Retention(RetentionPolicy.RUNTIME)
RetentionPolicy 共有三種策略,分別為:
- SOURCE:這個(gè)Annotation類型的信息只會(huì)保留在程序源碼里,源碼如果經(jīng)過了編譯之后,Annotation的數(shù)據(jù)就會(huì)消失,并不會(huì)保留在編譯好的.class文件里面
- CLASS:這個(gè)Annotation類型的信息保留在程序源碼里,同時(shí)也會(huì)保留在編譯好的.class文件里面,在執(zhí)行的時(shí)候,并不會(huì)把這些信息加載到JVM中。注:默認(rèn)策略為CLASS類型
- RUNTIME:表示在源碼、編譯好的.class文件中保留信息,在執(zhí)行的時(shí)候會(huì)把這一些信息加載到JVM中去的
3. MyAnnotation1中的@Documented
目的就是將這一Annotation的信息顯示在JAVA API文檔上,如果沒有增加@Documented的話,JAVA API文檔上不會(huì)顯示相關(guān)annotation信息
4. MyAnnotation1中的@interface
關(guān)鍵字,表示該類為Annotation定義
5. MyAnnotation1中的 String value();
表示有一個(gè)成員參數(shù),名字為value,訪問權(quán)為默認(rèn)(default)修飾符,注意以下兩點(diǎn):
- 訪問權(quán)只能用public和默認(rèn)(default)修飾
- 參數(shù)成員只能用基本類型byte,short,char,int,long,float,double,boolean八種基本數(shù)據(jù)類型和String,Enum,Class,annotations等數(shù)據(jù)類型,以及這一些類型的數(shù)組
6.AnnotationDemo中的@MyAnnotation1("this is annotation1")
因?yàn)镸yAnnotation1只有一個(gè)參數(shù),因此可以直接在括號中寫上value值。注:如果Annotation只有一個(gè)參數(shù),則建議最好將該參數(shù)名稱定義為value
7.TestAnnotation中的cls.isAnnotationPresent(MyAnnotation1.class)
判斷該類是否使用了MyAnnotation1的注釋
8. TestAnnotation中的MyAnnotation1 annotation1 = cls.getAnnotation(MyAnnotation1.class)
返回該類針對MyAnnotation1的注釋
9. TestAnnotation中的method.isAnnotationPresent(MyAnnotation2.class)
判斷該方法是否使用了MyAnnotation2的注釋