java:基于volatile和Thread Local Storage的双重检查锁定实现延迟初始化

总在同一个地方栽坑里是不可原谅的,以本文做个记录,以防下次再犯。 下面这段很简单的基于双重检查锁定(Double-checked locking)实现的延迟初始化(Lazy initialization)代码,还是让spotbugs找出了问题(感谢spotbugs)。 原因很简单,这种模式在java下无效,因为filedNames 变量不是线程可见的,具体原因涉及到java内存模型,网上已经有文章很深入的介绍,参见本文末尾的参考资料4

    private List<String> filedNames = null;
    public List<String> getFieldNames() {
        // Double-checked locking
        if(null == filedNames){
            synchronized(this){
                if(null == filedNames){
                    filedNames = doGetFieldNames();     
                }
            }
        }
        return filedNames;
    }

解决方案1

把 fieldName 声明为volatile型,其他代码不变。 注意: 这个解决方案需要JDK5或更高版本(因为从JDK5开始使用新的JSR-133内存模型规范,这个规范增强了volatile的语义)。关于volatile关键字的含义参见参考资料。

    /** JDK5 required */
    private volatile List<String> filedNames = null;
    public List<String> getFieldNames() {
        // Double-checked locking
        if(null == filedNames){
            synchronized(this){
                if(null == filedNames){
                    filedNames = doGetFieldNames();     
                }
            }
        }
        return filedNames;
    }

解决方案2

基于线程本地存储TLS(Thread Local Storage)实现双重检查锁定,这个方法也是 《The “Double-Checked Locking is Broken” Declaration》论文中提出的方案之一。 这个方案不需要volatile关键字支持当然也就没有JDK5以上版本的要求,但是略复杂,多了一个ThreadLocal变量,并且分成了两个方法。

    private volatile List<String> filedNames = null;
    /** 如果perThreadInstance.get() 返回一个非null值,说明 filedNames 已经被初始化过了 */
    @SuppressWarnings("rawtypes")
    private final ThreadLocal perThreadInstance = new ThreadLocal();
    public List<String> getFieldNames() {
        this.assertJavaBean();
        if(null == perThreadInstance.get()){
            initFieldNames();
        }
        return filedNames;
    }
    /** 同步初始化filedNames变量 */
    @SuppressWarnings({ "unchecked" })
    private void initFieldNames() {
        synchronized(this){
            if(null == filedNames){
                filedNames = doGetFieldNames();     
            }
        }
        // 给perThreadInstance设置一个非null值
        perThreadInstance.set(perThreadInstance);
    }

通用化封装

说话仅仅一个延迟初始化就整出这么多问题,搞出这么多代码,虽然问题解决了,但对于我这个懒人来说实在太复杂了,如果项目中还有多个地方要用到延迟初始化,每个都要这么写代码实在是一件非常痛苦的事儿。 既然原理搞明白了,那么把这两种延迟初始化的解决方案用用泛型类封装一下不就可以复用了么?

于是我很快把上面的代码做了封装,顶层是接口类ILazyInitVariable,只有一个接口方法get(),接下来是个中间BaseLazyVar抽象类定义一个doGet()方法用于具体的初始化,BaseTls和BaseVolatile分别是基于前述方案2和方案1的具体实现类(也是抽象类,具体doGet()方法还是需要子类来完成)

完整代码如下

ILazyInitVariable.java

接口定义 ILazyInitVariable.java,中间抽象类BaseLazyVar也在其中

package gu.simplemq;

/**
 * 延迟初始化(Lazy initialization)变量封装接口
 * @author guyadong
 *
 * @param <T> 延迟变量类型
 */
public interface ILazyInitVariable<T> {
    public static abstract class BaseLazyVar<T> implements ILazyInitVariable<T>{
        /**
         * 返回 T 实例
         * @return
         */
        abstract protected T doGet() ;
    }
    /**
     * 返回延迟初始化的 T 实例 
     * @return
     */
    public T get();
}

BaseVolatile.java

package gu.simplemq;

/**
 * 基于volatile的双重检查锁定实现{@link ILazyInitVariable}的抽象类<br>
 * 要求 JDK5 以上版本 
 * @author guyadong
 *
 * @param <T> variable type
 */
public abstract class BaseVolatile<T> extends ILazyInitVariable.BaseLazyVar<T>{
    private volatile T var = null;
    public BaseVolatile() {
    }
    @Override
    public T get() {
        // Double-checked locking
        if(null == var){
            synchronized(this){
                if(null == var){
                    var = doGet();
                }
            }
        }
        return var;
    }
}

BaseTls.java

package gu.simplemq;

/**
 * 基于Thread Local Storage的双重检查锁定实现{@link ILazyInitVariable}的抽象类<br>
 * @author guyadong
 *
 * @param <T> variable type
 */
public abstract class BaseTls<T> extends ILazyInitVariable.BaseLazyVar<T> {
    /**
     * If perThreadInstance.get() returns a non-null value, this thread has done
     * synchronization needed to see initialization of helper
     */
    @SuppressWarnings("rawtypes")
    private final ThreadLocal perThreadInstance = new ThreadLocal();
    private T var = null;

    public BaseTls() {
    }

    @Override
    public T get() {
        if (null == perThreadInstance.get()) {
            initFieldNames();
        }
        return var;
    }

    @SuppressWarnings({ "unchecked" })
    private void initFieldNames() {
        synchronized (this) {
            if (null == var) {
                var = doGet();
            }
        }
        // Any non-null value would do as the argument here
        perThreadInstance.set(perThreadInstance);
    }
}

使用示例

有了通用化封装,以用BaseVolatile为例

本文最开始的延迟初始化代码就很简单了:

    // filedNames  定义为ILazyInitVariable接口实例,并用BaseVolatile类实例化
    private final ILazyInitVariable<List<String>>filedNames = new BaseVolatile<List<String>>(){
        @Override
        protected List<String> doGet() {
            // 调用初始化方法
            return doGetFieldNames();
        }};
    public List<String> getFieldNames() {
        return filedNames.get();
    }

参考资料

  1. 《The “Double-Checked Locking is Broken” Declaration》
  2. 《Lazy initialization》
  3. 《Double-checked locking》
  4. 《双重检查锁定与延迟初始化》
  5. 《双重检查锁定失败可能性——参照《The “Double-Checked Locking is Broken” Declaration》》
  6. 《Java中Volatile关键字详解》

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏nnngu

记录某公司(简称SMKJ) 的一次面试

昨天去了一家公司面试 Java 开发岗位,这篇文章主要是做一个面试的记录以及总结。

5309
来自专栏青玉伏案

ReactiveSwift源码解析(十一) Atomic的代码实现以及其中的Defer延迟、Posix互斥锁、递归锁

本篇博客我们来聊一下ReactiveSwift中的原子性操作,在此内容上我们简单的聊一下Posix互斥锁以及递归锁的概念以及使用场景。然后再聊一下Atomic的...

3255
来自专栏程序员宝库

JDK 源码中的一些“小技巧”

均摘选自JDK源码 1 i++ vs i-- String源码的第985行,equals方法中: while (n--!= 0) { if...

3335
来自专栏androidBlog

一步步拆解 LeakCanary

版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/gdutxiaoxu/article/de...

591
来自专栏nnngu

记录某公司(简称SMKJ) 的一次面试

昨天去了一家公司面试 Java 开发岗位,这篇文章主要是做一个面试的记录以及总结。 这家公司的规模大概100-200人,环境还可以,在一栋大厦租了两层办公室(3...

3056
来自专栏Java架构沉思录

如何优雅实现优雅停机?

其实优雅停机,就是在要关闭服务之前,不是立马全部关停,而是做好一些善后操作,比如:关闭线程、释放连接资源等。

161
来自专栏偏前端工程师的驿站

JS魔法堂:剖析源码理解Promises/A规范

一、前言                                 Promises/A是由CommonJS组织制定的异步模式编程规范,有不少库已根据该规...

21810
来自专栏chenssy

哦,这就是java的优雅停机?(实现及原理)

其实优雅停机,就是在要关闭服务之前,不是立马全部关停,而是做好一些善后操作,比如:关闭线程、释放连接资源等。

702
来自专栏逸鹏说道

【推荐】C#线程篇---Task(任务)和线程池不得不说的秘密(5.2)

ContinueWith? 啥东西~~??  要写可伸缩的软件,一定不能使你的线程阻塞。这意味着如果调用Wait或者在任务未完成时查询Result属性,极有...

3796
来自专栏Java Web

JavaWeb中使用JSON

JSON 使用 JavaScript 语法来描述数据对象,但是 JSON 仍然独立于语言和平台。JSON 解析器和 JSON 库支持许多不同的编程语言。

1684

扫码关注云+社区