基于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 @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;
}
--------------------------------------------------------------------------------
自定义注解:
使用@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)这两个访问权修饰.例如,string value();这里把方法设为defaul默认类型;
第二,参数成员只能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型和 string,enum,class,annotations等数据类型,以及这一些类型的数组.例如,string value();这里的参数成员就为string;
第三,如果只有一个参数成员,最好把参数名称设为"value",后加小括号.例:下面的例子fruitname注解就只有一个参数成员。
简单的自定义注解和使用注解实例:
package annotation;
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 peida
*
*/
@target(elementtype.field)
@retention(retentionpolicy.runtime)
@documented
public @interface fruitname {
string value() default "";
}
package annotation;
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 peida
*
*/
@target(elementtype.field)
@retention(retentionpolicy.runtime)
@documented
public @interface fruitcolor {
/**
* 颜色枚举
* @author peida
*
*/
public enum color{ bule,red,green};
/**
* 颜色属性
* @return
*/
color fruitcolor() default color.green;
}
package annotation;
import annotation.fruitcolor.color;
public class apple {
@fruitname("apple")
private string applename;
@fruitcolor(fruitcolor=color.red)
private string applecolor;
public void setapplecolor(string applecolor) {
this.applecolor = applecolor;
}
public string getapplecolor() {
return applecolor;
}
public void setapplename(string applename) {
this.applename = applename;
}
public string getapplename() {
return applename;
}
public void displayname(){
system.out.println("水果的名字是:苹果");
}
}
定义了注解,并在需要的时候给相关类,类属性加上注解信息,如果没有响应的注解信息处理流程,注解可以说是没有实用价值。如何让注解真真的发挥作用,主要就在于注解处理方法,下一步我们将通过注解实现一个简单的orm,来深入学习注解,来利用注解!
推荐阅读
-
基于Java注解(Annotation)的自定义注解入门介绍
-
基于Java 注解(Annotation)的基本概念详解
-
Java Annotation(Java 注解)的实现代码
-
基于Java注解(Annotation)的自定义注解入门介绍
-
基于Java 注解(Annotation)的基本概念详解
-
5分钟搞懂java注解@Annotation的具体使用
-
Java注解Annotation与自定义注解详解
-
基于SpringBoot的操作日志管理(AOP+自定义注解方式)
-
Java自定义注解以及在POI导出EXCEL中的一个应用 javaannotationPOIexcel
-
Java语言注解Annotation的理解和使用