java基本注解学习

一、学习背景

今天摸鱼造demo学习时，突然感觉对注解很陌生，只知道用，也知道可以结合aop去进行切面编程，但只是知道，从来没有自己去造，所以特来跟着博客学习一下，然后跟着demo实践一下：

二、Java注解定义

• Java注解又称Java标注，是在 JDK5 时引入的新特性，注解（也被称为元数据）。
• Java注解它提供了一种安全的类似注释的机制，用来将任何的信息或元数据（metadata）与程序元素（类、方法、成员变量等）进行关联。
• Java注解是附加在代码中的一些元信息，用于一些工具在编译、运行时进行解析和使用，起到说明、配置的功能。

三、Java注解应用

1.生成文档这是最常见的，也是java 最早提供的注解;

2.在编译时进行格式检查，如@Override放在方法前，如果你这个方法并不是覆盖了超类方法，则编译时就能检查出；

3.跟踪代码依赖性，实现替代配置文件功能，比较常见的是spring 2.5 开始的基于注解配置,作用就是减少配置;

4.在反射的 Class, Method, Field 等函数中，有许多于 Annotation 相关的接口,可以在反射中解析并使用 Annotation。

四、Java注解分类

4.1、Java自带的标准注解

包括@Override、@Deprecated、@SuppressWarnings等，使用这些注解后编译器就会进行检查。

4.2、元注解

元注解是用于定义注解的注解，包括**@Retention、@Target、@Inherited、@Documented、@Repeatable** 等。
元注解也是Java自带的标准注解，只不过用于修饰注解，比较特殊。

4.3、自定义注解

用户可以根据自己的需求定义注解。

五、Java标准注解

JDK 中内置了以下注解：

5.1.@Override

该注解检查被标记的方法是否是重写方法或者实现接口的方法。如果试图使用 @Override 标记一个实际上并没有覆写父类或者是实现的接口没有的方法时，java 编译器会告警。

public class Parent {
    public void test(){
        System.out.println("hello");
    }
}
1
2
3
4
5

子类用@Override标记一个并没有重写父类的方法，java编译报错：

public class Son extends Parent{

    @Override
    public void test2(){}

}
1
2
3
4
5
6

5.2.Deprecated

用于标明被修饰的类或类成员、类方法已经废弃、过时，不建议使用。

public class Parent {
    @Deprecated
    public void test(){}
}
1
2
3
4

    public static void main(String[] args) {
        Parent parent = new Parent();
        parent.test();
    }
1
2
3
4

5.3.@SuppressWarnings

@SuppressWarnings 用于关闭对类、方法、成员编译时产生的特定警告。使开发者能看到一些他们真正关心的警告。从而提高开发者的效率
1）抑制单类型的警告

@SuppressWarnings(“”)

例如对刚刚过时的方法加入注解，编译器便不会告警过时的问题

    @SuppressWarnings(value = "deprecation")
    public static void main(String[] args) {
        Parent parent = new Parent();
        parent.test();
    }
1
2
3
4
5

2）抑制多类型的警告

@SuppressWarnings({})

@SuppressWarnings(value={"unchecked", "rawtypes"})  
public void addItems(String item){  
   List items = new ArrayList();  
   items.add(item);  
}
1
2
3
4
5

3）抑制所有类型的警告

@SuppressWarnings(“all”)

@SuppressWarnings("all")  
public void addItems(String item){  
   List items = new ArrayList();  
   items.add(item);  
}
1
2
3
4
5

@SuppressWarnings 注解的常见参数值的简单说明:

5.4.@FunctionalInterface

@FunctionalInterface 用于指示被修饰的接口是函数式接口,在 JDK8 引入。这种类型的接口也称为SAM接口，即Single Abstract Method interfaces。
它们主要用在Lambda表达式和方法引用（实际上也可认为是Lambda表达式）上。

如定义了一个函数式接口如下：

@FunctionalInterface
public interface FunctionTest {
    void systemOut();
}
1
2
3
4

那么就可以使用Lambda表达式来表示该接口的一个实现(注：JAVA 8 之前一般是用匿名类实现的)：

    public static FunctionTest getFunctionTest(){
        return msg -> logger.info("这就是{}",msg);
    }
1
2
3

ps:
@FunctionalInterface 仅对抽象方法检查。

• 1、该注解只能标记在"有且仅有一个抽象方法"的接口上。
  例如下面这种情况不会报错：

@FunctionalInterface
public interface FunctionTest {
   void systemOut();
}
1
2
3
4

但是如果再加一个抽象方法，java编译器告警：

@FunctionalInterface
public interface FunctionTest {
    void systemOut(String msg);
    void test();
}
1
2
3
4
5

• 2、JDK8接口中的静态方法和默认方法，都不算是抽象方法。
• 3、接口默认继承java.lang.Object，所以如果接口显示声明覆盖了Object中方法，那么 也不算抽象方法。
  

六、Java元注解

元注解是java API提供的，是用于修饰注解的注解，通常用在注解的定义上：

6.1.@Retention

@ Retention用来定义该注解在哪一个级别可用，在源代码中(SOURCE)、类文件中(CLASS)或者运行时(RUNTIME)。

@Retention 源码：

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Retention {
  RetentionPolicy value();
}
public enum RetentionPolicy {
  //此注解类型的信息只会记录在源文件中，编译时将被编译器丢弃，也就是说
  //不会保存在编译好的类信息中
  SOURCE,
  //编译器将注解记录在类文件中，但不会加载到JVM中。如果一个注解声明没指定范围，则系统
  //默认值就是Class
  CLASS,
  //注解信息会保留在源文件、类文件中，在执行的时也加载到Java的JVM中，因此可以反射性的读取。
  RUNTIME
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

RetentionPolicy 是一个枚举类型，它定义了被 @Retention 修饰的注解所支持的保留级别：

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE) //注解信息只能在源文件中出现
public @interface Override {
}
@Documented@Retention(RetentionPolicy.RUNTIME)  //注解信息在执行时出现@Target(value={CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, PARAMETER, TYPE})
public @interface Deprecated {
}
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
@Retention(RetentionPolicy.SOURCE)  //注解信息在源文件中出现
public @interface SuppressWarnings {
  String[] value();
}
1
2
3
4
5
6
7
8
9
10
11
12

6.2.@Documented

@Documented：生成文档信息的时候保留注解，对类作辅助说明

@Documented 示例

package com.mbw.uum.common.core.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

@Documented
@Retention(RetentionPolicy.RUNTIME)
public @interface Operation {
}

1
2
3
4
5
6
7
8
9
10
11

通过javadoc生成文档可以看到注解被保留：

6.3.@Target

@Target：用于描述注解的使用范围（即：被描述的注解可以用在什么地方）

@Target源码：

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Operation {
}
1
2
3
4
5

ElementType 是一个枚举类型，它定义了被 @Target 修饰的注解可以应用的范围：

6.4、@Inherited

说明子类可以继承父类中的该注解
表示自动继承注解类型。 如果注解类型声明中存在 @Inherited 元注解，则注解所修饰类的所有子类都将会继承此注解。
如下，我用@Inherited修饰一个注解

@Inherited
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface AnnotationTest {
    /**
     * 定义注解的一个元素 并给定默认值
     */
    String value() default "我是定义在方法上的注解元素value的默认值";
}
1
2
3
4
5
6
7
8
9

然后用这个注解修饰一个父类

@AnnotationTest
public class Parent {
    public void test(){}
}
1
2
3
4

这个时候用子类去取，发现能取出这个注解

public class Son extends Parent {

    public static void main(String[] args) {
        System.out.println(Son.class.getAnnotation(AnnotationTest.class));
    }

}
1
2
3
4
5
6
7

七、参考链接

https://blog.csdn.net/qq_44885775/article/details/124265154