🌿🌿🌿跟随博主脚步,从这里开始→博主主页🌿🌿🌿
概述
注解以结构化的方式为程序元素提供信息,这些信息能够被外部工具(编译器、解释器等)自动处理。
注解有许多用途,其中包括:
- 为编译器提供信息。(编译器可以使用注解检测错误或阻止编译警告)
- 编译时或部署时处理。(软件工具可以处理注解信息生成代码、XML文件等)
- 运行时处理。(有些注解在运行时可以被检查)
- 注解是Java源程序添加的说明信息。可以被编译器等工具使用
- 给Java包、类型、构造方法、方法、成员变量、参数及局部变量进行标注
- 注解类型是一种特殊的接口类型,像使用类一样,要使用注解必须先定义注解类型(也可以使用语言本身提供的注解类型)。
- 注解是注解类型的一个实例。就像接口一样,注解类型也有名称和成员。注解中包含的信息采用“键/值”对的形式,可以有零或多个“键/值”对,并且每个键有一个特定类型。它可以是一个Stirng、int或其他Java类型。
没有“键/值”对的注解类型
如果注解只需要一个“键/值”对- 在Java程序中为程序元素标注注解的语法如下:
- 格式一:
@AnnotationType
- 格式二:
@AnnotationType(elementValuePairs)
- 对没有默认值的元素,都应该以name = value的形式对元素初始化。
- 如果注解类型是标记注解类型(无元素),或者所有的元素都具有默认值,那么就可以省略初始化器列表。
- 如果注解类型只有一个元素,可以使用缩略形式初始化
例:@Copyright(“copyright 2010-2015”)
标准注解
注解的功能很强大,程序员很少需要定义自己的注解类型。Java语言规范中定义的3个注解类型,定义在java.lang包中,分别为
- ①@Override(可在方法中声明,告诉编译器该方法要覆盖父类方法)
实战演练
标准注解–@Override
public class Parent {
public double calculate(double x, double y){
return x * y;
}
}
public class Child extends Parent{
@Override
public double calculate(double x, double y){
return x * y;
}
}
- ②@Deprecated(可应用于某个方法或类型,指明方法或类型已经被弃用了)
实战演练
标准注解–@Deprecated
标记已被弃用的方法或类型,是为了警告其代码用户,不应该是使用或覆盖该方法,或不该使用或扩展该类型。
public class DeprecatedDemo{
@Deprecated
public void badMethod(){
System.out.println("Deprecated);
}
public static void main(String[] args){
DeprecatedDemo dd = new DeprecatedDemo();
dd. badMethod();//编译文件时,编译器将发出警告
}
}
- ③@SuppressWarnings(注解指示编译器阻止某些类型的警告,具体的警告类型可以用初始化该注解的字符串来定义。
实战演练
标准注解@SuppressWarnings
SuppressWarnings的用法是传递String数组,包含需要阻止的警告,格式如下
SuppressWarnings(value={string-1,…, string-1})
eg:该注解可应用于类型、构造方法、方法、成员变量、参数以及局部变量
【例】SuppressWarnings注解阻止三种警告。
import java.io.Serializable;
import java.util.*;
@SuppressWarnings(value={"unchecked","serial","deprecation"})
public class SuppressWarningDemo {
public static void main(String[] args) {
Date d = new Date();
System.out.println(d.getDate());
List myList = new ArrayList(); //该语句仍然有警告
myList.add("one");
myList.add("two");
myList.add("three");
System.out.println(myList);
}
}
定义注解类型
- 用户也可以定义注解类型。注解类型的定义与接口类型的定义类似。注解类型的定义使用interface关键字,前面加上@符号。
public @interface CustomAnnotation{
// 元素或属性声明
}
默认,所有注解类型扩展java.lang.annotation.Annotation接口。该接口定义返回class对象的anotationType()方法。
Class <?extends Annotation>annotationType
该接口还定义了equals()方法、hashCode()方法和toString()方法
public @interface ClassInfo{
可以像类和接口一样编译该注解类型,编译产生ClassInfo.class类文件
String created();
String author();
String lastModified();
int version();
}
在注解类型中声明的方法称为注解类型的元素, 它的声明类似于接口中的方法声明,没有方法体,但有返回类型。但只能是基本类型、String、枚举类型、其他注解类型等,不能声明参数
- 在定义注解时可以使用default关键字为元素指定默认值
- 如:
public @interface Version{
int major() default 1;
int minor() default 0;
}
Version注解类型可以用来标注类和接口,也可以供其他注解类型使用。
- 如:
public @interface ClassInfo{
String created();
String author();
String lastModified();
Version version();
}
- 注解类型中也可以没有元素,这样的注解称为标记注解(marker annotation),这与标记接口类似。例如,下面定义了一个标记注解类型Preliminary:
public @interface Preliminary { }
- 如果注解类型只有一个元素,这个元素应该命名为value。例如,Copyright注解类型只有一个String类型的元素,则其应该定义为:
public @interface Copyright {
String value();
}
- 这样,在为程序元素注解时就可以不需要指定元素名称,而采用一种缩略的形式:
@Copyright("flying dragon company")。
标准元注解
元注解是对注解进行标注的注解,在java.lang.annotation包中定义以下四类元注解类型
⚡️(1) Documented(标记注解类型。对注解类型声明进行标注,使类的实例包含在javadoc工具产生的文档中。)
(2)⚡️ Inherited(标注的注解类型任何实例都会继承。如标注一个类,则注解将会被这个标注类的子类继承)
⚡️(3) Retension(指明被标注的注解保留多长时间。注解值RetentionPolicy是枚举(SOURCE、CLASS、RUNTIME)的一个成员)
(4) ⚡️Target(用来指明那个程序元素可以利用被注解类型进行标注。值为java.lang.annotation.ElementType枚举的一个成员。)
博主用心写,读者点关注,互动传真情,知识不迷路。