@inherited 注解详解

桃扇骨 2022-09-05 01:51 194阅读 0赞

1【问题引出】

在 Springboot 项目中，通常会有一个启动类，而启动类中通常会有一个名为  @SpringBootApplication 的注解（如下图所示），而此注解就是 Springboot 项目启动类的核心注解。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bm55enlx_size_16_color_FFFFFF_t_70][]

我们打开 @SpringBootApplication 注解源码，可以看到，在源码中有一个 @Inherited 的注解，那么这个注解，它的作用是什么呢？

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bm55enlx_size_16_color_FFFFFF_t_70 1][]

2【@inherited 源码】

在了解该注解作用之前，我们不妨看看该注解的英文解释和源码定义，这样会更加有利于我们对该注解的理解。

（2.1）inherited 翻译

首先我们看翻译（来自百度翻译），可见 @inherited 有着 "继承"，"继任" 的意思。

![20210816165048732.png][]

（2.2）@inherite 源码

然后，我们打开 inherited 的源码，可以看到：

（1）该注解作用于整个程序运行中（@Retention(RetentionPolicy.RUNTIME）；

（2）该注解只能修饰注解（@Target(\{ElementType.ANNOTATION\_TYPE\})），因此，它是一个元注解。

![202108161653252.png][]

再了解到上面的情况后，我们就可以对 @inherited 注解进一步探究了。

3【举例说明】

既然它是一个有着关于"继承"的注解，那么我们便可以联想到，Java类之间也有继承的关系，我们不妨创建两个类，让他们为父子关系，然后创建两个注解，作用于类上，两个注解之间唯一不同的区别就是有无 @Inherited修饰。

我们创建父类 Father 和 子类Child，作为实验类。

（3.1）Father 类

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bm55enlx_size_16_color_FFFFFF_t_70 2][]

（3.2）Child 类（继承 Father  类）

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bm55enlx_size_16_color_FFFFFF_t_70 3][]

另外，我们再自定义两个注解，@HasInherited 和 @NoInherited，用于验证结果，前者注解包含@Inherited 注解，后者反之。

由于注解定义需要指明作用范围，以及作用的生命周期，那么我们不妨指定两个注解均作用于类上和整个代码运行生命周期中，让两者的唯一区别就是有无 @Inherited 注解。

（3.3）@HasInherited （有 @Inherited 注解）

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bm55enlx_size_16_color_FFFFFF_t_70 4][]

（3.4）@NoInherited（无 @Inherited 注解）

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bm55enlx_size_16_color_FFFFFF_t_70 5][]

4【测试验证】

（4.1）创建 Test 测试类

我们再写一个测试类 Test，用于获取实验类（Father 和 Child）上所有的注解信息。

package com.test.inherited;
    
    import java.lang.annotation.Annotation;
    
    public class Test {
    
        public static void main(String[] args) {
            // 打印父类注解信息
            Annotation[] fatherAnnotations = Father.class.getAnnotations();
            System.out.println("------- 父类 Father 信息 --------");
            System.out.println("父类注解个数：" + fatherAnnotations.length);
            for (Annotation fa : fatherAnnotations) {
                System.out.println(fa.annotationType().getSimpleName());
            }
            // 打印子类注解信息
            Annotation[] childAnnotations = Child.class.getAnnotations();
            System.out.println("------- 子类 Child 信息 --------");
            System.out.println("子类注解个数：" + childAnnotations.length);
            for (Annotation ca: childAnnotations) {
                System.out.println(ca.annotationType().getSimpleName());
            }
        }
    
    }

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bm55enlx_size_16_color_FFFFFF_t_70 6][]

（4.2） 有 @Inherited 注解验证

首先，我们在父类只打上 @HasInherited 注解，子类不做处理，然后执行测试类 Test。

@HasInherited
    public class Father {
    
    }

最终控制台打印所下：

------- 父类 Father 信息 --------
    父类注解个数：1
    HasInherited
    ------- 子类 Child 信息 --------
    子类注解个数：1
    HasInherited

（4.3） 无 @Inherited 注解验证

我们在父类上只打上 @NoInherited 注解，子类不做处理，然后执行测试类Test。

@NoInherited
    public class Father {
    
    }

最终控制台打印如下：

------- 父类 Father 信息 --------
    父类注解个数：1
    NoInherited
    ------- 子类 Child 信息 --------
    子类注解个数：0

（4.4）结论

经过上面的演示，那么最终的结论，我们就不难得出来了。

结论：被 @Inherited 注解修饰的注解，如果作用于某个类上，其子类是可以继承的该注解的。反之，如果一个注解没有被 @Inherited注解所修饰，那么他的作用范围只能是当前类，其子类是不能被继承的。

5.【修改 Springboot 启动类】

既然 @SpringBootApplication 注解中也包含了 @Inherited 注解，那么针对上面的结论，我们不妨尝试下对 Springboot 启动类进行修改，我们可以写一个子类，去继承原启动类，同时把原启动的 mian 方法去掉，加在子类中，看是否能够启动成功？

（5.1）修改 Springboot 启动类前

启动类如图所示：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bm55enlx_size_16_color_FFFFFF_t_70 7][]

启动打印如下：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bm55enlx_size_16_color_FFFFFF_t_70 8][]

（5.2）修改 Springboot 启动类后

原启动类（只保留 @SpringBootApplication 注解）

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bm55enlx_size_16_color_FFFFFF_t_70 9][]

子启动类（并未打任何注解）

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bm55enlx_size_16_color_FFFFFF_t_70 10][] 启动打印如下：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bm55enlx_size_16_color_FFFFFF_t_70 11][]

可以看到，确实也是启动 OK 的，也验证了我们的推理。

6【总结】

当以后我们在定义一个作用于类的注解时候，如果希望该注解也作用于其子类，那么可以用@Inherited 来进行修饰。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bm55enlx_size_16_color_FFFFFF_t_70]: /images/20220829/5e54501611464cd78742fc2e0ce7bb1c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bm55enlx_size_16_color_FFFFFF_t_70 1]: /images/20220829/d80f671e8f4549c29df5269df2a18f4a.png
[20210816165048732.png]: /images/20220829/3aa28a0a6ba440128fc366ff28c3ca7d.png
[202108161653252.png]: /images/20220829/de388253cb2b4bbc94322ecac121c6f5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bm55enlx_size_16_color_FFFFFF_t_70 2]: /images/20220829/99a0920da2b24b85ac6a50bc9f9391f0.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bm55enlx_size_16_color_FFFFFF_t_70 3]: /images/20220829/a03dacf14e9448438df679c601fc00b0.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bm55enlx_size_16_color_FFFFFF_t_70 4]: /images/20220829/4cc714cfaaa64bce91ee910fce4a859d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bm55enlx_size_16_color_FFFFFF_t_70 5]: /images/20220829/10dff035052c4f3190c4690a9c7f691a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bm55enlx_size_16_color_FFFFFF_t_70 6]: /images/20220829/327bf73273e54462b7a7eb5565c5297f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bm55enlx_size_16_color_FFFFFF_t_70 7]: /images/20220829/c6884a73f72d451f93345dfc55f225f1.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bm55enlx_size_16_color_FFFFFF_t_70 8]: /images/20220829/3a44c51066594c11a05069270f9c9b7a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bm55enlx_size_16_color_FFFFFF_t_70 9]: /images/20220829/16bb73eb48a747479d67fdbd008a5800.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bm55enlx_size_16_color_FFFFFF_t_70 10]: /images/20220829/2cf0cf3e3c5644948c9521602ea818d6.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bm55enlx_size_16_color_FFFFFF_t_70 11]: /images/20220829/6a2100b4c87e4fe8955418c56f3ad803.png