注解定义
-
Java注解它提供了一种安全的类似注释的机制,用来将任何的信息或元数据(metadata)与程序元素(类、方法、成员变量等)进行关联。
-
Java注解是附加在代码中的一些元信息,用于一些工具在编译、运行时进行解析和使用,起到说明、配置的功能。
注解应用
-
跟踪代码依赖性,实现替代配置文件功能,比较常见的是spring 2.5 开始的基于注解配置,作用就是减少配置;
-
在反射的 Class, Method, Field 等函数中,有许多于 Annotation 相关的接口,可以在反射中解析并使用 Annotation。
注解分类
1. Java自带的标准注解
1.包括@Override、@Deprecated、@SuppressWarnings等,使用这些注解后编译器就会进行检查。
注解定义:
- @Deprecated 用于标明被修饰的类或类成员、类方法已经废弃、过时,不建议使用。
- @SuppressWarnings 用于关闭对类、方法、成员编译时产生的特定警告。
下面举例:
- 抑制单类型的警告 @SuppressWarnings(“unchecked”)
- 抑制多类型的警告 @SuppressWarnings(value={“unchecked”, “rawtypes”})
- 抑制所有类型的警告 @SuppressWarnings(“all”)
- 用于指示被修饰的接口是函数式接口 @FunctionalInterface
2. 元注解(注解的注解)
-
元注解是用于定义注解的注解,包括@Retention、@Target、@Inherited、@Documented、@Repeatable 等。
-
元注解也是Java自带的标准注解,只不过用于修饰注解,比较特殊。
注解定义:
1. @Retention
定义: 用来定义该注解在哪一个级别可用,在源代码中(SOURCE)、类文件中(CLASS)或者运行时(RUNTIME),若不指定范围则默认CLASS
下面针对上面三种类型定义:
- SOURCE:此注解类型的信息只会记录在源码,编译时将被编译器丢弃
- CLASS:编译器将注解记录在类文件中,但不会加载到JVM中。
- RUNTIME:注解信息会保留在源文件、类文件中,在执行的时也加载到Java的JVM中,因此可以反射性的读取,一般都会设置成这种
使用举例:@Retention(RetentionPolicy.SOURCE)
2. @Documented
定义: 生成文档信息的时候保留注解,对类作辅助说明
使用举例:@Documented
3. @Target
定义: 用于描述注解的使用范围(即:被描述的注解可以用在什么地方)
应用范围:
使用举例:@Target(ElementType.ANNOTATION_TYPE)
4. @Inherited
定义: 说明子类可以继承父类中的该注解,表示自动继承注解类型。 如果注解类型声明中存在 @Inherited 元注解,则注解所修饰类的所有子类都将会继承此注解。
5. @Repeatable
定义: 表示注解可以重复使用。当我们需要重复使用某个注解时,希望利用相同的注解来表现所有的形式时,我们可以借助@Repeatable注解。
使用举例:@Repeatable(Schedules.class)
3. 自定义注解
- 用户可以根据自己的需求定义注解。
自定义注解格式:
// 元注解
public @interface 注解名称{
// 属性列表
}
创建自定义注解
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface TestHello {
String value() default “”;
}
自定义注解测试案例–通过反射获取注解信息
public class Test {
@TestHello("注解测试成功")
public void test(){
System.out.println("Inside sayHello method..");
}
public static void main(String[] args) throws NoSuchMethodException, InvocationTargetException, IllegalAccessException {
Test test = new Test();
Method method = test.getClass().getMethod("test");
if(method.isAnnotationPresent(TestHello.class)){
TestHello testHello = method.getAnnotation(TestHello.class);
String value = testHello.value();
System.out.println("获取注解value:"+value);
method.invoke(test);
}
}
}