java 继承 注解_JAVA注解的继承性

摘要

本文从三个方面介绍java注解的“继承性”：

基于元注解@Inherited，类上注解的继承性

基于类的继承，方法/属性上注解的继承性

基于接口的继承/实现，方法/属性上注解的继承性

一、基于@Inherited

首先元注解@Inherited作为一个元注解，只能修饰其他注解类型(由@Target(ElementType.ANNOTATION_TYPE)决定)。

所谓的基于@Inherited的继承性，指的是@Inherited修饰的其他注解修饰类时，这个类的子类是否可以继承到父类的注解；主角是@Inherited修饰的其他注解，而不是@Inherited本身。

JDK中@Inherited的说明文档很清楚的阐述了继承性：

当用户在一个程序元素类上，使用AnnotatedElement的相关注解查询方法，查询元注解Inherited修饰的其他注解类型A时，如果这个类本身并没有被注解A修饰，那么会自动查询这个类的父类是否被注解A修饰。查询过程会沿着类继承链一直向上查找，直到注解A被找到，或者到达继承链顶层(Object)。

如果元注解Inherited修饰的其他注解，修饰了除类之外的其他程序元素，那么继承性将会失效。

下面的以demo说明：

public class ClassInheritedTest {

@Target(value = ElementType.TYPE)

@Retention(value = RetentionPolicy.RUNTIME)

@Inherited // 声明注解具有继承性

@interface AInherited {

String value() default "";

}

@Target(value = ElementType.TYPE)

@Retention(value = RetentionPolicy.RUNTIME)

@Inherited // 声明注解具有继承性

@interface BInherited {

String value() default "";

}

@Target(value = ElementType.TYPE)

@Retention(value = RetentionPolicy.RUNTIME)

// 未声明注解具有继承性

@interface CInherited {

String value() default "";

}

@AInherited("父类的AInherited")

@BInherited("父类的BInherited")

@CInherited("父类的CInherited")

class SuperClass {

}

@BInherited("子类的BInherited")

class ChildClass extends SuperClass {

}

public static void main(String[] args) {

Annotation[] annotations = ChildClass.class.getAnnotations();

System.out.println(Arrays.toString(annotations));

// output: [@annotations.InheritedTest1$AInherited(value=父类的AInherited), @annotations.InheritedTest1$BInherited(value=子类的BInherited)]

}

}

说明：

自定义注解 @CInherited 没有被@Inherited 修饰，不具备继承性，子类ChildClass获取类上的注解时，没有该注解；

自定义注解@BInherited，具备继承性，但是子类ChildClass在类上自行指定了与父类相同类型的注解@BInherited，那么子类获取其类注解时，@BInherited为子类自己声明的；

自定义注解@AInherited，具备继承性，子类上未指定相同注解，子类获取注解时，成功获取到父类上的@AInherited注解。

二、基于类继承

属性和方法注解的继承，与类注解的继承完全不同，与元注解Inherited毫无关系，忠实于方法/属性本身的继承。

以下示例说明属性/方法注解的继承：

public class InheritedTest {

@Target(value = {ElementType.METHOD, ElementType.FIELD})

@Retention(value = RetentionPolicy.RUNTIME)

@interface DESC {

String value() default "";

}

class SuperClass {

@DESC("父类方法foo")

public void foo() {}

@DESC("父类方法bar")

public void bar(){}

@DESC("父类的属性")

public String field;

}

class ChildClass extends SuperClass {

@Override

public void foo() {

super.foo();

}

}

public static void main(String[] args) throws NoSuchMethodException, NoSuchFieldException {

Method foo = ChildClass.class.getMethod("foo");

System.out.println(Arrays.toString(foo.getAnnotations()));

// output: []

// 子类ChildClass重写了父类方法foo,并且@Override注解只在源码阶段保留，所以没有任何注解

Method bar = ChildClass.class.getMethod("bar");

System.out.println(Arrays.toString(bar.getAnnotations()));

// output: [@annotations.InheritedTest$DESC(value=父类方法bar)]

// bar方法未被子类重写，从父类继承到了原本注解

Field field = ChildClass.class.getField("field");

System.out.println(Arrays.toString(field.getAnnotations()));

}

// output: [@annotations.InheritedTest$DESC(value=父类的属性)]

// 解释同上

三、基于接口继承/实现

基于接口的继承/实现中，属性和方法注解的继承大体与类相似。jdk7以前接口的方法都需要实现，所以子类中的方法永远也无法获得父接口方法的注解，但是jdk8以后的默认方法打开了这种限制。

以下以demo说明:

public class IterInheritedTest {

@Target(value = {ElementType.METHOD, ElementType.FIELD})

@Retention(value = RetentionPolicy.RUNTIME)

@interface DESC {

String value() default "";

}

interface SuperInterface {

@DESC("父接口的属性")

String field = "field";

@DESC("父接口方法foo")

public void foo();

@DESC("父接口方法bar")

default public void bar() {

}

}

interface ChildInterface extends SuperInterface {

@DESC("子接口方法foo")

@Override

void foo();

}

class ChildClass implements SuperInterface {

@DESC("子类的属性")

public String field = "field";

@Override

public void foo() {

}

}

public static void main(String[] args) throws NoSuchMethodException, NoSuchFieldException {

Method iFoo = ChildInterface.class.getMethod("foo");

System.out.println(Arrays.toString(iFoo.getAnnotations()));

// output: [@annotations.IterInheritedTest$DESC(value=子接口方法foo)]

Method iBar = ChildInterface.class.getMethod("bar");

System.out.println(Arrays.toString(iBar.getAnnotations()));

// output: [@annotations.IterInheritedTest$DESC(value=父接口方法bar)]

Field iField = ChildInterface.class.getField("field");

System.out.println(Arrays.toString(iField.getAnnotations()));

// output: [@annotations.IterInheritedTest$DESC(value=父接口的属性)]

Method foo = ChildClass.class.getMethod("foo");

System.out.println(Arrays.toString(foo.getAnnotations()));

// output: []; 被子类覆盖

Method bar = ChildClass.class.getMethod("bar");

System.out.println(Arrays.toString(bar.getAnnotations()));

// output: [@annotations.IterInheritedTest$DESC(value=父接口方法bar)]

Field field = ChildClass.class.getField("field");

System.out.println(Arrays.toString(field.getAnnotations()));

// output: [@annotations.IterInheritedTest$DESC(value=子类的属性)]

// 是子类作用域下的属性`field`

}

}

总结

@Inherited 修饰的注解，继承性只体现在对类的修饰上；

方法和属性上注解的继承，忠实于方法/属性继承本身，客观反映方法/属性上的注解。