首页 > 其他分享 >一个由public关键字引发的bug

一个由public关键字引发的bug

时间:2023-03-14 10:36:18浏览次数:52  
标签:spring 代码 代理 value bug 关键字 方法 public

先来看一段代码:

@Service
@Slf4j
public class AopTestService {

    public String name = "真的吗";

    @Retryable
    public void test(){
        // 模拟业务操作
        log.debug("name:{}", this.name);
        // 模拟外部操作,失败重试
    }
   
}

很简单的代码,然后在另一个类中进行调用

public void test(){
        testService.test();
        log.info("name:{}", testService.name);
    }

问题也很简单,以上代码打印输出什么?


如果没能看出来,不妨先来看(笑)看(笑)我是怎样触发一个简单的BUG。

bug之路

以上代码肯定是不规范的。
正常应该是类里定义为一个private私有变量,然后提供getter/setter方法供外部访问。

像这种将变量直接为定义public,在外部类直接访问的情况,正常情况下我是写不出来。

但是,话说某天,活急了,一个类写了上千行代码,肯定得想把公共代码提取出来,将代码根据业务拆分。
原始类中有一个private的成员变量,在该类内部方法中访问。由于部份代码拆分到其它类当中,该变量需要在外部被访问,我一时偷懒,就将该变量的访问级别由private改为public
省略业务代码,大概就变成了上面一开头的示例代码。
习以为常的,我以为这样就能访问了。
但我却被啪啪打脸了。


正常情况下,这样虽然代码不规范,但确实能访问。 为什么这里确不能访问了呢?

因为我在方法加了个@Retryable注解。

retryable是什么?
由于一些网络,外部接口等不可预知的问题,我们的程序或者接口会失败,这时就需要重试机制,比如延时1S后重试、间隔不断增加重试等,自己去实现这些功能的话,显得笨重而不优雅,所以spring官方实现了retryable模块。

这里可以略过它的原理,只需知道它是使用了动态代理+AOP。

这个注解需给AopTestService 生成代理类。而动态代理是不能代理属性的。所以在另一个类当中,使用AopTestService 的代理类不能直接访问目标类的成员变量。

严格意义来说,这还不算BUG,因为在调试阶段就立马发现了,但我确实没能一眼看出来。

能够一眼看出问题所在的大佬,请喝茶。


现在我们知道,动态代理类只能代理方法而不能代理属性。但是话语是苍白的,我们还是要有直接的证据。
最表象的原因,直接Debug截图可以观察到,aopTestServicecglib生成了代理类。在这个代理类里value值为null

再通过反编译动态代理生成的代码,可以看到只有方法的定义,没有父类变量的定义。


为什么spring中的动态代理不能代理属性?


前面说到,spring动态代理只能代理方法,不能代理属性。

cglib都可以,为什么spring不可以呢?

再深入一点。我们可以在源码中断点,看看cglib究竟如何没有代理属性。

在spring-aop模块中查找类ObjenesisCglibAopProxy,从名字当中就可以看出来,spring的动态代理全用了Objenesis+cglib
在这个类中的createProxyClassAndInstance方法断点,在srping boot启动的时候,可以观察到:

可以看到这里使用了Objenesis实例化了AopTestService代理对象。如果Objenesis实例失败,再通过默认构造方法进行实例。
因为没有调用构造方法,所以spring生成动态代理类的时候没能保留父类的属性。


所以`Objenesis`是什么?

从以上的代码和注释当中也可以推测得出,它是一个可以绕过构造方法实例对象的一个工具。
为什么需要绕过构造方法实例对象?

这又分为spring非spring
非srping下确实有这样的场景,比如

构造器需要参数
构造器有side effects
构造器会抛异常

因此,在类库中经常会有类必须拥有一个默认构造器的限制。Objenesis通过绕开对象实例构造器来克服这个限制。


至于为什么spring要使用Objenesis绕过构造方法,那就是另一个问题了。


java为什么要有private关键字?


这似乎是一个无厘头的问题,但是确实有很多初学者有这个疑问。 我想了想,至少在我刚接触java的时候没想过这个问题。创建一个`java bean`,`private`所有变量,然后自动生成`getter/setter`干就完了。

又比如这个知乎问题,看起来看是在钓鱼,也有人认为是好问题,不晓得是不是反窜。

我觉得这位大佬说得很好

这位大佬说到最核心的点:

private标记内部代码,外部不应使用,并配合get/set使代码可控。

在一个系统里,多人协作,从业人员,代码品质良莠不齐的情况下,代码可控是多么的重要。


举一反三


不仅仅是@Retryable才会导致上面失效的场景,其它只要涉及到动态代理和AOP的都会导致失效。

比如最常见的事务,@Transcational

常见的面试经,导致spring事务失效的场景有哪些?

这12种场景,除却自身的原因比如不支持事务,未被spring纳入管理等,其它诸如方法访问权限,final方法,内部调用等等都跟动态管理和AOP有关。

访问权限和final


  1. springboot2.0以后动态代理使用cglib。cglib从名字Code Generation Library上来看就是一个代码生成的东西,它是要重写该类,而private方法,final方法均无法被重写。所以事务会失效。
private String value = "hello world";

    @Transactional
    public void proxy(ApplicationContext applicationContext) {
        log.info(this.value);
    }

    public fianl void noProxy(ApplicationContext applicationContext) {
        Object obj = applicationContext.getBean(this.getClass());
        proxy(applicationContext);
    }

以上示例代码中,通过在启动main方法中设置

System.setProperty(DebuggingClassWriter.DEBUG_LOCATION_PROPERTY, "目录");

将生成的动态代理类输出到目录中。

再反编译过后,可以看到final修改的方法没有在这里面,证明final方法没有被代理到。


内部调用


  1. 方法内部调用。如果同类中,一个非事务方法调用另一个事务方法,默认使用的是this对象,非动态代理类的目标对象调用,所以会失效。

注意以上两点,这是考点。


再来一题


在上面的示例代码的基础上简单改一下。两个事务方法,其中一个是final方法。

@Service
@Slf4j
public class AopTestService {

    private String value = "hello world";

    @Transcational
    public void proxy(ApplicationContext applicationContext) {
        Object obj = applicationContext.getBean(this.getClass());
        boolean bool1 = AopUtils.isAopProxy(obj);
        boolean bool2 = AopUtils.isAopProxy(this);
        log.info("bool1:{},bool2:{},value:{}", bool1, bool2, value);
    }


    @Transcational
    public final void noProxy(ApplicationContext applicationContext) {
        Object obj = applicationContext.getBean(this.getClass());
        boolean bool1 = AopUtils.isAopProxy(obj);
        boolean bool2 = AopUtils.isAopProxy(this);
        log.info("bool1:{},bool2:{},value:{}", bool1, bool2, value);
    }

    public String getValue() {
        return value;
    }

    public void setValue(String value) {
        this.value = value;
    }
}

请问上面两个方法分别输出什么?为什么?


我们来捋一捋。

首先,两个方法都加上了@Transcational注解,所以类AopTestService和两个方法都应该被代理。

然后noProxy方法因为被final修改,无法被重写,所以最终noProxy不会被代理。

当方法可以被代理的时候,代理对象使用的是目标对象来调用目标方法,所以'proxy'方法可以访问value
noProxy方法没有被代理的时候,同时类AopTestService却被代理了,所以只能拿代理类来调用目标方法。而代理类是无法代理属性的。所以这里无法访问value

1.当代理类发现调用的方法可以代理的时候,就使用目标对象进行调用

这一点从下图可以看出,最终invoke的传入的是target目标对象,而是代理对象。

点击进去可以更明显的看到,使用的是代理对象内部的目标对象

2.当代理类发现调用的方法无法代理的时候,就使用代理对象进行调用

这一点就更好理解了。假设我在controller层调用该service类方法,AopTestService 对象为代理对象,因该noProxy没有被代理,因此走的就是最普通正常的使用该代理对象直接调用。





所以 `proxy` 方法输出:

bool1:true,bool2:false,value:hello world

noProxy 方法输出:

bool1:true,bool2:true,value:null

proxy方法打印出来第1个布尔值是true,第2个布尔值是false,也可以反过来佐证上面的说法。
就是Object obj = applicationContext.getBean(this.getClass())直接获取spring ioc窗口里的对象是代理的对象(true),
而执行到当前调用的却是目标对象而非代理对象(false)。



但是,又一个问题来了,为什么在自己的类里面访问内部变量value会获取到null?
有点奇怪是吧?

因此,我给官方提了个issue:

https://github.com/spring-projects/spring-framework/issues/30102

但是,后来一想,这确实只是spring(非cglib)的一个feature,而不是bug。

因为既然方法是final的,代表方法事务已然不生效了,在这种情况下,方法内部获取不到类的内部变量属于事务不生效引发的次生问题。
它本身是由于不规范的写法导致的,因此我认为不能算是bug。

其实写到这里,这个不成熟的ussue有了回复,大概看了一下,可能是我渣渣英语,没有表述清楚,回复其实就是把我问题的描述重复了一下,大概是就这么设计的意思。

总结

java的private关键字本身是很有意义的,同时也是防止bug的利器。

如果面试官再问到你spring事务失效的原因,除了12个场景以外,你或许还可以结合本文引申出来其它的内容,引导话题。

标签:spring,代码,代理,value,bug,关键字,方法,public
From: https://www.cnblogs.com/eryuan/p/17210340.html

相关文章

  • 这篇文章汇聚33个BUG!来挑战一下,看看你能找出来几个?
    你好呀,我是歪歪。前几天看到“Qunar技术沙龙”公众号推送了一篇关于他们举办了一场“CodeReview大赛”的文章。看到CodeReview我很感兴趣啊,“啪”的一下就点进去了啊......
  • VSCode 的扩展包C/C++ IntelliSense, debugging, and code browsing的IntelliSense功
    文章目录​​1.说明​​​​2.结论​​​​3.c_cpp_properties.json文件的配置​​1.说明在公司内网条件下,即出现以下的错误,就是不能连接微软的相关网站,​​从github上更新......
  • 前后端BUG分析
    为什么找到网站中的bug后还要去分析它到底是属于前端bug还是后端bug,3个原因:1、一个系统是由前端和后端共同开发出来的,因此在分配bug的时候,不同模块的bug一般都会指派给对......
  • Bug -- 线性筛素数
    发现bug的题目bug代码voidget_primes(intn){for(inti=2;i<n;i++){if(!st[i])primes[idx++]=i;for(intj=0;primes......
  • BUG:Error: Invalid navigation guard或The "next" callback was never called inside
    错误代码:router.beforeEach(async(to,from,next)=>{NProgress.start()consttoken=store.getters.token;debuggerif(whiteList.indexOf(to.......
  • 记录沁恒芯片的一个bug
    使用场景:CH32V203F6P6作为SPI主机(同时使用UART作为调试口)         CH32V203C8T6作为SPI从机(同时使用UART作为调试口)使用杜邦线进行SPI的链......
  • Android Studio的各种bug(二)
    1.按钮Button无法改变背景色原因: AndroidStudio4.1之后的版本进行开发时,创建的项目默认的主题所有Button都是Material类型的Button,默认使用主题色,所以想要修改颜色,就要......
  • 低概率BUG,研发说复现不到怎么办?
    测试工作中,经常会遇到一些低概率出现的问题,如果再是个严重问题,那测试人员的压力无疑是很大的,一方面是因为低概率难复现,另一面则是来自项目组的压力。如何在测试时减少此类......
  • JavaScript实现搜索联想关键字高亮功能
    <!DOCTYPEhtml><htmllang="en"> <head> <metacharset="UTF-8"> <metaname="viewport"content="width=device-width,initial-scale=1.0"> <metahttp-equiv=......
  • 并发编程BUG源头
    背景核心矛盾CPU/内存/IO设备的速度差异解决思路计算机体系结构——CPU增加了缓存,以均衡与内存的速度差异操作系统——操作系统增加了进程、线程,以分时复用CPU,进而......