单一职责的英文名称是Single Responsibility Principle,缩写是SRP。
SRP的定义就是:就一个类而言,应该仅有一个引起它变化的原因。简单说来,一个类中应该是一组相关性很高的函数、数据的封装。单一职责的划分界限并不是总是那么清晰,很多时候需要靠个人经验来界定。当然,最大的问题就是堆职责的定义,什么是类的职责,以及怎么划分类的职责。
接下来以小明的工作过程为示例描述单一职责原则:
小明初入职场,在经历过一周的适应期以及熟悉公司的产品、开发规范后,小民的开发工作就正式开始了。小民的主管是个工作经验丰富的技术专家,对于小民的工作并不是很满意,尤其是小民最薄弱的面向对象设计,而Android开发又是使用Java语言,程序中的抽象、接口、六大原则、23种设计模式等名词把小民弄的晕头转向。于是,小民的主管决定先让小民做一个小项目来锻炼这方面的能力。
在经过一番思考后,主管挑选了使用范围广、难度也适中的图片加载器(ImageLoader)作为小民的训练项目。既然要训练小民的面向对象设计能力,那么久必须考虑到可扩展性、灵活性,而检测这一切是否符合需求的最好途径就是开源。
小民是不服输的,主管的要求很简单,要小民实现图片加载,并且要将图片缓存起来。在分析了需求之后,小民放下心来,胸有成竹,在经历了10分钟的编码之后,小民写下了如下代码:
ImageLoader.java
package com.deason.library.srp;
import android.graphics.Bitmap;
import android.graphics.BitmapFactory;
import android.util.LruCache;
import android.widget.ImageView;
import java.io.IOException;
import java.net.HttpURLConnection;
import java.net.URL;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
/**
* 图片加载类
* Created by liuguoquan on 2016/3/13.
*/
public class ImageLoader {
/**
* 图片缓存
*/
LruCache<String, Bitmap> 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<String, Bitmap>(cacheSize) {
@Override
protected int sizeOf(String key, Bitmap value) {
return value.getRowBytes() * value.getHeight() / 1024;
}
};
}
/**
* 显示图片
* @param url
* @param imageView
*/
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);
}
}
});
}
/**
* 下载图片
* @param url
* @return
*/
public Bitmap downloadImage(String imageUrl) {
Bitmap bitmap = null;
try {
URL url = new URL(imageUrl);
HttpURLConnection mConnection = (HttpURLConnection) url.openConnection();
int code = mConnection.getResponseCode();
if (200 == code) {
bitmap = BitmapFactory.decodeStream(mConnection.getInputStream());
}
mConnection.disconnect();
} catch (IOException e) {
e.printStackTrace();
}
return bitmap;
}
}
随后,小民将代码托管到GitHub上,伴随着git push命令的完成,小民的ImageLoader 0.1版本就发布了。小民开始幻想着待会儿被主管称赞。
在小民给主管报告了ImageLoader发布消息的几分钟后,主管把小民叫到了会议室,叼了小民一顿:“小民,你的ImageLoader耦合太严重啦!简直就没有设计可言,更不要说是扩展性、灵活性了。所有功能写在一个类里面怎么行呢,这样随着功能的增多,ImageLoader类会越来越大。代码也越来越复杂,图片的加载系统就会越来越弱...”,此时,小民默默吞下了泪水。
主管最后说:“你还是把ImageLoader拆分一下,把各个功能独立出来,让它们满足单一职责原则。”小民敏锐的捕捉到单一职责原则这个关键词,他用百度、Google搜索了资料之后,决定对ImageLoader进行一次重构。这次小民认真地先画了一幅UML类图:
ImageLoader修改后的代码如下:
package com.deason.library.srp.refactor;
import android.graphics.Bitmap;
import android.graphics.BitmapFactory;
import android.widget.ImageView;
import java.io.IOException;
import java.net.HttpURLConnection;
import java.net.URL;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
/**
* 图片加载类
* Created by liuguoquan on 2016/3/14.
*/
public class ImageLoader {
/**
* 图片缓存
*/
ImageCache mImageCache = new ImageCache();
/**
* 线程池,线程数量未CPU的数量
*/
ExecutorService mExecutorService = Executors.newFixedThreadPool(Runtime.getRuntime()
.availableProcessors());
/**
* 显示图片
* @param url
* @param imageView
*/
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);
}
});
}
/**
* 下载图片
* @param url
* @return
*/
public Bitmap downloadImage(String imageUrl) {
Bitmap bitmap = null;
try {
URL url = new URL(imageUrl);
HttpURLConnection mConnection = (HttpURLConnection) url.openConnection();
int code = mConnection.getResponseCode();
if (200 == code) {
bitmap = BitmapFactory.decodeStream(mConnection.getInputStream());
}
mConnection.disconnect();
} catch (IOException e) {
e.printStackTrace();
}
return bitmap;
}
}
并且添加类一个ImageCache类用于图片缓存,具体代码如下:
package com.deason.library.srp.refactor;
import android.graphics.Bitmap;
import android.util.LruCache;
/**
* 处理图片缓存
* Created by liuguoquan on 2016/3/14.
*/
public class ImageCache {
/**
* 图片缓存
*/
LruCache<String, Bitmap> mImageCache;
public ImageCache() {
initImageCache();
}
private void initImageCache() {
//计算可使用的最大内存
final int maxMemory = (int) (Runtime.getRuntime().maxMemory() / 1024);
//取内存的四分之一作为缓存
final int cacheSize = maxMemory / 4;
mImageCache = new LruCache<String, Bitmap>(cacheSize) {
@Override
protected int sizeOf(String key, Bitmap value) {
return value.getRowBytes() * value.getHeight() / 1024;
}
};
}
/**
* 将图片存入缓存
* @param key
* @param bitmap
*/
public void put(String key,Bitmap bitmap) {
mImageCache.put(key,bitmap);
}
/**
* 取出缓存图片
* @param key
* @return
*/
public Bitmap get(String key) {
return mImageCache.get(key);
}
}
综上所述,小民将ImageLoader一拆为二,ImageLoader只负责图片加载的逻辑,而ImageCache只负责处理图片缓存的逻辑,这样ImageLoader的代码量变少了,职责也清晰了;当与缓存相关的逻辑需要改变时,不需要修改ImageLoader类,而图片加载的逻辑需要修改时也不会影响到缓存处理逻辑。
从上述例子我们知道,单一职责所表达出来的用意就是“单一”两个字。如何划分一个类、一个函数的职责,每个人都有自己的看法,这需要根据个人经验、具体的业务逻辑而定。但是,它也有一些基本的指导原则,例如,两个完全不一样的功能就不应该方法一个类中,一个类中应该是一组相关性很高的函数、数据的封装。工程师可以不断地审视自己的代码,根据具体的业务、功能对类进行相应的拆分,这是程序员优化代码迈出的第一步。
优点
- 类的复杂度降低,实现什么职责都有清晰的定义。
- 复杂性降低,所以可读性提高了。
- 可读性提高了,所以可维护性提高了
- 变更引起的风险降低,变更是必不可少的,如果接口的单一职责做得好,一个接口修改只对相应的实现类有影响,对其他的接口无影响,这对系统的扩展性、维护性都有很大的帮助。
参考资料
《Android源码设计模式》 何红辉、关爱民 著