註解的講解

什麼是註解

Annotation的作用
1.不是程序本身 , 可以對程序作出解釋.(這一點和註釋(comment)沒什麼區別)
2.可以被其他程序(比如:編譯器等)讀取.

Annotation的格式 :
1.註解是以"@註釋名"在代碼中存在的 , 還可以添加一些參數值
2.例如:@SuppressWarnings(value=“unchecked”).

Annotation在哪裏使用?
可以附加在package , class , method , field 等上面 , 相當於給他們添加了額外的輔助信息, 我們可以通過反射機制編程實現對這些元數據的訪問。

內置註解

1.@Override:定義在java.lang.Override中,此註釋只適用於修辭方法,表示一個方法聲明打算重寫超類中的另一個方法聲明
2.@Deprecated:定義在java.lang.Deprecated,此註釋可以用於修辭方法,屬性,類,表示不鼓勵程序員使用這樣的元素,通常是因爲它很危險或者存在更好的選擇。
3.@SuppressWarnings:定義在java.lang.SuppressWarnings中,用來抑制編譯時的警告信息。與前兩個註釋有所不同,你需要添加一個參數才能正確使用,這些參數都是已經定義好了的,我們選擇性的使用就好了
@SuppressWarnings(“all”)
@SuppressWarnings(“unchecked”)
@SuppressWarnings(value = {“unchecked”,deprecation})
等等…

元註解

  • 元註解的作用就是負責註解其他註解,Java定義了4個標準的meta-annotation類型,他們被用來提供其他annotation類型說明.
  • 這些類型和它們所支持的類在java.lang.annotation包中可以找到.(@Target,@Retention,@Documented,@Inherited)
    @Target:用於描述註解的使用範圍(即:被描述的註解可以用在什麼地方)
    @Retention:表示需要在什麼級別保存該註解信息,用於描述註解的生命週期(SOURCE < CLASS < RUNTIME)
    @Document:說明該註解即將包含在javadoc中
    @Inherited:說明子類可以繼承父類中的該註解

*### 自定義註解
使用@interface 自定義註解時,自動繼承了java.lang.annotation.Annotation接口

分析
@interface 用來聲明一個註釋,格式:public @interface 註解名{定義內容}
其中的每一個方法實際上是聲明瞭一個配置參數
方法的名稱就是參數的名稱
返回值類型就是參數的類型(返回值只能是基本類型,Class,String ,enum).
可以通過default來聲明參數的默認值
如果只有一個參數成員,一般參數名爲value
註解元素必須要有值,我們定義註解元素時,經常使用空字符串,0作爲默認值.

下面就以代碼爲例看一看什麼是註解:

public class AnnotationTest1 {
    public static void main(String[] args) {
        int year = new Date().getYear();
        /**
         * 該方法的內置註解是不建議你使用這個方法
         * 源碼:
         * @Deprecated
         * public int getYear() {
         * eturn normalize().getYear() - 1900;
         * }
         */

    }
    //不建議使用該方法
    @Deprecated
    public int Test() {
        System.out.println("123");
        return 1;
    }
    //@Override 內置註解 只能定義在方法上  並且是重寫了頂層父類的方法
    @Override
    public String toString() {
        return "AnnotationTest1{}";
    }
public class AnnotationTest2  {
    public static void main(String[] args) {

    }
        /**
         * 如何定義個註解
         */
        //Annotation 語法:
        // public @interface 註解名{定義內容}
    private String name;
    @MyAnnotation
    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}


@Target(ElementType.METHOD) //表示這個註解,可以註解 方法、屬性(字段)、類
@Retention(RetentionPolicy.RUNTIME)    //通常使用的是RetentionPolicy.RUNTIME 表示在運行生效;
@Documented //表示可以在Javadoc中生成信息,沒有什麼作用;
@Inherited //表示的是子類可以繼承父類的註解,一般也不用;
@interface MyAnnotation {
}
public class AnnotationTest3 {

        private int age;
        private String name;

        public AnnotationTest3() {
        }

        public AnnotationTest3(int age, String name) {
            this.age = age;
            this.name = name;
        }

        public int getAge() {
            return age;
        }

        public void setAge(int age) {
            this.age = age;

        }

        public String getName() {
            return name;
        }

        @MyAnnotation2(schools = "123")
        public void setName(String name) {
            this.name = name;
        }

}

@Target(value = {ElementType.METHOD})
@Retention(value = RetentionPolicy.RUNTIME)
@interface MyAnnotation3 {
    String[] value();//只有一個參數 value 可以省略
}



@Target(value = {ElementType.METHOD})//註解在方法上
@Retention(value = RetentionPolicy.RUNTIME)//註解運行時生效
@interface MyAnnotation2 {
    String name() default "";
    int age() default 0;//通過default定義默認值;
    int id() default -1;//-1表示找不到
    String[] schools();
}

看完這些代碼我和大家一樣會有一些問題?

  • 註解的作用是什麼?
  • 可以幹嘛?
  • 定義的內容起什麼作用
  • 我們可以通過反射機制編程實現對這些元數據訪問

下一節通過反射機制來探討一些註解的作用到底是什麼

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章