java注解简介
java中的常见注解主要包括以下两类:jdk自带注解和元注解(可实现自定义注解)
jdk的自带注解
- @Override:告诉编译器我重写了接口方法
- @Deprecated:告诉编译器这个方法过时了,不建议使用,Ide会在方法上划横线
- @SuppressWarnings("deprecation"):关闭方法中出现的警告
等等
元注解
元注解的作用就是注解其他注解,一般我们使用自定义注解时,就需要用元注解来标注我们自己的注解,一共有四个元注解:
1、@Target:说明了Annotation被修饰的范围,可被用于packages、types(类、接口、枚举、Annotation类型)、类型成员(方法、构造方法、成员变量、枚举值)、方法参数和本地变量(如循环变量、catch参数)。在Annotation类型的声明中使用了target可更加清晰其修饰的目标。
例:@Target(ElementType.TYPE)
1.ElementType.CONSTRUCTOR:用于描述构造器
2.ElementType.FIELD:用于描述域(类的成员变量)
3.ElementType.LOCAL_VARIABLE:用于描述局部变量(方法内部变量)
4.ElementType.METHOD:用于描述方法
5.ElementType.PACKAGE:用于描述包
6.ElementType.PARAMETER:用于描述参数
7.ElementType.TYPE:用于描述类、接口(包括注解类型) 或enum声明
2、@Retention:定义了该Annotation被保留的时间长短,有些只在源码中保留,有时需要编译成的class中保留,有些需要程序运行时保留。即描述注解的生命周期。
例:@Retention(RetentionPolicy.RUNTIME)
1.RetentionPoicy.SOURCE:在源文件中有效(即源文件保留)
2.RetentionPoicy.CLASS:在class文件中有效(即class保留)
3.RetentionPoicy.RUNTIME:在运行时有效(即运行时保留)
3、@Documented:它是一个标记注解,即没有成员的注解,用于描述其它类型的annotation应该被作为被标注的程序成员的公共API,因此可以被例如javadoc此类的工具文档化
4、@Inherited:它也是一个标记注解,它的作用是,被它标注的类型是可被继承的,比如一个class被@Inherited标记,那么一个子类继承该class后,则这个annotation将被用于该class的子类。
自定义注解
public @interface 注解名 {定义体}
使用@interface定义一个注解,自动继承java.lang.annotation.Annotation接口,其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称,返回值类型就是参数的类型(返回值类型只能是基本类型、Class、String、enum)。可通过default来声明参数的默认值。default来声明参数的默认。注解参数的可支持数据类型:
1.所有基本数据类型(int,float,boolean,byte,double,char,long,short)
2.String类型
3.Class类型
4.enum类型
5.Annotation类型
6.以上所有类型的数组
定义注解成员的注意点:
第一,只能用public或默认(default)这个访问权修改。例如,String value();这里把方法设为default默认类型:
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface userName {
String value() default "";
}
第二,参数成员只能用基本类型byte,char,int,long,float,double,boolean八种基本数据类型和和 String,Enum,Class,annotations等。数据类型,以及这一些类型的数组。
//定义一个枚举
public enum RequestMethod {
GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS, TRACE
}
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Mapping
public @interface RequestMapping {
String name() default "";
String[] path() default {};
RequestMethod[] method() default {};//枚举数组
}
第三,如果只有一个参数成员,最好把参数名称设为"value",后加小括号。
注解的默认值
注解元素必须有确定的值,要么指定时给默认值,要么使用时给值。不过有时候我们需要确定表达一个元素不存在值,所以使用空字符串或者负数表示某个元素不存在,在定义注解,这已经成为一个约定用法。
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface User {
public int id() default -1;
public String name() default "";
public String address() default "";
}
父类的类上和方法上有自定义注解,并且被@Inherited标记,那么子类只有继承的情况下才会继承父类注解。重写、重载实现父类方法这些都不会继承。
总结AnnotatedElement的常用方法
注意:
getDeclaredAnnotations和getAnnotations得到的都是当前类上面所有的注解(不包括方法上注解和属性上注解),不同的是,前者不包括继承的。而getAnnotations得到的是包括继承的所有注解。
注解处理器实例
自定义注解定义:
@MyTable(value = "tb_student")
public class Student {
@MyField(columnName = "sname", type = "varchar2", length = 128)
private String name;
@MyField(columnName = "age", type = "int", length = 3)
private int age;
@MyField(columnName = "id", type = "int", length = 128)
private int id;
public int getId() {
return id;
}
public void setId(int id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public int getAge() {
return age;
}
public void setAge(int age) {
this.age = age;
}
}
注解处理器实现:
public class Demo {
public static void main(String[] args) {
try {
//通过反射获取Student类对象
Class clazz = Class.forName("com.wsh.annotation02.Student");
//获取Student类的所有有效注解
Annotation[] annotations = clazz.getAnnotations();
for (Annotation annotation : annotations) {
//@com.wsh.annotation02.MyTable(value=tb_student)
System.out.println(annotation);
}
//获取类指定的注解
MyTable myTable = (MyTable) clazz.getAnnotation(MyTable.class);
System.out.println(myTable.value()); //tb_student
//获取类的属性的注解
Field name_field = clazz.getDeclaredField("name");
MyField nameField = name_field.getAnnotation(MyField.class);
System.out.println(nameField.columnName()); //sname
System.out.println(nameField.type()); //varchar2
System.out.println(nameField.length()); //128
//至此,各个字段的属性名称、长度、类型都获取了、就可以动态拼接创建数据表的sql...
} catch (ClassNotFoundException | NoSuchFieldException e) {
e.printStackTrace();
}
}
}