You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

454 lines
23 KiB
Markdown

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

# 18 | 当反射、注解和泛型遇到OOP时会有哪些坑
你好我是朱晔。今天我们聊聊Java高级特性的话题看看反射、注解和泛型遇到重载和继承时可能会产生的坑。
你可能说业务项目中几乎都是增删改查用到反射、注解和泛型这些高级特性的机会少之又少没啥好学的。但我要说的是只有学好、用好这些高级特性才能开发出更简洁易读的代码而且几乎所有的框架都使用了这三大高级特性。比如要减少重复代码就得用到反射和注解详见第21讲
如果你从来没用过反射、注解和泛型,可以先通过官网有一个大概了解:
* [Java Reflection API](https://docs.oracle.com/javase/8/docs/technotes/guides/reflection/index.html) & [Reflection Tutorials](https://docs.oracle.com/javase/tutorial/reflect/index.html)
* [Annotations](https://docs.oracle.com/javase/8/docs/technotes/guides/language/annotations.html) & [Lesson: Annotations](https://docs.oracle.com/javase/tutorial/java/annotations/index.html)
* [Generics](https://docs.oracle.com/javase/8/docs/technotes/guides/language/generics.html) & [Lesson: Generics](https://docs.oracle.com/javase/tutorial/java/generics/index.html)。
接下来我们就通过几个案例看看这三大特性结合OOP使用时会有哪些坑吧。
## 反射调用方法不是以传参决定重载
反射的功能包括在运行时动态获取类和类成员定义以及动态读取属性调用方法。也就是说针对类动态调用方法不管类中字段和方法怎么变动我们都可以用相同的规则来读取信息和执行方法。因此几乎所有的ORM对象关系映射、对象映射、MVC框架都使用了反射。
反射的起点是Class类Class类提供了各种方法帮我们查询它的信息。你可以通过这个[文档](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html),了解每一个方法的作用。
接下来我们先看一个反射调用方法遇到重载的坑有两个叫age的方法入参分别是基本类型int和包装类型Integer。
```
@Slf4j
public class ReflectionIssueApplication {
private void age(int age) {
log.info("int age = {}", age);
}
private void age(Integer age) {
log.info("Integer age = {}", age);
}
}
```
如果不通过反射调用走哪个重载方法很清晰比如传入36走int参数的重载方法传入Integer.valueOf(“36”)走Integer重载
```
ReflectionIssueApplication application = new ReflectionIssueApplication();
application.age(36);
application.age(Integer.valueOf("36"));
```
**但使用反射时的误区是,认为反射调用方法还是根据入参确定方法重载**。比如使用getDeclaredMethod来获取age方法然后传入Integer.valueOf(“36”)
```
getClass().getDeclaredMethod("age", Integer.TYPE).invoke(this, Integer.valueOf("36"));
```
输出的日志证明走的是int重载方法
```
14:23:09.801 [main] INFO org.geekbang.time.commonmistakes.advancedfeatures.demo1.ReflectionIssueApplication - int age = 36
```
其实要通过反射进行方法调用第一步就是通过方法签名来确定方法。具体到这个案例getDeclaredMethod传入的参数类型Integer.TYPE代表的是int所以实际执行方法时无论传的是包装类型还是基本类型都会调用int入参的age方法。
把Integer.TYPE改为Integer.class执行的参数类型就是包装类型的Integer。这时无论传入的是Integer.valueOf(“36”)还是基本类型的36
```
getClass().getDeclaredMethod("age", Integer.class).invoke(this, Integer.valueOf("36"));
getClass().getDeclaredMethod("age", Integer.class).invoke(this, 36);
```
都会调用Integer为入参的age方法
```
14:25:18.028 [main] INFO org.geekbang.time.commonmistakes.advancedfeatures.demo1.ReflectionIssueApplication - Integer age = 36
14:25:18.029 [main] INFO org.geekbang.time.commonmistakes.advancedfeatures.demo1.ReflectionIssueApplication - Integer age = 36
```
现在我们非常清楚了,反射调用方法,是以反射获取方法时传入的方法名称和参数类型来确定调用方法的。接下来,我们再来看一下反射、泛型擦除和继承结合在一起会碰撞出什么坑。
## 泛型经过类型擦除多出桥接方法的坑
泛型是一种风格或范式,一般用于强类型程序设计语言,允许开发者使用类型参数替代明确的类型,实例化时再指明具体的类型。它是代码重用的有效手段,允许把一套代码应用到多种数据类型上,避免针对每一种数据类型实现重复的代码。
Java 编译器对泛型应用了强大的类型检测,如果代码违反了类型安全就会报错,可以在编译时暴露大多数泛型的编码错误。但总有一部分编码错误,比如泛型类型擦除的坑,在运行时才会暴露。接下来,我就和你分享一个案例吧。
有一个项目希望在类字段内容变动时记录日志,于是开发同学就想到定义一个泛型父类,并在父类中定义一个统一的日志记录方法,子类可以通过继承重用这个方法。代码上线后业务没啥问题,但总是出现日志重复记录的问题。开始时,我们怀疑是日志框架的问题,排查到最后才发现是泛型的问题,反复修改多次才解决了这个问题。
父类是这样的有一个泛型占位符T有一个AtomicInteger计数器用来记录value字段更新的次数其中value字段是泛型T类型的setValue方法每次为value赋值时对计数器进行+1操作。我重写了toString方法输出value字段的值和计数器的值
```
class Parent<T> {
//用于记录value更新的次数模拟日志记录的逻辑
AtomicInteger updateCount = new AtomicInteger();
private T value;
//重写toString输出值和值更新次数
@Override
public String toString() {
return String.format("value: %s updateCount: %d", value, updateCount.get());
}
//设置值
public void setValue(T value) {
this.value = value;
updateCount.incrementAndGet();
}
}
```
子类Child1的实现是这样的继承父类但没有提供父类泛型参数定义了一个参数为String的setValue方法通过super.setValue调用父类方法实现日志记录。我们也能明白开发同学这么设计是希望覆盖父类的setValue实现
```
class Child1 extends Parent {
public void setValue(String value) {
System.out.println("Child1.setValue called");
super.setValue(value);
}
}
```
在实现的时候子类方法的调用是通过反射进行的。实例化Child1类型后通过getClass().getMethods方法获得所有的方法然后按照方法名过滤出setValue方法进行调用传入字符串test作为参数
```
Child1 child1 = new Child1();
Arrays.stream(child1.getClass().getMethods())
.filter(method -> method.getName().equals("setValue"))
.forEach(method -> {
try {
method.invoke(child1, "test");
} catch (Exception e) {
e.printStackTrace();
}
});
System.out.println(child1.toString());
```
运行代码后可以看到虽然Parent的value字段正确设置了test但父类的setValue方法调用了两次计数器也显示2而不是1
```
Child1.setValue called
Parent.setValue called
Parent.setValue called
value: test updateCount: 2
```
显然两次Parent的setValue方法调用是因为getMethods方法找到了两个名为setValue的方法分别是父类和子类的setValue方法。
这个案例中,子类方法重写父类方法失败的原因,包括两方面:
* 一是子类没有指定String泛型参数父类的泛型方法setValue(T value)在泛型擦除后是setValue(Object value)子类中入参是String的setValue方法被当作了新方法
* 二是,**子类的setValue方法没有增加@Override注解因此编译器没能检测到重写失败的问题。这就说明重写子类方法时标记@Override是一个好习惯**。
但是开发同学认为问题出在反射API使用不当却没意识到重写失败。他查文档后发现getMethods方法能获得当前类和父类的所有public方法而getDeclaredMethods只能获得当前类所有的public、protected、package和private方法。
于是他就用getDeclaredMethods替代了getMethods
```
Arrays.stream(child1.getClass().getDeclaredMethods())
.filter(method -> method.getName().equals("setValue"))
.forEach(method -> {
try {
method.invoke(child1, "test");
} catch (Exception e) {
e.printStackTrace();
}
});
```
这样虽然能解决重复记录日志的问题,但没有解决子类方法重写父类方法失败的问题,得到如下输出:
```
Child1.setValue called
Parent.setValue called
value: test updateCount: 1
```
其实这治标不治本其他人使用Child1时还是会发现有两个setValue方法非常容易让人困惑。
幸好架构师在修复上线前发现了这个问题让开发同学重新实现了Child2继承Parent的时候提供了String作为泛型T类型并使用@Override关键字注释了setValue方法实现了真正有效的方法重写
```
class Child2 extends Parent<String> {
@Override
public void setValue(String value) {
System.out.println("Child2.setValue called");
super.setValue(value);
}
}
```
但很可惜,修复代码上线后,还是出现了日志重复记录:
```
Child2.setValue called
Parent.setValue called
Child2.setValue called
Parent.setValue called
value: test updateCount: 2
```
可以看到这次是Child2类的setValue方法被调用了两次。开发同学惊讶地说肯定是反射出Bug了通过getDeclaredMethods查找到的方法一定是来自Child2类本身而且怎么看Child2类中也只有一个setValue方法为什么还会重复呢
调试一下可以发现Child2类其实有2个setValue方法入参分别是String和Object。
![](https://static001.geekbang.org/resource/image/81/b8/81116d6f11440f92757e4fe775df71b8.png)
如果不通过反射来调用方法,我们确实很难发现这个问题。**其实,这就是泛型类型擦除导致的问题**。我们来分析一下。
我们知道Java的泛型类型在编译后擦除为Object。虽然子类指定了父类泛型T类型是String但编译后T会被擦除成为Object所以父类setValue方法的入参是Objectvalue也是Object。如果子类Child2的setValue方法要覆盖父类的setValue方法那入参也必须是Object。所以编译器会为我们生成一个所谓的bridge桥接方法你可以使用javap命令来反编译编译后的Child2类的class字节码
```
javap -c /Users/zhuye/Documents/common-mistakes/target/classes/org/geekbang/time/commonmistakes/advancedfeatures/demo3/Child2.class
Compiled from "GenericAndInheritanceApplication.java"
class org.geekbang.time.commonmistakes.advancedfeatures.demo3.Child2 extends org.geekbang.time.commonmistakes.advancedfeatures.demo3.Parent<java.lang.String> {
org.geekbang.time.commonmistakes.advancedfeatures.demo3.Child2();
Code:
0: aload_0
1: invokespecial #1 // Method org/geekbang/time/commonmistakes/advancedfeatures/demo3/Parent."<init>":()V
4: return
public void setValue(java.lang.String);
Code:
0: getstatic #2 // Field java/lang/System.out:Ljava/io/PrintStream;
3: ldc #3 // String Child2.setValue called
5: invokevirtual #4 // Method java/io/PrintStream.println:(Ljava/lang/String;)V
8: aload_0
9: aload_1
10: invokespecial #5 // Method org/geekbang/time/commonmistakes/advancedfeatures/demo3/Parent.setValue:(Ljava/lang/Object;)V
13: return
public void setValue(java.lang.Object);
Code:
0: aload_0
1: aload_1
2: checkcast #6 // class java/lang/String
5: invokevirtual #7 // Method setValue:(Ljava/lang/String;)V
8: return
}
```
可以看到入参为Object的setValue方法在内部调用了入参为String的setValue方法第27行也就是代码里实现的那个方法。如果编译器没有帮我们实现这个桥接方法那么Child2子类重写的是父类经过泛型类型擦除后、入参是Object的setValue方法。这两个方法的参数一个是String一个是Object明显不符合Java的语义
```
class Parent {
AtomicInteger updateCount = new AtomicInteger();
private Object value;
public void setValue(Object value) {
System.out.println("Parent.setValue called");
this.value = value;
updateCount.incrementAndGet();
}
}
class Child2 extends Parent {
@Override
public void setValue(String value) {
System.out.println("Child2.setValue called");
super.setValue(value);
}
}
```
使用jclasslib工具打开Child2类同样可以看到入参为Object的桥接方法上标记了public + synthetic + bridge三个属性。synthetic代表由编译器生成的不可见代码bridge代表这是泛型类型擦除后生成的桥接代码
![](https://static001.geekbang.org/resource/image/b5/08/b5e30fb0ade19d71cd7fad1730e85808.png)
知道这个问题之后修改方式就明朗了可以使用method的isBridge方法来判断方法是不是桥接方法
* 通过getDeclaredMethods方法获取到所有方法后必须同时根据方法名setValue和非isBridge两个条件过滤才能实现唯一过滤
* 使用Stream时如果希望只匹配0或1项的话可以考虑配合ifPresent来使用findFirst方法。
修复代码如下:
```
Arrays.stream(child2.getClass().getDeclaredMethods())
.filter(method -> method.getName().equals("setValue") && !method.isBridge())
.findFirst().ifPresent(method -> {
try {
method.invoke(chi2, "test");
} catch (Exception e) {
e.printStackTrace();
}
});
```
这样就可以得到正确输出了:
```
Child2.setValue called
Parent.setValue called
value: test updateCount: 1
```
**最后小结下,使用反射查询类方法清单时,我们要注意两点**
* getMethods和getDeclaredMethods是有区别的前者可以查询到父类方法后者只能查询到当前类。
* 反射进行方法调用要注意过滤桥接方法。
## 注解可以继承吗?
注解可以为Java代码提供元数据各种框架也都会利用注解来暴露功能比如Spring框架中的@Service、@Controller、@Bean注解Spring Boot的@SpringBootApplication注解。
框架可以通过类或方法等元素上标记的注解来了解它们的功能或特性并以此来启用或执行相应的功能。通过注解而不是API调用来配置框架属于声明式交互可以简化框架的配置工作也可以和框架解耦。
开发同学可能会认为,类继承后,类的注解也可以继承,子类重写父类方法后,父类方法上的注解也能作用于子类,但这些观点其实是错误或者说是不全面的。我们来验证下吧。
首先定义一个包含value属性的MyAnnotation注解可以标记在方法或类上
```
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
String value();
}
```
然后,定义一个标记了@MyAnnotation注解的父类Parent设置value为Class字符串同时这个类的foo方法也标记了@MyAnnotation注解设置value为Method字符串。接下来定义一个子类Child继承Parent父类并重写父类的foo方法子类的foo方法和类上都没有@MyAnnotation注解。
```
@MyAnnotation(value = "Class")
@Slf4j
static class Parent {
@MyAnnotation(value = "Method")
public void foo() {
}
}
@Slf4j
static class Child extends Parent {
@Override
public void foo() {
}
}
```
再接下来通过反射分别获取Parent和Child的类和方法的注解信息并输出注解的value属性的值如果注解不存在则输出空字符串
```
private static String getAnnotationValue(MyAnnotation annotation) {
if (annotation == null) return "";
return annotation.value();
}
public static void wrong() throws NoSuchMethodException {
//获取父类的类和方法上的注解
Parent parent = new Parent();
log.info("ParentClass:{}", getAnnotationValue(parent.getClass().getAnnotation(MyAnnotation.class)));
log.info("ParentMethod:{}", getAnnotationValue(parent.getClass().getMethod("foo").getAnnotation(MyAnnotation.class)));
//获取子类的类和方法上的注解
Child child = new Child();
log.info("ChildClass:{}", getAnnotationValue(child.getClass().getAnnotation(MyAnnotation.class)));
log.info("ChildMethod:{}", getAnnotationValue(child.getClass().getMethod("foo").getAnnotation(MyAnnotation.class)));
}
```
输出如下:
```
17:34:25.495 [main] INFO org.geekbang.time.commonmistakes.advancedfeatures.demo2.AnnotationInheritanceApplication - ParentClass:Class
17:34:25.501 [main] INFO org.geekbang.time.commonmistakes.advancedfeatures.demo2.AnnotationInheritanceApplication - ParentMethod:Method
17:34:25.504 [main] INFO org.geekbang.time.commonmistakes.advancedfeatures.demo2.AnnotationInheritanceApplication - ChildClass:
17:34:25.504 [main] INFO org.geekbang.time.commonmistakes.advancedfeatures.demo2.AnnotationInheritanceApplication - ChildMethod:
```
可以看到,父类的类和方法上的注解都可以正确获得,但是子类的类和方法却不能。这说明,**子类以及子类的方法,无法自动继承父类和父类方法上的注解**。
如果你详细了解过注解应该知道,在注解上标记@Inherited元注解可以实现注解的继承。那么把@MyAnnotation注解标记了@Inherited就可以一键解决问题了吗
```
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface MyAnnotation {
String value();
}
```
重新运行代码输出如下:
```
17:44:54.831 [main] INFO org.geekbang.time.commonmistakes.advancedfeatures.demo2.AnnotationInheritanceApplication - ParentClass:Class
17:44:54.837 [main] INFO org.geekbang.time.commonmistakes.advancedfeatures.demo2.AnnotationInheritanceApplication - ParentMethod:Method
17:44:54.838 [main] INFO org.geekbang.time.commonmistakes.advancedfeatures.demo2.AnnotationInheritanceApplication - ChildClass:Class
17:44:54.838 [main] INFO org.geekbang.time.commonmistakes.advancedfeatures.demo2.AnnotationInheritanceApplication - ChildMethod:
```
可以看到子类可以获得父类上的注解子类foo方法虽然是重写父类方法并且注解本身也支持继承但还是无法获得方法上的注解。
如果你再仔细阅读一下[@Inherited的文档](https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Inherited.html)就会发现,@Inherited只能实现类上的注解继承。要想实现方法上注解的继承你可以通过反射在继承链上找到方法上的注解。但这样实现起来很繁琐而且需要考虑桥接方法。
好在Spring提供了AnnotatedElementUtils类来方便我们处理注解的继承问题。这个类的findMergedAnnotation工具方法可以帮助我们找出父类和接口、父类方法和接口方法上的注解并可以处理桥接方法实现一键找到继承链的注解
```
Child child = new Child();
log.info("ChildClass:{}", getAnnotationValue(AnnotatedElementUtils.findMergedAnnotation(child.getClass(), MyAnnotation.class)));
log.info("ChildMethod:{}", getAnnotationValue(AnnotatedElementUtils.findMergedAnnotation(child.getClass().getMethod("foo"), MyAnnotation.class)));
```
修改后,可以得到如下输出:
```
17:47:30.058 [main] INFO org.geekbang.time.commonmistakes.advancedfeatures.demo2.AnnotationInheritanceApplication - ChildClass:Class
17:47:30.059 [main] INFO org.geekbang.time.commonmistakes.advancedfeatures.demo2.AnnotationInheritanceApplication - ChildMethod:Method
```
可以看到子类foo方法也获得了父类方法上的注解。
## 重点回顾
今天我和你分享了使用Java反射、注解和泛型高级特性配合OOP时可能会遇到的一些坑。
第一,反射调用方法并不是通过调用时的传参确定方法重载,而是在获取方法的时候通过方法名和参数类型来确定的。遇到方法有包装类型和基本类型重载的时候,你需要特别注意这一点。
第二反射获取类成员需要注意getXXX和getDeclaredXXX方法的区别其中XXX包括Methods、Fields、Constructors、Annotations。这两类方法针对不同的成员类型XXX和对象在实现上都有一些细节差异详情请查看[官方文档](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html)。今天提到的getDeclaredMethods方法无法获得父类定义的方法而getMethods方法可以只是差异之一不能适用于所有的XXX。
第三泛型因为类型擦除会导致泛型方法T占位符被替换为Object子类如果使用具体类型覆盖父类实现编译器会生成桥接方法。这样既满足子类方法重写父类方法的定义又满足子类实现的方法有具体的类型。使用反射来获取方法清单时你需要特别注意这一点。
第四,自定义注解可以通过标记元注解@Inherited实现注解的继承不过这只适用于类。如果要继承定义在接口或方法上的注解可以使用Spring的工具类AnnotatedElementUtils并注意各种getXXX方法和findXXX方法的区别详情查看[Spring的文档](https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/core/annotation/AnnotatedElementUtils.html)。
最后我要说的是。编译后的代码和原始代码并不完全一致编译器可能会做一些优化加上还有诸如AspectJ等编译时增强框架使用反射动态获取类型的元数据可能会和我们编写的源码有差异这点需要特别注意。你可以在反射中多写断言遇到非预期的情况直接抛异常避免通过反射实现的业务逻辑不符合预期。
今天用到的代码我都放在了GitHub上你可以点击[这个链接](https://github.com/JosephZhu1983/java-common-mistakes)查看。
## 思考与讨论
1. 泛型类型擦除后会生成一个bridge方法这个方法同时又是synthetic方法。除了泛型类型擦除你知道还有什么情况编译器会生成synthetic方法吗
2. 关于注解继承问题你觉得Spring的常用注解@Service、@Controller是否支持继承呢
你还遇到过与Java高级特性相关的其他坑吗我是朱晔欢迎在评论区与我留言分享你的想法也欢迎你把今天的内容分享给你的朋友或同事一起交流。