Java註解用法


Java註解用法

註解元素的提供值必須是編譯時常數表示式,不能使用null作為註解中任何型別元素的值。

基本型別

註解型別中的元素的資料型別可以是任何基本資料型別:byteshortintlongfloatdoublebooleanchar

Version注釋型別宣告兩個元素:majorminor,並且都是int資料型別。

以下程式碼宣告了註解型別:

public @interface MyAnnotation {
  byte a();

  short b();

  int c();

  long d();

  float e();

  double f();

  boolean g();

  char h();
}
@MyAnnotation(a=1, b=2,  c=3,  d=4,  e=12.34F, f=1.89, g=true, h='Y')

可以使用編譯時常數表示式來指定註解元素的值。以下兩個版本註釋範例有效的:

@Version(major=2+1, minor=(int)13.2)
@Version(major=3, minor=13)

字串型別

可以在註釋型別中使用String型別的元素。以下程式碼定義了名為Name的註解型別。 它有兩個元素:firstlast,它們都是String型別。

public @interface Name  { 
   String first(); 
   String last();
}

@Name(first="Tom", last="Smith")
public class NameTest {
    @Name(first="Jack", last="Iaan")
    public void  aMethod()   {
    }
}

String型別的元素的值表示式中使用字串連線+運算子是有效的。

@Name(first="Ja" + "ck", last="Ia" + "an")

Class型別

以下程式碼顯示如何使用Class型別作為註解值。

import java.io.IOException;

@interface MyAnnotation {
  Class<? extends Throwable> willThrow() default java.lang.Throwable.class;
}

public class Main {
  @MyAnnotation(willThrow = IOException.class)
  public static void testCase1() {
    // Code goes here
  }

  @MyAnnotation()
  public static void testCase2() {
  }
}

列舉型別

註解可以具有列舉型別的元素。

enum Level {
  PENDING, FAILED, PASSED;
}

@interface Review {
  Level status() default Level.PENDING;

  String comments() default "";
}

@Review(status = Level.PASSED)
public class Main {

}

註解型別

可以使用註解型別作為另一個註解型別的宣告內的元素的型別。要為註解型別的元素提供值,請使用用於建立註解型別範例的語法。

@interface Name {
  String first();

  String last();
}

@interface Version {
  int major();

  int minor() default 0; // zero as default value for minor
}

@interface Description {
  Name name();

  Version version();

  String comments() default "";
}

@Description(name = @Name(first = "Tom", last = "Smith"), version = @Version(major = 1, minor = 2), comments = "Just a  test class")
public class Main {

}

註解可以具有陣列型別的元素。陣列型別可以是以下型別之一:

  • 原始型別
  • java.lang.String型別
  • java.lang.Class型別
  • 列舉型別
  • 註解型別

需要在大括號中指定陣列元素的值。陣列的元素由逗號分隔。

@interface ItemList {
  String[] items();
}

@ItemList(items = { "A", "B" })
public class Main {

}

如果陣列中只有一個元素,則允許省略括號。

@ToDo(items={"A"})
@ToDo(items="A")

傳遞一個空陣列

@ToDo(items={})

速記註解語法

假設有一個注釋型別如下。

public  @interface Enabled  {
    boolean status() default true;
}

要使用帶有預設值的Enabled註解型別注釋程式元素,可以使用@Enabled()語法。
不需要為status元素指定值,因為它具有預設值。可以進一步省略括號。

@Enabled
public class Main {

}

@Enabled()
public class Main {

}

只有一個元素的註解型別有速記語法。如果注釋型別只有一個具有命名值的元素,可以省略name = value對中的名稱。以下程式碼宣告了 Company 註解型別,它只有一個名為value的元素:

public  @interface Company  {
    String value(); 
}

當使用 Company 註釋時,可以省略name = value對的名稱。

@Company(value="Inc.")
public class Test   {
}

變成 -

@Company("Inc.")
public class Test   {
}

以下程式碼顯示了如果元素資料型別是陣列,如何使用縮寫。

public  @interface Item   {
    String[] value();
}

@Item({"A", "B"})
public class Test   {
}

如果在陣列注釋型別中只指定一個元素,可以進一步省略括號。

@Item("A")
public class Test   {
}

如果在使用註釋時只提供一個值,則元素的名稱為假設那個值。