注解
1 内置注解
内置注解有
@Override对父类的方法重写:
@Deprecated过时的,废弃的:
@SuppressWarning 镇压报警信息
@Override
方法上的注解
@Override定义在java.lang.Override中,此注释只适用于修辞方法,表示一个方法声明打算重写超类中的另一个方法声明。如果方法利用此注释类型进行注解但没有重写超类方法,则编译器会生成一条错误消息。
在子类中重写父类或接口的方法,@Overide并不是必须的。但是还是建议使用这个注解,在某些情况下,假设你修改了父类的方法的名字,那么之前重写的子类方法将不再属于重写,如果没有@Overide,你将不会察觉到这个子类的方法。有了这个注解修饰,编译器则会提示你这些信息。
//例如重写Object类的toString()方法
public class Test {
private String name;
@Override //@Override重写注解用于标识重写了父类方法,不加注解也可以
public String toString() {
return "Test{" +
"name='" + name + '\'' +
'}';
}
}
@Deprecated
类/属性/方法上的注解
@Deprecated定义在java.lang.Deprecated中,此注释可用于修辞方法、属性、类,表示不鼓励程序员使用这样的元素,通常是因为它很危险或存在更好的选择。在使用不被赞成的程序元素或在不被赞成的代码中执行重写时,编译器会发出警告。
个人程序中的类、方法、变量用@Deprecated修饰同样是不希望自己和别人在以后的时间再次使用此类、方法。当编译器编译时遇到了使用@Deprecated修饰的类、方法、变量时会提示相应的警告信息。
@SuppressWarnings
@SuppressWarnings定义在java.lang.SuppressWarnings中,用来抑制编译时的警告信息。
不建议使用@SuppressWarnings注解,使用此注解,开发人员看不到编译时编译器提示的相应的警告,不能选择更好、更新的类、方法或者不能编写更规范的编码。
与前两个注释有所不同,你需要添加一个参数才能正确使用,这些参数值都是已经定义好了的,我们选择性的使用就好了,参数如下:
不过,要想注解能够正常工作,还需要介绍一下一个新的概念那就是元注解。
2 元注解
元注解是可以注解到注解上的注解,或者说元注解是一种基本注解,但是它能够应用到其它的注解上面。
元标签有
@Retention、@Documented、@Target、@Inherited、@Repeatable 5 种。
@Retention
当 @Retention 应用到一个注解上的时候,它解释说明了这个注解的的存活时间。
它的取值如下:
RetentionPolicy.SOURCE | 注解只在源码阶段保留,在编译器进行编译时它将被丢弃忽视 |
---|---|
RetentionPolicy.CLASS | 注解只被保留到编译进行的时候,它并不会被加载到 JVM 中 |
RetentionPolicy.RUNTIME | 解可以保留到程序运行的时候,它会被加载进入到 JVM 中,所以在程序运行时可以获取到它们 |
@Retention 相当于给一张标签上面盖了一张时间戳,时间戳指明了标签张贴的时间周期
@Target
Target 是目标的意思,@Target 指定了注解运用的地方(注解使用范围)。
可以理解为,当一个注解被 @Target 注解时,这个注解就被限定了运用的场景。
@Target 有下面的取值如下
ElementType.ANNOTATION_TYPE | 可以给一个注解进行注解 |
---|---|
ElementType.CONSTRUCTOR | 可以给构造方法进行注解 |
ElementType.FIELD | 可以给属性进行注解 |
ElementType.LOCAL_VARIABLE | 可以给局部变量进行注解 |
ElementType.METHOD | 可以给方法进行注解 |
ElementType.PACKAGE | 可以给一个包进行注解 |
ElementType.PARAMETER | 可以给一个方法内的参数进行注解 |
ElementType.TYPE | 可以给一个类型进行注解,比如类、接口、枚举 |
@Inherited
Inherited 是继承的意思,但是它并不是说注解本身可以继承,而是说如果一个超类被 @Inherited 注解过的注解进行注解的话,那么如果它的子类没有被任何注解应用的话,那么这个子类就继承了超类的注解。
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@interface Test {}
@Test
public class A {}
public class B extends A {}
注解 Test 被 @Inherited 修饰,之后类 A 被 Test 注解,类 B 继承 A,类 B 也拥有 Test 这个注解
@Documented
@Documented,这个元注解肯定是和文档有关。它的作用是能够将注解中的元素包含到 Javadoc 中去。
3 注解
3.1 注解的定义
注解通过 @interface 关键字进行定义
@interface MyAnnotation{
}
它的形式跟接口很类似,不过前面多了一个 @ 符号。上面的代码就创建了一个名字为 MyAnnotation 的注解。可以简单理解为创建了一张名字为 MyAnnotation 的标签。
3.2 注解的使用
@MyAnnotation
class TestAnnotation{
}
创建一个类 TestAnnotation,然后在类定义的地方加上 @MyAnnotation 就可以用 MyAnnotation 注解这个类了。
3.3 注解的属性
3.3.1 一般属性
注解的属性也叫做成员变量。注解只有成员变量,没有方法。注解的成员变量在注解的定义中以“无形参的方法”形式来声明,其方法名定义了该成员变量的名字,其返回值定义了该成员变量的类型。
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
int id();
String msg();
}
定义了 MyAnnotation 这个注解中拥有 id 和 msg 两个属性。在使用的时候,我们应该给它们进行赋值。赋值的方式是在注解的括号内以 value=”” 形式,多个属性之前用 ,隔开。
@MyAnnotation(id=1,msg="test MyAnnotation")
public class Test{
}
在注解中定义属性时它的类型必须是 8 种基本数据类型外加 类、接口、注解及它们的数组。
3.3.2 默认值
注解中属性可以有默认值,默认值需要用 default 关键值指定。
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
public int id() default -1;
public String msg() default "Hi";
}
@MyAnnotation()
public class Test{
}
3.3.3 一个属性value
有一种情况。如果一个注解内仅仅只有一个名字为 value 的属性时,应用这个注解时可以直接接属性值填写到括号内。
public @interface MyAnnotation {
String value();
}
上面代码中,Check 这个注解只有 value 这个属性。所以可以这样应用。
@MyAnnotation("just a value()")
class Test{
}
3.3.4 无属性
最后,还需要注意的一种情况是一个注解没有任何属性。比如
public @interface MyAnnotation {}
那么在应用这个注解的时候,括号都可以省略
@MyAnnotation
public void testMethod(){}