Annotation是从JDK5.0开始引入的新技术
Annotation的作用:
1、不是程序本身,可以对程序做出解释。(这一点和注释(comment)没什么区别)
如在重写父类方法时常见的@Override,它有检查和约束的作用
2、可以被其他程序(如编译器)读取
Annotation的格式:
注解是以“@注解名”在代码中存在的,还可以添加一些参数值,如
@SuppressWarnings(value = "unchecked")
Annotation在哪里使用:
可以附加在package、class、method,field等上面。相当于给他们添加了额外的辅助信息,我们可以通过反射机制编程实现对这些元数据(反射有讲到)的访问
内置注解
最常见的三个内置注解
@Override:重写,定义在java.lang.Override中,此注解只适用于修辞方法,表示一个方法声明打算重写超类中的另一个方法声明
@Deprecated:废弃,定义在java.lang.Deprecated中,此注解可以用于修辞方法、属性、类,表示不鼓励使用这样的元素,通常是因为它很危险或者存在更好的选择
@SuppressWarnings:抑制警告,定义在java.lang.SuppressWarnings中,用来抑制编译时的警告信息。与上面两个注解不同,需要添加一个参数才能正常使用,这些参数都是已经定义好的,直接选择使用就行
@SuppressWarnings("{unchecked}")
@SuppressWarnings( "all")
@SuppressWarnings(value = { "unchecked",”deprecation”})
等等
元注解
元注解的作用就是负责注解其他注解,Java定义了4个标准的meta-annotation类型,他们被用来提供对其他annotation类型作说明
这些类型和它们所支持的类在java.lang.annotation包中可以找到。(@Target,@Retention,@Document,@Inherited)
@Target:用于描述注解的使用范围(即:被描述的注解可以用在什么地方)
@Retention:表示需要在什么级别保存该注解信息,用于描述注解的生命周期
(SOURCE<CLASS<RUNTIME)
@Document:说明该注解将被包含在javadoc()。(表示是否将我们的注解生成再Javadoc中)
@Inherited:说明子类可以继承父类的该注解
自定义一个注解使用:@interface 注解名{}
如上图,@Target约束了自定义注解的使用范围为方法,所以当在字段上使用该注解时会报错,其他三个元注解类似
自定义注解
1、使用@interface用来声明一个注解,格式:public @interface 注解名{定义内容}
2、注解中可以包含常量和方法
常量:定义后对外部没有太多实际意义。外部使用该注解时无法对该值进行修改,常量默认使用public static final修饰
方法:必须有返回值,且返回值类型就是参数的类型(返回值只能是基本类型,Class,String,enum、注解类型及以上类型的一维数组),方法默认使用public abstract修饰
3、其中的每一个方法实际上是声明了一个配置函数,方法的名称就是参数的名称
虽然定义注解时是方法,但是对于外部使用时当做属性使用
4、可以通过default来声明参数的默认值
5、如果只有一个参数成员,一般参数名为value(只有是value时才不用写”value = “)
6、注解元素必须要有值,我们定义注解元素时,经常使用空字符串,0作为默认值
使用反射读取注解中配置的值,判断对象属性值是否满足要求,如果不满足就抛出异常。一般实际项目中会专门针对这个定义一个异常。
@Target(value = {ElementType.CONSTRUCTOR, TYPE,ElementType.METHOD, FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
public @interface OwnDefinedAnnotation {
//注解的参数:参数类型 + 参数名
String value() default "";//通过default来声明参数的默认值,经常使用空字符串,0作为默认值
ElementType[] values();
// ElementType[] values() default {TYPE,FIELD};
}
@Target(ElementType.TYPE)
public @interface Hello {
int name() default 0;//通过default来声明参数的默认值,经常使用空字符串,0作为默认值
int age() default -1;//如果默认值为-1,代表不存在
}
package com.zdz.annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* @version null
* @anthor zdz/Maddox
*/
@Hello
public class Test {
//如果没有默认值,我们就必须给注解赋值,有默认值也可以显式赋值
@OwnDefinedAnnotation(value = "zdz",values = {ElementType.TYPE,ElementType.METHOD})
private String test;
@MyAnnotation
public void f1(){
}
}
//定义一个注解
@Target(value = {ElementType.METHOD,ElementType.TYPE})
@Retention(value = RetentionPolicy.CLASS)
@interface MyAnnotation{
}
反射获取注解
注解的作用演示
package com.zdz.annotation;
import java.lang.annotation.*;
/**
* @version null
* @anthor zdz/Maddox
*/
@Target(value = {ElementType.TYPE,ElementType.FIELD,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ScareRestrain {
int max() default 100;//限制满分是100
int min() default 0;//限制最低分是0
}
package com.zdz.annotation;
/**
* @version null
* @anthor zdz/Maddox
*/
public class SubjectScare {
@ScareRestrain
public int math;
@ScareRestrain
public int english;
public SubjectScare(int math, int english) {
this.math = math;
this.english = english;
}
}
package com.zdz.annotation;
import java.lang.reflect.Field;
/**
* @version null
* @anthor zdz/Maddox
*/
public class MyScan {
public static void checked(Object obj) throws IllegalAccessException {
//获得传入的Object的Class类对象
Class<?> clazz = obj.getClass();
//获得Object中定义的所有字段
Field[] fields = clazz.getDeclaredFields();
for (Field field : fields) {
field.setAccessible(true);//突破封装的限制(可能有私有属性)
//判断当前属性上是否包含MyAnnotation
if (field.isAnnotationPresent(ScareRestrain.class)){
System.out.println("当前获得的字段:" + field.getName());
ScareRestrain myAnnotation = field.getAnnotation(ScareRestrain.class);
int max = myAnnotation.max();//获取用户设置的最大值
int min = myAnnotation.min();//获取用户设置的最小值
int num = field.getInt(obj);
if (num> 100 || num < 0){
throw new RuntimeException("超过最大值或小于最小值,注意最大值为100,最小值为0" + min + "-" + max);
}
}
}
}
}
package com.zdz.annotation;
import java.lang.reflect.Method;
/**
* @version null
* @anthor zdz/Maddox
*/
public class ReflectAnnotation {
public static void main(String[] args) throws IllegalAccessException {
SubjectScare subjectScare = new SubjectScare(1000, 1000);
//对我们当前设置的值进行校验
//一般这个判断不是由手动操作的,以后使用过滤器/AOP自动调用这个方法进行校验
MyScan.checked(subjectScare);
}
}
注解的底层是通过反射解析的