type
status
date
slug
summary
tags
category
icon
password
example-row
example-row
定义:注解(Annotation),也叫元数据。一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性,与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面,用来对这些元素进行说明,注释。注解通过
@interface
关键字进行定义。元注解
元注解是可以注解到注解上的注解,或者说元注解是一种基本注解,但是它能够应用到其它的注解上面。元注解有
@Retention
、@Documented
、@Target
、@Inherited
、@Repeatable
5 种。@Retention
说明这个注解的的存活时间,它的取值如下:
RetentionPolicy.SOURCE
注解只在源码阶段保留,在编译器进行编译时它将被丢弃忽视。
RetentionPolicy.CLASS
注解只被保留到编译进行的时候,它并不会被加载到JVM
中。
-
RetentionPolicy.RUNTIME
注解可以保留到程序运行的时候,它会被加载进入到JVM
中,所以在程序运行时可以获取到它们。JVM将在运行期间保留注解,因此可以通过反射机制读取注解的信息
@Documented
将注解中的元素包含到 Javadoc 中去。
@Target
表示该注解可以用于什么地方,可能的
ElementType
参数有: ElementType.ANNOTATION_TYPE
可以给一个注解进行注解
ElementType.CONSTRUCTOR
可以给构造方法进行注解
ElementType.FIELD
可以给属性进行注解
-
ElementType.LOCAL_VARIABLE
可以给局部变量进行注解
ElementType.METHOD
可以给方法进行注解
ElementType.PACKAGE
可以给一个包进行注解
-
ElementType.PARAMETER
可以给一个方法内的参数进行注解
-
ElementType.TYPE
可以给一个类型进行注解,比如类、接口、枚举
@Inherited
它并不是说注解本身可以继承,而是说如果一个超类被
@Inherited
注解过的注解进行注解的话,那么如果它的子类没有被任何注解应用的话,那么这个子类就继承了超类的注解。注解
Test
被 @Inherited
修饰,之后类 A
被Test
注解,类B
继承A
,类 B
也拥有Test
这个注解@Repeatable
Repeatable
是可重复的意思。@Repeatable
是 Java 1.8
才加进来的,所以算是一个新的特性。@Repeatable
注解了Person
。而 @Repeatable
后面括号中的类相当于一个容器注解。什么是容器注解呢?就是用来存放其它注解的地方。它本身也是一个注解。
注解的属性
注解的属性也叫做成员变量。注解只有成员变量,没有方法。注解的成员变量在注解的定义中以“无形参的方法”形式来声明,其方法名定义了该成员变量的名字,其返回值定义了该成员变量的类型。
上面代码定义了
TestAnnotation
这个注解中拥有id
和msg
两个属性。在使用的时候,我们应该给它们进行赋值。赋值的方式是在注解的括号内以
value=“”
形式,多个属性之前用 ,
隔开。在注解中定义属性时它的类型必须是 8 种基本数据类型外加类、接口、注解及它们的数组。 注解中属性可以有默认值,默认值需要用default 关键值指定。比如:
Java 预置的注解
JDK
中预定义的一些注解 @Override
:检测被该注解标注的方法是否是继承自父类(接口)的
@Deprecated
:该注解标注的内容,表示已过时
@SuppressWarnings
:压制警告- 一般传递参数all
@SuppressWarnings(“all”)
@SafeVarargs:
参数安全类型注解。它的目的是提醒开发者不要用参数做一些不安全的操作,它的存在会阻止编译器产生unchecked
这样的警告。它是在Java 1.7
的版本中加入的。
上面的代码中,编译阶段不会报错,但是运行时会抛出
ClassCastException
这个异常,所以它虽然告诉开发者要妥善处理,但是开发者自己还是搞砸了。Java
官方文档说,未来的版本会授权编译器对这种不安全的操作产生错误警告。@FunctionalInterface
:函数式接口注解,这个是Java 1.8
本引入的新特性。函数式编程很火,所以Java 8
也及时添加了这个特性。函数式接口 (Functional Interface)就是一个具有一个方法的普通接口。比如
函数式接口标记有什么用,这个原因是函数式接口可以很容易转换为
Lambda
表达式。注解与反射
首先可以通过 Class 对象的
isAnnotationPresent()
方法判断它是否应用了某个注解然后通过
getAnnotation()
方法来获取Annotation
对象。方法返回指定类型的注解。或者是
getAnnotations()
方法。方法返回注解到这个元素上的所有注解。如果获取到的
Annotation
如果不为null
,则就可以调用它们的属性方法了。比如自定义注解
注解类
使用注解
解析注解
总结
java
注解是附加在代码中的一些元信息,用于一些工具在编译、运行时进行解析和使用,起到说明、配置的功能。
- 注解不会也不能影响代码的实际逻辑,仅仅起到辅助性的作用。包含在
java.lang.annotation
包中
- java自定义注解和运行时靠反射获取注解。
参考
- 作者:黄x黄
- 链接:https://hxhowl.site/article/javanote005-annotation
- 声明:本文采用 CC BY-NC-SA 4.0 许可协议,转载请注明出处。
相关文章