自定义注解前置知识

浅浅的花香味﹌ 2024-04-01 17:59 74阅读 0赞

**目录**

一、简介

二、作用

三、注解分类

1、JDK自带注解

2、 元注解（自定义注解重要前置知识）

2.1、@Target

2.2、@Retention

2.3、@Repeatable

2.4、@Native

2.5、@Inherited

2.6、@Documented

--------------------

## 一、简介 ##

java注解是在JDK5的时候引入的一种新特性。  
注解（也可以称为[元数据][Link 1]）为在代码中添加信息提供了一种形式化的方法，使得在代码中任一时刻可以非常方便的使用这些数据。

## 二、作用 ##

1、提供信息给编译器：编译器可直接通过注解探测错误和警告信息，例如：@Override，@Deprecated

2、编译阶段时的处理：软件工具可以用来利用注解信息生成代码、html文档或者做其他相应处理，例如：@Param，@Return，@See，@Author用于生成javadoc文档

3、运行时的处理：某些注解可以在程序运行时接收代码的提取，但注解本身不是代码的一部分

## 三、注解分类 ##

### 1、JDK自带注解 ###

>  *  @Override 检测重写
>  *  @Deprecated 已过时, 只是一个标志, 还是能够使用
>  *  @SuppressWarnings("all") 抑制编译器生成警告信息

### 2、 元注解（自定义注解重要前置知识） ###

所在路径：**java.lang.annotation**

![8ec1cad0147d4108a9d3068c6d58d74b.png][]

#### 2.1、@Target ####

> @Target(ElementType.TYPE)——接口、类、枚举、注解  
> @Target(ElementType.FIELD)——字段、枚举的常量  
> @Target(ElementType.METHOD)——方法  
> @Target(ElementType.PARAMETER)——方法参数  
> @Target(ElementType.CONSTRUCTOR) ——构造函数  
> @Target(ElementType.LOCAL\_VARIABLE)——局部变量  
> @Target(ElementType.ANNOTATION\_TYPE)——注解  
> @Target(ElementType.PACKAGE)——包，用于记录java文件的package信息

#### 2.2、@Retention ####

> @Retention(RetentionPolicy.SOURCE)——注解只保留在源文件，当Java文件编译成class文件的时候，注解被遗弃；被编译器忽略
> 
> @Retention(RetentionPolicy.CLASS)——注解被保留到class文件，但jvm加载class文件时候被遗弃，这是默认的生命周期
> 
> @Retention(RetentionPolicy.RUNTIME)——注解不仅被保存到class文件中，jvm加载class文件之后，仍然存在

#### 2.3、@Repeatable ####

可重复注解：允许在同一声明类型（类，属性，或方法）上多次使用同一个注解。这个注解在 jdk 1.8 中加入。

#### 2.4、@Native ####

使用 @Native 注解修饰成员变量，则表示这个变量可以被本地代码引用，常常被代码生成工具使用。对于 @Native 注解不常使用，这个注解在 jdk 1.8 中加入。 了解即可

#### 2.5、@Inherited ####

表明使用了@Inherited注解的注解，所标记的类的子类也会拥有这个注解

#### 2.6、@Documented ####

表明该注解标记的元素可以被Javadoc 或类似的工具文档化

[Link 1]: https://so.csdn.net/so/search?q=%E5%85%83%E6%95%B0%E6%8D%AE&spm=1001.2101.3001.7020
[8ec1cad0147d4108a9d3068c6d58d74b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/677cc8c902fd4be0827f7026d23d8bbc.png