深入理解 Java:注解(Annotation)自己定义注解入门
要深入学习注解。我们就必须能定义自己的注解,并使用注解,在定义自己的注解之前。我们就必须要了解 Java 为我们提供的元注解和相关定义注解的语法。
元注解:
元注解的作用就是负责注解其它注解。
Java5.0 定义了 4 个标准的 meta-annotation 类型。它们被用来提供对其它 annotation 类型作说明。Java5.0 定义的元注解:
1.@Target,
2.@Retention,
3.@Documented,
4.@Inherited
这些类型和它们所支持的类在 java.lang.annotation 包中能够找到。以下我们看一下每一个元注解的作用和对应分參数的使用说明。
@Target:
[email protected]: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 仅可用于注解类的成员变量。
[email protected]:
[email protected] 定义了该 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, 这样注解处理器能够通过反射,获取到该注解的属性值。从而去做一些执行时的逻辑处理
[email protected]:
@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;
- }
[email protected]:
@Inherited 元注解是一个标记注解,@Inherited 阐述了某个被标注的类型是被继承的。假设 [email protected]class,则这个 annotation 将被用于该 class 的子类。
注意:@Inherited annotation 类型是被标注过的 class 的子类所继承。
类并不从它所实现的接口继承 annotation,方法并不从它所重载的方法继承 annotation。
[email protected] [email protected].RUNTIME,则反射 API 增强了这样的继承性。
[email protected] annotation 类型的 annotation 时,反射代码检查将展开工作:检查 class 和其父类,直到发现指定的 annotation 类型被发现。或者到达类继承结构的顶层。
实例代码:
- /**
- *
- * @author peida
- *
- */
- @Inherited public@interface Greeting {
- public enum FontColor {
- BULE,
- RED,
- GREEN
- };
- String name();
- FontColor fontColor()
- default FontColor.GREEN;
- }
自己定义注解:
[email protected],[email protected]��译程序自己主动完毕其它细节。在定义注解时,[email protected]��注解,当中的每一个方法实际上是声明了一个配置參数。方法的名称就是參数的名称,返回值类型就是參数的类型(返回值类型仅仅能是基本类型、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("水果的名字是:苹果");
- }
- }
注解元素的默认值:
注解元素必须有确定的值。要么在定义注解的默认值中指定,要么在使用注解时指定。非基本类型的注解元素的值不可为 null。因此, 使用空字符串或 0 作为默认值是一种经常使用的做法。这个约束使得处理器非常难表现一个元素的存在或缺失的状态。由于每一个注解的声明中,全部元素都存在,而且都具有对应的值,为了绕开这个约束。我们仅仅能定义一些特殊的值。比如空字符串或者负数。一次表示某个元素不存在,在定义注解时,这已经成为一个习惯使用方法。
比如:
- 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 FruitProvider {
- /**
- * 供应商编号
- * @return
- */
- public int id()
- default - 1;
- /**
- * 供应商名称
- * @return
- */
- public String name()
- default "";
- /**
- * 供应商地址
- * @return
- */
- public String address()
- default "";
- }
定义了注解。并在须要的时候给相关类,类属性加上注解信息,假设没有响应的注解信息处理流程。注解能够说是没有有用价值。
怎样让注解真真的发挥作用。主要就在于注解处理方法。下一步我们将学习注解信息的获取和处理!
来源: http://www.bubuko.com/infodetail-2222610.html