注解
相当于一种标记,在程序中加入注解就是为程序打上了某种标记。加入标记后,Java编译器可以利用反射机制来了解类和各种元素上有无任何标记,然后根据标记去做相应的事情。标记可以加在包、类、字段、方法、方法的参数以及局部变量上。
定义一个最简单的注解:
1
| public @interface MyAnnotation{ ... }
|
在类上写注解:
12
| @MyAnnotation
public void AnnotationTest{ ... }
|
注解分类
Java中提供了四中元注解,专门用来注解其他的注解,分别如下:
@Retention元注解:表示在什么级别保存该注释信息(注解的生命周期)。
可选的参数包括:
12 3
| @Retention(RetentionPolicy.SOURCE):停留在Java源文件,编译器被丢掉。
@Retention(RetentionPolicy.CLASS):停留在Class文件中,但不会被VM丢弃。
@Retention(RetentionPolicy.RUNTIME):内存中的字节码,VM在运行时也保留注解,因此通过反射机制可以读取注解中的信息。
|
@Target元注解:默认值为任何元素,表示该注解可以用于什么地方。可选的参数包括:
12 3 4 5 6 7
| @Target(ElementType.SOURCE):构造器声明
@Target(ElementType.FIELD):成员变量、对象、属性
@Target(ElementType.Local_VARIABLE):局部变量声明
@Target(ElementType.METHOD):方法声明
@Target(ElementType.PACKAGE):包声明
@Target(ElementType.PARAMETER):参数声明
@Target(ElementType.TYPE):类,接口等的声明
|
@Documented将注解包含在JavaDoc中
@Inheried允许子类继承父类中的注解
举例:
12
| @Retention(RetentionPolicy.RUNTIME) @Target({ElementType.METHOD, ElementType.TYPE})
public @interface MyAnnotation { //为注解添加属性 String color(); String value() default"我是林计钦"; //为属性提供默认值 int[] array() default {1, 2, 3}; Gender gender() default Gender.MAN; //添加一个枚举 MetaAnnotation metaAnnotation() default @MetaAnnotation(birthday="我的出身日期为1988-2-18"); //添加枚举属性 }
|
注解写完之后需要注解解析器来解析注解,要看注解声明的地方,然后再调用不同的方法去解析。
注解标注在类上时:
12 3 4 5
| if(AnnotationTest.class.isAnnotationPresent(MyAnnotation.class)){
//若存在就获取注解
MyAnnotation annotation=(MyAnnotation)AnnotationTest.class.getAnnotation(MyAnnotation.class);
System.out.println(annotation);
}
|
注解标注在方法上的实例:
12 3 4 5 6
| @Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface PrivilegeInfo {
String name() default "";
}
|
注解解析器:
解析目标类中的目标方法,返回目标方法中注解的name的属性值
12 3 4 5 6 7 8 9 10 1112
| public static String parse(Class serviceClass,String methodName) throws Exception{
//获取目标方法的method形式
Method method = serviceClass.getMethod(methodName);
String privilegeName = "";
//若存在就获取注解
if(method.isAnnotationPresent(PrivilegeInfo.class)){
PrivilegeInfo privilegeInfo = method.getAnnotation(PrivilegeInfo.class);
privilegeName = privilegeInfo.name();
}
return privilegeName;
}
|
总结
注解目前非常的流行,很多主流框架都支持注解,而且自己编写代码的时候也会尽量的去用注解,一时方便,而是代码更加简洁。
original link: http://longliqiang88.github.io/2015/07/23/Java%E5%AD%A6%E4%B9%A0-%E6%B3%A8%E8%A7%A3/