1、什么是注解
Annotation是从JDK5.0开始引入的新技术
Annotation的作用:
- 不是程序本身,可以对程序作出解释。(这一点和注释(comment)没有什么区别)
- 可以被其他程序(比如:编译器等)读取.
Annotation的格式:
-
注解是以"@注释名"在代码中存在的,还可以添加一些参数值
例如:@SuppressWarnings(value="unchecked")
Annotation在哪里使用?
-
可以附加在package,class,method,field 等上面,相当于给他们添加了额外的辅助信息
我们可以通过反射机制编程实现对这些元数据的访问。
2、内置注解
Override
@Override:定义在 java.lang.Override 中,此注释只适用于修辞方法,表示一个方法声明打算重写超类中的另一个方法声明。
// 重写的注解
@Override
public String toString() {
return super.toString();
}
@Override 只能重写父类的方法,不然编译器报错
Deprecated
@Deprecated:定义在 java.lang.Deprecated 中,此注释可以用于修辞方法,属性,类,表示不鼓励程序员使用这样的元素,通常是因为它很危险或者存在更好的选择。
@Deprecated
public static void test() {
System.out.println("Deprecated");
}
@Deprecated 不推荐程序员使用,但是可以使用,或者存在更好的方法
SuppressWarnings
@SuppressWarnings∶定义在java.lang.SuppressWarnings 中,用来抑制编译时的警告信息
与前两个注释有所不同,你需要添加一个参数才能正确使用,这些参数都是已经定义好了的,我们选择性的使用就好了。
- @SuppressWarnings("all")
- @SuppressWarnings("unchecked")
- @SuppressWarnings(value={"unchecked"," deprecation"})
- 等等......
@SuppressWarnings("all")
public class Test01 extends Object {
@SuppressWarnings("all")
public static void test02(){
List list = new ArrayList();
}
}
3、元注解
元注解的作用就是负责注解其他注解,Java定义了4个标准的meta-annotation类型,他们被用来提供对其他annotation类型作说明。
这些类型和它们所支持的类在java.long.annotation包中可以找到(@Target,@Retention,@Documented,@Inherited)
- @Target:用于描述注解的使用范围(即:被描述的注解可以用在什么地方)
- @Retention:表示需要在什么级别保存该注释信息,用于描述注解的生命周期
- (SOURCCE < CLASS < RUNTIME)
- @Document:说明该注解将被包含在javadoc中
- @Inherited:说明子类可以继承父类中的该注解
// 测试元注解
@MyAnnotation
public class Test02 {
@MyAnnotation
public void test(){
}
}
// 定义一个注解
// Target ,表示我们的注解可以用在哪些地方
@Target(value = {ElementType.METHOD,ElementType.TYPE})
// Retention 表示我们的注解在什么地方还有效
// runtime > class > sources
@Retention(value = RetentionPolicy.RUNTIME)
// Documented 表示是否将我们的注解生成在javaDoc中
@Documented
// Inherited 子类可以继承父类的注解
@Inherited
@interface MyAnnotation {
}
4、自定义注解
使用 @interface 自定义注解时,自动继承了 java.lang.annotation.Annotation 接口
- @interface 用来声明一个注解,格式: public @interface 注解名{ 定义内容 }
- 其中的每一个方法实际上是声明了一个配置参数。
- 方法的名称就是参数的名称。
- 返回值类型就是参数的类型(返回值只能是基本类型,Class,String,enum )。
- 可以通过default来声明参数的默认值。
- 如果只有一个参数成员,一般参数名为value。
- 注解元素必须要有值,我们定义注解元素时,经常使用空字符串,0作为默认值。
public class Test03 {
// 注解可以显示赋值,如果没有默认值,我们就必须为注解添加值
@MyAnnotation2(name = "你好",schools = {"川大","北大"})
public void test(){}
}
@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation2{
// 注解的参数:参数类型 + 参数名();
String name() default ""; // 设置默认值
int age() default 0;
int id() default -1; // 如果默认值为-1,则表示不存在
String[] schools() default {"清华","北大"};
}
public class Test03 {
@MyAnnotation3("你好")
public void test2(){}
}
@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation3{
String value(); // 参数名为value时,只有一个参数,可以直接添加参数
}