JAVA基础学习-注解

本文最后更新于:December 3, 2021 pm

Java 注解(Annotation)又称 Java 标注,是 JDK5.0 引入的一种注释机制。Java 语言中的类、方法、变量、参数和包等都可以被标注。和 Javadoc 不同,Java 标注可以通过反射获取标注内容。在编译器生成类文件时,标注可以被嵌入到字节码中。Java 虚拟机可以保留标注内容,在运行时可以获取到标注内容 。 当然它也支持自定义 Java 标注。Java 定义了一套注解,共有 7 个,3 个在 java.lang 中,剩下 4 个在 java.lang.annotation 中。

目录

1.内置注解

  1. @Override。定义在 java.lang.Override 中,此注释只使用与修辞方法,表示一个方法声明打算重写超类(父类)中的另一个方法声明。检查该方法是否是重写方法。如果发现其父类,或者是引用的接口中并没有该方法时,会报编译错误。
  1. @Deprecated。定义在 java.lang.Deprecated 中, 标记过时方法。如果使用该方法,会报编译警告。了解即可。
  1. @SuppressWarnings。定义在 java.lang.SuppressWarnings 中,指示编译器去忽略注解中声明的警告。与前面不同的是,需要添加一个参数才能正确使用。
  • @SuppressWarnings(“all”)

  • @SuppressWarnings(“unchecked”)

  • @SuppressWarnings(value={“unchecked”,”deprecation”})

  • 等等··

2.元注解

元注解的作用就是负责注解其他注解。

  1. @Retention - 标识这个注解怎么保存,是只在代码中,还是编入class文件中,或者是在运行时可以通过反射访问。runtime > class > sources 。表示需要在什么级别保存该注释信息,用于描述注解的生命周期。
1
2
3
4
5
6
7
8
9
10
11
12
13
package java.lang.annotation;
public enum RetentionPolicy {
SOURCE, /* Annotation信息仅存在于编译器处理期间,编译器处理完之后就没有该Annotation信息了 */

CLASS, /* 编译器将Annotation存储于类对应的.class文件中。默认行为 */

RUNTIME /* 编译器将Annotation存储于class文件中,并且可由JVM读入 */
}

//示例
@Retention(RetentionPolicy.RUNTIME)
@Retention(RetentionPolicy.CLASS)
@Retention(RetentionPolicy.SOURCE)
  1. @Documented - 标记这些注解是否包含在用户文档(javadoc)中。
  1. @Target - 标记这个注解应该是哪种 Java 成员、用于哪些地方。是用于方法、字段、还是用于类等等。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
package java.lang.annotation;

public enum ElementType {
TYPE, /* 类、接口(包括注释类型)或枚举声明 */

FIELD, /* 字段声明(包括枚举常量) */

METHOD, /* 方法声明 */

PARAMETER, /* 参数声明 */

CONSTRUCTOR, /* 构造方法声明 */

LOCAL_VARIABLE, /* 局部变量声明 */

ANNOTATION_TYPE, /* 注释类型声明 */

PACKAGE /* 包声明 */

/**
* Type parameter declaration
*类型参数声明
* @since 1.8
*/
TYPE_PARAMETER,

/**
* Use of a type
*类型的使用
* @since 1.8
*/
TYPE_USE
}

//示例
@Target({ElementType.TYPE,ElementType.METHOD})
  1. @Inherited - 标记这个注解是继承于哪个注解类(默认 注解并没有继承于任何子类)。子类可以继承父类的注解。

从 Java 7 开始,额外添加了 3 个注解:

  • @SafeVarargs - Java 7 开始支持,忽略任何使用参数为泛型变量的方法或构造函数调用产生的警告。

  • @FunctionalInterface - Java 8 开始支持,标识一个匿名函数或函数式接口。

  • @Repeatable - Java 8 开始支持,标识某注解可以在同一个声明上使用多次。

3.自定义注解

使用 @interface 自定义注解。自动继承了 java.lang.annotation.Annotation 接口。

分析:

  • 格式:public @interface 注解名{定义内容} 。如果是在一个类里面声明则将public去掉。

  • 可以通过 default 来声明参数的默认值。

  • 如果只有一个参数成员,一般参数名为 value 。

  • 注解的参数:参数类型 + 参数名();

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
//只有一个参数时

/**
* @Author DragonOne
* @Date 2021/8/3 18:03
*/
public class interfaceTest {
@myin(name = "tothefor")
public void test(){

}

}

/**
* @author dragonone
*/
@Target({ElementType.TYPE,ElementType.METHOD}) //可以作用于类、方法
@Retention(RetentionPolicy.RUNTIME) //在运行时
@interface myin{
String name(); //如果只有一个参数,则可以写成value。
}

/*------------------------------------------------------*/

//只有一个参数,且参数名为value

/**
* @Author DragonOne
* @Date 2021/8/3 18:03
*/
public class interfaceTest {
@myin("tothefor") //因为参数名为value,所以可以直接写”tothefor“。只能是value,其他的不行
public void test(){

}

}

/**
* @author dragonone
*/
@Target({ElementType.TYPE,ElementType.METHOD}) //可以作用于类、方法
@Retention(RetentionPolicy.RUNTIME) //在运行时
@interface myin{
String value();
}

3.1 参数添加默认值

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
/**
* @Author DragonOne
* @Date 2021/8/3 18:03
*/
public class interfaceTest {
@myin() //有了默认值就可以不用写,也可以写
public void test(){

}

}

/**
* @author dragonone
*/
@Target({ElementType.TYPE,ElementType.METHOD}) //可以作用于类、方法
@Retention(RetentionPolicy.RUNTIME) //在运行时
@interface myin{
String value() default "";
}

3.2 数组参数

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
/**
* @Author DragonOne
* @Date 2021/8/3 18:03
*/
public class interfaceTest {
@myin(name={"dfwef","dfwef"}) //有默认值可以写,也可以不用写。
public void test(){

}

}

/**
* @author dragonone
*/
@Target({ElementType.TYPE,ElementType.METHOD}) //可以作用于类、方法
@Retention(RetentionPolicy.RUNTIME) //在运行时
@interface myin{
String[] name() default {"sfds","dsfdfs"};
}



/*=====================================================*/
//参数没有顺序
/**
* @Author DragonOne
* @Date 2021/8/3 18:03
*/
public class interfaceTest {
@myin(name={"dfwef","dfwef"},age = 23,fir = "234324") //位置任意写
public void test(){

}

}

/**
* @author dragonone
*/
@Target({ElementType.TYPE,ElementType.METHOD}) //可以作用于类、方法
@Retention(RetentionPolicy.RUNTIME) //在运行时
@interface myin{
int age();
String fir();
String[] name() default {"sfds","dsfdfs"};
}

本文作者: 墨水记忆
本文链接: https://tothefor.com/DragonOne/3069847648.html
版权声明: 本博客所有文章除特别声明外,均采用 CC BY-SA 4.0 协议 ,转载请注明出处!