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

Posted on by

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"};
}

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：