单一职责原则(SRP)又称单一功能原则,为面向对象六大基本原则之一。
我们先来看一下官方是如何描述该原则的:
该原则是由罗伯特·C·马丁于《敏捷软件开发:原则、模式和实践》一书中给出。它规定一个类只应该只有一个发生变化的原因。所谓职责是指类变化的原因,如果一个类有多于一个的动机被改变,那么这个类就具有多于一个的职责,而单一职责原则就是指一个类或者模块应该只有一个改变的原因。
这样解释单一职责原则恐怕比较难以理解,我们可先通过实现一个图片加载器,并且将图片缓存起来的需求的例子来理解一下单一职责原则。
import android.graphics.Bitmap;
import android.graphics.BitmapFactory;
import android.util.LruCache;
import android.widget.ImageView;
import java.net.HttpURLConnection;
import java.net.URL;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import retrofit2.http.Url;
/**
* 图片加载类
*/
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);
//取可用内存的1/4
final int cachesize=maxMemory/4;
mImageCache=new LruCache(cachesize){
@Override
protected int sizeOf(String key, Bitmap bitmap) {
return bitmap.getRowBytes()*bitmap.getHeight()/1024;
}
};
}
/**
* 将下载的Bitmap对象显示在Imageview上
* @param url
* @param imageView
*/
public void displayBitmap(final String url, final ImageView imageView){
imageView.setTag(url);
mExecutorService.submit(new Runnable() {
@Override
public void run() {
Bitmap bitmap=downBitmap(url);
if(bitmap==null)
{
return;
}
if(imageView.getTag().equals(url))
{
imageView.setImageBitmap(bitmap);
}
mImageCache.put(url,bitmap);
}
});
}
/**
* 通过URL下载图片,并返回Bitmap
* @param imageUrl
* @return
*/
public Bitmap downBitmap(String imageUrl)
{
Bitmap bitmap=null;
try{
URL url=new URL(imageUrl);
final HttpURLConnection connection= (HttpURLConnection) url.openConnection();
bitmap= BitmapFactory.decodeStream(connection.getInputStream());
connection.disconnect();
}catch (Exception e)
{
e.printStackTrace();
}
return bitmap;
}
}
在这个类中我们实现了加载图片、设置缓存,下载图片三个基本功能。如此以来我们就实现了上文提出的需求。然而这样的代码仅仅适用于我们学习使用,在真实的正产环境当中由于需求会变的比较复杂,并且对可读性,扩展性、后期维护都会有这较高的要求,如果这样实现该功能,这个类会变得越来越大,代码也越来越复杂,图片加载系统也会越来越弱。这样写出的功能毫无设计可言,更不要说扩展性、灵活性了。所谓的单一职责原则,简单的来说就是一个类负责一个功能。我们在此原则的基础上对代码进行拆分重构。
ImageLoader类负责图片加载功能,重构后代码如下:
import android.graphics.Bitmap;
import android.graphics.BitmapFactory;
import android.util.LruCache;
import android.widget.ImageView;
import java.net.HttpURLConnection;
import java.net.URL;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import retrofit2.http.Url;
/**
* 图片加载类
*/
public class ImageLoader {
ImageCache mImageCache=new ImageCache();
//线程池,线程数量为CPU的数量
ExecutorService mExecutorService= Executors.newFixedThreadPool(Runtime.getRuntime().availableProcessors());
/**
* 将下载的Bitmap对象显示在Imageview上
* @param url
* @param imageView
*/
public void displayBitmap(final String url, final ImageView imageView){
imageView.setTag(url);
mExecutorService.submit(new Runnable() {
@Override
public void run() {
Bitmap bitmap=downBitmap(url);
if(bitmap==null)
{
return;
}
if(imageView.getTag().equals(url))
{
imageView.setImageBitmap(bitmap);
}
mImageCache.put(url,bitmap);
}
});
}
/**
* 通过URL下载图片,并返回Bitmap
* @param imageUrl
* @return
*/
public Bitmap downBitmap(String imageUrl)
{
Bitmap bitmap=null;
try{
URL url=new URL(imageUrl);
final HttpURLConnection connection= (HttpURLConnection) url.openConnection();
bitmap= BitmapFactory.decodeStream(connection.getInputStream());
connection.disconnect();
}catch (Exception e)
{
e.printStackTrace();
}
return bitmap;
}
}
ImageCache类负责图片缓存功能代码如下:
import android.graphics.Bitmap;
import android.graphics.BitmapFactory;
import android.util.LruCache;
import android.widget.ImageView;
import java.net.URL;
/**
* 图片加载类
*/
public class ImageCache {
LruCache mImageCache;
public ImageCache(){
initImageCache();
}
private void initImageCache()
{
//计算可以使用的最大内存
final int maxMemory= (int) (Runtime.getRuntime().maxMemory()/1024);
//取可用内存的1/4
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只负责图片加载的逻辑,新创建一个类ImageCache只负责处理图片缓存的逻辑,这样ImageLoader的代码量减少了,职责相对也变得更清晰了;当与缓存相关的逻辑需要修改时,图片加载的逻辑不需要改变,而图片加载逻辑需要改变时,也不会影响图片缓存的逻辑。
单一职责原则主要在于“单一”两个字,如何划分一个类,或者一个函数,每个人根据自己的经验和业务逻辑都有自己不同的看法。但他也有一些基本规则的,如两个完全不一样的功能不应该放在同一个类中。一个类中应该是一组相关性较强的函数或者数据的封装。我们要经常审视自己的代码,根据需要对类进行相应的拆分。单一职责原则是优化代码需要迈出的第一步。
参考文献:《Android源码设计模式解析与实战》 ----- 何红辉 关爱民 著