Annotation（注解）

SYXIXI
433 阅读9分钟

Annotation（注解）

什么是注解

Annotation是Java5引入的新特性，中文名叫注解。

对于初学者而言，注解叫好比标签，反应这物理的某些信息。比如：商场中的商品都有标签，标签上一般都有价格、材质、商品名称等等，这些信息是对商品的说明，让顾客进一步的了解商品，与商品是怎样制作出来的（实现过程）无关。

注解为程序的元素加上更直观明了的说明，这些说明信息与程序的业务逻辑无关，注解可以用于包、类型、构造方法、方法、成员变量、参数及本地变量的声明语句中。

注解的声明

先来看一段代码：

public @interface TestAnnotation {
}

以上代码创建了一个名为TestAnnotation的注解，它的声明形式与接口非常相似，不过多了一个@符号。

注解的应用

注解的用法如下：

@TestAnnotation
public class Test {
}

使用@TestAnnotation注解了Test类

注解不仅能用在类的声明上，还能用在包、构造方法、方法、成员变量、参数及本地变量的声明语句中

要想注解能够称心如意的发挥作用，我们就该了解一下元注解了。

元注解

什么是元注解

元注解是可以注解到注解上的注解，或者说元注解是一种基本注解，但是它能够应用到其它的注解上面。

元注解有 @Retention、@Documented、@Target、@Inherited、@Repeatable 5 种。

@Retention

Retention 的英文意为保留期的意思。当 @Retention 应用到一个注解上的时候，它解释说明了这个注解的的存活时间。

  • RetentionPolicy.SOURCE 注解只在源码阶段保留，在编译器进行编译时它将被丢弃忽视。
  • RetentionPolicy.CLASS 注解只被保留到编译进行的时候，它并不会被加载到 JVM 中。（默认使用这种方式）
  • RetentionPolicy.RUNTIME 注解可以保留到程序运行的时候，它会被加载进入到 JVM 中，所以在程序运行时可以获取到它们
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {
}

上面的代码指定 TestAnnotation 可以在程序运行周期被获取到

@Documented

表示是否将注解信息添加在Javadoc中

@Target

Target 是目标的意思，@Target 指定了注解运用的地方。

当一个注解被 @Target 注解时，这个注解就被限定了运用的场景。

  • ElementType.ANNOTATION_TYPE 可以给一个注解进行注
  • ElementType.CONSTRUCTOR 可以给构造方法进行注解
  • ElementType.FIELD 可以给属性进行注解
  • ElementType.LOCAL_VARIABLE 可以给局部变量进行注解
  • ElementType.METHOD 可以给方法进行注解
  • ElementType.PACKAGE 可以给一个包进行注解
  • ElementType.PARAMETER 可以给一个方法内的参数进行注解
  • ElementType.TYPE 可以给一个类型进行注解，比如类、接口、枚举

如果没有指定@Target，那么在能使用注解的地方都能使用。反之，只能在指定声明上使用该注解，不然编译器会报错。

@Inherited

Inherited 是继承的意思，但是它并不是说注解本身可以继承，而是说如果一个超类被 @Inherited 注解过的注解进行注解的话，那么如果它的子类没有被任何注解应用的话，那么这个子类就继承了超类的注解。

@Inherited
@Retention(RetentionPolicy.RUNTIME)
@interface Test {}


@Test
public class A {}


public class B extends A {}

注解 Test 被 @Inherited 修饰，类A使用了@Test注解，类B继承了类A，那么类B也拥有@Test注解

@Repeatable

Repeatable 是可重复的意思。@Repeatable 是 Java 1.8 才加进来的，所以算是一个新的特性。

什么样的注解会多次应用呢？通常是注解的值可以同时取多个。

举个例子，一个人他既是程序员又是产品经理,同时他还是个画家。

@interface Persons {
	Person[]  value();
}

@Repeatable(Persons.class)
@interface Person{
	String role default "";
}

@Person(role="artist")
@Person(role="coder")
@Person(role="PM")
public class SuperMan{
	
}

注意上面的代码，@Repeatable 注解了 Person。而 @Repeatable 后面括号中的类相当于一个容器注解。

什么是容器注解呢？就是用来存放其它注解的地方。它本身也是一个注解。

按照规定，它里面必须要有一个 value 的属性，属性类型是一个被 @Repeatable 注解过的注解数组，注意它是数组。

注解的属性

注解的属性也叫做成员变量。注解只有成员变量，没有方法。注解的成员变量在注解的定义中以“无形参的方法”形式来声明，其方法名定义了该成员变量的名字，其返回值定义了该成员变量的类型。

参数成员只能用基本类型byte、short、char、int、long、float、double、boolean八种基本数据类型和String、Enum、Class、annotations等数据类型，以及这一些类型的数组.

参数成员只能用public 或默认(default) 这两个访问权修饰

注解中属性的应用

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {
	
	int id();
	
	String msg();

}

上面代码定义了 TestAnnotation 这个注解中拥有 id 和 msg 两个属性。在使用的时候，我们应该给它们进行赋值。

赋值的方式是在注解的括号内以 属性名="" 形式，多个属性之前用 ,隔开：

@TestAnnotation(id=3,msg="hello annotation")
public class Test {

}

属性的默认值

注解中属性可以有默认值，默认值需要用 default 关键值指定。比如：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {
	
	public int id() default -1;
	
	public String msg() default "Hi";

}

TestAnnotation 中 id 属性默认值为 -1，msg 属性默认值为 Hi。

它可以这样应用：

@TestAnnotation()
public class Test {}

因为有默认值，所以无需要再在@TestAnnotation 后面的括号里面进行赋值了。

注意：

只有当属性有默认值时，才能省略参数赋值，否则会报错.

单value属性注解

如果一个注解内仅仅只有一个名字为 value 的属性时，应用这个注解时可以直接接将属性值填写到括号内。

public @interface Check {
	String value();
}

上面代码中，Check 这个注解只有 value 这个属性。所以可以这样应用：

@Check("hi")
int a;

这和下面的效果是一样的：

@Check(value="hi")
int a;

无属性注解

顾名思义，一个注解没有任何属性。比如：

public @interface Perform {}

那么在应用这个注解的时候，括号都可以省略。

@Perform
public void testMethod(){}

Java 预置的注解

@Deprecated

当一个类型或者类型成员使用@Deprecated 修饰的话，编译器将不鼓励使用这个被标注的程序元素。所以使用这种修饰具有一定的“延续性”：如果我们在代码中通过继承或者覆盖的方式使用了这个过时的类型或者成员，虽然继承或者覆盖后的类型或者成员并不是被声明为@Deprecated，但编译器仍然要报警。

public class Test {

    @Deprecated
    public static void testMethod(){
    }
    
}

在调用被@Deprecated注释的元素时，IDE中会出现下面的效果：

Test.testMethod();

@Override

这个大家应该很熟悉了，提示子类要复写父类中被 @Override 修饰的方法

@SuppressWarnings

阻止警告的意思。之前说过调用被 @Deprecated 注解的方法后，编译器会警告提醒，而有时候开发者会忽略这种警告，他们可以在调用的地方通过 @SuppressWarnings 达到目的。

@SuppressWarnings("deprecation")
public void test1(){
	Test.testMethod();
}

@SafeVarargs

参数安全类型注解。它的目的是提醒开发者不要用参数做一些不安全的操作,它的存在会阻止编译器产生 unchecked 这样的警告。它是在 Java 1.7 的版本中加入的。

@SafeVarargs // Not actually safe!
static void m(List<String>... stringLists) {
	Object[] array = stringLists;
	List<Integer> tmpList = Arrays.asList(42);
	array[0] = tmpList; // Semantically invalid, but compiles without warnings
	String s = stringLists[0].get(0); // Oh no, ClassCastException at runtime!
}

上面的代码中，编译阶段不会报错，但是运行时会抛出 ClassCastException 这个异常，所以它虽然告诉开发者要妥善处理，但是开发者自己还是搞砸了。

Java 官方文档说，未来的版本会授权编译器对这种不安全的操作产生错误警告。

@FunctionalInterface

函数式接口注解，这个是 Java 1.8 版本引入的新特性。函数式编程很火，所以 Java 8 也及时添加了这个特性。

函数式接口 (Functional Interface) 就是一个具有一个方法的普通接口。

@FunctionalInterface
public interface Runnable {
    public abstract void run();
}

我们进行线程开发中常用的 Runnable 就是一个典型的函数式接口，上面源码可以看到它就被 @FunctionalInterface 注解。

可能有人会疑惑，函数式接口标记有什么用，这个原因是函数式接口可以很容易转换为 Lambda 表达式

注解的提取

要获取类方法和字段的注解信息，必须通过Java的反射技术来获取 Annotation 对象，因为你除此之外没有别的获取注解对象的方法

首先可以通过 Class 对象的 isAnnotationPresent() 方法判断它是否应用了某个注解：

public boolean isAnnotationPresent(Class<? extends Annotation> annotationClass) {}

然后通过 getAnnotation() 方法来获取 Annotation 对象。

 public <A extends Annotation> A getAnnotation(Class<A> annotationClass) {}

或者是 getAnnotations() 方法。

public Annotation[] getAnnotations() {}

前一种方法返回指定类型的注解，后一种方法返回注解到这个元素上的所有注解。

如果获取到的 Annotation 如果不为 null，则就可以调用它们的属性方法了。

自定义注解

我们以手机为例子，来自定义注解

MobilePhonePrice.java

/**
 * 手机价格
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MobilePhonePrice {

    String price() default "";

}

MobilePhoneColor.java

/**
 * 手机颜色
 */
@Documented
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Repeatable(MobilePhoneColors.class)//手机可以有不同的颜色
public @interface MobilePhoneColor {

    enum Color {RED, BLUE, GREEN}

    Color color() default Color.BLUE;

}

MobilePhoneColors.java

/**
 * 注解容器
 */
@Documented
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface MobilePhoneColors {
    MobilePhoneColor[] value();
}

PhoneMenufacturerInfo.java

/**
 * 厂商信息
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface PhoneMenufacturerInfo {

    String brandName() default "";

    String address() default "";

}

MobilePhone.java

/**
 * 手机类
 */
public class MobilePhone {

    @MobilePhonePrice(price = "999")
    private String price;

    @MobilePhoneColor(color = MobilePhoneColor.Color.BLUE)
    @MobilePhoneColor(color = MobilePhoneColor.Color.RED)
    @MobilePhoneColor(color = MobilePhoneColor.Color.GREEN)
    private String color;

    @PhoneMenufacturerInfo(brandName = "华为", address = "深圳")
    private String menufacturerInfo;

    setter and getter ...
}

MobilePhonePaser.java

/**
 * 注解解析器
 */
public class MobilePhonePaser {

    public static void getMobilePhoneInfo(Class<?> clazz){

        String price = " 手机价格：";
        String color = " 手机颜色：";
        String menufacturerInfo = " 厂商信息：";

        Field[] fields = clazz.getDeclaredFields();

        for (Field field : fields) {
            if(field.isAnnotationPresent(MobilePhonePrice.class)){
                MobilePhonePrice mobilePhonePrice = field.getAnnotation(MobilePhonePrice.class);
                price = price + mobilePhonePrice.price();
                System.out.println(price);
            }
            if(field.isAnnotationPresent(MobilePhoneColors.class)){
                MobilePhoneColors mobilePhoneColors = field.getAnnotation(MobilePhoneColors.class);
                MobilePhoneColor[] colors = mobilePhoneColors.value();
                for (MobilePhoneColor mobilePhoneColor : colors) {
                    color = color + mobilePhoneColor.color() + "、";
                }
                color = color.substring(0,color.length()-1);
                System.out.println(color);
            }
            if(field.isAnnotationPresent(PhoneMenufacturerInfo.class)){
                PhoneMenufacturerInfo phoneMenufacturerInfo = field.getAnnotation(PhoneMenufacturerInfo.class);
                menufacturerInfo = menufacturerInfo + "品牌（" + phoneMenufacturerInfo.brandName() + "），地址（"+ phoneMenufacturerInfo.address() +"）";
                System.out.println(menufacturerInfo);
            }
        }

    }
}

Application.java

public class Application {

    public static void main(String[] args) {

        MobilePhonePaser.getMobilePhoneInfo(MobilePhone.class);

    }

}

运行结果：

手机价格：999
手机颜色：BLUE、RED、GREEN
厂商信息：品牌（华为），地址（深圳）




引用：
blog.csdn.net/briblue/art…
www.cnblogs.com/acm-bingzi/…

avatar
文章
阅读
粉丝