如何快速的写一个单例

本文中方法适用与Android StudioIntelliJ 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的模版。如图:

image

我们选择单例,然后在右边的编辑区就可以编写自己的代码模版。

那么我这里提供一套代码模版给大家,如果你不愿意自己写,直接把我的复制粘贴过去就行了。

#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}() {
    }
}

然后我们使用这个模版再试一下:

image

就是我们想要的代码。怎么样?但是这样并不总是符合我们的使用场景。我们有的时候,在创建一个类的时候并没有想好它就是一个单例。有的时候是对一个现有的类的改造。但我们总不能再重新去创建一个吧。

那么好。看下面。

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

2.1 自定义活动模版

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

自定义活动模版的入口:

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

image

例如我已经在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()。如图。

image

好了大功告成!

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,那么看看使用我们的活动模版怎么做吧!

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

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

参考:https://www.jianshu.com/p/cfc504e88d4f

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 211,948评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,371评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,490评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,521评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,627评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,842评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,997评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,741评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,203评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,534评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,673评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,339评论 4 330
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,955评论 3 313
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,770评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,000评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,394评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,562评论 2 349

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,799评论 25 707
  • 如果不是翻回收站我已经记不得第一次和你在一起的日子,那天你的样子了,也就得最好年纪的自己,真难想象我已经淡出你生...
    _S长安阅读 383评论 0 0
  • 生活本就五味俱全 添油加醋只会破坏 它原有的美味 对待生活 你什么也不用做 用心烹饪 用心品尝 就足够了
    宫本本是个菇凉阅读 182评论 0 0
  • 如果回到童年, 我玩超级玛丽还能过到几关? 我还会为集不齐方便面包里的“旋风卡”,而眼谗吗? 如果回到童年, 我一...
    生执念阅读 304评论 45 29
  • 概念不清晰会有什么可怕的后果? 如果让自己详细来描述某个概念,多维度的阐述这个概念、我能搞明白吗? 结果是脑子糊涂...
    拇指王成长笔记阅读 199评论 0 0