K:注解语法简介

@转载自:http://www.cnblogs.com/peida/archive/2013/04/24/3036689.html

注解分为元注解(meta-annotation)和自定义注解

元注解:

元注解:是负责注解(动词)其它注解(名词)的注解(名词)

java5.0中有4个标准的注解。它用来对其它annotation类型作说明

1.@Target

2.@Retention

3.@Documented

4.@Inherited

 

以上的四个元注解,以及其所支持的类位于java.lang.annotation包中。

 

@Target:

用于描述注解所修饰的对象范围,Annotation可用于packages()types(类,接口,枚举,annotation类型)、类型成员(方法、构造方法、成员变量、枚举值)、方法参数和本地变量(如循环变量、catch参数)。在Annotation类型的声明中使用了target可更加清晰其修饰的目标。

作用:用于描述注解的使用范围(即:被描述的注解可以被使用在什么地方)

取值(ElementType)有:

1.CONSTRUCTOR:用于描述构造器(构造方法)

2.FIELD:用于描述域(即成员变量或静态变量)

3.LOCAL_VARIABLE:用于描述局部变量(方法中的变量)

4.METHOD:用于描述方法(成员方法或者静态方法)

5.PACKAGE:用于描述包

6.PARAMETER:用于描述参数(成员方法或者静态方法中的参数)

7.TYPE:用于描述类、接口(包括注解类型)或enum声明

8.ANNOTATION_TYPE:用于描述注解

 

例子:

@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被转载时将被读取。这个元注解可以对Annotation的“生命周期”进行限制。

作用:表示需要在什么级别保存该注释信息,用于描述注解的生命周期(即被描述的注解在什么范围内有效)

取值(RetentionPolicy)有:

1.SOURCE:在源文件中有效(即注解仅存在于源码中,在class字节码文件中不包含。当Java文件编译成class文件的时候,注解被遗弃。Annotations are to be discarded by the compiler.)

2.CLASS:class文件中有效(即默认的保留策略,注解会在class字节码文件中存在,但运行时无法获得。jvm加载class文件时候被遗弃。这是默认的生命周期。Annotations are to be recorded in the class file by the compiler but need not be retained by the VM at run time.  This is the default behavior.)

3.RUNTIME:在运行时有效(即注解会在class字节码文件中存在,在运行时可以通过反射获取到。jvm加载class文件之后,仍然存在,保存到class对象中,可以通过反射来获取。)

 

 

例子:

@Target(ElementType.FIELD)

@Retention(RetentionPolicy.RUNTIME)

public @interface Column

{

public String name() default ”fieldName”;

public boolean defaultDBValue() default false;
}

Column注解的RetentionPolicy的属性值为RUNTIME,其表示该Column注解是运行时保留的,这样注解处理器可以通过反射,获取到该属性值,从而去做一些运行时的逻辑处理。

 

@Documented

@Documented用于描述其它类型的注解应该被作为被标注的程序成员的公共API(也就是说,被@Documented注解的注解其在注解程序的时候,被注解的程序是对外开放的公共API),因此可以被例如javadoc此类的工具文档化。Documented是一个标记注解,没有成员

 

例子:

@Target(ElementType.FIELD)

@Retention(RetentionPolicy.RUNTIME)

@Documented

public @interface Column

{

public String name() default “fieldName”;

}

 

 

@Inherited

@Inherited元注解是一个标记注解,@Inherited阐述了某个被标注的类型是被继承的,即子类型会继承父类型的该注解。如果一个使用了@Inherited修饰的注解类型被用于一个class,则其annotation将被用于该class的子类。

注意:@Inherited annotation类型是被标注过的class的子类所继承。类并不从它所实现的接口继承annotation,方法并不从它所重载的方法继承annotation

 

@Inherited annotation类型标注的annotationRetentionRetentionPolicy.RUNTIME,则反射API增强了这种继承性。如果我们使用java.lang.reflect去查询一个@Inherited annotation类型的annotation时,反射代码检查将展开工作:检查class和其父类,直到发现指定的annotation类型被发现,或者到达类继承结构的顶层。

 

例子:

@Inherited

public @interface Greeting

{

public enum FontColor{BLUED,RED,GREEN};

String name();

FontColor fontColor() default FontColor.GREEN;
}

 

 

 

自定义注解:

自定义注解,就是自己所编写的注解,java中提供了四个元注解,其与的注解均为自定义注解。

使用@interface自定义注解时,自动继承了java.lang.annotation.Annotation接口,由编译程序自动完成其它细节。在定义注解时,不能继承其它的注解或者接口。@interface用来什么一个注解,其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称,返回值类型就是参数的类型(返回值类型只能是基本数据类型,Class类型,Stringenum)。可以通过default来声明参数的默认值。

语法格式如下:

@元注解

public @interface 注解名

{

public [static][final] 变量类型 变量名=变量值;

public [abstract] 返回值类型(也就是注解的参数类型) 方法名称(也就是注解的参数名称) [default 返回值类型的值](其表示可选);
}

 

注解参数的可支持数据类型:

1.所有基本数据类型(intfloatbooleanbytedoubleshortlongchar)

2.String类型

3.Class类型

4.enum类型

5.Annotation类型

6.以上所有类型的数组

 

Annotation类型里面的参数的设定:

1.只能用public或默认(缺省)这两个访问权修饰。例如 String value();这里就是把方法用缺省值进行修饰。

2.参数成员只能是基本基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型和 String,Enum,Class,annotations等数据类型,以及这一些类型的数组.例如,String value();这里的参数成员就为String;

3.如果只有一个参数成员,最好把参数名称设为"value"。即类型String value();这样

 

 

注解使用的一个例子:

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;

 

@Target(ElementType.FIELD)

@Retention(RetentionPolicy.RUNTIME)

@Documented

@interface FruitName 

{

String value() default "";

}

 

@Target(ElementType.FIELD)

@Retention(RetentionPolicy.RUNTIME)

@Documented

@interface FruitColor

{

public enum Color{BLUED,YELLOW,GREEN};

Color fruitColor() default Color.BLUED;

}

 

 

package annotation;

 

import annotation.FruitColor.Color;

 

/**

 * 自定义注解的使用例子,对于注解而言,如果没有相应

 * 的注解信息处理流程,注解便毫无使用价值

 * 让注解发挥真正作用,主要在于注解处理方法

 * @author 学徒

 *

 */

public class Test

{

@FruitName(value="apple")

private String appleName;

@FruitColor(fruitColor=Color.BLUED)

private String appleColor;

public void displayInformation()

{

System.out.println(this.appleColor+"\t"+this.appleName);

}

public static void main(String[] args)

{

new Test().displayInformation();

}

}

 

 

对于注解元素而言(即注解中定义的方法也就是注解的参数),注解元素必须要有确定的值,要么在定义注解的默认值中指定,要么在使用注解时指定,非基本类型的注解元素的值不可以为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;

 

/**

 * 该类用于演示默认的annotation的值

 * @author 学徒

 *

 */

@Target(ElementType.FIELD)

@Documented

@Retention(RetentionPolicy.RUNTIME)

public @interface AnnotationDefault 

{

public int id() default -1;

public String name() default "";

public String address() default "";

}

 

定义了注解,并在需要的时候给相关的类,类属性加上注解信息,如果没有相应的注解信息处理流程,注解可以说是没有实用价值。如何让注解真的发挥作用,主要在于注解的处理方法上。往下,将介绍注解信息的获取和处理。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值