Spring中RestartClassLoader导致静态属性Null

发表于 更新于 分类于

一次项目改造中，为了兼容一起获取配置代码，在 Spring 启动后，把Environment写入静态属性，其他地方需要获取值时，直接通过静态方法中从Environment内获取。

1
2
3
4
5
6
7
8
9
public class SystemEnv {
    private static Environment environment;
    public static void setEnvironment(Environment environment) {
        SystemEnv.environment = environment;
    }
    public static String getProperty(String key) {
        return environment.getProperty(key);
    }
}

本地开发测试完成后，其他同事启动，直接NullPointerException，在其电脑上Debug时发现，当前SystemEnv的类加载器为org.springframework.boot.devtools.restart.classloader.RestartClassLoader，因为本地配置了devtool开发导致该类被加载了2次，第一次正常Spring流程启动后设置属性。第二次的时候由RestartClassLoader加载的类，未设置属性，获取时默认null。

本地同样参数启动，测试未能复现第二次由RestartClassLoader加载情况。未找到是否由其他配置导

解决办法：
获取属性的时候，判断当前类加载器是否RestartClassLoader，如果是则获取父类加载器。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
public class SystemEnv {
    private static Environment environment;
    public static void setEnvironment(Environment environment) {
        SystemEnv.environment = environment;
    }
    public static String getProperty(String key) {
        return getEnvironment().getProperty(key);
    }
    public static Environment getEnvironment() {
        //如果已经设置就返回
        if (environment != null) {
            return environment;
        }
        //判断类加载器，如果是RestartClassLoader获取父类加载器
        ClassLoader classLoader = Thread.currentThread().getContextClassLoader();
        if (Objects.equals(classLoader.getClass().getSimpleName(), "RestartClassLoader")) {
            classLoader = classLoader.getParent();
        }
        try {
            //因为Spring第一次启动会设置值，所以父加载器能获取到值
            Field field = classLoader.loadClass("com.rtmart.promotion.util.SystemEnv").getDeclaredField("environment");
            field.setAccessible(true);
            environment = (Environment) field.get(null);
        } catch (IllegalAccessException | NoSuchFieldException | ClassNotFoundException e) {
            throw new RuntimeException(e);
        }
        return environment;
    }
}