您的位置 首页 java

Java注解开发及原理

现在的Spring项目开发中,越来越多的都是由原先基于xml等配置开发,转成了基于注解开发。原先所有的内容都配置在.xml文件上,在 Java 文件和配置文件来回转换,是相当麻烦和耗时的。为了解决这些个问题,Spring引入了注解,通过” @注解名称 ”的方式,让注解与Java Bean紧密结合,既大大减少了配置文件的体积,又增加了Java Bean的可读性与内聚性。今天就分享下,Java注解开发的原理。

元注解

先来看下如何定义一个注解,Jdk1.5提供给开发者四种元注解:@Retention、@Inherited、@Documented、@Target,jdk1.8又补充的2种 @Repeatable、@ Native 注解 ,目的是为了让开发者可以通过元注解自定义注解,使用注解开发。下面对元注解进行介绍。

Java注解开发及原理

@Retention

注解的保留位置(枚举RetentionPolicy),RetentionPolicy可选值:

  • SOURCE:注解仅存在于源码中,在class 字节码 文件中不包含
  • CLASS:默认的保留策略,注解在class字节码文件中存在,但运行时无法获得
  • RUNTIME:注解在class字节码文件中存在,在运行时可以通过反射获取到

如下图,可以看到使用RetentionPolicy.SOURCE仅存在源码中

Java注解开发及原理

如下图,使用RetentionPolicy.CLASS, class文件 也存在,运行期无法获取

Java注解开发及原理

没有获取到注解

Java注解开发及原理

如下图,使用RetentionPolicy.RUNTIME,class文件也存在,运行期可以获取

@Inherited

声明子类可以继承此注解,如果一个类A使用此注解,则类A的子类也继承此注解

未使用@ Inherited 注解,子类无法基础注解

使用@ Inherited 注解后,子类则继承注解

@Documented

声明注解能够被javadoc等识别。

未使用 @Documented 注解,通过idea查看Javadoc,快捷键(ctrl + Q),发现注解并没有

使用 @Documented 注解,则doc文档中含有注解

@Target

用来声明注解范围(枚举ElementType),ElementType可选值:

  • TYPE:可以使用在接口、类、枚举、注解上
  • FIELD:可以使用在字段、枚举的常量中
  • METHOD:可以使用在方法上
  • PARAMETER:可以使用在方法参数上
  • CONSTRUCTOR:可以使用在构造函数中
  • LOCAL_VARIABLE:可以使用在局部变量中
  • Annotation _TYPE:可以使用在注解中
  • PACKAGE:可以使用在package-info.java的包上
  • TYPE_PARAMETER:jdk1.8中新增,表示该注解能使用在自定义类型参数(参数的自定义类型可以是javaBean或者枚举等)的声明语句中
  • TYPE_USE:jdk1.8中新增,表示该注解能使用在使用类型的任意语句中

如下图,定义为 ElementType.TYPE,则只能修饰类,不能修饰方法

@Repeatable

@Repeatable注解即可以在同一方法、属性、类等类型中多次使用同一个注解。此特性相当于对Java8之前的重复注解在编译层面的增强

没有使用 @Repeatable注解的时候写法

使用 @Repeatable注解的时候写法

@Native

该注解修饰成员变量,则表示这个变量可以被本地代码引用,常常被代码生成工具使用。对于 @Native 注解不常使用,了解即可

注解开发原理

注解的本质就是一个继承了 Annotation 接口的接口。我们可以去反编译任意一个注解类,可以通过字节码文件看到确实实现了Annotation接口

注解只不过是一种特殊的注释而已,如果没有解析它的代码,它可能连注释都不如。因此注解解析是非常重要的,而解析一个类或者方法的注解往往有两种形式,一种是编译期直接的扫描,一种是运行期反射。

编译器的扫描指的是编译器在对 java 代码编译字节码的过程中会检测到某个类或者方法被一些注解修饰,这时它就会对于这些注解进行某些处理。jdk中典型的就是注解 @ Override ,一旦编译器检测到某个方法被修饰了 @Override 注解,编译器就会检查当前方法的方法签名是否真正重写了父类的某个方法,也就是比较父类中是否具有一个同样的方法签名。这一种情况只适用于那些编译器已经熟知的注解类,比如 JDK 内置的几个注解,而你自定义的注解,编译器是不知道你这个注解的作用的,当然也不知道该如何处理,往往只是会根据该注解的作用范围来选择是否编译进字节码文件,仅此而已。

因此对于自定义接口,常常我们是通过运行期反射获取,代码如下

运行期间,可以获取注解,以及注解的属性

一旦当我们获取到相应的注解及属性,可以执行一些特有的逻辑,从而实现注解的真正的意义。

文章来源:智云一二三科技

文章标题:Java注解开发及原理

文章地址:https://www.zhihuclub.com/185213.shtml

关于作者: 智云科技

热门文章

网站地图