用枚举enum实现单例

Posted 2021-12-15 PacosonSWJTU

【README】

• 1，effectivejava 讲到使用 枚举类实现单例的例子，非常好用；
• 2，好处如下：
  • 不用定义私有构造器；
  • 不用定义获取单例的方法，如 getInstance() ；通过 枚举类.INSTANCE() 就可以获取单例了；少了很多代码；（枚举类满足单例天然的性质）

---

【1】枚举enum单例

【1.1】枚举类

/**
 * @Description kafka管理器
 * @author xiao tang
 * @version 1.0.0
 * @createTime 2021年11月19日
 */
public enum PPKafkaManager 
    /** 单例 */
    INSTANCE;

    /** 缓存/kafka集群名-属性配置映射 */
    public final ConcurrentMap<String, Properties> kafkaConfigs = new ConcurrentHashMap<>();
    /**
     * @description 获取或添加属性配置
     * @param clusterName 集群名
     * @author xiao tang
     * @date 2021/11/19 
     */
    public Properties getOrCreate(String clusterName) 
        // 若存在，直接取走
        if (kafkaConfigs.containsKey(clusterName)) 
            return kafkaConfigs.get(clusterName);
        
        // 新建kafka属性
        Properties newProps = create();
        Properties oldProps = kafkaConfigs.putIfAbsent(clusterName, newProps);
        // 若旧属性存在，则使用旧属性，丢弃新属性（注意关闭资源）
        if (oldProps != null) 
            // 这里注意关闭资源，其他业务场景可能这里还连接到了kafka集群
            newProps.clear();
        
        return kafkaConfigs.get(clusterName);
    
    /**
     * @description 新建kafka属性
     * @return kafka属性
     * @author xiao tang
     * @date 2021/11/19
     */
    private Properties create() 
        // 其他属性加工逻辑
        return new Properties();
    

我们发现，基于枚举实现的单例类，我们不用定义私有构造器，不用声明getInstance方法，因为 PPKafkaManager.INSTANCE 就可以引用单例；

---

【1.2】枚举类构造器

【1.2.1】为啥枚举类可以没有私有构造器 ？

为此，我们反编译了  PPKafkaManager 类， 如下：

// 枚举类反编译结果 
D:\\workbench_idea\\study4vw\\vwstudy01\\src>javap com.cmc.vw.javaoop.enumtest.PPKafkaManager
Compiled from "PPKafkaManager.java"
public final class com.cmc.vw.javaoop.enumtest.PPKafkaManager extends java.lang.Enum<com.cmc.vw.javaoop.enumtest.PPKafkaManager> 
  public static final com.cmc.vw.javaoop.enumtest.PPKafkaManager INSTANCE;
  public final java.util.concurrent.ConcurrentMap<java.lang.String, java.util.Properties> kafkaConfigs;
  public static com.cmc.vw.javaoop.enumtest.PPKafkaManager[] values();
  public static com.cmc.vw.javaoop.enumtest.PPKafkaManager valueOf(java.lang.String);
  public java.util.Properties getOrCreate(java.lang.String);
  static ;

我们也可以查看 idea的反编译结果，发现枚举类构造器是私有；

 

 我们发现

• 1，PPKafkaManager 枚举类 编译后是一个 final 类，所以它是不能被继承的；
• 2，PPKafkaManager 枚举类 继承自 Enum 类；
• 3，枚举类实例 INSTANCE 是一个static final 静态常量，仅有一份；所以可以直接引用；
• 4， 枚举类 PPKafkaManager 默认为私有构造器；

【1.2.2.】查看 Enum构造器

1）类定义

public abstract class Enum<E extends Enum<E>>
        implements Comparable<E>, Serializable 

2）Enum 只有一个构造器，如下：

protected Enum(String name, int ordinal) 
	this.name = name;
	this.ordinal = ordinal;

很显然， 这个构造器是 protected，访问权限是 同包下或其子类，又因为 INSTANCE 被final修饰，所以它不能被继承，即没有子类；

总结下：

• 1，Enum枚举子类的类被final修饰，所以无法被子类继承；
• 2，构造器默认为private，所以不能被其他类实例化；
• 3，通过反射也是无法实例化枚举类的；
• 4，线程安全，因为枚举类实例 被 static final修饰，主程序启动时，枚举类实例就已经加载到内存了；

以上，枚举类天然满足单例类的条件，且代码更加简单；