第一步,定义注解——相当于定义标记;
第二步,配置注解——把标记打在需要用到的程序代码中;
第三步,解析注解——在编译期或运行时检测到标记,并进行特殊操作。
注解在Java中,与类、接口、枚举类似,因此其声明语法基本一致,只是所使用的关键字有所不同,注解使用@interface关键字来声明。在底层实现上,所有定义的注解都会自动继承java.lang.annotation.Annotation接口。
public @interface Information { }
注解类型的实现部分:
根据我们日常定义类或接口的经验,在类中无非是要定义构造方法、属性或一般方法。但是,在自定义注解中,其实现部分只能定义一个东西:注解类型元素(annotation type element)。基本语法如下:
public @interface Information { String name(); int age(); String[] hobbies(); String address(); }
根据上面定义的属性,我们可以发现这种定义的内容类似抽象方法,实际上这是一种规定的注解类型元素。
注解类型元素允许我们设置默认值,如果不设置则在后续使用注解时候,必须填写对应的属性值。
public @interface Information { String name(); int age(); String[] hobbies(); String address() default "中国"; }
定义注解类型元素时需要注意如下几点:
1.访问修饰符必须为public,不写默认为public;2.该元素的类型只能是基本数据类型、String、Class、枚举类型、注解类型(体现了注解的嵌套效果)以及上述类型的一位数组;
3.该元素的名称一般定义为名词,如果注解中只有一个元素,请把名字起为value(后面使用会带来便利操作);
4.()不是定义方法参数的地方,也不能在括号中定义任何参数,仅仅只是一个特殊的语法;
5.default代表默认值,值必须和第2点定义的类型一致;
6.如果没有默认值,代表后续使用注解时必须给该类型元素赋值。
可以看出,注解类型元素的语法非常奇怪,即又有属性的特征(可以赋值),又有方法的特征(打上了一对括号)。但是这么设计是有道理的,在后续的代码示例中我们可以看到:注解在定义好了以后,使用的时候操作元素类型像在操作属性,解析的时候操作元素类型像在操作方法。
2.元注解
一个最基本的注解定义就只包括了上面的两部分内容:1、注解的名字;2、注解包含的类型元素。但是,我们在使用JDK自带注解的时候发现,有些注解只能写在方法上面(比如@Override);有些却可以写在类的上面(比如@Deprecated)。当然除此以外还有很多细节性的定义,那么这些定义该如何做呢?这些限定就是通过元注解来实现的。
元注解:专门修饰注解的注解。它们都是为了更好的设计自定义注解的细节而专门设计的。
public enum ElementType { /** Class, interface (including annotation type), or enum declaration */ TYPE, /** Field declaration (includes enum constants) */ FIELD, /** Method declaration */ METHOD, /** Formal parameter declaration */ PARAMETER, /** Constructor declaration */ CONSTRUCTOR, /** Local variable declaration */ LOCAL_VARIABLE, /** Annotation type declaration */ ANNOTATION_TYPE, /** Package declaration */ PACKAGE, /** * Type parameter declaration * * @since 1.8 */ TYPE_PARAMETER, /** * Use of a type * * @since 1.8 */ TYPE_USE } //限定@Information注解只能使用在类、接口或方法上面。 @Target({ElementType.TYPE,ElementType.METHOD}) public @interface Information { String name(); int age(); String[] hobbies(); String address() default "中国"; }
Java源文件阶段。
编译到class文件阶段。
运行期阶段。
注:只有注解信息在运行时保留,我们才能在运行时通过反射操作获取到注解信息。
同样使用了RetentionPolicy枚举类型定义了三个阶段:
public enum RetentionPolicy { /** * Annotations are to be discarded by the compiler. * (注解将被编译器忽略掉) */ SOURCE, /** * 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. * (注解将被编译器记录在class文件中,但在运行时不会被虚拟机保留,这是一个默认的行为) */ CLASS, /** * Annotations are to be recorded in the class file by the compiler and * retained by the VM at run time, so they may be read reflectively. * (注解将被编译器记录在class文件中,而且在运行时会被虚拟机保留,因此它们能通过反射被读取到) * @see java.lang.reflect.AnnotatedElement */ RUNTIME }
1.如果一个注解被定义为RetentionPolicy.SOURCE,则它将被限定在Java源文件中,那么这个注解即不会参与编译也不会在运行期起任何作用,这个注解就和一个注释是一样的效果,只能被阅读Java文件的人看到;
2.如果一个注解被定义为RetentionPolicy.CLASS,则它将被编译到Class文件中,那么编译器可以在编译时根据注解做一些处理动作,但是运行时JVM(Java虚拟机)会忽略它,我们在运行期也不能读取到;
3.如果一个注解被定义为RetentionPolicy.RUNTIME,那么这个注解可以在运行期的加载阶段被加载到Class对象中。那么在程序运行阶段,我们可以通过反射得到这个注解,并通过判断是否有这个注解或这个注解中属性的值,从而执行不同的程序代码段。
我们实际开发中的自定义注解几乎都是使用的RetentionPolicy.RUNTIME;
4.在默认的情况下,自定义注解是使用的RetentionPolicy.CLASS。
(3)@Documented
@Documented注解,是被用来指定自定义注解是否能随着被定义的java文件生成到JavaDoc文档当中。
(4)@Inherited
@Inherited注解,是指定某个自定义注解如果写在了父类的声明部分,那么子类的声明部分也能自动拥有该注解,类似继承。@Inherited注解只对那些@Target被定义为ElementType.TYPE的自定义注解起作用。
注:类并不从它所实现的接口继承annotation,方法并不从它所重载的方法继承annotation。
@Retention(RetentionPolicy.RUNTIME) @Target(value = {ElementType.TYPE}) @Documented public @interface FirstAnnotation { } //等效于@FirstAnnotation() @FirstAnnotation public class DemoClass{ //省略实现部分 }
@Retention(RetentionPolicy.RUNTIME) @Target(value = {ElementType.TYPE}) @Documented public @interface SecondAnnotation { String value(); } //等效于@ SecondAnnotation(value = "this is second annotation") @SecondAnnotation("this is annotation") public class DemoClass{ //省略实现部分 }
@Retention(RetentionPolicy.RUNTIME) @Target(value = {ElementType.TYPE}) @Documented public @interface ThirdAnnotation { String[] name(); } //等效于@ ThirdAnnotation(name = {"this is third annotation"}) @ ThirdAnnotation(name = "this is third annotation") public class DemoClass{ //省略实现部分 }
明确我们的需求后,前面我们说过,只有将注解的生命周期配置成运行时,即在Runntime时保留,才能获取注解中的相关信息。
操作和使用注解 要用到Java中的核心技术——反射。
废话少说,下面直接上代码。
/** * @ClassName Information * @Description 信息注解 * @Author EvanWang * @Version 1.0.0 * @Date 2019/11/6 14:49 */ @Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) public @interface Information { String name(); int age(); String[] hobbies(); String address() default "中国"; }
/** * @ClassName Person * @Description Person Pojo * @Author EvanWang * @Version 1.0.0 * @Date 2019/11/6 17:06 */ public class Person { String name; int age; String hobbies; String address; 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 String getHobbies() { return hobbies; } public void setHobbies(String hobbies) { this.hobbies = hobbies; } public String getAddress() { return address; } public void setAddress(String address) { this.address = address; } }
/** * @ClassName PersonService * @Description * @Author EvanWang * @Version 1.0.0 * @Date 2019/11/6 16:55 */ public class PersonService { @Information(name = "Evan", age = 18, hobbies = {"编程", "看电影", "踢足球"}) public void outputPersonInfo(Person person) { String outputStr = String.format("我是%s,我来自%s,今年%s岁,我的爱好是%s。", person.getName(), person.getAddress(), person.getAge(), person.getHobbies()); System.out.println(outputStr); } }
/** * @ClassName AnnotationTest * @Description 自定义注解测试类 * @Author EvanWang * @Version 1.0.0 * @Date 2019/11/6 16:18 */ public class AnnotationTest { public static void main(String[] args) throws Exception { Class<?> clazz = PersonService.class; Method method = clazz.getMethod("outputPersonInfo", Person.class); if (!method.isAnnotationPresent(Information.class)){ System.out.println(method.getName()+"方法没有标注@Information注解!"); return; } Person person = new Person(); Information information = method.getAnnotation(Information.class); person.setName(information.name()); person.setAddress(information.address()); person.setAge(information.age()); person.setHobbies(Arrays.asList(information.hobbies()).toString()); PersonService personService=new PersonService(); method.invoke(personService,person); } } 运行结果: 标注注解: 我是Evan,我来自中国,今年18岁,我的爱好是[编程, 看电影, 踢足球]。 未标注注解: outputPersonInfo方法没有标注@Information注解!
原文链接:https://blog.csdn.net/qq_41378597/article/details/102934784