如何快速的写一个单例

发布更新 9/27：改正了读者指出的错误。谢谢你们!还有什么错误和不足尽管指出!

本文中方法适用与Android Studio和IntelliJ Idea

咱们写代码的时候常常要写个单例，其实在Android Studio中能够快速写一个单例的方法有不少。

1 从代码模版建立一个单例

1.1 从默认单例模版建立一个单例

File -> New -> Singleton。

这是生成单例代码的一个例子。

public class Test {
    private static Test ourInstance = new Test();

    public static Test getInstance() {
        return ourInstance;
    }

    private Test() {
    }
}复制代码

谢谢读者提醒!这里写错了!这里保留原文。下面正文更正!下面代码和模版代码同时更正，但因篇幅缘由，代码保留原文了!

原文：这个单例有几个缺点。getInstance没有对ourInstance进行空判断，因此可能返回null。若是加上空判断，并在其内部若是实例化一个对象就又有一个问题，若是不一样步的话可能产生多个对象。因此，Android Studio为咱们提供的这个方法并很差。我但愿的是这个样子的：

上面单例是直接赋值的，可是一般，咱们都是使用的时候才去赋值，因此一般状况下是下面这个样子。

public class Test {
    private static Test instance ; 

    public static Test getInstance() {
        if (instance == null) {
            synchronized (Test.class) {
                if (instance == null) {
                    instance = new Test();
                }
            }
        }
        return instance;
    }

    private Test() {
    }
}复制代码

1.2 自定义单例模版

既然需求默认的需求不能实现咱们的要求，那么，去自定义单例模版。在 Preference->Editor->File and Code Templates能够找到建立各类File的模版。如图：

咱们选择单例，而后在右边的编辑区就能够编写本身的代码模版。

那么我这里提供一套代码模版给你们，若是你不肯意本身写，直接把个人复制粘贴过去就好了。

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
public class ${NAME} {
    private static ${NAME} instance ;

    public static ${NAME} getInstance() {
        if (instance == null) {
            synchronized(${NAME}.class){
                if (instance == null) {
                    instance = new ${NAME}();
                }
            }
        }
        return instance;
    }

    private ${NAME}() {
    }
}复制代码

而后咱们使用这个模版再试一下：

就是咱们想要的代码。怎么样？可是这样并不老是符合咱们的使用场景。咱们有的时候，在建立一个类的时候并无想好它就是一个单例。有的时候是对一个现有的类的改造。但咱们总不能再从新去建立一个吧。

那么好。看下面。

2 从活动模版重构出一个单例

2.1 自定义活动模版

这个我在我以前的，Android Studio相见恨晚的操做锦集中已经讲过一次了，可是为了防止没有看过那篇文章的读者我再讲一遍。

自定义活动模版的入口：

Prefrence->Editor->Live Templates，下面就是整个界面的一些介绍。

例如我已经在user组中建立好了本身的singleton活动模版。若是是大家，能够按照下面步骤作：

1. 先点击＋建立一个新的活动模版
2. 而后本身起一个名字
3. 描述能够不写
4. 编写本身的活动模版代码
5. 有必要的须要在Edit variables中编辑函数式

固然我已经编写好了活动模版代码，我贴在这里，你能够直接复制粘贴到本身的里面：

private static $SELECTION$ instance ;

private $CLASS_NAME$($param1$){
    $init$
}

public static $SELECTION$ getInstance($param1$){
    if (instance == null) {
        synchronized ($CLASS_NAME$.class){
            if (instance == null) {
                instance = new $CLASS_NAME$($param2$) ;
            }
        }
    }
    return instance ;
}复制代码

注意 下面一步很关键

复制完以后。点击Edit variables；在CLASS_NAME对应的后面一格填写表达式className()。如图。

好了大功告成!

2.2 使用自定义模版重构单例代码

首先说一下，在咱们公司，JavaBean的赋值都是经过依赖注入的方式。几乎每个JavaBean都提供了一个接口，单例也是。固然我上面的活动模版也是针对这种状况编写的，并兼容不是依赖注入的状况。

那么好咱们看一个例子：

咱们将一个现有的Test类改形成一个单例；

public class Test implements ITest {

    private static final String TAG = Test.class.getSimpleName();

    public Test(String test) {
        init(test);
    }

    private void init(String test) {
        Log.d(TAG, "init: " + test);
    }
}复制代码

咱们的目标应该是将其改形成这样：

public class Test implements ITest {

    private static final String TAG = Test.class.getSimpleName();

    private static ITest instance;

    private Test(String test) {
        init(test);
    }

    public static ITest getInstance(String test) {
        if (instance == null) {
            synchronized (Test.class) {
                if (instance == null) {
                    instance = new Test(test);
                }
            }
        }
        return instance;
    }

    private void init(String test) {
        Log.d(TAG, "init: " + test);
    }
}复制代码

OK，那么看看使用咱们的活动模版怎么作吧!

1. 输入要返回的接口，或者类。(由于咱们是依赖注入，因此我写的接口，若是你不是这样子，你就写你要返回的类命就好了)
2. 选中刚才输入的名字。
3. 使用Surround With，快捷键Alt+Command+T(若是你是windows，或者快捷键不是这个，看下图，你能够双击shift键，输入surround with查看，若是你的红框部分没有东西，本身去keymap中去设置吧)
4. 选择咱们写好的singleton活动模版。就会生成好大部分代码。
5. 而后跟着光标输入构造函数中的参数，初始化的方法，getInstance中生成对象要传入的参数便可。
6. 这个时候报错，没有关系，由于以前的public构造方法没有删除。这一步就是删除原来的public方法

那么好，在录制的时候我故意在关键的地方放慢了速度，不然能够更快。这样是否是能够很快的改造一个单例类了!

3 结束语

我发现个人文章老是被转成图片在微博中转发，在这里很是感谢你们的赏识。我也但愿本身能够给你们分享更多精彩的文章。其实本身在分享的同时也收获了不少。

可是转成图片，就看不到动图的效果了。有些操做的演示仍是很依赖动图展现的。不过我看转发我文章的人都会附上原文连接，我在这里，很是建议你们去看原文。我保证原文更加精彩。

若是你只看到了图片，那也无所谓了，个人文章暂时也没有维权呢，那些不带原文连接和做者信息的人，他们转就转吧，他们开心就好。若是对咱们文章感兴趣能够到 掘金 中搜索做者，柴泽建_Jack，就能够查看个人文章了。

“做者好菜连个连接都不会放吗？”

“若是生成了图片大家会去敲连接吗？”

“会!”

哈哈!我就是“一个逗逼，一个Android开发者，一个持续分享技术干货的小浪逼。”

相关阅读

我其它可能与本文相关的文章。

教你把Java Bean撸成串的最快方法-自定义setter生成脚本

让你的Android Studio性感起来--Sexy Editor

Android Studio相见恨晚的操做锦集