java 普通方法的注解 java方法上加注解

转载

墨守成规de网工 2023-07-19 02:37:48

文章标签 java 普通方法的注解 java 元注解自定义注解 Java 文章分类 Java 后端开发

文章目录

1. 注解的理解
2. 注解的使用示例
3. 自定义注解
4. 元注解：对现有的注解进行解释说明的注解。
5. 如何获取注解信息:通过发射来进行获取、调用。
6. JDK8中注解的新特性：可重复注解、类型注解

6.1 可重复注解
6.2 类型注解

1. 注解的理解

jdk 5.0 新增的功能
Annotation 其实就是代码里的特殊标记, 这些标记可以在编译, 类加载, 运行时被读取, 并执行相应的处理。通过使用 Annotation, 程序员可以在不改变原逻辑的情况下, 在源文件中嵌入一些补充信息。
在JavaSE中，注解的使用目的比较简单，例如标记过时的功能，忽略警告等。在JavaEE/Android中注解占据了更重要的角色，例如用来配置应用程序的任何切面，代替JavaEE旧版中所遗留的繁冗代码和XML配置等。

框架 = 注解 + 反射机制 + 设计模式

2. 注解的使用示例

示例一：生成文档相关的注解

@author 标明开发该类模块的作者，多个作者之间使用,分割
@version 标明该类模块的版本
@see 参考转向，也就是相关主题
@since 从哪个版本开始增加的
@param对方法中某参数的说明，如果没有参数就不能写
@return 对方法返回值的说明，如果方法的返回值类型是void就不能写
@exception 对方法可能抛出的异常进行说明，如果方法没有用throws显式抛出的异常就不能写
其中

@param @return 和 @exception 这三个标记都是只用于方法的。
@param的格式要求： @param 形参名形参类型形参说明@return 的格式要求：@return 返回值类型返回值说明@exception的格式要求： @exception 异常类型异常说明@param和@exception可以并列多个

示例二：在编译时进行格式检查(JDK内置的个基本注解)

@Override: 限定重写父类方法, 该注解只能用于方法
@Deprecated: 用于表示所修饰的元素(类, 方法等)已过时。通常是因为所修饰的结构危险或存在更好的择
@SuppressWarnings: 抑制编译器警告

示例三：跟踪代码依赖性，实现替代配置文件功能

3. 自定义注解

参照@SuppressWarnings定义

① 注解声明为：@interface
② 内部定义成员，通常使用value表示
③ 可以指定成员的默认值，使用default定义
④ 如果自定义注解没成员，表明是一个标识作用。

说明：

如果注解有成员，在使用注解时，需要指明成员的值。
自定义注解必须配上注解的信息处理流程(使用反射)才意义。
自定义注解通过都会指明两个元注解：Retention、Target

代码举例：

@Inherited
@Repeatable(MyAnnotations.class)
@Retention(RetentionPolicy.RUNTIME)
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, 	LOCAL_VARIABLE,TYPE_PARAMETER,TYPE_USE})
public @interface MyAnnotation {

    String value() default "hello";
}

4. 元注解：对现有的注解进行解释说明的注解。

JDK 的元 Annotation 用于修饰其他 Annotation 定义
jdk 提供的4种元注解：

Retention：指定所修饰的 Annotation 的生命周期：SOURCE\CLASS（默认行为\RUNTIME

RetentionPolicy.SOURCE:在源文件中有效（即源文件保留），编译器直接丢弃这种策略的注释
RetentionPolicy.CLASS:在class文件中有效（即class保留），当运行 Java 程序时, JVM不会保留注解。这是默认值
RetentionPolicy.RUNTIME:在运行时有效（即运行时保留），当运行 Java 程序时, JVM 会保留注释。程序可以通过反射获取该注释
只声明为RUNTIME生命周期的注解，才能通过反射获取。

java 普通方法的注解 java方法上加注解_元注解

Target:用于指定被修饰的 Annotation 能用于修饰哪些程序元素

取值	描述
CONSTRUCTOR	用于描述构造器
FIELD	用于描述域
LOCAL_VARIABLE	用于描述局部变量
METHOD	用于描述方法
PACKAGE	用于描述包
PARAMETER	用于描述参数
TYPE	用于描述类、接口（包括注解声明）或enum声明

*******出现的频率较低*******

Documented:表用于指定被该元 Annotation 修饰的 Annotation 类将被javadoc 工具提取成文档。默认情况下， javadoc是不包括注解的。

定义为Documented的注解必须设置Retention值为RUNTIME

Inherited:被它修饰的 Annotation 将具继承性。如果某个类使用了被@Inherited 修饰的 Annotation, 则其子类将自动具有该注解。

5. 如何获取注解信息:通过发射来进行获取、调用。

JDK 5.0 在 java.lang.reflect 包下新增了 AnnotatedElement 接口, 该接口代表程序中可以接受注解的程序元素
当一个 Annotation 类型被定义为运行时 Annotation 后, 该注解才是运行时可见, 当 class 文件被载入时保存在 class 文件中的 Annotation 才会被虚拟机读取