注解类
1. 注解类的基本概念
（1）注解(Annotation)：也被称为元数据(Metadata)，用于修饰解释 包、类、方法、属性、构造器、局部变量等数据信息。
（2）和注释一样，注解不影响程序逻辑，但注解可以被编译或运行，相当于嵌入在代码中的补充信息。
（3）在 JavaSE 中，注解的使用目的比较简单，例如标记过时的功能，忽略警告等。在 JavaEE 中注解占据了更重要的角色，例如用来配置应用程序的任何切面，代替 java EE 旧版中所遗留的繁冗代码和 XML 配置等。
- 基本用法：
- 使用 Annotation 时要在其前面增加 @ 符号, 并把该 Annotation 当成一个修饰符使用，用于修饰它支持的程序元素。基本的3个注解类如下：
| 注解 | 功能 |
|---|---|
| @Override | 限定某个方法，是重写父类的方法, 该注解只能用于方法 |
| @Deprecated | 用于表示某个程序元素(类, 方法等)已过时 |
| @SuppressWarnings | 抑制编译器警告 |
2. 注解的应用案例
2.1 @Override 注解的案例
-
使用说明：
-
代码说明：
//父类
class Father{
public void fly(){
System.out.println("Father fly...");
}
}
//子类
class Son extends Father {
/*
1. @Override 注解放在fly 方法上，表示子类的fly 方法重写了父类的 fly；
2. 这里如果没有添加 @Override, 子类还是会重写父类fly，编译器不会报错；
3. 但如果你写了@Override 注解，编译器就会去检查该方法是否真的重写了父类的
方法，如果的确重写了，则编译通过，如果没有构成重写，则编译错误；
4. 看看 @Override 注解类的定义
*/
@Override 类的源码如下：
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface Override {
}
// 解读： 如果发现用 @interface 修饰一个类，则表示该类是一个 注解类；
@Override
public void fly() {
// 无论有无 @Override，子类都重写了父类
System.out.println("Son fly....");
}
/* 但如果你写了@Override 注解，编译器就会去检查该方法是否真的重写了父类的
方法，如果的确重写了，则编译通过，如果没有构成重写，则编译错误*/
@Override
public void say() {
} // 报错，父类中没有该方法
}
- 说明：@Override 注解相当于一个检查机制，可以使用它来检查子类的方法是否真的重写了父类的方法。
2.2 @Deprecated 注解的案例
- 使用说明：
- 代码说明：
public class Deprecated_ {
public static void main(String[] args) {
A a = new A();
a.hi();
System.out.println(a.n1);
}
}
/*
1. @Deprecated 修饰某个元素, 表示该元素已经过时
2. 即不再推荐使用，但是仍然可以使用；
3. 查看 @Deprecated 注解类的源码；
4. 可以修饰方法，类，字段, 包, 参数 等等；
5. @Deprecated 可以做版本升级过渡使用；
*/
@Deprecated 注解的源码如下：
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(value={
CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, PARAMETER, TYPE})
public @interface Deprecated {
}
// 使用
@Deprecated
class A {
@Deprecated
public int n1 = 10;
@Deprecated
public void hi(){
}
}
2.3 @SuppressWarnings 注解的案例
- 使用说明：
- @SuppressWarnings ：抑制编译器警告
（1）当我们不希望看到这些警告的时候，可以使用 SuppressWarnings 注解来抑制警告信息；
（2）在{“”} 中，可以写入你希望抑制(不显示)警告信息；
（3）关于SuppressWarnings 作用范围是和你放置的位置相关；比如 @SuppressWarnings 放置在 main方法，那么抑制警告的范围就是 main方法；
（4） @SuppressWarnings 注解接收的是一个字符串数组，可以看其源码。
- 代码说明：
@SuppressWarnings({
"rawtypes", "unchecked", "unused"})
public class SuppressWarnings_ {
/*
1. 当我们不希望看到这些警告的时候，可以使用 SuppressWarnings注解来抑制警告信息；
2. 在{""} 中，可以写入你希望抑制(不显示)警告信息；
3. 关于SuppressWarnings 作用范围是和你放置的位置相关；
比如 @SuppressWarnings放置在 main方法，那么抑制警告的范围就是 main；
通常我们可以放置具体的语句, 方法, 类.
4. 看看 @SuppressWarnings 源码
(1) 放置的位置就是 TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE
(2) 该注解类有数组 String[] values()， 设置一个数组比如 {"rawtypes", "unchecked", "unused"}
*/
@SuppressWarnings 注解的源码如下：
@Target({
TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
@Retention(RetentionPolicy.SOURCE)
public @interface SuppressWarnings {
String[] value();
}
public static void main(String[] args) {
List list = new ArrayList();
list.add("jack");
list.add("tom");
list.add("mary");
int i;
System.out.println(list.get(1));
}
public void f1() {
// @SuppressWarnings({"rawtypes"})
List list = new ArrayList();// 如果不加注解，则会有警告，加了就不会有警告
list.add("jack");
list.add("tom");
list.add("mary");
// @SuppressWarnings({"unused"})
int i;
System.out.println(list.get(1));
}
}
- 可以指定的警告类型如下：
| 类型 | 范围 |
|---|---|
| all | 抑制所有警告 |
| boxing， | 抑制与封装/拆装作业相关的警告 |
| cast， | 抑制与强制转型作业相关的警告 |
| dep-ann | 抑制与淘汰注释相关的警告 |
| deprecation | 抑制与淘汰的相关警告 |
| fallthrough | 抑制与switch陈述式中遗漏break相关的警告 |
| finally | 抑制与未传回finally区块相关的警告 |
| hiding | 抑制与隐藏变数的区域变数相关的警告 |
| incomplete-switch | 抑制与switch陈述式(enum case)中遗漏项目相关的警告 |
| javadoc | 抑制与javadoc相关的警告 |
| nls | 抑制与非nls字串文字相关的警告 |
| null | 抑制与空值分析相关的警告 |
| rawtypes | 抑制与使用raw类型相关的警告 |
| resource | 抑制与使用Closeable类型的资源相关的警告 |
| restriction | 抑制与使用不建议或禁止参照相关的警告 |
| serial | 抑制与可序列化的类别遗漏serialVersionUID栏位相关的警告 |
| static-access | 抑制与静态存取不正确相关的警告 |
| static-method | 抑制与可能宣告为static的方法相关的警告 |
| super | 抑制与置换方法相关但不含super呼叫的警告 |
| synthetic-access | 抑制与内部类别的存取未最佳化相关的警告 |
| sync-override | 抑制因为置换同步方法而遗漏同步化的警告 |
| unchecked | 抑制与未检查的作业相关的警告 |
| unqualified-field-access | 抑制与栏位存取不合格相关的警告 |
| unused | 抑制与未用的程式码及停用的程式码相关的警告 |
3. JDK 的元注解
- JDK 的元注解 是用于修饰其他注解类的注解。元注解本身作用不大，只需了解，看源码时知道其作用就行。
- 元注解的种类如下：
| 元注解 | 作用 |
|---|---|
| Retention | 指定注解的作用范围，有三种： SOURCE,CLASS,RUNTIME |
| Target | 指定注解可以在哪些地方使用 |
| Documented | 指定该注解是否会在 javadoc 体现 |
| Inherited | 子类会继承父类注解 |
3.1 @Retention 元注解
- 使用说明：
@Retention 元注解：只能用于修饰一个 注解的定义, 用于指定该 注解 可以保留多长时间, @Rentention 包含一个 RetentionPolicy 类型的成员变量 value , 使用 @Rentention 时必须为该成员变量指定值。
- @Retention 的成员变量三种值如下：
| 变量 | 作用 |
|---|---|
| RetentionPolicy.SOURCE | 编译器使用后，直接丢弃这种策略的注解 |
| RetentionPolicy.CLASS | 编译器将把注解记录在 class 文件中. 当运行 Java 程序时, JVM 不会保留注解。 这是默认值 |
| RetentionPolicy.RUNTIME | 编译器将把注解记录在 class 文件中. 当运行 Java 程序时, JVM 会保留注解. 程序可以 通过反射获取该注解 |
- 使用案例：
- 以修饰 @Override 注解为例：
3.2 @Target 元注解
- 使用说明：
@Target 元注解：只能用于修饰一个 注解的定义, 用于指定被修饰的注解能用于修饰哪些程序元素, @Target 包含一个 ElementType 数组类型的成员变量 value, 使用@Target 时必须为该成员变量指定值，可以指定多个值。
- 使用案例：
- 以修饰 @Override 注解为例：
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface Override {
}
- 解释：@Target 元注解指定的 value 值是 METHOD，说明 Override 注解类只能修饰方法。
3.3 @Documented 元注解
- 使用说明：
@Documented 元注解：用于指定被修饰的注解类将被 javadoc 工具提取成文档，即在生成文档时，可以看到该注解。定义一个注解为 @Documented 时，必须先设置 @Retention 的值为 RUNTIME。
- 使用案例：
- 以 其源码为例：
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Documented {
}
3.4 @Inherited 元注解
- 使用说明：
@Inherited 元注解：被它修饰的注解类将具有继承性，如果某个类使用了被@Inherited 修饰的注解，则其子类将自动具有该注解。@Inherited 实际应用中很少使用，在这不举例了。
总结
- 本文是小白博主在学习B站韩顺平老师的Java网课时整理总结的学习笔记，在这里感谢韩顺平老师的网课，如有有兴趣的小伙伴也可以去看看。
- 本文详细解释了 注解类 的概念与使用，注解类在Java基础中不是很重要，只需了解即可，希望小伙伴们看后能有所收获！
- 最后，如果本文有什么错漏的地方，欢迎大家批评指正！一起加油！！我们下一篇博文见吧！