说说自定义注解及简单使用

哪里不懂磕哪里:smile:

谈及注解,应该都很熟悉不过了,例如你在web控制层需要@RequestMapping来映射路径,有碧如你的借口实现类上面的@Override… 那么,这些注解怎么来的,我们如何自定义注解来完成一些功能?

注解是什么

Annotation(注解)就是Java提供了一种元程序中的元素关联任何信息和着任何元数据(metadata)的途径和方法。Annotion(注解)是一个接口,程序可以通过反射来获取指定程序元素的Annotion对象,然后通过Annotion对象来获取注解里面的元数据。

Annotation(注解)是JDK5.0及以后版本引入的。它可以用于创建文档,跟踪代码中的依赖性,甚至执行基本编译时检查。从某些方面看,annotation就像修饰符一样被使用,并应用于包、类 型、构造方法、方法、成员变量、参数、本地变量的声明中。这些信息被存储在Annotation的“name=value”结构对中。

注解的用处

  • 生成文档。这是最常见的,也是java 最早提供的注解。常用的有@param @return 等

  • 跟踪代码依赖性,实现替代配置文件功能。比如Dagger 2依赖注入,未来java开发,将大量注解配置,具有很大用处;

  • 在编译时进行格式检查。如@override 放在方法前,如果你这个方法并不是覆盖了超类方法,则编译时就能检查出。

注解的原理

注解本质是一个继承了Annotation的特殊接口,其具体实现类是Java运行时生成的动态代理类。而我们通过反射获取注解时,返回的是Java运行时生成的动态代理对象$Proxy1。通过代理对象调用自定义注解(接口)的方法,会最终调用AnnotationInvocationHandler的invoke方法。该方法会从memberValues这个Map中索引出对应的值。而memberValues的来源是Java常量池。

注解的组成

元注解

java.lang.annotation提供了四种元注解,专门注解其他的注解(在自定义注解的时候,需要使用到元注解):

@Documented –一个简单的Annotations标记注解,表示是否将注解信息添加在java文档中。

@Retention –什么时候使用该注解,定义该注解的生命周期

  • RetentionPolicy.SOURCE : 在编译阶段丢弃。这些注解在编译结束之后就不再有任何意义,所以它们不会写入字节码。例如@Override, @SuppressWarnings都属于这类注解。

  • RetentionPolicy.CLASS : 在类加载的时候丢弃。在字节码文件的处理中有用。注解默认使用这种方式

  • RetentionPolicy.RUNTIME : 始终不会丢弃,运行期也保留该注解,因此可以使用反射机制读取该注解的信息。我们自定义的注解通常使用这种方式。

@Target –注解用于什么地方,可用的ElementType参数包括:

  • ElementType.CONSTRUCTOR:用于描述构造器

  • ElementType.FIELD:成员变量、对象、属性(包括enum实例)

  • ElementType.LOCAL_VARIABLE:用于描述局部变量

  • ElementType.METHOD:用于描述方法

  • ElementType.PACKAGE:用于描述包

  • ElementType.PARAMETER:用于描述参数

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

@Inherited – 定义该注释和子类的关系,或者说是否允许子类继承该注解

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

常见标准的Annotation

  • Override
    java.lang.Override是一个标记类型注解,它被用作标注方法。它说明了被标注的方法重载了父类的方法,起到了断言的作用。如果我们使用了这种注解在一个没有覆盖父类方法的方法时,java编译器将以一个编译错误来警示。

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

  • SuppressWarnings
    SuppressWarning不是一个标记类型注解。它有一个类型为String[]的成员,这个成员的值为被禁止的警告名。对于javac编译器来讲,被-Xlint选项有效的警告名也同样对@SuppressWarings有效,同时编译器忽略掉无法识别的警告名。
    @SuppressWarnings(“unchecked”)

自定义注解遵守原则

凡事都要有原则的,对猿们来讲,更是要严谨了:yum:,看看这些规则:

  • Annotation型定义为@interface, 所有的Annotation会自动继承java.lang.Annotation这一接口,并且不能再去继承别的类或是接口.

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

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

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

  • 注解也可以没有定义成员, 不过这样注解就没啥用了

自定义注解实例

有关相关代码示例,可以点此GitHub地址
该工程简单实现了mybatis的@Insert和@select注解的实现,如果有兴趣,你可以做一下@update和@delete的实现

说说注解在哪使用

例如签名校验,接口防刷等场景,说白了,类似上一文的springboot对控制层全局异常的处理,个人认为还是结合拦截器或者aop机制来用的场景想对较多吧,当然也有别的用途,暂时没有遇到。

参考

https://blog.csdn.net/PORSCHE_GT3RS/article/details/80304701

越码越幸福:sweat_smile: