本文是《Android源码设计模式解析与实战》第一章读书笔记
一、单一原则
单一原则的英文是 Single Responsibility Principle,缩写是 SRP 。SRP 的定义是:就一个类而言,应该仅有一个引起它变化的原因。ImageLoader的最初版本:
public class ImageLoader {
//图片缓存
LruCache mImageCache;
//线程池,线程数量为 CPU 的数量
ExecutorService mExecutorService = Executors.newFixedThreadPool(Runtime.getRuntime().availableProcessors());
public ImageLoader() {
initImageCache();
}
private void initImageCache() {
final int maxMemory = (int) (Runtime.getRuntime().maxMemory() / 1024);
final int cacheSize = maxMemory / 4;
mImageCache = new LruCache(cacheSize) {
@Override
protected int sizeOf(String key, Bitmap bitmap) {
return bitmap.getRowBytes() * bitmap.getHeight() / 1024;
}
};
}
public void displayImage(final String url, final ImageView imageView) {
imageView.setTag(url);
mExecutorService.submit(new Runnable() {
@Override
public void run() {
Bitmap bitmap = downloadImage(url);
if (bitmap == null) {
return;
}
if (imageView.getTag().equals(url)) {
imageView.setImageBitmap(bitmap);
}
mImageCache.put(url, bitmap);
}
});
}
private Bitmap downloadImage(String imageUrl) {
Bitmap bitmap = null;
try {
URL url = new URL(imageUrl);
final HttpURLConnection conn = (HttpURLConnection) url.openConnection();
bitmap = BitmapFactory.decodeStream(conn.getInputStream());
conn.disconnect();
} catch (IOException e) {
e.printStackTrace();
}
return bitmap;
}
}
最初的版本所有的代码都写在一个类里面,随着功能增加会越来越大,应该把ImageLoader
拆分开来,各个功能独立出来,满足单一职责原则。
public class ImageLoader {
//图片缓存
ImageCache mImageCache = new ImageCache();
//线程池,线程数量为 CPU 的数量
ExecutorService mExecutorService = Executors.newFixedThreadPool(Runtime.getRuntime().availableProcessors());
public void displayImage(final String url, final ImageView imageView) {
Bitmap bitmap = mImageCache.get(url);
if (bitmap != null) {
imageView.setImageBitmap(bitmap);
return;
}
imageView.setTag(url);
mExecutorService.submit(new Runnable() {
@Override
public void run() {
Bitmap bitmap = downloadImage(url);
if (bitmap == null) {
return;
}
if (imageView.getTag().equals(url)) {
imageView.setImageBitmap(bitmap);
}
mImageCache.put(url, bitmap);
}
});
}
private Bitmap downloadImage(String imageUrl) {
Bitmap bitmap = null;
try {
URL url = new URL(imageUrl);
final HttpURLConnection conn = (HttpURLConnection) url.openConnection();
bitmap = BitmapFactory.decodeStream(conn.getInputStream());
conn.disconnect();
} catch (IOException e) {
e.printStackTrace();
}
return bitmap;
}
}
public class ImageCache {
LruCache mImageCache;
public ImageCache() {
}
private void initImageCache() {
final int maxMemory = (int) (Runtime.getRuntime().maxMemory() / 1024);
final int cacheSize = maxMemory / 4;
mImageCache = new LruCache(cacheSize) {
@Override
protected int sizeOf(String key, Bitmap bitmap) {
return bitmap.getRowBytes() * bitmap.getHeight() / 1024;
}
};
}
public void put(String url, Bitmap bitmap) {
mImageCache.put(url, bitmap);
}
public Bitmap get(String url) {
return mImageCache.get(url);
}
}
这样一拆分,ImageLoader
的功能基本满足了单一职责原则,分成了两块,图片加载和图片缓存,这样缓存逻辑如果要修改时,就不需要修改ImageLoader
了。
单一职责原则的使用一定要根据实际业务来,不能过度使用,拆分的太细。
让程序更灵活——开闭原则
开闭原则英文全称是 Open Close Principle,缩写是 OCP。开闭原则的定义是:软件中的对象(类、模块、函数等)应该对于扩展是开放的,对于修改是封闭的。定义读起来比较抽象,我们还是以上面的ImageLoader
的例子来理解。经过第一轮重构,ImageLoader
职责单一、结构清晰,但有一个问题是,我们的缓存只有一种内存缓存,每次应用重新打开就没有缓存了。所以打算引入 SD 缓存。DiskCache.java
类的代码如下:
public class DiskCache {
static String cacheDir = "sdcard/cache/";
//从缓存中取图片
public Bitmap get(String url) {
return BitmapFactory.decodeFile(cacheDir + url);
}
//将图片缓存到SD卡
public void put(String url, Bitmap bmp) {
FileOutputStream outputStream = null;
try {
outputStream = new FileOutputStream(cacheDir + url);
bmp.compress(Bitmap.CompressFormat.PNG, 100, outputStream);
} catch (FileNotFoundException e) {
e.printStackTrace();
} finally {
if (outputStream != null) {
try {
outputStream.close();
} catch (IOException e) {
e.printStackTrace();
}
}
}
}
}
加了 SD 卡缓存后,ImageLoader
类也有所更新:
public class ImageLoader {
//内存缓存
ImageCache mImageCache = new ImageCache();
//SD卡缓存
DiskCache mDiskCache = new DiskCache();
boolean isUserDiskCache = false;
//线程池,线程数量为 CPU 的数量
ExecutorService mExecutorService = Executors.newFixedThreadPool(Runtime.getRuntime().availableProcessors());
public void displayImage(final String url, final ImageView imageView) {
//判断使用哪种缓存
Bitmap bitmap = isUserDiskCache ? mDiskCache.get(url) : mImageCache.get(url);
if (bitmap != null) {
imageView.setImageBitmap(bitmap);
return;
}
...
}
public void useDiskCache(boolean useDiskCache) {
isUserDiskCache = useDiskCache;
}
}
这个版本的修改,用户需要设置一个变量来选择用内存还是SD卡的缓存方式。虽然增加了一个类,但我们还要去改动ImageLoader
,如果有多个缓存方式的话,按这种方式ImageLoader
中的条件判断会变得很复杂。
而且这个版本用户只能二选一,如果用户有这种需求,优先使用内存缓存,内存缓存中没有再使用SD卡缓存,SD卡没有通过网络加载图片。于是有了一个双缓存类DoubleCache.java
。
public class DoubleCache {
//内存缓存
ImageCache mMemoryCache = new ImageCache();
//SD卡缓存
DiskCache mDiskCache = new DiskCache();
public Bitmap get(String url) {
Bitmap bitmap = mMemoryCache.get(url);
if (bitmap == null) {
bitmap = mDiskCache.get(url);
}
return bitmap;
}
public void put(String url, Bitmap bmp) {
mMemoryCache.put(url, bmp);
mDiskCache.put(url, bmp);
}
}
这时的ImageLoader
也要做如下修改:
if (isUseDoubleCache) {
bitmap = mDoubleCache.get(url);
} else if (isUseDiskCache) {
bitmap = mDiskCache.get(url);
} else {
mImageCache.get(url);
}
代码写到这我们发现,每一次新加一个缓存都要去修改ImageLoader
中的条件判断,非常的麻烦,还有可能引入Bug。可扩展性比较差。
“软件中的对象(类、模块、函数等)应该对于扩展是开放的,但是对于修改是封闭的,这就是开放——关闭原则。也就是说,当软件需要变化时,我们应该尽量通过扩展的方式来实现变化,而不是通过修改已有的代码来实现。”
所以下面对ImageLoader
再一次重构:
public class ImageLoader {
ImageCache mImageCache = new MemoryCache();
//线程池,线程数量为 CPU 的数量
ExecutorService mExecutorService = Executors.newFixedThreadPool(Runtime.getRuntime().availableProcessors());
public void displayImage(final String url, final ImageView imageView) {
//判断使用哪种缓存
Bitmap bitmap = mImageCache.get(url);
if (bitmap != null) {
imageView.setImageBitmap(bitmap);
return;
}
imageView.setTag(url);
mExecutorService.submit(new Runnable() {
@Override
public void run() {
Bitmap bitmap = downloadImage(url);
if (bitmap == null) {
return;
}
if (imageView.getTag().equals(url)) {
imageView.setImageBitmap(bitmap);
}
mImageCache.put(url, bitmap);
}
});
}
public void setImageCache(ImageCache cache) {
mImageCache = cache;
}
private Bitmap downloadImage(String imageUrl) {
Bitmap bitmap = null;
try {
URL url = new URL(imageUrl);
final HttpURLConnection conn = (HttpURLConnection) url.openConnection();
bitmap = BitmapFactory.decodeStream(conn.getInputStream());
conn.disconnect();
} catch (IOException e) {
e.printStackTrace();
}
return bitmap;
}
}
这里的ImageCache
已经不是原来的那个类了,这次重构把它提取成一个接口:
public interface ImageCache {
Bitmap get(String url);
void put(String url, Bitmap bmp);
}
接口定义了两个函数,MemoryCache、DiskCache、DoubleCache都实现了该接口。ImageLoader
中的默认缓存方式是内存缓存,用户想使用别的只要调用 setImageCache 就可以。也可以自定义 ImageCache 的实现。
开闭原则指导我们,当软件需要变化时,应该尽量通过扩展的方式来实现变化,而不是通过修改已有的代码来实现。
构建扩展性——里氏替换原则
里氏替换原则英文全称是 Liskov Substiution Primciple,缩写是 LSP。LSP 通俗定义是:所有引用基类的地主必须能透明的使用其子类对象。其实最终总结就两个字:抽象。
MemoryCache、DiskCache、DoubleCache都可以替换 ImageCache的工作,这很好的反应了里氏替换原则,并且能够保证行为的正确性。ImageCache 建立了获取缓存图片、保存缓存图片的接口规范,MemoryCache 等根据接口规范实现了相应的功能,用户只需要在使用时指定具体的缓存对象就可以动态地替换 ImageCache 中的缓存策略。这就使得 ImageLoader 有了无限的可能性,也就是保证了可扩展性。
让项目拥有变化的能力——依赖倒置原则
依赖倒置原则英文全称是 Dependence Inversion Principle,缩写是 DIP。DIP的几个关键点:
1、高层模块不应该依赖低层模块,两者都应该依赖其抽象;
2、抽象不应该依赖细节;
3、细节应该依赖抽象。
在 Java 中抽象就是指接口或抽象类,两者都是不能直接被实例化的;细节就是实现类,实现接口或继承抽象类而产生的类就是细节,其特点就是,可以直接被实例化。依赖倒置原则在 Java 语言中的表现就是:模块间的依赖通过抽象发生,实现类之间不发生直接的依赖关系,其依赖关系是通过接口或抽象类发生的。
更高的灵活性——接口隔离原则
接口隔离原则英文全称是 Interface Segregation Principles,缩写是 ISP。ISP的定义是:客户端不应该依赖它不需要的接口。另一种定义是:类间的依赖关系应该建立在最小的接口上。
总结以上的5点原则就是单一职责、开闭原则、里氏替换、接口隔离以及依赖倒置,这5大原则被称为SOLID。
更好的可扩展性——迪米特原则
定义:一个对象应该对其他对象有最少的了解。通俗地讲,一个类应该对自己需要耦合或调用的类知道得最少,类的内部如何实现与调用者或者依赖者没关系,调用者或者依赖者只需要知道它需要的方法即可,其它可一概不用管。类与类之间的关系越密切,耦合度越大,当一个类发生改变时,对另一个类的影响也越大。