Effective-Java-3用私有构造器或枚举类型强化Singleton属性

发表于 更新于 分类于 本文字数： 851 阅读时长 ≈ 3 分钟

Singleton 指仅仅被实例化一次的类。Singleton 通常被用来代表那些本质上唯一的系统组件，比如窗口管理器或者文件系统。(单例模式)[1]

在 Java 1.5 发行版本之前，实现Singleton有两种方法。这两种方法都要把构造器保持为私有的，并指定一个共有的静态成员。[2]

  1. 在第一个方法中，共有静态成员是个 final 域：

    1
    2
    3
    4
    5
    6
    // Singleton with public final field
    public class Elvis{
        public class final Elvis INSTANCE = new Elvis();
    	private Elvis(){ ... }
    	public void leaveTheBuilding(){ ... }
    }

    私有的构造器仅被调用一次，用来实例化共有的静态 final 域 Elvis.INSTANCE。由于缺少共有的或者受保护的构造器，所以保证了Elvis的全局唯一性：一旦 Elvis 类被实例化，只会存在一个Elvis实例，不多也不少。[3]

    但要提醒一点：享有特权的客户端可以借助AccessibleObject.setAccessible方法，通过反射机制调用私有构造器 (java 反射攻击) 。如果需要抵御这种攻击，可以修改构造器，让他在被要求创建第二个实例的时候抛出异常。[4]

  2. 在第二种方法中，共有的成员是个静态工厂方法：

    1
    2
    3
    4
    5
    6
    7
    // Singleton with static factory
    public class Elvis{
        private class final Elvis INSTANCE = new Elvis();
    	private Elvis(){ ... }
        public static Elvis getInstance() { return INSTANCE; }
    	public void leaveTheBuilding(){ ... }
    }

    为了使利用这其中一种方法实现的Singleton类变成可序列化的(Serializable)，仅仅在声明中加上"implements Serializable" 是不够的。为了维护并保证Singleton，必须声明所有实例域都是顺时的(transient) 的，并提供一个readResolve方法。否则，每次反序列化一个序列化的实例时，都会创建一个新的实例。[5]

    在如下的例子中会导致"假的Elvis"出现。为了防止这种情况，要在Elvis类中加入下面这个readResovle方法：

    1
    2
    3
    4
    5
    // readResovle method to preserve singleton property
    private Object readResolve(){
        // Return the one true Elvis and let the garbage collector take care of the Elvis impersonator
        return INSTANCE;
    }

  3. 从 Java 1.5 发行版本起，实现Singleton还有第三种方法。只需要编写一个包含单个元素的枚举类型：(推荐方法)

    1
    2
    3
    4
    5
    // Enum singleton - the preferred approch
    public enum Elvis{
        INSTANCE;
        public void leaveTheBuilding(){ ... }
    }

    这种方法在功能上域共有域方法相近，但是他更加简洁，无偿的提供了序列化机制，绝对防止多次实例化，即使是在面对复杂序列化或者反射攻击的时候。虽然这种方法还没有广泛的采用，但是单元素的枚举类型已经成为实现Singleton的最佳方法。[6]

  1. Erich Gamma et al., Design Patterns: Elements of Reusable Object-Oriented Software, defines Singleton around ensuring a class has one instance and providing an access point; Joshua Bloch, Effective Java, 3rd Edition, Item 3, discusses the Java-specific instance-control variants. ↩︎

  2. Joshua Bloch, Effective Java, 3rd Edition, Item 3, compares public static final field singletons, static factory singletons, and enum singletons. ↩︎

  3. Oracle, Java Language Specification §12.4 Initialization of Classes and Interfaces, defines class initialization timing, and JLS §8.3.1.1 static Fields defines static fields as class variables rather than instance variables. ↩︎

  4. Oracle Java SE 21 API, AccessibleObject.setAccessible(boolean), documents suppressing Java language access checks, which is why a private constructor is not an absolute reflection boundary. ↩︎

  5. Oracle, Java Object Serialization Specification §3.7 The readResolve Method, documents how readResolve can replace a deserialized object with the canonical instance. ↩︎

  6. Oracle, Java Language Specification §8.9 Enum Classes, defines enum constants as enum instances; Oracle Java SE 21 API, Constructor.newInstance(Object…), documents that enum constructors cannot be reflectively invoked this way; Oracle’s Serialization of Enum Constants describes enum-specific serialization. ↩︎