每天进步一点,不做curd工程师与Api调用工程师!
欢迎大家访问我的博客:https://coder-programming.cn/
为了防止篇幅过长不易阅读,在介绍Java注解时。分为两篇文章进行详细介绍。
内容如下
Java注解基本介绍
简介
注解也叫元数据,例如我们常见的@Override和@Deprecated,注解是JDK1.5版本开始引入的一个特性,用于对代码进行说明,可以对包、类、接口、字段、方法参数、局部变量等进行注解。
功能
- 作为特定的标记,用于告诉编译器一些信息
- 编译时动态处理,如动态生成代码
- 运行时动态处理,作为额外信息的载体,如获取注解信息
其中了解下XML与注解的区别:
注解:是一种分散式的元数据,与源代码紧绑定。
XML:是一种集中式的元数据,与源代码无绑定
分类
- 标准注解:
@Override
、@Deprecated
、@SuppresWarnings
- 元注解:
@Retention
、@Target
、@Inherited
、@Documented
- 自定义注解:可以根据自己的需求定义注解
注:
@Override(标明重写某个方法)、
@Deprecated(标明某个类或方法过时)
@SuppressWarnings(标明要忽略的警告)
元注解详细介绍
元注解的作用就是负责注解其他注解。Java5.0定义了4个标准的meta-annotation类型,它们被用来提供对其它 annotation类型作说明。Java5.0定义的元注解有以下几种:
- @Target
- @Retention
- @Documented
- @Inherited
元注解 @Target
用于描述注解的范围,即注解在哪用。它说明了Annotation所修饰的对象范围:Annotation可被用于 packages、types(类、接口、枚举、Annotation类型)、类型成员(方法、构造方法、成员变量、枚举值)、方法参数和本地变量(如循环变量、catch参数)等。通过源码我们可以看到取值类型(ElementType)有以下几种:
package java.lang.annotation;
public enum ElementType {
TYPE, //用于描述类、接口(包括注解类型) 或enum声明
FIELD, //用于描述域即类成员变量
METHOD, //用于描述方法
PARAMETER, //用于描述参数
CONSTRUCTOR, //用于描述构造器
LOCAL_VARIABLE, //用于描述局部变量
ANNOTATION_TYPE, //描述注解
PACKAGE,//用于描述包
TYPE_PARAMETER,//1.8版本开始,描述类、接口或enum参数的声明
TYPE_USE, //1.8版本开始,描述一种类、接口或enum的使用声明
MODULE; //表示作用在部分模块中(Java9引入的概念)
private ElementType() {
}
}
举例:
///表示Log注解可以用在类、接口、enum和方法上
@Target({ElementType.METHOD, ElementType.TYPE})
public @interface Log {
......
}
元注解 @Retention
用于描述注解的生命周期,表示需要在什么级别保存该注解,即保留的时间长短。取值类型(RetentionPolicy)有以下几种:
- SOURCE:在源文件中有效(即源文件保留)
- CLASS:在class文件中有效(即class保留)
- RUNTIME:在运行时有效(即运行时保留)
举例:
//使用RetentionPolicy.RUNTIME,这样注解处理器可以通过反射,获取到该注解的属性值,从而去做一些运行时的逻辑处理。
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Log {
......
}
元注解 @Documented
用于描述其它类型的annotation应该被作为被标注的程序成员的公共API,因此可以被例如javadoc此类的工具文档化。它是一个标记注解,没有成员。
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Log {
......
}
元注解 @Inherited
用于表示某个被标注的类型是被继承的。如果一个使用了@Inherited修饰的annotation类型被用于一个class,则这个annotation将被用于该class的子类。
文末
文章收录至
Github: https://github.com/CoderMerlin/coder-programming
Gitee: https://gitee.com/573059382/coder-programming
欢迎关注并star~