Java注解入门
注解的分类
1 package com.flypie.annotations; 2 3 import java.lang.annotation.Documented; 4 import java.lang.annotation.ElementType; 5 import java.lang.annotation.Inherited; 6 import java.lang.annotation.Retention; 7 import java.lang.annotation.RetentionPolicy; 8 import java.lang.annotation.Target; 9 10 /* @Target,@Retention,@Inherited,@Documented 11 * 这四个是对注解进行注解的元注解,负责自定义的注解的属性 12 */ 13 @Target({ElementType.TYPE,ElementType.METHOD}) //表示注解的作用对象,ElementType.TYPE表示类,ElementType.METHOD表示方法 14 @Retention(RetentionPolicy.RUNTIME) //表示注解的保留机制,RetentionPolicy.RUNTIME表示运行时注解 15 @Inherited //表示该注解可继承 16 @Documented //表示该注解可生成文档 17 public @interface Design { 18 String author(); //注解成员,如果注解只有一个成员,则成员名必须为value(),成员类型只能为原始类型 19 int data() default 0; //注解成员,默认值为0 20 } 21
说明:
元注解:
元注解的作用就是负责注解其他注解。Java5.0定义了4个标准的meta-annotation类型,它们被用来提供对其它 annotation类型作说明。Java5.0定义的元注解:
1.@Target,
2.@Retention,
3.@Documented,
4.@Inherited
这些类型和它们所支持的类在java.lang.annotation包中可以找到。下面我们看一下每个元注解的作用和相应分参数的使用说明。
@Target:
@Target说明了Annotation所修饰的对象范围:Annotation可被用于 packages、types(类、接口、枚举、Annotation类型)、类型成员(方法、构造方法、成员变量、枚举值)、方法参数和本地变量(如循环变量、catch参数)。在Annotation类型的声明中使用了target可更加明晰其修饰的目标。
作用:用于描述注解的使用范围(即:被描述的注解可以用在什么地方)
取值(ElementType)有:
1.CONSTRUCTOR:用于描述构造器
2.FIELD:用于描述域
3.LOCAL_VARIABLE:用于描述局部变量
4.METHOD:用于描述方法
5.PACKAGE:用于描述包
6.PARAMETER:用于描述参数
7.TYPE:用于描述类、接口(包括注解类型) 或enum声明
使用实例:
@Target(ElementType.TYPE) public @interface Table { /** * 数据表名称注解,默认值为类名称 * @return */ public String tableName() default "className"; } @Target(ElementType.FIELD) public @interface NoDBColumn { }
注解Table 可以用于注解类、接口(包括注解类型) 或enum声明,而注解NoDBColumn仅可用于注解类的成员变量。
@Retention:
@Retention定义了该Annotation被保留的时间长短:某些Annotation仅出现在源代码中,而被编译器丢弃;而另一些却被编译在class文件中;编译在class文件中的Annotation可能会被虚拟机忽略,而另一些在class被装载时将被读取(请注意并不影响class的执行,因为Annotation与class在使用上是被分离的)。使用这个meta-Annotation可以对 Annotation的“生命周期”限制。
作用:表示需要在什么级别保存该注释信息,用于描述注解的生命周期(即:被描述的注解在什么范围内有效)
取值(RetentionPoicy)有:
1.SOURCE:在源文件中有效(即源文件保留)
2.CLASS:在class文件中有效(即class保留)
3.RUNTIME:在运行时有效(即运行时保留)
Retention meta-annotation类型有唯一的value作为成员,它的取值来自java.lang.annotation.RetentionPolicy的枚举类型值。具体实例如下:
@Target(ElementType.FIELD) @Retention(RetentionPolicy.RUNTIME) public @interface Column { public String name() default "fieldName"; public String setFuncName() default "setField"; public String getFuncName() default "getField"; public boolean defaultDBValue() default false; }
Column注解的的RetentionPolicy的属性值是RUTIME,这样注解处理器可以通过反射,获取到该注解的属性值,从而去做一些运行时的逻辑处理
@Documented:
@Documented用于描述其它类型的annotation应该被作为被标注的程序成员的公共API,因此可以被例如javadoc此类的工具文档化。Documented是一个标记注解,没有成员。
@Target(ElementType.FIELD) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface Column { public String name() default "fieldName"; public String setFuncName() default "setField"; public String getFuncName() default "getField"; public boolean defaultDBValue() default false; }
@Inherited:
@Inherited 元注解是一个标记注解,@Inherited阐述了某个被标注的类型是被继承的。如果一个使用了@Inherited修饰的annotation类型被用于一个class,则这个annotation将被用于该class的子类。
注意:@Inherited annotation类型是被标注过的class的子类所继承。类并不从它所实现的接口继承annotation,方法并不从它所重载的方法继承annotation。
当@Inherited annotation类型标注的annotation的Retention是RetentionPolicy.RUNTIME,则反射API增强了这种继承性。如果我们使用java.lang.reflect去查询一个@Inherited annotation类型的annotation时,反射代码检查将展开工作:检查class和其父类,直到发现指定的annotation类型被发现,或者到达类继承结构的顶层。
实例代码:
/** * * @author peida * */ @Inherited public @interface Greeting { public enum FontColor{ BULE,RED,GREEN}; String name(); FontColor fontColor() default FontColor.GREEN; }
使用注解
1 package com.flypie; 2 3 import com.flypie.annotations.Design; 4 5 @Design(author="flypie",data=100) //使用自定义注解,有默认值的成员可以不用赋值,其余成员都要复值 6 public class Person { 7 @Design(author="flypie",data=90) 8 public void live(){ 9 10 } 11 }
解析java注解
1 package com.flypie; 2 3 import java.lang.annotation.Annotation; 4 import java.lang.reflect.Method; 5 6 import com.flypie.annotations.Design; 7 8 public class Main { 9 10 public static void main(String[] args) throws ClassNotFoundException { 11 12 Class c=Class.forName("com.flypie.Person"); //使用类加载器加载类 13 14 //1、找到类上的注解 15 if(c.isAnnotationPresent(Design.class)){ //判断类是否被指定注解注解 16 Design d=(Design) c.getAnnotation(Design.class); //拿到类上的指定注解实例 17 System.out.println(d.data()); 18 } 19 20 //2、找到方法上的注解 21 Method[] ms=c.getMethods(); 22 for(Method m:ms){ 23 if(m.isAnnotationPresent(Design.class)){ //判断方法是否被指定注解注解 24 Design d=m.getAnnotation(Design.class); //拿到类上的指定注解实例 25 System.out.println(d.data()); 26 } 27 } 28 29 //3、另外一种方法 30 for(Method m:ms){ 31 Annotation[] as=m.getAnnotations(); //拿到类上的注解集合 32 for(Annotation a:as){ 33 if(a instanceof Design){ //判断指定注解 34 Design d=(Design) a; 35 System.out.println(d.data()); 36 } 37 } 38 } 39 } 40 41 }
原文出处
flypie, Java注解入门, https://www.cnblogs.com/flypie/p/5134752.html
竹子-博客-架构未来, 深入理解Java:注解(Annotation)自定义注解入门, https://www.cnblogs.com/peida/archive/2013/04/24/3036689.html