Java注解用法

注解元素的提供值必须是编译时常量表达式，不能使用null作为注解中任何类型元素的值。

基本类型

注解类型中的元素的数据类型可以是任何基本数据类型：byte，short，int，long，float，double，boolean 和 char。

Version注释类型声明两个元素：major和minor，并且都是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的注解类型。 它有两个元素：first和last，它们都是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注解类型注释程序元素，可以使用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 {

}

如果在使用注释时只提供一个值，则元素的名称为假设那个值。

¥ 我要打赏

纠错/补充

收藏

加QQ群啦，易百教程官方技术学习群

注意：建议每个人选自己的技术方向加群，同一个QQ最多限加 3 个群。

可以为注解中的元素定义默认值。不需要为带有默认值的注解元素提供值。

默认值可以使用以下一般语法定义：

@interface {

() default ;

}

关键字default指定默认值。默认值必须是与元素的数据类型兼容的类型。

以下代码通过将minor元素的默认值指定为0，来创建Version注释类型，如下所示：

public @interface Version {

int major();

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

}

示例

以下代码显示注解如何使用默认值。

@Version(major=1) // minor is zero, which is its default value

@Version(major=2, minor=1) // minor is 1, which is the specified value

以下代码显示如何为数组和其他数据类型指定默认值：

public @interface Version {

double d() default 1.89;

int num() default 1;

int[] x() default { 1, 2 };

String s() default "Hello";

String[] s2() default { "abc", "xyz" };

Class c() default Exception.class;

Class[] c2() default { Exception.class, java.io.IOException.class };

}

元注解：

元注解的作用就是负责注解其他注解。Java5.0定义了4个标准的meta-annotation类型，它们被用来提供对其它 annotation类型作说明。Java5.0定义的元注解：

1.@Target,

2.@Retention,

3.@Documented,

4.@Inherited

这些类型和它们所支持的类在java.lang.annotation包中可以找到。下面我们看一下每个元注解的作用和相应分参数的使用说明。

@Target：

@Target说明了Annotation所修饰的对象范围：Annotation可被用于 packages、types(类、接口、枚举、Annotation类型)、类型成员(方法、构造方法、成员变量、枚举值)、方法参数和本地变量(如循环变量、catch参数)。在Annotation类型的声明中使用了target可更加明晰其修饰的目标。

作用：用于描述注解的使用范围(即：被描述的注解可以用在什么地方)

取值(ElementType)有：

1.CONSTRUCTOR:用于描述构造器

2.FIELD:用于描述域

3.LOCAL_VARIABLE:用于描述局部变量

4.METHOD:用于描述方法

5.PACKAGE:用于描述包

6.PARAMETER:用于描述参数

7.TYPE:用于描述类、接口(包括注解类型) 或enum声明

使用实例：

@Target(ElementType.TYPE)

public @interface Table {

/**

* 数据表名称注解，默认值为类名称

* @return

*/

public String tableName() default "className";

}

@Target(ElementType.FIELD)

public @interface NoDBColumn {

}

注解Table 可以用于注解类、接口(包括注解类型) 或enum声明,而注解NoDBColumn仅可用于注解类的成员变量。

@Retention：

@Retention定义了该Annotation被保留的时间长短：某些Annotation仅出现在源代码中，而被编译器丢弃；而另一些却被编译在class文件中；编译在class文件中的Annotation可能会被虚拟机忽略，而另一些在class被装载时将被读取(请注意并不影响class的执行，因为Annotation与class在使用上是被分离的)。使用这个meta-Annotation可以对 Annotation的“生命周期”限制。

作用：表示需要在什么级别保存该注释信息，用于描述注解的生命周期(即：被描述的注解在什么范围内有效)

取值(RetentionPoicy)有：

1.SOURCE:在源文件中有效(即源文件保留)

2.CLASS:在class文件中有效(即class保留)

3.RUNTIME:在运行时有效(即运行时保留)

Retention meta-annotation类型有唯一的value作为成员，它的取值来自java.lang.annotation.RetentionPolicy的枚举类型值。具体实例如下：

@Target(ElementType.FIELD)

@Retention(RetentionPolicy.RUNTIME)

public @interface Column {

public String name() default "fieldName";

public String setFuncName() default "setField";

public String getFuncName() default "getField";

public boolean defaultDBValue() default false;

}

Column注解的的RetentionPolicy的属性值是RUTIME,这样注解处理器可以通过反射，获取到该注解的属性值，从而去做一些运行时的逻辑处理

@Documented:

@Documented用于描述其它类型的annotation应该被作为被标注的程序成员的公共API，因此可以被例如javadoc此类的工具文档化。Documented是一个标记注解，没有成员。

@Target(ElementType.FIELD)

@Retention(RetentionPolicy.RUNTIME)

@Documented

public @interface Column {

public String name() default "fieldName";

public String setFuncName() default "setField";

public String getFuncName() default "getField";

public boolean defaultDBValue() default false;

}

@Inherited：

@Inherited 元注解是一个标记注解，@Inherited阐述了某个被标注的类型是被继承的。如果一个使用了@Inherited修饰的annotation类型被用于一个class，则这个annotation将被用于该class的子类。

注意：@Inherited annotation类型是被标注过的class的子类所继承。类并不从它所实现的接口继承annotation，方法并不从它所重载的方法继承annotation。

当@Inherited annotation类型标注的annotation的Retention是RetentionPolicy.RUNTIME，则反射API增强了这种继承性。如果我们使用java.lang.reflect去查询一个@Inherited annotation类型的annotation时，反射代码检查将展开工作：检查class和其父类，直到发现指定的annotation类型被发现，或者到达类继承结构的顶层。

实例代码：

/**

*

* @author peida

*

*/

@Inherited

public @interface Greeting {

public enum FontColor{ BULE,RED,GREEN};

String name();

FontColor fontColor() default FontColor.GREEN;

}

自定义注解：

使用@interface自定义注解时，自动继承了java.lang.annotation.Annotation接口，由编译程序自动完成其他细节。在定义注解时，不能继承其他的注解或接口。@interface用来声明一个注解，其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称，返回值类型就是参数的类型(返回值类型只能是基本类型、Class、String、enum)。可以通过default来声明参数的默认值。

定义注解格式：

public @interface 注解名 {定义体}

注解参数的可支持数据类型：

1.所有基本数据类型(int,float,boolean,byte,double,char,long,short)

2.String类型

3.Class类型

4.enum类型

5.Annotation类型

6.以上所有类型的数组

Annotation类型里面的参数该怎么设定:

第一,只能用public或默认(default)这两个访问权修饰.例如,String value();这里把方法设为defaul默认类型；

第二,参数成员只能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型和 String,Enum,Class,annotations等数据类型,以及这一些类型的数组.例如,String value();这里的参数成员就为String;

第三,如果只有一个参数成员,最好把参数名称设为"value",后加小括号.例:下面的例子FruitName注解就只有一个参数成员。

简单的自定义注解和使用注解实例：

package 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;

/**

* 水果名称注解

* @author peida

*

*/

@Target(ElementType.FIELD)

@Retention(RetentionPolicy.RUNTIME)

@Documented

public @interface FruitName {

String value() default "";

}

package 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;

/**

* 水果颜色注解

* @author peida

*

*/

@Target(ElementType.FIELD)

@Retention(RetentionPolicy.RUNTIME)

@Documented

public @interface FruitColor {

/**

* 颜色枚举

* @author peida

*

*/

public enum Color{ BULE,RED,GREEN};

/**

* 颜色属性

* @return

*/

Color fruitColor() default Color.GREEN;

}

package annotation;

import annotation.FruitColor.Color;

public class Apple {

@FruitName("Apple")

private String appleName;

@FruitColor(fruitColor=Color.RED)

private String appleColor;

public void setAppleColor(String appleColor) {

this.appleColor = appleColor;

}

public String getAppleColor() {

return appleColor;

}

public void setAppleName(String appleName) {

this.appleName = appleName;

}

public String getAppleName() {

return appleName;

}

public void displayName(){

System.out.println("水果的名字是：苹果");

}

}

注解元素的默认值：

注解元素必须有确定的值，要么在定义注解的默认值中指定，要么在使用注解时指定，非基本类型的注解元素的值不可为null。因此, 使用空字符串或0作为默认值是一种常用的做法。这个约束使得处理器很难表现一个元素的存在或缺失的状态，因为每个注解的声明中，所有元素都存在，并且都具有相应的值，为了绕开这个约束，我们只能定义一些特殊的值，例如空字符串或者负数，一次表示某个元素不存在，在定义注解时，这已经成为一个习惯用法。例如：

1 package annotation;

2

3 import java.lang.annotation.Documented;

4 import java.lang.annotation.ElementType;

5 import java.lang.annotation.Retention;

6 import java.lang.annotation.RetentionPolicy;

7 import java.lang.annotation.Target;

8

9 /**

10 * 水果供应者注解

11 * @author peida

12 *

13 */

14 @Target(ElementType.FIELD)

15 @Retention(RetentionPolicy.RUNTIME)

16 @Documented

17 public @interface FruitProvider {

18 /**

19 * 供应商编号

20 * @return

21 */

22 public int id() default -1;

23

24 /**

25 * 供应商名称

26 * @return

27 */

28 public String name() default "";

29

30 /**

31 * 供应商地址

32 * @return

33 */

34 public String address() default "";

35 }

定义了注解，并在需要的时候给相关类，类属性加上注解信息，如果没有响应的注解信息处理流程，注解可以说是没有实用价值。如何让注解真真的发挥作用，主要就在于注解处理方法，下一步我们将学习注解信息的获取和处理！