【Spring系列】SpringContext.getBean()方法调用导致NPE?

简介: 在实际的业务开发中,为了方便获取Spring容器中的Bean对象,一个常见的case就是创建一个SpringUtil类,内部持有SpringContext上下文,然后提供一个静态的方式获取bean对象,然而这种使用姿势,一个不小心可能导致npe今天我们来看一下这个场景

image.png


在实际的业务开发中,为了方便获取Spring容器中的Bean对象,一个常见的case就是创建一个SpringUtil类,内部持有SpringContext上下文,然后提供一个静态的方式获取bean对象,然而这种使用姿势,一个不小心可能导致npe


今天我们来看一下这个场景


场景复现



1. 基础工程搭建


搭建一个基础的SpringBoot项目,具体的过程这里省略,下面标注关键的信息

本项目借助SpringBoot 2.2.1.RELEASE +  maven 3.5.3 + IDEA进行开发

开一个web服务用于测试


<dependencies>
    <!-- 邮件发送的核心依赖 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
</dependencies>
复制代码


2. SpringUtil


构建一个基础的SpringUtil工具类,借助SpringContextAware来持有上下文


@Component
public class SpringUtil implements ApplicationContextAware, EnvironmentAware {
    private static ApplicationContext applicationContext;
    private static Environment environment;
    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        SpringUtil.applicationContext = applicationContext;
    }
    @Override
    public void setEnvironment(Environment environment) {
        SpringUtil.environment = environment;
    }
    public static <T> T getBean(Class<T> clz) {
        return applicationContext.getBean(clz);
    }
    public static String getProperty(String key) {
        return environment.getProperty(key);
    }
}
复制代码


3. 使用实例


首先构建一个简单的bean对象


@Component
public class TestDemo {
    public String showCase() {
        return UUID.randomUUID().toString();
    }
    public String testCase() {
        return "test-" + Math.random();
    }
}
复制代码


接着是另外一个对象,依赖上面这个对象,对外提供的主要接口是 process,其内部实现是根据枚举类,来做的一个策略选择;


@Component
public class BasicDemo {
    @Autowired
    private TestDemo testDemo;
    public String process(String data) {
        return Data.process(data);
    }
    private String show() {
        return testDemo.showCase();
    }
    String test() {
        return testDemo.testCase();
    }
    public enum Data {
        SHOW("show") {
            @Override
            String doProcess() {
                return SpringUtil.getBean(BasicDemo.class).show();
            }
        },
        CASE("test") {
            @Override
            String doProcess() {
                return SpringUtil.getBean(BasicDemo.class).test();
            }
        };
        private String data;
        Data(String data) {
            this.data = data;
        }
        abstract String doProcess();
        static String process(String data) {
            for (Data d: values()) {
                if (d.data.equalsIgnoreCase(data)) {
                    return d.doProcess();
                }
            }
            return null;
        }
    }
}
复制代码


重点关注上面实现中的枚举类,在枚举类中,根据SpringUtil获取到BasicDemo对象,然后执行它的私有方法show()及包内方法test()


这种用法会有什么问题么?


4. 测试case


接下来写个简单接口测试一下


@Aspect
@RestController
@SpringBootApplication
public class Application implements WebMvcConfigurer {
    public static void main(String[] args) {
        SpringApplication.run(Application.class);
    }
    @Autowired
    private BasicDemo basicDemo;
    @GetMapping(path = "show")
    public String show(String data) {
        return basicDemo.process(data);
    }
}
复制代码


接下来访问看看会是怎样


image.png


what? 不是说会npe么?这不是很正常的返回了么!!!

接下来就是见证bug的时刻了,同样是上面的代码,就让它出现npe


5. bug复现


接下来我们添加一个切面,目的就是让通过SpringUtil.getBean获取到的对象是代理类


// 注意在这个方法所在类上,添加注解 @Aspect
@Around("execution(public * com.git.hui.boot.web.interceptor.server.BasicDemo.*(..))")
public Object around(ProceedingJoinPoint joinPoint) throws Throwable {
    return joinPoint.proceed();
}
复制代码


然后再重新请求一下上面的访问


image.png


在访问私有方法 show()这里抛了异常,从服务端的堆栈可以看到异常类型为NPE,主要原因就是 testDemo 为null


简单来讲就是访问代理类的私有方法时,内部若有注入bean对象,这个时候拿到的是null


这个就有点神奇了,那么我们再变一下,私有方法内部不直接使用注入的bean对象,改调用一个bean对象的共有方法,会怎样


将上面的show()方法重写一下


private String show() {
    return show2();
}
public String show2() {
    return testDemo.showCase();
}
复制代码


再次测试,输出如


image.png


居然没有问题!!!


就这么神奇有木有,那么是什么原因呢?


  • 关键知识点:Spring代理类的生成逻辑


6. 小结


好像刚进入主体,结果到这里就结束了,真是过分😡,这里先小结一下这个问题出现的场景,至于具体原因有待下片博文介绍


当我们通过SpringContext获取到的bean对象时,不要直接访问它的私有方法,可能导致npe


100%必先的场景

  • 这个bean对象有代理类(如有切面拦截了它,如类内部有一些特定注解)
  • 私有方法内使用了注入对象


看到上面就会有个疑问,谁会去访问私有方法呢?我脑子又没坑😒,何况私有方法在外面也访问不了啊


这就涉及到一个相当常见的场景了,类内部方法A调用希望切面拦截的方法B,这时我们常这么做

public class A {
    @Autowired
    private A a;
    public void test() {
        a.testB();
    }
    @Point
    public String testB() {
        return "hello";
    }
}
复制代码


上面的test方法,访问testB方法就可以走切面逻辑,在上面这个类中,就有可能出现直接是用a.privetMethod()的场景了


此外就是反射执行某些逻辑的时候也有可能出现访问私有方法了,这里就不展开了;



相关文章
|
2天前
|
Java 数据库连接 API
Spring事务管理嵌套事务详解 : 同一个类中,一个方法调用另外一个有事务的方法
Spring事务管理嵌套事务详解 : 同一个类中,一个方法调用另外一个有事务的方法
|
1月前
|
Java Spring 容器
Spring 中一个事务方法调用另一个事务方法会怎样?
【6月更文挑战第5天】如果我们在一个包含事务的方法中,调用了另一个包含里事务的方法,那么,Spring 会创建新的事物吗?如果方法抛出异常导致事务会滚了呢?
27 0
|
Java Spring
Spring 源码阅读 62:基于 JDK 的 AOP 代理对特殊方法调用的处理
本文深入分析了 JdkDynamicAopProxy 的invoke方法的第一部分逻辑,也就是,对于哪些方法的调用,不对其进行增强,而是执行对应的特定逻辑,从中可以了解,Spring AOP 对哪些方法是默认不进行增强的。
132 0
|
Java 编译器 索引
Spring杂谈 | 从桥接方法到JVM方法调用
Spring杂谈 | 从桥接方法到JVM方法调用
97 0
Spring杂谈 | 从桥接方法到JVM方法调用
|
Java Spring 容器
Spring - 解决 SpringUtil getBean NPE 问题
Spring - 解决 SpringUtil getBean NPE 问题
562 0
|
Java Spring 数据格式
spring声明式事务 同一类内方法调用事务失效
只要避开Spring目前的AOP实现上的限制,要么都声明要事务,要么分开成两个类,要么直接在方法里使用编程式事务[问题]        Spring的声明式事务,我想就不用多介绍了吧,一句话“自从用了Spring AOP啊,事务管理真轻松啊,真轻松;事务管理代码没有了,脑不酸了,手不痛了,一口气全配上了事务;轻量级,测试起来也简单,嘿!”。
4340 0
|
4天前
|
Java 应用服务中间件 开发者
Java面试题:解释Spring Boot的优势及其自动配置原理
Java面试题:解释Spring Boot的优势及其自动配置原理
23 0
|
12天前
|
Java 开发者 Spring
深入理解Spring Boot中的自动配置原理
深入理解Spring Boot中的自动配置原理