Java注解是java5版本发布的,其作用就是节省配置文件,增强代码可读性。在如今各种框架及开发中非常常见,特此说明一下。
如何创建一个注解
每一个自定义的注解都由四个元注解组成,这四个元注解由java本身提供:
@Target(ElementType.**)
这是一个枚举,它置顶是该自定义的注解使用的地方,像类、变量、方法等
@Retention(RetentionPolicy.**)作用是标明注解保存在什么级别,像在编译时、class文件中,vm运行中
@Documented 将此注解包含在 javadoc 中 ,它代表着此注解会被javadoc工具提取成文档。在doc文档中的内容会因为此注解的信息内容不同而不同
@Inherited : 在您定义注解后并使用于程序代码上时,预设上父类别中的注解并不会被继承至子类别中,您可以在定义注解时加上java.lang.annotation.Inherited 限定的Annotation,这让您定义的Annotation型别被继承下来。
介绍完理论,开始代码(talk is cheap,show your code)
package com.yasin.JavaLearn;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* 这是一个类级别的注释,这个注释中有一个name字段,默认值是 yasin
* @author yasin
*
*/
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Learn {
String name() default "yasin";
}
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
package com.yasin.JavaLearn;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* 这是一个变量级别的注解,注解中有一个字段name,默认值是field
* @author yasin
*
*/
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FiledLearn {
String name() default "field";
}
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
package com.yasin.JavaLearn;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* 这是一个方法级别的注解
* @author yasin
*
*/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MethodLearn {
String name() default "method";
}
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
上面了我定义了三个注解,分别是常用的类、变量、方法三个级别的注解。
下面我定义一个类,使用这三个注解
package com.yasin.JavaLearn;
@Learn
public class Yasin {
@FiledLearn
public int level;
@FiledLearn(name="xq")
public String xq;
public String a;
@MethodLearn(name="test")
public void setMain(){
}
public void setA(){
}
}
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
下面就是如何使用这个注解了,注解的提取,都是通过class反射得到相应的变量和方法,在从变量和方法中获得注解。
package com.yasin.JavaLearn
import java.lang.reflect.Field
import java.lang.reflect.Method
import java.text.ParseException
import java.text.SimpleDateFormat
import java.util.ArrayList
import java.util.Date
import java.util.HashMap
import java.util.Iterator
import java.util.List
import java.util.Map
import org.apache.commons.logging.Log
import org.apache.commons.logging.LogFactory
import org.apache.log4j.Logger
import org.apache.log4j.PropertyConfigurator
import org.apache.log4j.xml.DOMConfigurator
public class App {
public static void main(String[] args) {
Learn learn = Yasin.class.getAnnotation(Learn.class)
System.out.println(learn.name())
Field[] fields = Yasin.class.getFields()
for(Field filed:fields){
if(filed.isAnnotationPresent(FiledLearn.class)){//校验该字段是否添加这个注解
System.out.println(filed.getName())
FiledLearn filedLearn = filed.getAnnotation(FiledLearn.class)
System.out.println(filedLearn.name())
}
}
Method[] methods = Yasin.class.getMethods()
for(Method method:methods){
if(method.isAnnotationPresent(MethodLearn.class)){//校验该方法是否有这个注解
System.out.println(method.getName())
MethodLearn methodLearn = method.getAnnotation(MethodLearn.class)
System.out.println(methodLearn.name())
}
}
}
}