单例模式(Singleton Pattern)是指确保一个类在任何情况下都绝对只有一个实例,并提供一个全局的访问点。单例模式是创建型模式,单例模式在现实生活中的应用也非常广泛。例如公司CEO、部门经理等。在J2EE标准中,ServletContext、ServletContextConfig等;在Spring框架应用中ApplicationContext;数据库的连接池都是单例形式。
在Java中,有下面几种方式去创建单例:
1. 饿汉式单例
先看一下单例模式的类结构图:
饿汉式单例是在类加载的时候就立即初始化,并且创建单例对象。绝对线程安全,在线程还没出现以前就是实例化了,不可能存在访问安全的问题。
优点:没有加任何的锁,执行效率比较高,在用户体验上来说,比懒汉式要好。
缺点:类加载的时候就初始化,不管用于不用都占着空间,浪费了内存。
Spring中IOC容器ApplicationContext本身就是典型的饿汉式单例,下面代码是我们自己实现饿汉式单例的例子:
public class Singleton2 {
private static Singleton2 instance = new Singleton2();
private Singleton2() {}
public static Singleton2 getInstance() {
return instance;
}
}
还有另外一种写法,利用静态代码块机制:
public class Singleton4 {
private static Singleton4 instance;
static {
instance = new Singleton4();
}
private Singleton4() {}
public static Singleton4 getInstance() {
return instance;
}
}
这两种写法都非常的简单,也非常好理解,饿汉式适用在单例对象较少的情况。
2. 懒汉式单例
懒汉式单例的特点是被外部类调用的时候才加载和初始化,下面是懒汉式单例的代码:
public class LazySimpleSingleton {
private static LazySimpleSingleton instance;
private LazySimpleSingleton() {}
public static LazySimpleSingleton getInstance() {
if (instance == null) {
instance = new LazySimpleSingleton();
}
return instance;
}
}
然后写一个线程类ExectorThread类:
public class ExectorThread implements Runnable {
@Override
public void run() {
LazySimpleSingleton singleton = LazySimpleSingleton.getInstance();
System.out.println(Thread.currentThread().getName() + ":" + singleton);
}
}
客户端测试代码:
public class LazySimpleSingletonTest {
public static void main(String[] args) {
Thread t1 = new Thread(new ExecutorThread());
Thread t2 = new Thread(new ExecutorThread());
t1.start();
t2.start();
System.out.println("End");
}
}
运行结果:
End
Thread-0:com.yrk.designpattern.singleton.LazySimpleSingleton@39bcfec1
Thread-1:com.yrk.designpattern.singleton.LazySimpleSingleton@1733c6a5
有一定几率出现创建两个不同对象的结果,这意味着上面的单例存在着线程安全的隐患。那么我们如何优化我们代码,使懒汉式单例在多线程环境下安全呢?看下面的代码,给getInstance方法加上synchronized关键字,使这个方法变成线程同步的方法:
public class LazySimpleSingleton {
private static LazySimpleSingleton instance;
private LazySimpleSingleton() {}
public static synchronized LazySimpleSingleton getInstance() {
if (instance == null) {
instance = new LazySimpleSingleton();
}
return instance;
}
}
这时候,我们再来调试。当我们将其中一个线程执行并调用getInstance()方法时,另一个线程再调用getInstance()方法,线程的状态由RUNNING 变成了Stepping,出现阻塞。直到第一个线程执行完,第二个线程才恢复RUNNING 状态继续调用getInstance()方法。如下图所示:
完美的展现了synchronized 监视锁的运行状态,线程安全的问题便解决了。但是,用synchronized 加锁,在线程数量比较多情况下,如果CPU分配压力上升,会导致大批量线程出现阻塞,从而导致程序运行性能大幅下降。那么,有没有一种更好的方式,既兼顾线程安全又提升程序性能呢?答案是肯定的。我们来看双重检查锁的单例模式:
public class LazyDoubleCheckSingleton {
private static volatile LazyDoubleCheckSingleton instance;
private LazyDoubleCheckSingleton() {}
public static LazyDoubleCheckSingleton getInstance() {
if (instance == null) {
synchronized (LazyDoubleCheckSingleton.class) {
if (instance == null) {
instance = new LazyDoubleCheckSingleton();
}
}
}
return instance;
}
}
当第一个线程调用getInstance()方法时,第二个线程也可以调用getInstance()。当第一个线程执行到synchronized 时会上锁,第二个线程就会变成Stepping状态,出现阻塞。此时,阻塞并不是基于整个LazySimpleSingleton 类的阻塞,而是在getInstance()
方法内部阻塞,只要逻辑不是太复杂,对于调用者而言感知不到。但是,用到synchronized 关键字,总归是要上锁,对程序性能还是存在一定影响的。难道就真的没有更好的方案吗?当然是有的。我们可以从类初始化角度来考虑,看下面的代码,采用静态内部类的方式:
public class LazyInnerClassSingleton {
// 如果没使用的时候,不会加载内部类
private LazyInnerClassSingleton() {}
public static final LazyInnerClassSingleton getInstance() {
// 在返回结果前,一定会加载内部类
return LazyHolder.instance;
}
private static class LazyHolder {
private static final LazyInnerClassSingleton instance = new LazyInnerClassSingleton();
}
}
这种形式兼顾饿汉式的内存浪费,也兼顾synchronized 性能问题。内部类一定是要在方法调用之前初始化,巧妙地避免了线程安全问题。
反射破坏单例
大家有没有发现,上面介绍的单例模式的构造方法除了加上private以外,没有做任何处理。如果我们使用反射来调用其构造方法,然后在调用getInstance()方法,应该就会 产生两个不同的实例。看下面一段测试代码:
public class LazyInnerClassSingletonTest {
/**
* @param args
*/
public static void main(String[] args) {
try {
Class<?> clazz = LazyInnerClassSingleton.class;
Constructor constructor = clazz.getDeclaredConstructor(null);
constructor.setAccessible(true);
Object c1 = constructor.newInstance();
Object c2 = constructor.newInstance();
System.out.println(c1 == c2);
} catch (Exception e) {
e.printStackTrace();
}
}
}
运行结果:
false
显然,是创建了两个不同的实例,现在我们在其构造方法上做一些限制,一旦出现多次重复创建,则直接抛出异常:
public class LazyInnerClassSingleton {
// 如果没使用的时候,不会加载内部类
private LazyInnerClassSingleton() {
if (LazyHolder.instance != null) {
throw new RuntimeException("不允许创建多个实例");
}
}
public static final LazyInnerClassSingleton getInstance() {
// 在返回结果前,一定会加载内部类
return LazyHolder.instance;
}
private static class LazyHolder {
private static final LazyInnerClassSingleton instance = new LazyInnerClassSingleton();
}
}
再次测试代码,会得到下面结果:
java.lang.reflect.InvocationTargetException
at sun.reflect.NativeConstructorAccessorImpl.newInstance0(Native Method)
at sun.reflect.NativeConstructorAccessorImpl.newInstance(NativeConstructorAccessorImpl.java:62)
at sun.reflect.DelegatingConstructorAccessorImpl.newInstance(DelegatingConstructorAccessorImpl.java:45)
at java.lang.reflect.Constructor.newInstance(Constructor.java:423)
at com.yrk.designpattern.singleton.LazyInnerClassSingletonTest.main(LazyInnerClassSingletonTest.java:22)
Caused by: java.lang.RuntimeException: 不允许创建多个实例
at com.yrk.designpattern.singleton.LazyInnerClassSingleton.<init>(LazyInnerClassSingleton.java:15)
... 5 more
至此,最好的单例便大功告成。
序列化破坏单例
当我们将一个单例对象创建好,有时候需要将对象序列化并写入磁盘,下次使用时再从磁盘读取对象,反序列化转化为内存对象。反序列化后的对象会重新分配内存,即重新创建,那如果序列化的目标对象为单例对象,就违背了单例模式的初衷,相当于破坏了单例,来看一段代码:
/**
*
* 反序列化时导致单例被破坏
*/
public class SeriableSingleton implements Serializable {
// 序列化就是说把内存中的状态通过转换成字节码的形式,从而转换一个IO流,写入到其它地方
// 反序列化是讲已经持久化的字节码内容,转换成IO流。通过IO流的读取,将内容转化为Java对象
// 在转换过程中会重新创建对象
private static SeriableSingleton instance = new SeriableSingleton();
private SeriableSingleton() {}
public static SeriableSingleton getInstance() {
return instance;
}
}
编写测试代码:
public class SeriableSingletonTest {
public static void main(String[] args) {
SeriableSingleton s1 = null;
SeriableSingleton s2 = SeriableSingleton.getInstance();
FileOutputStream fos = null;
try {
fos = new FileOutputStream("SeriableSingleton.obj");
ObjectOutputStream oos = new ObjectOutputStream(fos);
oos.writeObject(s2);
oos.flush();
oos.close();
FileInputStream fis = new FileInputStream("SeriableSingleton.obj");
ObjectInputStream ois = new ObjectInputStream(fis);
s1 = (SeriableSingleton) ois.readObject();
ois.close();
System.out.println(s1);
System.out.println(s2);
System.out.println(s1 == s2);
} catch (Exception e) {
e.printStackTrace();
}
}
}
运行结果:
com.yrk.designpattern.singleton.SeriableSingleton@e9e54c2
com.yrk.designpattern.singleton.SeriableSingleton@5c647e05
false
运行结果中可以看出,反序列化后的对象和手动创建的对象是不一致的,实例化了两次,违背了单例的初衷。那么我们如何保证序列化的情况下也能够实现单例?其实很简单,只需要增加readResolve方法即可,来看一下优化后的代码:
public class SeriableSingleton implements Serializable{
// 序列化就是说把内存中的状态通过转换成字节码的形式,从而转换一个IO流,写入到其它地方
// 反序列化是讲已经持久化的字节码内容,转换成IO流。通过IO流的读取,将内容转化为Java对象
// 在转换过程中会重新创建对象
private static SeriableSingleton instance = new SeriableSingleton();
private SeriableSingleton() {}
public static SeriableSingleton getInstance() {
return instance;
}
private Object readResolve() {
return instance;
}
}
再看运行结果:
com.yrk.designpattern.singleton.SeriableSingleton@5c647e05
com.yrk.designpattern.singleton.SeriableSingleton@5c647e05
true
这是什么原因呢?为什么要这样写?下面我们看一下JDK的源码实现应该就可以明白了。我们进入ObjectInputStream类的readObject方法:
public final Object readObject() throws IOException, ClassNotFoundException {
if (enableOverride) {
return readObjectOverride();
}
// if nested read, passHandle contains handle of enclosing object
int outerHandle = passHandle;
try {
Object obj = readObject0(false);
handles.markDependency(outerHandle, passHandle);
ClassNotFoundException ex = handles.lookupException(passHandle);
if (ex != null) {
throw ex;
}
if (depth == 0) {
vlist.doCallbacks();
}
return obj;
} finally {
passHandle = outerHandle;
if (closed && depth == 0) {
clear();
}
}
}
我们发现readObject方法又调用了重写方法readObject(false)方法:
private Object readObject0(boolean unshared) throws IOException {
// 省略代码
try {
switch (tc) {
// 省略代码
case TC_OBJECT:
return checkResolve(readOrdinaryObject(unshared));
// 省略代码
}
}
我们看到TC_OBJECTD 中判断,调用了ObjectInputStream 的readOrdinaryObject()方法,我们继续进入看源码:
private Object readOrdinaryObject(boolean unshared)
throws IOException
{
if (bin.readByte() != TC_OBJECT) {
throw new InternalError();
}
ObjectStreamClass desc = readClassDesc(false);
desc.checkDeserialize();
Class<?> cl = desc.forClass();
if (cl == String.class || cl == Class.class
|| cl == ObjectStreamClass.class) {
throw new InvalidClassException("invalid class descriptor");
}
Object obj;
try {
obj = desc.isInstantiable() ? desc.newInstance() : null;
} catch (Exception ex) {
throw (IOException) new InvalidClassException(
desc.forClass().getName(),
"unable to create instance").initCause(ex);
}
// 省略代码
return obj;
}
发现调用了ObjectStreamClass 的isInstantiable()方法,而isInstantiable()里面的代码如下:
boolean isInstantiable() {
requireInitialized();
return (cons != null);
}
代码非常简单,就是判断一下构造方法是否为空,构造方法不为空就返回true。意味着,只要有无参构造方法就会实例化。
这时候,其实还没有找到为什么加上readResolve()方法就避免了单例被破坏的真正原因。我再回到ObjectInputStream 的readOrdinaryObject()方法继续往下看:
private Object readOrdinaryObject(boolean unshared)
throws IOException
{
// 省略代码
if (obj != null &&
handles.lookupException(passHandle) == null &&
desc.hasReadResolveMethod())
{
Object rep = desc.invokeReadResolve(obj);
if (unshared && rep.getClass().isArray()) {
rep = cloneArray(rep);
}
if (rep != obj) {
handles.setObject(passHandle, obj = rep);
}
}
return obj;
}
判断无参构造方法是否存在之后,又调用了hasReadResolveMethod()方法,来看代码:
boolean hasReadResolveMethod() {
requireInitialized();
return (readResolveMethod != null);
}
逻辑非常简单,就是判断readResolveMethod 是否为空,不为空就返回true。那么readResolveMethod 是在哪里赋值的呢?通过全局查找找到了赋值代码在私有方法ObjectStreamClass()方法中给readResolveMethod 进行赋值,来看代码:
readResolveMethod = getInheritableMethod(cl, "readResolve", null, Object.class);
上面的逻辑其实就是通过反射找到一个无参的readResolve()方法,并且保存下来。现在再回到ObjectInputStream 的readOrdinaryObject() 方法继续往下看, 如果readResolve()存在则调用invokeReadResolve()方法,来看代码:
Object invokeReadResolve(Object obj) throws IOException, UnsupportedOperationException {
requireInitialized();
if (readResolveMethod != null) {
try {
return readResolveMethod.invoke(obj, (Object[]) null);
} catch (InvocationTargetException ex) {
Throwable th = ex.getTargetException();
if (th instanceof ObjectStreamException) {
throw (ObjectStreamException) th;
} else {
throwMiscException(th);
throw new InternalError(th); // never reached
}
} catch (IllegalAccessException ex) {
// should not occur, as access checks have been suppressed
throw new InternalError(ex);
}
} else {
throw new UnsupportedOperationException();
}
}
我们可以看到在invokeReadResolve()方法中用反射调用了readResolveMethod 方法。通过JDK 源码分析我们可以看出,虽然,增加readResolve()方法返回实例,解决了单例被破坏的问题。但是,我们通过分析源码以及调试,我们可以看到实际上实例化了两次,只不过新创建的对象没有被返回而已。那如果,创建对象的动作发生频率增大,就意味着内存分配开销也就随之增大,难道真的就没办法从根本上解决问题吗?下面我们来注册式单例也许能帮助到你。
注册式单例又称登记式单例,就是将每一个实例都登记到某一个地方,使用唯一的标识获取实例。注册式单例有两种写法:一种为容器缓存,一种为枚举登记。先来看枚举式单例的写法:
public enum EnumSingleton {
INSTANCE;
private Object data;
public Object getData() {
return data;
}
public void setData(Object data) {
this.data = data;
}
public static EnumSingleton getInstance() {
return INSTANCE;
}
}
测试代码:
public class EnumSingletonTest {
public static void main(String[] args) {
EnumSingleton e1 = null;
EnumSingleton e2 = EnumSingleton.getInstance();
e2.setData(new Object());
FileOutputStream fos = null;
try {
fos = new FileOutputStream("SeriableSingleton.obj");
ObjectOutputStream oos = new ObjectOutputStream(fos);
oos.writeObject(e2);
oos.flush();
oos.close();
FileInputStream fis = new FileInputStream("SeriableSingleton.obj");
ObjectInputStream ois = new ObjectInputStream(fis);
e1 = (EnumSingleton) ois.readObject();
ois.close();
System.out.println(e1);
System.out.println(e2);
System.out.println(e1 == e2);
} catch (Exception e) {
e.printStackTrace();
}
}
}
运行结果:
INSTANCE
INSTANCE
true
没有做任何处理,我们发现运行结果和我们预期的一样。那么枚举式单例如此神奇,它的神秘之处在哪里体现呢?下面我们通过分析源码来揭开它的神秘面纱。下载一个非常好用的Java 反编译工具Jad(下载地址:https://varaneckas.com/jad/),解压后配置好环境变量(这里不做详细介绍),就可以使用命令行调用了。找到工程所在的class 目录,复制EnumSingleton.class 所在的路径,执行jad命令,会生成EnumSingleton.jad 文件。打开EnumSingleton.jad文件我们惊奇又巧妙地发现有如下代码:
static
{
INSTANCE = new EnumSingleton("INSTANCE", 0);
$VALUES = (new EnumSingleton[] {
INSTANCE
});
}
原来,枚举式单例在静态代码块中就给INSTANCE 进行了赋值,是饿汉式单例的实现。至此,我们还可以试想,序列化我们能否破坏枚举式单例呢?我们不妨再来看一下JDK源码,还是回到ObjectInputStream 的readObject0()方法:
private Object readObject0(boolean unshared) throws IOException {
...
case TC_ENUM:
return checkResolve(readEnum(unshared));
...
}
我们看到在readObject0()中调用了readEnum()方法,来看readEnum()中代码实现:
private Enum<?> readEnum(boolean unshared) throws IOException {
if (bin.readByte() != TC_ENUM) {
throw new InternalError();
}
ObjectStreamClass desc = readClassDesc(false);
if (!desc.isEnum()) {
throw new InvalidClassException("non-enum class: " + desc);
}
int enumHandle = handles.assign(unshared ? unsharedMarker : null);
ClassNotFoundException resolveEx = desc.getResolveException();
if (resolveEx != null) {
handles.markException(enumHandle, resolveEx);
}
String name = readString(false);
Enum<?> result = null;
Class<?> cl = desc.forClass();
if (cl != null) {
try {
@SuppressWarnings("unchecked")
Enum<?> en = Enum.valueOf((Class)cl, name);
result = en;
} catch (IllegalArgumentException ex) {
throw (IOException) new InvalidObjectException(
"enum constant " + name + " does not exist in " +
cl).initCause(ex);
}
if (!unshared) {
handles.setObject(enumHandle, result);
}
}
handles.finish(enumHandle);
passHandle = enumHandle;
return result;
}
我们发现枚举类型其实通过类名和Class 对象类找到一个唯一的枚举对象。因此,枚举对象不可能被类加载器加载多次。那么反射是否能破坏枚举式单例呢?来看一段测代码:
public static void main(String[] args) {
try {
Class clazz = EnumSingleton.class;
Constructor c = clazz.getDeclaredConstructor();
c.newInstance();
}catch (Exception e){
e.printStackTrace();
}
}
运行结果:
java.lang.NoSuchMethodException: com.yrk.designpattern.singleton.EnumSingleton.<init>()
at java.lang.Class.getConstructor0(Class.java:3082)
at java.lang.Class.getDeclaredConstructor(Class.java:2178)
at com.yrk.designpattern.singleton.EnumSingletonTest.main(EnumSingletonTest.java:10)
报的是java.lang.NoSuchMethodException 异常,意思是没找到无参的构造方法。这时候,我们打开java.lang.Enum 的源码代码,查看它的构造方法,只有一个protected的构造方法,代码如下:
protected Enum(String name, int ordinal) {
this.name = name;
this.ordinal = ordinal;
}
那我们再来做一个这样的测试:
public static void main(String[] args) {
try {
Class clazz = EnumSingleton.class;
Constructor c = clazz.getDeclaredConstructor(String.class,int.class);
c.setAccessible(true);
EnumSingleton enumSingleton = (EnumSingleton)c.newInstance("Test", 666);
}catch (Exception e){
e.printStackTrace();
}
}
运行结果:
java.lang.IllegalArgumentException: Cannot reflectively create enum objects
at java.lang.reflect.Constructor.newInstance(Constructor.java:417)
at com.yrk.designpattern.singleton.EnumSingletonTest.main(EnumSingletonTest.java:12)
这时错误已经非常明显了,告诉我们Cannot reflectively create enum objects,不能用反射来创建枚举类型。还是习惯性地想来看看JDK 源码,进入Constructor 的newInstance()方法:
public T newInstance(Object ... initargs)
throws InstantiationException, IllegalAccessException,
IllegalArgumentException, InvocationTargetException
{
if (!override) {
if (!Reflection.quickCheckMemberAccess(clazz, modifiers)) {
Class<?> caller = Reflection.getCallerClass();
checkAccess(caller, clazz, null, modifiers);
}
}
if ((clazz.getModifiers() & Modifier.ENUM) != 0)
throw new IllegalArgumentException("Cannot reflectively create enum objects");
ConstructorAccessor ca = constructorAccessor; // read volatile
if (ca == null) {
ca = acquireConstructorAccessor();
}
@SuppressWarnings("unchecked")
T inst = (T) ca.newInstance(initargs);
return inst;
}
在newInstance()方法中做了强制性的判断,如果修饰符是Modifier.ENUM 枚举类型,直接抛出异常。到这为止,我们是不是已经非常清晰明了呢?枚举式单例也是《Effective Java》书中推荐的一种单例实现写法。在JDK 枚举的语法特殊性,以及反射也为枚举保驾护航,让枚举式单例成为一种比较优雅的实现。
接下来看注册式单例还有另一种写法,容器缓存的写法,创建ContainerSingleton 类:
public class ContainerSingleton {
private static Map<String, Object> ioc = new ConcurrentHashMap<String, Object>();
public static Object getBean(String className) {
synchronized (ioc) {
if (!ioc.containsKey(className)) {
Object obj = null;
try {
obj = Class.forName(className).newInstance();
ioc.put(className, obj);
} catch (Exception e) {
e.printStackTrace();
}
return obj;
} else {
return ioc.get(className);
}
}
}
}
容器式写法适用于创建实例非常多的情况,便于管理。但是,是非线程安全的。到此,注册式单例介绍完毕。我们还可以来看看Spring 中的容器式单例的实现代码:
public abstract class AbstractAutowireCapableBeanFactory extends AbstractBeanFactory
implements AutowireCapableBeanFactory {
// 省略代码
/** Cache of unfinished FactoryBean instances: FactoryBean name to BeanWrapper. */
private final ConcurrentMap<String, BeanWrapper> factoryBeanInstanceCache = new ConcurrentHashMap<>();
// 省略代码
}
ThreadLocal线程单例
ThreadLocal 不能保证其创建的对象是全局唯一,但是能保证在单个线程中是唯一的,天生的线程安全。下面我们来看代码:
public class ThreadLocalSingleton {
private static final ThreadLocal<ThreadLocalSingleton> threadLocalInstance =
new ThreadLocal<ThreadLocalSingleton>(){
@Override
protected ThreadLocalSingleton initialValue() {
return new ThreadLocalSingleton();
}
};
private ThreadLocalSingleton(){}
public static ThreadLocalSingleton getInstance(){
return threadLocalInstance.get();
}
}
测试代码:
public class ThreadLocalSingletonTest {
public static void main(String[] args) {
System.out.println(ThreadLocalSingleton.getInstance());
System.out.println(ThreadLocalSingleton.getInstance());
System.out.println(ThreadLocalSingleton.getInstance());
System.out.println(ThreadLocalSingleton.getInstance());
Thread t1 = new Thread(new ExecutorThread());
Thread t2 = new Thread(new ExecutorThread());
t1.start();
t2.start();
System.out.println("End");
}
}
运行结果:
com.yrk.designpattern.singleton.ThreadLocalSingleton@15db9742
com.yrk.designpattern.singleton.ThreadLocalSingleton@15db9742
com.yrk.designpattern.singleton.ThreadLocalSingleton@15db9742
com.yrk.designpattern.singleton.ThreadLocalSingleton@15db9742
End
Thread-1:com.yrk.designpattern.singleton.ThreadLocalSingleton@b840848
Thread-0:com.yrk.designpattern.singleton.ThreadLocalSingleton@6055f8fb
我们发现,在主线程main 中无论调用多少次,获取到的实例都是同一个,都在两个子线程中分别获取到了不同的实例。那么ThreadLocal 是如果实现这样的效果的呢?我们知道上面的单例模式为了达到线程安全的目的,给方法上锁,以时间换空间。ThreadLocal将所有的对象全部放在ThreadLocalMap 中,为每个线程都提供一个对象,实际上是以空间换时间来实现线程间隔离的。