反射取得Annotation信息 | 带你学《Java语言高级特性》之九十七-阿里云开发者社区

开发者社区> Java开发者> 正文

反射取得Annotation信息 | 带你学《Java语言高级特性》之九十七

简介: 本节介绍了获取Annotation信息的方法,以及Annotation的运行策略,通过案例解释如何实现自定义的Annotation。

上一篇:CGLIB实现代理设计模式 | 带你学《Java语言高级特性》之九十六
【本节目标】
本节介绍了获取Annotation信息的方法,以及Annotation的运行策略,通过案例解释如何实现自定义的Annotation。
从JDK1.5后Java开发提供了Annotation技术支持,这种技术为项目的编写带来了新的模型,而后经过了十多年的发展,Annotation的技术得到了非常广泛的应用,并且在所有的项目开发中都会存在。

获取Annotation信息

在进行类或方法定义时,都可以使用一系列的Annotation进行声明,于是如果要想获得这些Annotation信息,那么可以直接通过反射来完成。在java.lang.reflect里面有一个AccessibleObject类,在本类中提供有获取Annotation类的方法:

获取全部Annotation:
public Annotation[] getAnnotations()
获取指定Annotation:
public <T extends Annotation> T getAnnotation​(Class<T> annotationClass)

image.png

范例:定义一个接口,并在接口在使用Annotation

import java.io.Serializable;
import java.lang.annotation.Annotation;
import java.lang.reflect.Method;

public class JavaAPIDemo {
    public static void main(String[] args) throws Exception {
        {   //获取接口上的Annotation信息
            Annotation annotations [] = IMessage.class.getAnnotations();  //获取接口上的全部Annotation
            for (Annotation temp : annotations) {
                System.out.println(temp);
                //@java.lang.FunctionalInterface()
                //@java.lang.Deprecated(forRemoval=false, since="1.0")
            }
        }
        System.out.println("-----------------------");
        {//获取MessageImpl子类上的Annotation信息
            Annotation annotations []= MessageImpl.class.getAnnotations();  //获取类上的全部Annotation
            for (Annotation temp : annotations) {
                System.out.println(temp);
            }
        }
        System.out.println("-----------------------");
        {   //获取MessageImpl.toString()方法上的Annotation信息
            Method method = MessageImpl.class.getDeclaredMethod("send", String.class);
            Annotation annotations [] = method.getAnnotations();  
            for (Annotation temp : annotations) {
                System.out.println(temp);
            }
        }
    }
}
@FunctionalInterface    //程序执行时可以获取
@Deprecated(since = "1.0")     
interface IMessage {     //有2个Annotation
    public void send(String msg);
}
@SuppressWarnings("serial")     //无法在程序执行时获取
class MessageImpl implements IMessage, Serializable {
    @Override      //无法在程序执行时获取
    public void send(String msg) {
        System.out.println("【消息发送】" + msg);
    }
}

不同的Annotation有它的存在范围,下面对比两个Annotation:
@FunctionalInterface(运行时):

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface FunctionalInterface {}

@SuppressWarnings(源代码):

@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE, MODULE})
@Retention(RetentionPolicy.SOURCE)
public @interface SuppressWarnings {}

现在发现“@FunctionalInterface”是在运行时生效的Annotation,所以程序执行时可以获取Annotation;而“@SuppressWarnings”是在源代码编写时有效。
在RetentionPolicy枚举类中还有一个class的定义,指的是在类定义时生效。

自定义Annotation

现在已经清楚了Annotation的获取,以及Annotation的运行策略,但是最为关键性的因素是如何实现自定义的Annotation呢?为此在Java中提供了新的语法,使用“@interface”来定义Annotation。
范例:自定义Annotation

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.reflect.Method;

@Retention(RetentionPolicy.RUNTIME)   //定义Annotation的运行策略
@interface DefaultAnnotation {      //自定义的Annotation
    public String title();      //获取数据
    public String url() default "www.mldn.cn";   //获取数据
class Message {
    @DefaultAnnotation(title = "MLDN")
    public void send(String msg) {
        System.out.println("【消息发送】" + msg);
    }
}
public class JavaAPIDemo {
    public static void main(String[] args) throws Exception {
        Method method = Message.class.getMethod("send",String.class);  //获取指定方法
        DefaultAnnotation  anno = method.getAnnotation(DefaultAnnotation.class);  //获取指定的Annotation
        //System.out.println(anno.title());  //直接调用Annotation中的方法  MLDN
        //System.out.println(anno.url());    //直接调用Annotation中的方法  www.mldn.cn
        //直接调用Annotation中的方法
        String msg = anno.title()+"("+anno.url()+")";  //消息内容 
        method.invoke(Message.class.getDeclaredConstructor().newInstance(), msg);   //【消息发送】MLDN(www.mldn.cn)
    }
}

使用Annotation之后的最大特点是可以结合反射机制实现程序的处理。

想学习更多的Java的课程吗?从小白到大神,从入门到精通,更多精彩不容错过!免费为您提供更多的学习资源。
本内容视频来源于阿里云大学

下一篇:整合工厂设计模式与Annotation | 带你学《Java语言高级特性》之九十八
更多Java面向对象编程文章查看此处

版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

分享:
Java开发者
使用钉钉扫一扫加入圈子
+ 订阅

Java开发者成长课堂,课程资料学习,实战案例解析,Java工程师必备词汇等你来~

官方博客
官网链接