概述
通过反射获取类、方法或成员上的 运行时 注解信息,从而实现动态控制程序运行逻辑,这也是注解的魅力所在。当然反射是比较影响性能的一种方式,在手机端是不适用的。但手机端也有很多注解类框架,那么他们是怎么实现的呢?
那就是使用 APT 解析 编译时 注解。在编译时会通过注解标示来动态生成一些 Java 代码或者 xml,而在运行时,注解已经不存在了,它会依靠编译时生成的 Java 代码来实现我们需要的业务逻辑。就是普通的 java 代码,当然不会影响效率了。由 Annotaion Processing Tool(简称 APT)
自动进行解析。本文主要分析如何用反射解析注解,APT会在后续章节展开。
自定义注解系列文章
- 那些高端、优雅的注解是怎么实现的<0> – 注解的分类
- 那些高端、优雅的注解是怎么实现的 <1> – 自定义注解语法
- 那些高端、优雅的注解是怎么实现的<2> – 解析注解
- 那些高端、优雅的注解是怎么实现的<3> – 可继承性@Inherited
- 那些高端、优雅的注解是怎么实现的<4> – 使用Annotaion Processing Tool 解析注解
- 那些高端、优雅的注解是怎么实现的<5> –使用Annotaion Processing Tool 自定义注解
- 那些高端、优雅的注解是怎么实现的<6> –自定义持久层框架-类 Hibernate
一:解析类上的注解
/**
* 找到类上的注解
*/
private static void findAnnotationOnClass() {
try {
//1.类加器加载类
Class aClass = Class.forName("com.demo.bean.Dog");
//2。找到类上的注解
boolean isExist = aClass.isAnnotationPresent(Message.class);
//3。如果存在拿到注解
if (isExist) {
Message messageAnnotation = (Message) aClass.getAnnotation(Message.class);
System.out.println("类的描述为:" + messageAnnotation.decr() + ",作者:" + messageAnnotation.author());
}
} catch (ClassNotFoundException e) {
e.printStackTrace();
}
}
具体怎么解析的看代码吧,我写了详细的注释。下面看下我注解的类
@Message(decr = "描述狗狗的特性的类",author = "zhang",age = 28)
public class Dog extends Animal{
String name;
String age;
@Override
@Message(decr = "获取狗狗名称的方法",author = "zhang",age = 28)
public String getName() {
return name;
}
@Override
public void setName(String name) {
this.name = name;
}
@Override
public String getAge() {
return age;
}
@Override
public void setAge(String age) {
this.age = age;
}
}
打印的结果为
类的描述为:描述狗狗的特性的类,作者:zhang
二:解析方法 上的注解
找到方法上的注解,我采用了两种方式去解析注解的值
/**
* 找到方法上的注解
*/
private static void findAnnotationOnMethod() {
try {
//1.类加载器加载类
Class<?> dogClass = Class.forName("com.demo.bean.Dog");
//2。找到这个类上的所有方法
Method[] methods = dogClass.getMethods();
//3。 采用第一种写法获取注解的值
getAnnotationValuesOne(methods);
//4。采用第二种方式获取注解的值
getAnnotationValuesTwo(methods);
} catch (ClassNotFoundException e) {
e.printStackTrace();
}
}
第一种获取方法上注解值的解析方式
/**
* 遍历获取注解方法的第一种写法
*/
private static void getAnnotationValuesOne(Method[] methods) {
//遍历所有方法
for (Method method : methods) {
//判断该方法上是否有我们定义的注解
boolean isExist = method.isAnnotationPresent(Message.class);
if (isExist) {
Message message = method.getAnnotation(Message.class);
System.out.println("该方法的描述为:" + message.decr() + ",作者为:" + message.author() + "--第一种获取方法上的注解的解析方法");
}
}
}
####第二种获取方法上注解值的解析方式
/**
* 找到方法上的注解值的第二种写法
*/
private static void getAnnotationValuesTwo(Method[] methods) {
//采用第二种方法获取注解的值
for (Method method : methods) {
//获取方法上的所有注解
Annotation[] annotations = method.getAnnotations();
for (Annotation annotation : annotations) {
if (annotation instanceof Message) {
Message message = (Message) annotation;
System.out.print("该方法的描述为:" + message.decr() + ",作者:" + message.author() + "--第二种获取方法上的注解的解析方法");
}
}
}
}
总结
本篇的完整代码已经上传到 github ,需要的可以去 clone 下来。强调一点,只有生命周期为运行时的注解,才能通过反射进行解析。