基于Java注解(Annotation)的自定义注解入门介绍
要深入学习注解,我们就必须能定义自己的注解,并使用注解,在定义自己的注解之前,我们就必须要了解Java为我们提供的元注解和相关定义注解的语法。
--------------------------------------------------------------------------------
元注解:
元注解的作用就是负责注解其他注解。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@interfaceTable{
/**
*数据表名称注解,默认值为类名称
*@return
*/
publicStringtableName()default"className";
}
@Target(ElementType.FIELD)
public@interfaceNoDBColumn{
}
注解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:在运行时有效(即运行时保留)
Retentionmeta-annotation类型有唯一的value作为成员,它的取值来自java.lang.annotation.RetentionPolicy的枚举类型值。具体实例如下:
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public@interfaceColumn{
publicStringname()default"fieldName";
publicStringsetFuncName()default"setField";
publicStringgetFuncName()default"getField";
publicbooleandefaultDBValue()defaultfalse;
}
Column注解的的RetentionPolicy的属性值是RUTIME,这样注解处理器可以通过反射,获取到该注解的属性值,从而去做一些运行时的逻辑处理
--------------------------------------------------------------------------------
@Documented:
@Documented用于描述其它类型的annotation应该被作为被标注的程序成员的公共API,因此可以被例如javadoc此类的工具文档化。Documented是一个标记注解,没有成员。
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public@interfaceColumn{
publicStringname()default"fieldName";
publicStringsetFuncName()default"setField";
publicStringgetFuncName()default"getField";
publicbooleandefaultDBValue()defaultfalse;
}
@Inherited:
@Inherited元注解是一个标记注解,@Inherited阐述了某个被标注的类型是被继承的。如果一个使用了@Inherited修饰的annotation类型被用于一个class,则这个annotation将被用于该class的子类。
注意:@Inheritedannotation类型是被标注过的class的子类所继承。类并不从它所实现的接口继承annotation,方法并不从它所重载的方法继承annotation。
当@Inheritedannotation类型标注的annotation的Retention是RetentionPolicy.RUNTIME,则反射API增强了这种继承性。如果我们使用java.lang.reflect去查询一个@Inheritedannotation类型的annotation时,反射代码检查将展开工作:检查class和其父类,直到发现指定的annotation类型被发现,或者到达类继承结构的顶层。
实例代码:
/**
*
*@authorpeida
*
*/
@Inherited
public@interfaceGreeting{
publicenumFontColor{BULE,RED,GREEN};
Stringname();
FontColorfontColor()defaultFontColor.GREEN;
}
--------------------------------------------------------------------------------
自定义注解:
使用@interface自定义注解时,自动继承了java.lang.annotation.Annotation接口,由编译程序自动完成其他细节。在定义注解时,不能继承其他的注解或接口。@interface用来声明一个注解,其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称,返回值类型就是参数的类型(返回值类型只能是基本类型、Class、String、enum)。可以通过default来声明参数的默认值。
定义注解格式:
public@interface注解名{定义体}
注解参数的可支持数据类型:
1.所有基本数据类型(int,float,boolean,byte,double,char,long,short)
2.String类型
3.Class类型
4.enum类型
5.Annotation类型
6.以上所有类型的数组
Annotation类型里面的参数该怎么设定:
第一,只能用public或默认(default)这两个访问权修饰.例如,Stringvalue();这里把方法设为defaul默认类型;
第二,参数成员只能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型和String,Enum,Class,annotations等数据类型,以及这一些类型的数组.例如,Stringvalue();这里的参数成员就为String;
第三,如果只有一个参数成员,最好把参数名称设为"value",后加小括号.例:下面的例子FruitName注解就只有一个参数成员。
简单的自定义注解和使用注解实例:
packageannotation;
importjava.lang.annotation.Documented;
importjava.lang.annotation.ElementType;
importjava.lang.annotation.Retention;
importjava.lang.annotation.RetentionPolicy;
importjava.lang.annotation.Target;
/**
*水果名称注解
*@authorpeida
*
*/
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public@interfaceFruitName{
Stringvalue()default"";
}
packageannotation;
importjava.lang.annotation.Documented;
importjava.lang.annotation.ElementType;
importjava.lang.annotation.Retention;
importjava.lang.annotation.RetentionPolicy;
importjava.lang.annotation.Target;
/**
*水果颜色注解
*@authorpeida
*
*/
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public@interfaceFruitColor{
/**
*颜色枚举
*@authorpeida
*
*/
publicenumColor{BULE,RED,GREEN};
/**
*颜色属性
*@return
*/
ColorfruitColor()defaultColor.GREEN;
}
packageannotation;
importannotation.FruitColor.Color;
publicclassApple{
@FruitName("Apple")
privateStringappleName;
@FruitColor(fruitColor=Color.RED)
privateStringappleColor;
publicvoidsetAppleColor(StringappleColor){
this.appleColor=appleColor;
}
publicStringgetAppleColor(){
returnappleColor;
}
publicvoidsetAppleName(StringappleName){
this.appleName=appleName;
}
publicStringgetAppleName(){
returnappleName;
}
publicvoiddisplayName(){
System.out.println("水果的名字是:苹果");
}
}
定义了注解,并在需要的时候给相关类,类属性加上注解信息,如果没有响应的注解信息处理流程,注解可以说是没有实用价值。如何让注解真真的发挥作用,主要就在于注解处理方法,下一步我们将通过注解实现一个简单的ORM,来深入学习注解,来利用注解!
相关文章
- fileinputstream java_Java FileInputStream close()方法
- java 怎样卸载一个类_Java 动态卸载类[通俗易懂]
- java单例模式_Java单例模式
- 【测开技能】Java语言系列(九)输入和输出
- java 舆情分析_基于Java实现网络舆情分析系统研究与实现.doc[通俗易懂]
- java算术运算符(二)
- java JNI: C 语言调用 Java 方法示例详解编程语言
- Boyer-Moore算法java实现详解编程语言
- Java学习笔记之九java二维数组及其多维数组的内存应用拓展延伸详解编程语言
- java集合框架02详解编程语言
- java日志文件log4j.properties配置详解编程语言
- java-jpa-criteriaBuilder使用入门详解编程语言
- Java操作MySQL数据库快速入门(java访问mysql)
- Linux上部署Java项目实践指南(linux部署java项目)
- 玩转Linux:Java开发入门指南(linux上开发java)
- Oracle与Java的连接:揭秘数据库开发技术之间的神奇联系(oracle连接java)
- 面试前准备:Java技术和Redis快速入门(java面试redis)
- 如何在Linux系统中正确配置Java?(linux下配置java)
- Linux平台上C语言接口调用Java语言实现(linux c调java)
- 数据Java操作MySQL库:获取你所需的数据(java获取mysql)
- Linux上善用Java:实现智能开发(linux 运行java)
- Java Redis一次实现无限数据加速的尝试(用java redis)
- Java实现与Oracle数据库的无缝整合(java整合oracle)
- Java技术将数据写入Oracle数据库(java写入oracle)
- 并发Redis锁保障Java并发性(redis锁实现java)
- [JAVA]十四种Java开发工具点评
- java代理模式与动态代理模式详解
- Java实现JSP在Servelt中连接Oracle数据库的方法