Java中的三種標準註解和四種元註解說明

2022-02-17 13:00:21

Java的三種標準註解和四種元註解

先來說說什麼是註解

註解（也被稱為後設資料）為我們在程式碼中新增資訊提供了一種形式化的方法，使我們可以在稍後某個時刻非常方便地使用這些資料。

註解的語法比較簡單，除了@符號的使用之外，它基本與Java固有的語法一致。

Java內建了三種註解，定義在java.lang中的註解

@Override：表示當前的方法定義將覆蓋超類中的方法。如果你不小心拼寫錯誤，或者方法簽名對不上被覆蓋的方法，編譯器就會發出錯誤提示。
@Deprecated：如果程式設計師使用了註解為它的元素，那麼編譯器會發出警告資訊。
@SuppressWarnings：關閉不當的編譯器警告資訊。在java SE5之前的版本中，也可以使用該註解，不過會被忽略不起作用。

我們來看一下註解@Test的定義：

定義註解時，會需要一些元註解（meta-annotation），如@Target和@Retention。

@Target 用來定義你的註解將應用於什麼地方（例如是一個方法或者一個域）。
@Retention 用來定義該註解在哪一個級別可用，在原始碼中（SOURCE）、類檔案中（CLASS）或者執行時（RUNTIME）。

Java除了內建了三種標準註解，還有四種元註解

@Target 表示該註解用於什麼地方，可能的值在列舉類 ElemenetType 中，包括：

ElemenetType.CONSTRUCTOR 構造器宣告
ElemenetType.FIELD 域宣告（包括 enum 範例）
ElemenetType.LOCAL_VARIABLE 區域性變數宣告
ElemenetType.METHOD 方法宣告
ElemenetType.PACKAGE 包宣告
ElemenetType.PARAMETER 引數宣告
ElemenetType.TYPE 類，介面（包括註解型別）或enum宣告

@Retention 表示在什麼級別儲存該註解資訊。可選的引數值在列舉型別 RetentionPolicy 中，包括：

RetentionPolicy.SOURCE 註解將被編譯器丟棄
RetentionPolicy.CLASS 註解在class檔案中可用，但會被VM丟棄
RetentionPolicy.RUNTIME VM將在執行期也保留註釋，因此可以通過反射機制讀取註解的資訊。

@Documented 將此註解包含在 javadoc 中，它代表著此註解會被javadoc工具提取成檔案。在doc檔案中的內容會因為此註解的資訊內容不同而不同。相當與@see,@param 等。

@Inherited 允許子類繼承父類別中的註解。

元註解和自己寫一個註解

一、元註解

@Target 表示這個註解可以用在什麼地方
@Retention 表示我們的註解在什麼地方還有效(runtime>class>sources)
@Documented 表示是否將我們的註解生成在javaDoc中
@Inherited 子類可以繼承父類別的註解

package com.epoch.customproject.utils;
import java.lang.annotation.*;
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface DataSource {
    String value() default "dataSourceMdm";
}

二、自己寫註解

public class test {
    @Myobject2(age = 18)
    public void test1(){ }
    @Myobject("預設")
    public void test2(){ }
}
@Target(value = {ElementType.TYPE,ElementType.METHOD})
@Retention(value = RetentionPolicy.RUNTIME)
@interface  Myobject{
    //只有一個引數，所以傳一個值就行  @Myobject("預設")
    String value();
}
@Target(value = {ElementType.TYPE,ElementType.METHOD})
@Retention(value = RetentionPolicy.RUNTIME)
@interface  Myobject2{
        //   @Myobject2(age = 18)  其他引數不用傳的原因是給過預設值
    //註釋的引數   引數型別   引數名()
    String name() default "預設名字";
    int age()  ;
    double height() default  -1;//如果預設值-1，代表不存在
    String[] school() default {"預設學校1","預設學校2"};
}

以上為個人經驗，希望能給大家一個參考，也希望大家多多支援it145.com。