Java的注解总结

java 1.5开始引入了注解和反射，正确的来说注解是反射的一部分，没有反射，注解无法正常使用，但离开注解，反射依旧可以使用。
Java的注解详解和自定义注解： https://blog.csdn.net/u010902721/article/details/52576624
一、注解的基本概念
Java的注解像修饰符一样，可以用于从Java代码中抽取文档、跟踪代码中的依赖性或者是编译时检查。注解可以应用到包、类、
方法、成员变量、参数和本地变量的声明中。

二、注解的工作原理
先使用注解修饰java代码，然后另一块叫做注解处理器的代码会解析这段注解和被修饰的代码，并做相应的处理。

三、JDK内置的标准注解
JavaSE中内置了三个标准注解，都是定义在java.lang中，它们是：
@Override:用于修饰子类的方法覆盖了父类中的方法；
@Deprecated:用于修饰已经过时了的方法，不推荐使用的方法；
@SuppressWarnnings:告诉java编译器禁止编译警告。
2.1 @Override
@Override很简单，只是一个标记，用于标注一个方法。它表示，被它标注的方法覆盖了父类的方法。如果一不小心，子类的方法名写错了，
有了@Override之后，编译时会报错。也就是说被@Override标注的方法如果没有覆盖父类的方法，编译时报错。
2.2 @Deprecated
@Deprecated也是一个标记注解，用于修饰一个方法。它表示此方法不推荐使用。无论是继承、覆盖或直接使用此方法，编译器都会给出警告。
2.3 @SuppressWarnings
字面翻译就是抑制警告，它用于告诉编译器，对被标注的这句代码不要给出特定的警告。
@SuppressWarnings有一些参数用于表示特定的警告：
deprecation:不要给出“不赞成使用的类或方法的警告”；
unchecked:不要给出“类型转换时警告”；
fallthrough:不要给出”switch语句块没有break的警告”；
path:不要给出“不存在的路径”的警告；
serial:不要给出“可序列化类缺少serialVersionUID”的警告；
finally:不要给出“finally语句块不能正常完成”的警告；
all:不要给出以上所有情况的警告。

三、自定义注解
java允许我们自己定义注解，它提供了元注解用于自定义注解。

3.1 元注解
java提供元注解的目的就是让开发者自定义注解，元注解负责注解自定义注解。
@Target；
@Retention；
@Documented；
@Inherited。
Java5.0定义了4个元注解。接下来，分别分析这四个元注解：

3.1.1 @Target
@Target用来说明自定义注解可以用在什么地方，其ElementType取值有：
1. CONSTRUCTOR:用于描述构造器
2. FIELD:用于描述（域，字段） //作用于对象，在field前加上static，field就变成了类变量
3. LOCAL_VARIABLE: //用于描述局部变量，作用于方法中，方法结束，它就消失
4. METHOD:用于描述方法
5. PACKAGE:用于描述包
6. PARAMETER:用于描述参数
7. TYPE:用于描述类、接口(包括注解类型) 或enum声明

使用示例：@Target(ElementType.FIELD)

3.1.2 @Retention
@Retention用来描述自定义注解的生命周期，其RetentionPoicy取值有：
1. SOURCE:在源文件中有效
2. CLASS:在class文件中有效
3. RUNTIME:在运行时有效

使用示例：@Retention(RetentionPolicy.RUNTIME)
3.1.3 @Documented
@Documented用于表示自定义注解可以被javadoc之类的工具文档化，没有成员。
使用示例：@Documented

3.1.4 @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类型被发现，
或者到达类继承结构的顶层。

3.2 开始自定义注解
定义注解格式： public @interface 注解名 {定义体}
注解参数的可支持数据类型：
所有基本数据类型（int,float,boolean,byte,double,char,long,short)
String类型
Class类型
enum类型
Annotation类型
以上所有类型的数组
使用@interface自定义注解时，自动继承了java.lang.annotation.Annotation接口，由编译程序自动完成其他细节。
在定义注解时，不能继承其他的注解或接口。

@interface用来声明一个注解，其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称，返回值类型就是参数的类型
（返回值类型只能是基本类型、Class、String、enum）。可以通过default来声明参数的默认值。

注意：
只能用public或默认(default)这两个访问权修饰.例如,String value();这里把方法设为defaul默认类型；　
参数成员只能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型和 String,Enum,Class,annotations等数据类型,
以及这一些类型的数组.例如,String value();这里的参数成员就为String;
如果只有一个参数成员,最好把参数名称设为”value”,后加小括号.

3.3 例子
定义一个注解@Persion:
package com.zcx.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.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Persion {
String name() default "zcx";
int age() default 18;
String[] hobby() default {"basketball", "football"};
}

再定义一个注解@StudentGender：
package com.zcx.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
public @interface StudentGender {
public enum Gender{BOY, GIRL};
Gender gender() default Gender.BOY;
}

定义一个类，使用刚才定义的两个注解：
package com.zcx.annotation;
import com.zcx.annotation.StudentGender.Gender;

@Persion(name="haha", age=97, hobby={"test1", "test2"})
public class Student {
@StudentGender(gender=Gender.BOY)
private String stuGender;

public String getStuGender() {
return stuGender;
}
public void setStuGender(String stuGender) {
this.stuGender = stuGender;
}
}

定义一个注解处理器，用于处理注解内容：
package com.zcx.annotation;
import java.lang.reflect.Field;
public class AnnotationProcessor {
public static void getStudentInfo(Class<?> clazz){
if(clazz.isAnnotationPresent(Persion.class)){
Persion annotation = (Persion)clazz.getAnnotation(Persion.class);
System.out.println(annotation);
System.out.println(annotation.age());
System.out.println(annotation.name());
String[] hobby = annotation.hobby();
for(String str : hobby){
System.out.println(str);
}
}
Field[] fields = clazz.getDeclaredFields();

for(Field field :fields){
System.out.println("fieldName=" + field.toString());
if(field.isAnnotationPresent(StudentGender.class)){
StudentGender annotation = (StudentGender)field.getAnnotation(StudentGender.class);
System.out.println(annotation);
System.out.println(annotation.gender());
}
}
}
}

最后，定义测试类：
package com.zcx.annotation;
public class Test {
/**
* @param args
*/
public static void main(String[] args) {
// TODO Auto-generated method stub
AnnotationProcessor.getStudentInfo(Student.class);
}
}

巴特西

Java的注解总结

最新文章

热门文章