如何创建JVM全局Singleton?


问题内容

如何创建一个Java类实例,以确保整个JVM进程只能使用一次?然后,在该JVM上运行的每个应用程序都应该能够使用该单例实例。


问题答案:

实际上,您可以实现这种单例。在注释中向您描述的问题是可能有多个ClassLoaders
加载类。ClassLoader然后,每个都可以定义一个相同名称的类,该类将错误地假定为唯一。

但是,您可以通过实现单例的访问器来避免这种情况,该访问器显式依赖于检查特定ClassLoader名称的类,该类又包含您的单例。这样,您可以避免由两个不同的ClassLoaders
提供一个单例实例,从而避免了您需要在整个JVM中唯一的实例。

出于稍后说明的原因,我们将把SingletonSingletonAccessor分为两个不同的类。对于以下类,我们需要稍后确保始终使用特定的类来访问它ClassLoader

package pkg;
class Singleton {
  static volatile Singleton instance;
}

方便ClassLoader的是系统类加载器。系统类加载器知道JVM的类路径上的所有类,并且按照定义将扩展和引导类加载器作为其父类。这两个类加载器通常不知道任何特定于域的类,例如我们的Singleton类。这使我们免于意外的意外。此外,我们知道它在整个JVM实例中都是可访问和全局的。

现在,让我们假设Singleton该类在类路径上。这样,我们可以使用反射通过该访问器接收实例:

class SingletonAccessor {
  static Object get() {
    Class<?> clazz = ClassLoader.getSystemClassLoader()
                                .findClass("pkg.Singleton");
    Field field = clazz.getDeclaredField("instance");
    synchronized (clazz) {
      Object instance = field.get(null);
      if(instance == null) {
        instance = clazz.newInstance();
        field.set(null, instance);
      }
      return instance;
    }
  }
}

通过指定我们明确pkg.Singleton要从系统类加载器加载,我们确保无论哪个类加载器加载了我们的实例,我们总是收到相同的实例SingletonAccessor。在上面的示例中,我们另外确保Singleton仅实例化一次。另外,您可以将实例化逻辑放入Singleton类本身,并在未Singleton加载其他类的情况下使未使用的实例腐烂。

但是,这有一个很大的缺点。您会错过所有类型安全的方法,因为您不能假设您的代码始终从ClassLoader将类加载委托Singleton给系统类加载器的方式运行。这是尤其如此。这通常是工具儿童第一语义的类加载器和它的应用服务器上运行的应用程序
要求系统类加载器已知类型的,但首先会尝试加载自己的类型。请注意,运行时类型具有两个功能:

  1. 它的全名
  2. 它的 ClassLoader

因此,该SingletonAccessor::get方法需要返回Object而不是Singleton

另一个缺点是Singleton必须在类路径上找到该类型才能起作用。否则,系统类加载器将不知道这种类型。如果可以将Singleton类型放到类路径中,则可以在此处完成。没问题。

如果您无法做到这一点,那么还有另一种方法,例如使用我的代码生成库Byte
Buddy
。使用这个库,我们可以在运行时简单地定义这样的类型,并将其注入系统类加载器中:

new ByteBuddy()
  .subclass(Object.class)
  .name("pkg.Singleton")
  .defineField("instance", Object.class, Ownership.STATIC)
  .make()
  .load(ClassLoader.getSytemClassLoader(), 
        ClassLoadingStrategy.Default.INJECTION)

您刚刚pkg.Singleton为系统类加载器定义了一个类,以上策略再次适用。

另外,您可以通过实现包装器类型来避免类型安全问题。您还可以借助Byte Buddy将其自动化:

new ByteBuddy()
  .subclass(Singleton.class)
  .method(any())
  .intercept(new Object() {
    @RuntimeType
    Object intercept(@Origin Method m, 
                     @AllArguments Object[] args) throws Exception {
      Object singleton = SingletonAccessor.get();
      return singleton.getClass()
        .getDeclaredMethod(m.getName(), m.getParameterTypes())
        .invoke(singleton, args);
    }
  })
  .make()
  .load(Singleton.class.getClassLoader(), 
        ClassLoadingStrategy.Default.INJECTION)
  .getLoaded()
  .newInstance();

您刚刚创建了一个委托,该委托重写了Singleton该类的所有方法,并将它们的调用委派给JVM全局单例实例的调用。请注意,即使反射方法具有相同的签名,也需要重新加载它们,因为我们不能依赖ClassLoader委托的s和JVM全局类的相同。

在实践中,您可能希望缓存对调用SingletonAccessor.get()甚至反射方法查找的调用(与反射方法调用相比,这是相当昂贵的)。但是这种需求在很大程度上取决于您的应用程序域。如果您对构造函数的层次结构有疑问,也可以将方法签名分解为一个接口,并为上述访问器和您的Singleton类实现此接口。