本文中方法适用与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
活动模版。如果是你们,可以按照下面步骤做:
- 先点击
+
创建一个新的活动模版 - 然后自己起一个名字
- 描述可以不写
- 编写自己的活动模版代码
- 有必要的需要在
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,那么看看使用我们的活动模版怎么做吧!
- 输入要返回的接口,或者类。(因为我们是依赖注入,所以我写的接口,如果你不是这样子,你就写你要返回的类命就行了)
- 选中刚才输入的名字。
- 使用
Surround With
,快捷键Alt+Command+T
(如果你是windows
,或者快捷键不是这个,看下图,你可以双击shift
键,输入surround with
查看,如果你的红框部分没有东西,自己去keymap中去设置吧) - 选择我们写好的
singleton
活动模版。就会生成好大部分代码。 - 然后跟着光标输入构造函数中的参数,初始化的方法,getInstance中生成对象要传入的参数即可。
- 这个时候报错,没有关系,因为之前的
public
构造方法没有删除。这一步就是删除原来的public
方法
那么好,在录制的时候我故意在关键的地方放慢了速度,否则可以更快。这样是不是可以很快的改造一个单例类了!