转至:http://blog.csdn.net/bboyfeiyu/article/details/50103471
- 本文出自《Android源码设计模式解析与实战》中的第一章。
1、优化代码的第一步——单一职责原则
单一职责原则的英文名称是Single Responsibility Principle,简称SRP。它的定义是:就一个类而言,应该仅有一个引起它变化的原因。简单来说,一个类中应该是一组相关性很高的函数、数据的封装。就像秦小波老师在《设计模式之禅》中说的:“这是一个备受争议却又及其重要的原则。只要你想和别人争执、怄气或者是吵架,这个原则是屡试不爽的”。因为单一职责的划分界限并不是总是那么清晰,很多时候都是需要靠个人经验来界定。当然,最大的问题就是对职责的定义,什么是类的职责,以及怎么划分类的职责。
对于计算机技术,通常只单纯地学习理论知识并不能很好地领会其深意,只有自己动手实践,并在实际运用中发现问题、解决问题、思考问题,才能够将知识吸收到自己的脑海中。下面以我的朋友小民的事迹说起。
自从Android系统发布以来,小民就是Android的铁杆粉丝,于是在大学期间一直保持着对Android的关注,并且利用课余时间做些小项目,锻炼自己的实战能力。毕业后,小民如愿地加入了心仪的公司,并且投入到了他热爱的Android应用开发行业中。将爱好、生活、事业融为一体,小民的第一份工作也算是顺风顺水,一切尽在掌握中。
在经历过一周的适应期以及熟悉公司的产品、开发规范之后,小民的开发工作就正式开始了。小民的主管是个工作经验丰富的技术专家,对于小民的工作并不是很满意,尤其小民最薄弱的面向对象设计,而Android开发又是使用Java语言,什么抽象、接口、六大原则、23种设计模式等名词把小民弄得晕头转向。小民自己也察觉到了自己的问题所在,于是,小民的主管决定先让小民做一个小项目来锻炼锻炼这方面的能力。正所谓养兵千日用兵一时,磨刀不误砍柴工,小民的开发之路才刚刚开始。
在经过一番思考之后,主管挑选了使用范围广、难度也适中的ImageLoader(图片加载)作为小民的训练项目。既然要训练小民的面向对象设计,那么就必须考虑到可扩展性、灵活性,而检测这一切是否符合需求的最好途径就是开源。用户不断地提出需求、反馈问题,小民的项目需要不断升级以满足用户需求,并且要保证系统的稳定性、灵活性。在主管跟小民说了这一特殊任务之后,小民第一次感到了压力,“生活不容易呐!”年仅22岁至今未婚的小民发出了如此深刻的感叹!
挑战总是要面对的,何况是从来不服输的小民。主管的要求很简单,要小民实现图片加载,并且要将图片缓存起来。在分析了需求之后,小民一下就放心下来了,“这么简单,原来我还以为很难呢……”小民胸有成足的喃喃自语。在经历了十分钟的编码之后,小民写下了如下代码:
<code class="language-java hljs has-numbering"><span class="hljs-javadoc">/** * 图片加载类 */</span> <span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">ImageLoader</span> {</span> <span class="hljs-comment">// 图片缓存</span> LruCache<String, Bitmap> mImageCache; <span class="hljs-comment">// 线程池,线程数量为CPU的数量</span> ExecutorService mExecutorService = Executors.newFixedThreadPool (Runtime.getRuntime().availableProcessors()); <span class="hljs-keyword">public</span> <span class="hljs-title">ImageLoader</span>() { initImageCache(); } <span class="hljs-keyword">private</span> <span class="hljs-keyword">void</span> <span class="hljs-title">initImageCache</span>() { <span class="hljs-comment">// 计算可使用的最大内存</span> <span class="hljs-keyword">final</span> <span class="hljs-keyword">int</span> maxMemory = (<span class="hljs-keyword">int</span>) (Runtime.getRuntime().maxMemory() / <span class="hljs-number">1024</span>); <span class="hljs-comment">// 取四分之一的可用内存作为缓存</span> <span class="hljs-keyword">final</span> <span class="hljs-keyword">int</span> cacheSize = maxMemory / <span class="hljs-number">4</span>; mImageCache = <span class="hljs-keyword">new</span> LruCache<String, Bitmap>(cacheSize) { <span class="hljs-annotation">@Override</span> <span class="hljs-keyword">protected</span> <span class="hljs-keyword">int</span> <span class="hljs-title">sizeOf</span>(String key, Bitmap bitmap) { <span class="hljs-keyword">return</span> bitmap.getRowBytes() * bitmap.getHeight() / <span class="hljs-number">1024</span>; } }; } <span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">displayImage</span>(<span class="hljs-keyword">final</span> String url, <span class="hljs-keyword">final</span> ImageView imageView) { imageView.setTag(url); mExecutorService.submit(<span class="hljs-keyword">new</span> Runnable() { <span class="hljs-annotation">@Override</span> <span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">run</span>() { Bitmap bitmap = downloadImage(url); <span class="hljs-keyword">if</span> (bitmap == <span class="hljs-keyword">null</span>) { <span class="hljs-keyword">return</span>; } <span class="hljs-keyword">if</span> (imageView.getTag().equals(url)) { imageView.setImageBitmap(bitmap); } mImageCache.put(url, bitmap); } }); } <span class="hljs-keyword">public</span> Bitmap <span class="hljs-title">downloadImage</span>(String imageUrl) { Bitmap bitmap = <span class="hljs-keyword">null</span>; <span class="hljs-keyword">try</span> { URL url = newURL(imageUrl); <span class="hljs-keyword">final</span> HttpURLConnection conn = (HttpURLConnection)url.openConnection(); bitmap = BitmapFactory.decodeStream( conn.getInputStream()); conn.disconnect(); } <span class="hljs-keyword">catch</span> (Exception e) { e.printStackTrace(); } <span class="hljs-keyword">return</span> bitmap; } }</code>
并且使用git软件进行版本控制,将工程托管到github上,伴随着git push命令的完成,小民的ImageLoader 0.1版本就正式发布了!如此短的时间内就完成了这个任务,而且还是一个开源项目,小民暗暗自喜,幻想着待会儿主管的称赞。
在小民给主管报告了ImageLoader的发布消息的几分钟之后,主管就把小民叫到了会议室。这下小民纳闷了,怎么夸人还需要到会议室。“小民,你的ImageLoader耦合太严重啦!简直就没有设计可言,更不要说扩展性、灵活性了。所有的功能都写在一个类里怎么行呢,这样随着功能的增多,ImageLoader类会越来越大,代码也越来越复杂,图片加载系统就越来越脆弱……”Duang,这简直就是当头棒喝,小民的脑海里已经听不清主管下面说的内容了,只是觉得自己之前没有考虑清楚就匆匆忙忙完成任务,而且把任务想得太简单了。
“你还是把ImageLoader拆分一下,把各个功能独立出来,让它们满足单一职责原则。”主管最后说道。小民是个聪明人,敏锐地捕捉到了单一职责原则这个关键词。用Google搜索了一些优秀资料之后总算是对单一职责原则有了一些认识。于是打算对ImageLoader进行一次重构。这次小民不敢过于草率,也是先画了一幅UML图,如图1-1所示。
图1-1
ImageLoader代码修改如下所示:
<code class="language-java hljs has-numbering"><span class="hljs-javadoc">/** * 图片加载类 */</span> <span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">ImageLoader</span> {</span> <span class="hljs-comment">// 图片缓存</span> ImageCache mImageCache = <span class="hljs-keyword">new</span> ImageCache() ; <span class="hljs-comment">// 线程池,线程数量为CPU的数量</span> ExecutorService mExecutorService = Executors.newFixedThreadPool (Runtime.getRuntime().availableProcessors()); <span class="hljs-comment">// 加载图片</span> <span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">displayImage</span>(<span class="hljs-keyword">final</span> String url, <span class="hljs-keyword">final</span> ImageView imageView) { Bitmap bitmap = mImageCache.get(url); <span class="hljs-keyword">if</span> (bitmap != <span class="hljs-keyword">null</span>) { imageView.setImageBitmap(bitmap); <span class="hljs-keyword">return</span>; } imageView.setTag(url); mExecutorService.submit(<span class="hljs-keyword">new</span> Runnable() { <span class="hljs-annotation">@Override</span> <span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">run</span>() { Bitmap bitmap = downloadImage(url); <span class="hljs-keyword">if</span> (bitmap == <span class="hljs-keyword">null</span>) { <span class="hljs-keyword">return</span>; } <span class="hljs-keyword">if</span> (imageView.getTag().equals(url)) { imageView.setImageBitmap(bitmap); } mImageCache.put(url, bitmap); } }); } <span class="hljs-keyword">public</span> Bitmap <span class="hljs-title">downloadImage</span>(String imageUrl) { Bitmap bitmap = <span class="hljs-keyword">null</span>; <span class="hljs-keyword">try</span> { URL url = <span class="hljs-keyword">new</span> URL(imageUrl); <span class="hljs-keyword">final</span> HttpURLConnection conn = (HttpURLConnection) url.openConnection(); bitmap = BitmapFactory.decodeStream(conn.getInputStream()); conn.disconnect(); } <span class="hljs-keyword">catch</span> (Exception e) { e.printStackTrace(); } <span class="hljs-keyword">return</span> bitmap; } } </code>
并且添加了一个ImageCache类用于处理图片缓存,具体代码如下:
<code class="language-java hljs has-numbering"><span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">ImageCache</span> {</span> <span class="hljs-comment">// 图片LRU缓存</span> LruCache<String, Bitmap> mImageCache; <span class="hljs-keyword">public</span> <span class="hljs-title">ImageCache</span>() { initImageCache(); } <span class="hljs-keyword">private</span> <span class="hljs-keyword">void</span> <span class="hljs-title">initImageCache</span>() { <span class="hljs-comment">// 计算可使用的最大内存</span> <span class="hljs-keyword">final</span> <span class="hljs-keyword">int</span> maxMemory = (<span class="hljs-keyword">int</span>) (Runtime.getRuntime().maxMemory() / <span class="hljs-number">1024</span>); <span class="hljs-comment">// 取四分之一的可用内存作为缓存</span> <span class="hljs-keyword">final</span> <span class="hljs-keyword">int</span> cacheSize = maxMemory / <span class="hljs-number">4</span>; mImageCache = <span class="hljs-keyword">new</span> LruCache<String, Bitmap>(cacheSize) { <span class="hljs-annotation">@Override</span> <span class="hljs-keyword">protected</span> <span class="hljs-keyword">int</span> <span class="hljs-title">sizeOf</span>(String key, Bitmap bitmap) { <span class="hljs-keyword">return</span> bitmap.getRowBytes() * bitmap.getHeight() / <span class="hljs-number">1024</span>; } }; } <span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">put</span>(String url, Bitmap bitmap) { mImageCache.put(url, bitmap) ; } <span class="hljs-keyword">public</span> Bitmap <span class="hljs-title">get</span>(String url) { <span class="hljs-keyword">return</span> mImageCache.get(url) ; } }</code>
如图1-1和上述代码所示,小民将ImageLoader一拆为二,ImageLoader只负责图片加载的逻辑,而ImageCache只负责处理图片缓存的逻辑,这样ImageLoader的代码量变少了,职责也清晰了,当与缓存相关的逻辑需要改变时,不需要修改ImageLoader类,而图片加载的逻辑需要修改时也不会影响到缓存处理逻辑。主管在审核了小民的第一次重构之后,对小民的工作给予了表扬,大致意思是结构变得清晰了许多,但是可扩展性还是比较欠缺,虽然没有得到主管的完全肯定,但也是颇有进步,再考虑到自己确实有所收获,小民原本沮丧的心里也略微地好转起来。
从上述的例子中我们能够体会到,单一职责所表达出的用意就是“单一”二字。正如上文所说,如何划分一个类、一个函数的职责,每个人都有自己的看法,这需要根据个人经验、具体的业务逻辑而定。但是,它也有一些基本的指导原则,例如,两个完全不一样的功能就不应该放在一个类中。一个类中应该是一组相关性很高的函数、数据的封装。工程师可以不断地审视自己的代码,根据具体的业务、功能对类进行相应的拆分,我想这会是你优化代码迈出的第一步。
2、让程序更稳定、更灵活——开闭原则
开闭原则的英文全称是Open Close Principle,简称OCP,它是Java世界里最基础的设计原则,它指导我们如何建立一个稳定的、灵活的系统。开闭原则的定义是:软件中的对象(类、模块、函数等)应该对于扩展是开放的,但是,对于修改是封闭的。在软件的生命周期内,因为变化、升级和维护等原因需要对软件原有代码进行修改时,可能会将错误引入原本已经经过测试的旧代码中,破坏原有系统。因此,当软件需要变化时,我们应该尽量通过扩展的方式来实现变化,而不是通过修改已有的代码来实现。当然,在现实开发中,只通过继承的方式来升级、维护原有系统只是一个理想化的愿景,因此,在实际的开发过程中,修改原有代码、扩展代码往往是同时存在的。
软件开发过程中,最不会变化的就是变化本身。产品需要不断地升级、维护,没有一个产品从第一版本开发完就再没有变化了,除非在下个版本诞生之前它已经被终止。而产品需要升级,修改原来的代码就可能会引发其他的问题。那么如何确保原有软件模块的正确性,以及尽量少地影响原有模块,答案就是尽量遵守本章要讲述的开闭原则。
勃兰特·梅耶在1988年出版的《面向对象软件构造》一书中提出这一原则。这一想法认为,一旦完成,一个类的实现只应该因错误而被修改,新的或者改变的特性应该通过新建不同的类实现。新建的类可以通过继承的方式来重用原类的代码。显然,梅耶的定义提倡实现继承,已存在的实现对于修改是封闭的,但是新的实现类可以通过覆写父类的接口应对变化。
说了这么多,想必大家还是半懂不懂,还是让我们以一个简单示例说明一下吧。
在对ImageLoader进行了一次重构之后,小民的这个开源库获得了一些用户。小民第一次感受到自己发明“*”的快感,对开源的热情也越发高涨起来!通过动手实现一些开源库来深入学习相关技术,不仅能够提升自我,也能更好地将这些技术运用到工作中,从而开发出更稳定、优秀的应用,这就是小民的真实想法。
小民第一轮重构之后的ImageLoader职责单一、结构清晰,不仅获得了主管的一点肯定,还得到了用户的夸奖,算是个不错的开始。随着用户的增多,有些问题也暴露出来了,小民的缓存系统就是大家“吐槽”最多的地方。通过内存缓存解决了每次从网络加载图片的问题,但是,Android应用的内存很有限,且具有易失性,即当应用重新启动之后,原来已经加载过的图片将会丢失,这样重启之后就需要重新下载!这又会导致加载缓慢、耗费用户流量的问题。小民考虑引入SD卡缓存,这样下载过的图片就会缓存到本地,即使重启应用也不需要重新下载了!小民在和主管讨论了该问题之后就投入了编程中,下面就是小民的代码。
DiskCache.java类,将图片缓存到SD卡中:
<code class="language-java hljs has-numbering"><span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">DiskCache</span> {</span> <span class="hljs-comment">// 为了简单起见临时写个路径,在开发中请避免这种写法 !</span> <span class="hljs-keyword">static</span> String cacheDir = <span class="hljs-string">"sdcard/cache/"</span>; <span class="hljs-comment">// 从缓存中获取图片</span> <span class="hljs-keyword">public</span> Bitmap <span class="hljs-title">get</span>(String url) { <span class="hljs-keyword">return</span> BitmapFactory.decodeFile(cacheDir + url); } <span class="hljs-comment">// 将图片缓存到内存中</span> <span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">put</span>(String url, Bitmap bmp) { FileOutputStream fileOutputStream = <span class="hljs-keyword">null</span>; <span class="hljs-keyword">try</span> { fileOutputStream = <span class="hljs-keyword">new</span> FileOutputStream(cacheDir + url); bmp.compress(CompressFormat.PNG, <span class="hljs-number">100</span>, fileOutputStream); } <span class="hljs-keyword">catch</span> (FileNotFoundException e) { e.printStackTrace(); } <span class="hljs-keyword">final</span> ly { <span class="hljs-keyword">if</span> (fileOutputStream != <span class="hljs-keyword">null</span>) { <span class="hljs-keyword">try</span> { fileOutputStream.close(); } <span class="hljs-keyword">catch</span> (IOException e) { e.printStackTrace(); } } } } }</code>
因为需要将图片缓存到SD卡中,所以,ImageLoader代码有所更新,具体代码如下:
<code class="language-java hljs has-numbering"><span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">ImageLoader</span> {</span> <span class="hljs-comment">// 内存缓存</span> ImageCache mImageCache = <span class="hljs-keyword">new</span> ImageCache(); <span class="hljs-comment">// SD卡缓存</span> DiskCache mDiskCache = <span class="hljs-keyword">new</span> DiskCache(); <span class="hljs-comment">// 是否使用SD卡缓存</span> <span class="hljs-keyword">boolean</span> isUseDiskCache = <span class="hljs-keyword">false</span>; <span class="hljs-comment">// 线程池,线程数量为CPU的数量</span> ExecutorService mExecutorService = Executors.newFixedThreadPool (Runtime.getRuntime().availableProcessors()); <span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">displayImage</span>(<span class="hljs-keyword">final</span> String url, <span class="hljs-keyword">final</span> ImageView imageView) { <span class="hljs-comment">// 判断使用哪种缓存</span> Bitmap bitmap = isUseDiskCache ? mDiskCache.get(url) : mImageCache.get (url); <span class="hljs-keyword">if</span> (bitmap != <span class="hljs-keyword">null</span>) { imageView.setImageBitmap(bitmap); <span class="hljs-keyword">return</span>; } <span class="hljs-comment">// 没有缓存,则提交给线程池进行下载</span> } <span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">useDiskCache</span>(<span class="hljs-keyword">boolean</span> useDiskCache) { isUseDiskCache = useDiskCache ; } }</code>
从上述的代码中可以看到,仅仅新增了一个DiskCache类和往ImageLoader类中加入了少量代码就添加了SD卡缓存的功能,用户可以通过useDiskCache方法来对使用哪种缓存进行设置,例如:
<code class="language-java hljs has-numbering">ImageLoader imageLoader = <span class="hljs-keyword">new</span> ImageLoader() ; <span class="hljs-comment">// 使用SD卡缓存</span> imageLoader.useDiskCache(<span class="hljs-keyword">true</span>); <span class="hljs-comment">// 使用内存缓存</span> imageLoader.useDiskCache(<span class="hljs-keyword">false</span>);</code>
通过useDiskCache方法可以让用户设置不同的缓存,非常方便啊!小民对此很满意,于是提交给主管做代码审核。“小民,你思路是对的,但是有些明显的问题,就是使用内存缓存时用户就不能使用SD卡缓存,类似的,使用SD卡缓存时用户就不能使用内存缓存。用户需要这两种策略的综合,首先缓存优先使用内存缓存,如果内存缓存没有图片再使用SD卡缓存,如果SD卡中也没有图片最后才从网络上获取,这才是最好的缓存策略。”主管真是一针见血,小民这时才如梦初醒,刚才还得意洋洋的脸上突然有些泛红……
于是小民按照主管的指点新建了一个双缓存类DoudleCache,具体代码如下:
<code class="language-java hljs has-numbering"><span class="hljs-javadoc">/** * 双缓存。获取图片时先从内存缓存中获取,如果内存中没有缓存该图片,再从SD卡中获取。 * 缓存图片也是在内存和SD卡中都缓存一份 */</span> <span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">DoubleCache</span> {</span> ImageCache mMemoryCache = <span class="hljs-keyword">new</span> ImageCache(); DiskCache mDiskCache = <span class="hljs-keyword">new</span> DiskCache(); <span class="hljs-comment">// 先从内存缓存中获取图片,如果没有,再从SD卡中获取</span> <span class="hljs-keyword">public</span> Bitmap <span class="hljs-title">get</span>(String url) { Bitmap bitmap = mMemoryCache.get(url); <span class="hljs-keyword">if</span> (bitmap == <span class="hljs-keyword">null</span>) { bitmap = mDiskCache.get(url); } <span class="hljs-keyword">return</span> bitmap; } <span class="hljs-comment">// 将图片缓存到内存和SD卡中</span> <span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">put</span>(String url, Bitmap bmp) { mMemoryCache.put(url, bmp); mDiskCache.put(url, bmp); } }</code>
我们再看看最新的ImageLoader类吧,代码更新也不多:
<code class="language-java hljs has-numbering"><span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">ImageLoader</span> {</span> <span class="hljs-comment">// 内存缓存</span> ImageCache mImageCache = <span class="hljs-keyword">new</span> ImageCache(); <span class="hljs-comment">// SD卡缓存</span> DiskCache mDiskCache = <span class="hljs-keyword">new</span> DiskCache(); <span class="hljs-comment">// 双缓存</span> DoubleCache mDoubleCache = <span class="hljs-keyword">new</span> DoubleCache() ; <span class="hljs-comment">// 使用SD卡缓存</span> <span class="hljs-keyword">boolean</span> isUseDiskCache = <span class="hljs-keyword">false</span>; <span class="hljs-comment">// 使用双缓存</span> <span class="hljs-keyword">boolean</span> isUseDoubleCache = <span class="hljs-keyword">false</span>; <span class="hljs-comment">// 线程池,线程数量为CPU的数量</span> ExecutorService mExecutorService = Executors.newFixedThreadPool (Runtime.getRuntime().availableProcessors()); <span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">displayImage</span>(<span class="hljs-keyword">final</span> String url, <span class="hljs-keyword">final</span> ImageView imageView) { Bitmap bmp = <span class="hljs-keyword">null</span>; <span class="hljs-keyword">if</span> (isUseDoubleCache) { bmp = mDoubleCache.get(url); } <span class="hljs-keyword">else</span> <span class="hljs-keyword">if</span> (isUseDiskCache) { bmp = mDiskCache.get(url); } <span class="hljs-keyword">else</span> { bmp = mImageCache.get(url); } <span class="hljs-keyword">if</span> ( bmp != <span class="hljs-keyword">null</span> ) { imageView.setImageBitmap(bmp); } <span class="hljs-comment">// 没有缓存,则提交给线程池进行异步下载图片</span> } <span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">useDiskCache</span>(<span class="hljs-keyword">boolean</span> useDiskCache) { isUseDiskCache = useDiskCache ; } <span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">useDoubleCache</span>(<span class="hljs-keyword">boolean</span> useDoubleCache) { isUseDoubleCache = useDoubleCache ; } }</code>
通过增加短短几句代码和几处修改就完成了如此重要的功能。小民已越发觉得自己Android开发已经到了的得心应手的境地,不仅感觉一阵春风袭来,他那飘逸的头发一下从他的眼前拂过,小民感觉今天天空比往常敞亮许多。
“小民,你每次加新的缓存方法时都要修改原来的代码,这样很可能会引入Bug,而且会使原来的代码逻辑变得越来越复杂,按照你这样的方法实现,用户也不能自定义缓存实现呀!”到底是主管水平高,一语道出了小民这缓存设计上的问题。
我们还是来分析一下小民的程序,小民每次在程序中加入新的缓存实现时都需要修改ImageLoader类,然后通过一个布尔变量来让用户使用哪种缓存,因此,就使得在ImageLoader中存在各种if-else判断,通过这些判断来确定使用哪种缓存。随着这些逻辑的引入,代码变得越来越复杂、脆弱,如果小民一不小心写错了某个if条件(条件太多,这是很容易出现的),那就需要更多的时间来排除。整个ImageLoader类也会变得越来越臃肿。最重要的是用户不能自己实现缓存注入到ImageLoader中,可扩展性可是框架的最重要特性之一。
“软件中的对象(类、模块、函数等)应该对于扩展是开放的,但是对于修改是封闭的,这就是开放-关闭原则。也就是说,当软件需要变化时,我们应该尽量通过扩展的方式来实现变化,而不是通过修改已有的代码来实现。”小民的主管补充到,小民听得云里雾里的。主管看小民这等反应,于是亲自“操刀”,为他画下了如图1-2的UML图。
图1-2
小民看到图1-2似乎明白些什么,但是又不是太明确如何修改程序。主管看到小民这般模样只好亲自上阵,带着小民把ImageLoader程序按照图1-2进行了一次重构。具体代码如下:
<code class="language-java hljs has-numbering"><span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">ImageLoader</span> {</span> <span class="hljs-comment">// 图片缓存</span> ImageCache mImageCache = <span class="hljs-keyword">new</span> MemoryCache(); <span class="hljs-comment">// 线程池,线程数量为CPU的数量</span> ExecutorService mExecutorService = Executors.newFixedThreadPool (Runtime.getRuntime().availableProcessors()); <span class="hljs-comment">// 注入缓存实现</span> <span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">setImageCache</span>(ImageCache cache) { mImageCache = cache; } <span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">displayImage</span>(String imageUrl, ImageView imageView) { Bitmap bitmap = mImageCache.get(imageUrl); <span class="hljs-keyword">if</span> (bitmap != <span class="hljs-keyword">null</span>) { imageView.setImageBitmap(bitmap); <span class="hljs-keyword">return</span>; } <span class="hljs-comment">// 图片没缓存,提交到线程池中下载图片</span> submitLoadRequest(imageUrl, imageView); } <span class="hljs-keyword">private</span> <span class="hljs-keyword">void</span> <span class="hljs-title">submitLoadRequest</span>(<span class="hljs-keyword">final</span> String imageUrl, <span class="hljs-keyword">final</span> ImageView imageView) { imageView.setTag(imageUrl); mExecutorService.submit(<span class="hljs-keyword">new</span> Runnable() { <span class="hljs-annotation">@Override</span> <span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">run</span>() { Bitmap bitmap = downloadImage(imageUrl); <span class="hljs-keyword">if</span> (bitmap == <span class="hljs-keyword">null</span>) { <span class="hljs-keyword">return</span>; } <span class="hljs-keyword">if</span> (imageView.getTag().equals(imageUrl)) { imageView.setImageBitmap(bitmap); } mImageCache.put(imageUrl, bitmap); } }); } <span class="hljs-keyword">public</span> Bitmap <span class="hljs-title">downloadImage</span>(String imageUrl) { Bitmap bitmap = <span class="hljs-keyword">null</span>; <span class="hljs-keyword">try</span> { URL url = <span class="hljs-keyword">new</span> URL(imageUrl); <span class="hljs-keyword">final</span> HttpURLConnection conn = (HttpURLConnection) url.openConnection(); bitmap = BitmapFactory.decodeStream(conn.getInputStream()); conn.disconnect(); } <span class="hljs-keyword">catch</span> (Exception e) { e.printStackTrace(); } <span class="hljs-keyword">return</span> bitmap; } }</code>
经过这次重构,没有了那么多的if-else语句,没有了各种各样的缓存实现对象、布尔变量,代码确实清晰、简单了很多,小民对主管的崇敬之情又“泛滥”了起来。需要注意的是,这里的ImageCache类并不是小民原来的那个ImageCache,这次程序重构主管把它提取成一个图片缓存的接口,用来抽象图片缓存的功能。我们看看该接口的声明:
<code class="language-java hljs has-numbering"><span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">interface</span> <span class="hljs-title">ImageCache</span> {</span> <span class="hljs-keyword">public</span> Bitmap <span class="hljs-title">get</span>(String url); <span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">put</span>(String url, Bitmap bmp); }</code>
ImageCache接口简单定义了获取、缓存图片两个函数,缓存的key是图片的url,值是图片本身。内存缓存、SD卡缓存、双缓存都实现了该接口,我们看看这几个缓存实现:
<code class="language-java hljs has-numbering"><span class="hljs-comment">// 内存缓存MemoryCache类</span> <span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MemoryCache</span> <span class="hljs-keyword">implements</span> <span class="hljs-title">ImageCache</span> {</span> <span class="hljs-keyword">private</span> LruCache<String, Bitmap> mMemeryCache; <span class="hljs-keyword">public</span> <span class="hljs-title">MemoryCache</span>() { <span class="hljs-comment">// 初始化LRU缓存</span> } <span class="hljs-annotation">@Override</span> <span class="hljs-keyword">public</span> Bitmap <span class="hljs-title">get</span>(String url) { <span class="hljs-keyword">return</span> mMemeryCache.get(url); } <span class="hljs-annotation">@Override</span> <span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">put</span>(String url, Bitmap bmp) { mMemeryCache.put(url, bmp); } } <span class="hljs-comment">// SD卡缓存DiskCache类</span> <span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">DiskCache</span> <span class="hljs-keyword">implements</span> <span class="hljs-title">ImageCache</span> {</span> <span class="hljs-annotation">@Override</span> <span class="hljs-keyword">public</span> Bitmap <span class="hljs-title">get</span>(String url) { <span class="hljs-keyword">return</span> <span class="hljs-keyword">null</span><span class="hljs-comment">/* 从本地文件中获取该图片 */</span>; } <span class="hljs-annotation">@Override</span> <span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">put</span>(String url, Bitmap bmp) { <span class="hljs-comment">// 将Bitmap写入文件中</span> } } <span class="hljs-comment">// 双缓存DoubleCache类</span> <span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">DoubleCache</span> <span class="hljs-keyword">implements</span> <span class="hljs-title">ImageCache</span>{</span> ImageCache mMemoryCache = <span class="hljs-keyword">new</span> MemoryCache(); ImageCache mDiskCache = <span class="hljs-keyword">new</span> DiskCache(); <span class="hljs-comment">// 先从内存缓存中获取图片,如果没有,再从SD卡中获取</span> <span class="hljs-keyword">public</span> Bitmap <span class="hljs-title">get</span>(String url) { Bitmap bitmap = mMemoryCache.get(url); <span class="hljs-keyword">if</span> (bitmap == <span class="hljs-keyword">null</span>) { bitmap = mDiskCache.get(url); } <span class="hljs-keyword">return</span> bitmap; } <span class="hljs-comment">// 将图片缓存到内存和SD卡中</span> <span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">put</span>(String url, Bitmap bmp) { mMemoryCache.put(url, bmp); mDiskCache.put(url, bmp); } }</code>
细心的朋友可能注意到了,ImageLoader类中增加了一个setImageCache(ImageCache cache)函数,用户可以通过该函数设置缓存实现,也就是通常说的依赖注入。下面就看看用户是如何设置缓存实现的:
<code class="language-java hljs has-numbering">ImageLoader imageLoader = <span class="hljs-keyword">new</span> ImageLoader() ; <span class="hljs-comment">// 使用内存缓存</span> imageLoader.setImageCache(<span class="hljs-keyword">new</span> MemoryCache()); <span class="hljs-comment">// 使用SD卡缓存</span> imageLoader.setImageCache(<span class="hljs-keyword">new</span> DiskCache()); <span class="hljs-comment">// 使用双缓存</span> imageLoader.setImageCache(<span class="hljs-keyword">new</span> DoubleCache()); <span class="hljs-comment">// 使用自定义的图片缓存实现</span> imageLoader.setImageCache(<span class="hljs-keyword">new</span> ImageCache() { <span class="hljs-annotation">@Override</span> <span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">put</span>(String url, Bitmap bmp) { <span class="hljs-comment">// 缓存图片</span> } <span class="hljs-annotation">@Override</span> <span class="hljs-keyword">public</span> Bitmap <span class="hljs-title">get</span>(String url) { <span class="hljs-keyword">return</span> <span class="hljs-keyword">null</span><span class="hljs-comment">/*从缓存中获取图片*/</span>; } });</code>
在上述代码中,通过setImageCache(ImageCache cache)方法注入不同的缓存实现,这样不仅能够使ImageLoader更简单、健壮,也使得ImageLoader的可扩展性、灵活性更高。MemoryCache、DiskCache、DoubleCache缓存图片的具体实现完全不一样,但是,它们的一个特点是都实现了ImageCache接口。当用户需要自定义实现缓存策略时,只需要新建一个实现ImageCache接口的类,然后构造该类的对象,并且通过setImageCache(ImageCache cache)注入到ImageLoader中,这样ImageLoader就实现了变化万千的缓存策略,而扩展这些缓存策略并不会导致ImageLoader类的修改。经过这次重构,小民的ImageLoader已经基本算合格了。咦!这不就是主管说的开闭原则么!“软件中的对象(类、模块、函数等)应该对于扩展是开放的,但是对于修改是封闭的。而遵循开闭原则的重要手段应该是通过抽象……”小民细声细语的念叨中,陷入了思索中……
开闭原则指导我们,当软件需要变化时,应该尽量通过扩展的方式来实现变化,而不是通过修改已有的代码来实现。这里的“应该尽量”4个字说明OCP原则并不是说绝对不可以修改原始类的,当我们嗅到原来的代码“腐化气味”时,应该尽早地重构,以使得代码恢复到正常的“进化”轨道,而不是通过继承等方式添加新的实现,这会导致类型的膨胀以及历史遗留代码的冗余。我们的开发过程中也没有那么理想化的状况,完全地不用修改原来的代码,因此,在开发过程中需要自己结合具体情况进行考量,是通过修改旧代码还是通过继承使得软件系统更稳定、更灵活,在保证去除“代码腐化”的同时,也保证原有模块的正确性。
3、构建扩展性更好的系统——里氏替换原则
里氏替换原则英文全称是Liskov Substitution Principle,简称LSP。它的第一种定义是:如果对每一个类型为S的对象o1,都有类型为T的对象o2,使得以T定义的所有程序P在所有的对象o1都代换成o2时,程序P的行为没有发生变化,那么类型S是类型T的子类型。上面这种描述确实不太好理解,理论家有时候容易把问题抽象化,本来挺容易理解的事让他们一概括就弄得拗口了。我们再看看另一个直截了当的定义。里氏替换原则第二种定义:所有引用基类的地方必须能透明地使用其子类的对象。
我们知道,面向对象的语言的三大特点是继承、封装、多态,里氏替换原则就是依赖于继承、多态这两大特性。里氏替换原则简单来说就是,所有引用基类的地方必须能透明地使用其子类的对象。通俗点讲,只要父类能出现的地方子类就可以出现,而且替换为子类也不会产生任何错误或异常,使用者可能根本就不需要知道是父类还是子类。但是,反过来就不行了,有子类出现的地方,父类未必就能适应。说了那么多,其实最终总结就两个字:抽象。
小民为了深入地了解Android中的Window与View的关系特意写了一个简单示例,为了便于理解,我们先看如图1-3所示。
▲图1-3
我们看看具体的代码:
<code class="language-java hljs has-numbering"><span class="hljs-comment">// 窗口类</span> <span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">Window</span> {</span> <span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">show</span>(View child){ child.draw(); } } <span class="hljs-comment">// 建立视图抽象,测量视图的宽高为公用代码,绘制交给具体的子类</span> <span class="hljs-keyword">public</span> <span class="hljs-keyword">abstract</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">View</span> {</span> <span class="hljs-keyword">public</span> <span class="hljs-keyword">abstract</span> <span class="hljs-keyword">void</span> <span class="hljs-title">draw</span>() ; <span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">measure</span>(<span class="hljs-keyword">int</span> width, <span class="hljs-keyword">int</span> height){ <span class="hljs-comment">// 测量视图大小</span> } } <span class="hljs-comment">// 按钮类的具体实现</span> <span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">Button</span> <span class="hljs-keyword">extends</span> <span class="hljs-title">View</span> {</span> <span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">draw</span>(){ <span class="hljs-comment">// 绘制按钮</span> } } <span class="hljs-comment">// TextView的具体实现</span> <span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">TextView</span> <span class="hljs-keyword">extends</span> <span class="hljs-title">View</span> {</span> <span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">draw</span>(){ <span class="hljs-comment">// 绘制文本</span> } }</code>
上述示例中,Window依赖于View,而View定义了一个视图抽象,measure是各个子类共享的方法,子类通过覆写View的draw方法实现具有各自特色的功能,在这里,这个功能就是绘制自身的内容。任何继承自View类的子类都可以设置给show方法,也就我们所说的里氏替换。通过里氏替换,就可以自定义各式各样、千变万化的View,然后传递给Window,Window负责组织View,并且将View显示到屏幕上。
里氏替换原则的核心原理是抽象,抽象又依赖于继承这个特性,在OOP当中,继承的优缺点都相当明显。
优点如下:
- (1)代码重用,减少创建类的成本,每个子类都拥有父类的方法和属性;
- (2)子类与父类基本相似,但又与父类有所区别;
- (3)提高代码的可扩展性。
继承的缺点:
- (1)继承是侵入性的,只要继承就必须拥有父类的所有属性和方法;
- (2)可能造成子类代码冗余、灵活性降低,因为子类必须拥有父类的属性和方法。
事物总是具有两面性,如何权衡利与弊都是需要根据具体场景来做出选择并加以处理。里氏替换原则指导我们构建扩展性更好的软件系统,我们还是接着上面的ImageLoader来做说明。
上文的图1-2也很好地反应了里氏替换原则,即MemoryCache、DiskCache、DoubleCache都可以替换ImageCache的工作,并且能够保证行为的正确性。ImageCache建立了获取缓存图片、保存缓存图片的接口规范,MemoryCache等根据接口规范实现了相应的功能,用户只需要在使用时指定具体的缓存对象就可以动态地替换ImageLoader中的缓存策略。这就使得ImageLoader的缓存系统具有了无线的可能性,也就是保证了可扩展性。
想象一个场景,当ImageLoader中的setImageCache(ImageCache cache)中的cache对象不能够被子类所替换,那么用户如何设置不同的缓存对象以及用户如何自定义自己的缓存实现,通过1.3节中的useDiskCache方法吗?显然不是的,里氏替换原则就为这类问题提供了指导原则,也就是建立抽象,通过抽象建立规范,具体的实现在运行时替换掉抽象,保证系统的高扩展性、灵活性。开闭原则和里氏替换原则往往是生死相依、不弃不离的,通过里氏替换来达到对扩展开放,对修改关闭的效果。然而,这两个原则都同时强调了一个OOP的重要特性——抽象,因此,在开发过程中运用抽象是走向代码优化的重要一步。
4、 让项目拥有变化的能力——依赖倒置原则
依赖倒置原则英文全称是Dependence Inversion Principle,简称DIP。依赖反转原则指代了一种特定的解耦形式,使得高层次的模块不依赖于低层次的模块的实现细节的目的,依赖模块被颠倒了。这个概念有点不好理解,这到底是什么意思呢?
依赖倒置原则的几个关键点:
- (1)高层模块不应该依赖低层模块,两者都应该依赖其抽象;
- (2)抽象不应该依赖细节;
- (3)细节应该依赖抽象。
在Java语言中,抽象就是指接口或抽象类,两者都是不能直接被实例化的;细节就是实现类,实现接口或继承抽象类而产生的类就是细节,其特点就是,可以直接被实例化,也就是可以加上一个关键字 new 产生一个对象。高层模块就是调用端,低层模块就是具体实现类。依赖倒置原则在 Java 语言中的表现就是:模块间的依赖通过抽象发生,实现类之间不发生直接的依赖关系,其依赖关系是通过接口或抽象类产生的。这又是一个将理论抽象化的实例,其实一句话就可以概括:面向接口编程,或者说是面向抽象编程,这里的抽象指的是接口或者抽象类。面向接口编程是面向对象精髓之一,也就是上面两节强调的抽象。
如果在类与类直接依赖于细节,那么它们之间就有直接的耦合,当具体实现需要变化时,意味着在这要同时修改依赖者的代码,并且限制了系统的可扩展性。我们看1.3节的图1-3中,ImageLoader直接依赖于MemoryCache,这个MemoryCache是一个具体实现,而不是一个抽象类或者接口。这导致了ImageLoader直接依赖了具体细节,当MemoryCache不能满足ImageLoader而需要被其他缓存实现替换时,此时就必须修改ImageLoader的代码,例如:
<code class="language-java hljs has-numbering"><span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">ImageLoader</span> {</span> <span class="hljs-comment">// 内存缓存 ( 直接依赖于细节 )</span> MemoryCache mMemoryCache = <span class="hljs-keyword">new</span> MemoryCache(); <span class="hljs-comment">// 加载图片到ImageView中</span> <span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">displayImage</span>(String url, ImageView imageView) { Bitmap bmp = mMemoryCache.get(url); <span class="hljs-keyword">if</span> (bmp == <span class="hljs-keyword">null</span>) { downloadImage(url, imageView); } <span class="hljs-keyword">else</span> { imageView.setImageBitmap(bmp); } } <span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">setImageCache</span>(MemoryCache cache) { mCache = cache ; } <span class="hljs-comment">// 代码省略</span> }</code>
随着产品的升级,用户发现MemoryCache已经不能满足需求,用户需要小民的ImageLoader可以将图片同时缓存到内存和SD卡中,或者可以让用户自定义实现缓存。此时,我们的MemoryCache这个类名不仅不能够表达内存缓存和SD卡缓存的意义,也不能够满足功能。另外,用户需要自定义缓存实现时还必须继承自MemoryCache,而用户的缓存实现可不一定与内存缓存有关,这在命名上的限制也让用户体验不好。重构的时候到了!小民的第一种方案是将MemoryCache修改为DoubleCache,然后在DoubleCache中实现具体的缓存功能。我们需要将ImageLoader修改如下:
<code class="language-java hljs has-numbering"><span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">ImageLoader</span> {</span> <span class="hljs-comment">// 双缓存 ( 直接依赖于细节 )</span> DoubleCache mCache = <span class="hljs-keyword">new</span> DoubleCache(); <span class="hljs-comment">// 加载图片到ImageView中</span> <span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">displayImage</span>(String url, ImageView imageView) { Bitmap bmp = mCache.get(url); <span class="hljs-keyword">if</span> (bmp == <span class="hljs-keyword">null</span>) { <span class="hljs-comment">// 异步下载图片</span> downloadImageAsync(url, imageView); } <span class="hljs-keyword">else</span> { imageView.setImageBitmap(bmp); } } <span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">setImageCache</span>(DoubleCache cache) { mCache = cache ; } <span class="hljs-comment">// 代码省略</span> }</code>
我们将MemoryCache修改成DoubleCache,然后修改了ImageLoader中缓存类的具体实现,轻轻松松就满足了用户需求。等等!这不还是依赖于具体的实现类(DoubleCache)吗?当用户的需求再次变化时,我们又要通过修改缓存实现类和ImageLoader代码来实现?修改原有代码不是违反了1.3节中的开闭原则吗?小民突然醒悟了过来,低下头思索着如何才能让缓存系统更灵活、拥抱变化……
当然,这些都是在主管给出图1-2(1.3节)以及相应的代码之前,小民体验的煎熬过程。既然是这样,那显然主管给出的解决方案就能够让缓存系统更加灵活。一句话概括起来就是:依赖抽象,而不依赖具体实现。针对于图片缓存,主管建立的ImageCache抽象,该抽象中增加了get和put方法用以实现图片的存取。每种缓存实现都必须实现这个接口,并且实现自己的存取方法。当用户需要使用不同的缓存实现时,直接通过依赖注入即可,保证了系统的灵活性。我们再来简单回顾一下相关代码:
ImageCache缓存抽象:
<code class="language-java hljs has-numbering"><span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">interface</span> <span class="hljs-title">ImageCache</span> {</span> <span class="hljs-keyword">public</span> Bitmap <span class="hljs-title">get</span>(String url); <span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">put</span>(String url, Bitmap bmp); }</code>
ImageLoader类:
<code class="language-java hljs has-numbering"><span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">ImageLoader</span> {</span> <span class="hljs-comment">// 图片缓存类,依赖于抽象,并且有一个默认的实现</span> ImageCache mCache = <span class="hljs-keyword">new</span> MemoryCache(); <span class="hljs-comment">// 加载图片</span> <span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">displayImage</span>(String url, ImageView imageView) { Bitmap bmp = mCache.get(url); <span class="hljs-keyword">if</span> (bmp == <span class="hljs-keyword">null</span>) { <span class="hljs-comment">// 异步加载图片</span> downloadImageAsync(url, imageView); } <span class="hljs-keyword">else</span> { imageView.setImageBitmap(bmp); } } <span class="hljs-javadoc">/** * 设置缓存策略,依赖于抽象 */</span> <span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">setImageCache</span>(ImageCache cache) { mCache = cache; } <span class="hljs-comment">// 代码省略</span> }</code>
在这里,我们建立了ImageCache抽象,并且让ImageLoader依赖于抽象而不是具体细节。当需求发生变更时,小民只需要实现ImageCahce类或者继承其他已有的ImageCache子类完成相应的缓存功能,然后将具体的实现注入到ImageLoader即可实现缓存功能的替换,这就保证了缓存系统的高可扩展性,拥有了拥抱变化的能力,而这一切的基本指导原则就是我们的依赖倒置原则。从上述几节中我们发现,要想让我们的系统更为灵活,抽象似乎成了我们唯一的手段。
5、系统有更高的灵活性——接口隔离原则
接口隔离原则英文全称是InterfaceSegregation Principles,简称ISP。它的定义是:客户端不应该依赖它不需要的接口。另一种定义是:类间的依赖关系应该建立在最小的接口上。接口隔离原则将非常庞大、臃肿的接口拆分成为更小的和更具体的接口,这样客户将会只需要知道他们感兴趣的方法。接口隔离原则的目的是系统解开耦合,从而容易重构、更改和重新部署。
接口隔离原则说白了就是,让客户端依赖的接口尽可能地小,这样说可能还是有点抽象,我们还是以一个示例来说明一下。在此之前我们来说一个场景,在Java 6以及之前的JDK版本,有一个非常讨厌的问题,那就是在使用了OutputStream或者其他可关闭的对象之后,我们必须保证它们最终被关闭了,我们的SD卡缓存类中就有这样的代码:
<code class="language-java hljs has-numbering"><span class="hljs-comment">// 将图片缓存到内存中</span> <span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">put</span>(String url, Bitmap bmp) { FileOutputStream fileOutputStream = <span class="hljs-keyword">null</span>; <span class="hljs-keyword">try</span> { fileOutputStream = <span class="hljs-keyword">new</span> FileOutputStream(cacheDir + url); bmp.compress(CompressFormat.PNG, <span class="hljs-number">100</span>, fileOutputStream); } <span class="hljs-keyword">catch</span> (FileNotFoundException e) { e.printStackTrace(); } <span class="hljs-keyword">finally</span> { <span class="hljs-keyword">if</span> (fileOutputStream != <span class="hljs-keyword">null</span>) { <span class="hljs-keyword">try</span> { fileOutputStream.close(); } <span class="hljs-keyword">catch</span> (IOException e) { e.printStackTrace(); } } <span class="hljs-comment">// end if</span> } <span class="hljs-comment">// end if finally</span> }</code>
我们看到的这段代码可读性非常差,各种try…catch嵌套,都是些简单的代码,但是会严重影响代码的可读性,并且多层级的大括号很容易将代码写到错误的层级中。大家应该对这类代码也非常反感,那我们看看如何解决这类问题。
我们可能知道Java中有一个Closeable接口,该接口标识了一个可关闭的对象,它只有一个close方法,如图1-4所示。
我们要讲的FileOutputStream类就实现了这个接口,我们从图1-4中可以看到,还有一百多个类实现了Closeable这个接口,这意味着,在关闭这一百多个类型的对象时,都需要写出像put方法中finally代码段那样的代码。这还了得!你能忍,反正小民是忍不了的!于是小民打算要发挥他的聪明才智解决这个问题,既然都是实现了Closeable接口,那只要我建一个方法统一来关闭这些对象不就可以了么?说干就干,于是小民写下来如下的工具类:
▲图1-4
<code class="language-java hljs has-numbering"><span class="hljs-keyword">public</span> <span class="hljs-keyword">final</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">CloseUtils</span> {</span> Private CloseUtils() { } <span class="hljs-javadoc">/** * 关闭Closeable对象 *<span class="hljs-javadoctag"> @param</span> closeable */</span> <span class="hljs-keyword">public</span> <span class="hljs-keyword">static</span> <span class="hljs-keyword">void</span> <span class="hljs-title">closeQuietly</span>(Closeable closeable) { <span class="hljs-keyword">if</span> (<span class="hljs-keyword">null</span> != closeable) { <span class="hljs-keyword">try</span> { closeable.close(); } <span class="hljs-keyword">catch</span> (IOException e) { e.printStackTrace(); } } } }</code>
我们再看看把这段代码运用到上述的put方法中的效果如何:
<code class="language-java hljs has-numbering"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">put</span>(String url, Bitmap bmp) { FileOutputStream fileOutputStream = <span class="hljs-keyword">null</span>; <span class="hljs-keyword">try</span> { fileOutputStream = <span class="hljs-keyword">new</span> FileOutputStream(cacheDir + url); bmp.compress(CompressFormat.PNG, <span class="hljs-number">100</span>, fileOutputStream); } <span class="hljs-keyword">catch</span> (FileNotFoundException e) { e.printStackTrace(); } <span class="hljs-keyword">final</span> ly { CloseUtils.closeQuietly(fileOutputStream); } }</code>
代码简洁了很多!而且这个closeQuietly方法可以运用到各类可关闭的对象中,保证了代码的重用性。CloseUtils的closeQuietly方法的基本原理就是依赖于Closeable抽象而不是具体实现(这不是1.4节中的依赖倒置原则么),并且建立在最小化依赖原则的基础,它只需要知道这个对象是可关闭,其他的一概不关心,也就是这里的接口隔离原则。
试想一下,如果在只是需要关闭一个对象时,它却暴露出了其他的接口函数,比如OutputStream的write方法,这就使得更多的细节暴露在客户端代码面前,不仅没有很好地隐藏实现,还增加了接口的使用难度。而通过Closeable接口将可关闭的对象抽象起来,这样只需要客户端依赖于Closeable就可以对客户端隐藏其他的接口信息,客户端代码只需要知道这个对象可关闭(只可调用close方法)即可。小民ImageLoader中的ImageCache就是接口隔离原则的运用,ImageLoader只需要知道该缓存对象有存、取缓存图片的接口即可,其他的一概不管,这就使得缓存功能的具体实现对ImageLoader具体的隐藏。这就是用最小化接口隔离了实现类的细节,也促使我们将庞大的接口拆分到更细粒度的接口当中,这使得我们的系统具有更低的耦合性,更高的灵活性。
Bob大叔(Robert C Martin)在21世纪早期将单一职责、开闭原则、里氏替换、接口隔离以及依赖倒置(也称为依赖反转)5个原则定义为SOLID原则,指代了面向对象编程的5个基本原则。当这些原则被一起应用时,它们使得一个软件系统更清晰、简单、最大程度地拥抱变化。SOLID被典型地应用在测试驱动开发上,并且是敏捷开发以及自适应软件开发基本原则的重要组成部分。在经过第1.1~1.5节的学习之后,我们发现这几大原则最终就可以化为这几个关键词:抽象、单一职责、最小化。那么在实际开发过程中如何权衡、实践这些原则,是大家需要在实践中多思考与领悟,正所谓”学而不思则罔,思而不学则殆”,只有不断地学习、实践、思考,才能够在积累的过程有一个质的飞越。
6、更好的可扩展性——迪米特原则
迪米特原则英文全称为Law of Demeter,简称LOD,也称为最少知识原则(Least Knowledge Principle)。虽然名字不同,但描述的是同一个原则:一个对象应该对其他对象有最少的了解。通俗地讲,一个类应该对自己需要耦合或调用的类知道得最少,类的内部如何实现、如何复杂都与调用者或者依赖者没关系,调用者或者依赖者只需要知道他需要的方法即可,其他的我一概不关心。类与类之间的关系越密切,耦合度越大,当一个类发生改变时,对另一个类的影响也越大。
迪米特法则还有一个英文解释是:Only talk to your immedate friends,翻译过来就是:只与直接的朋友通信。什么叫做直接的朋友呢?每个对象都必然会与其他对象有耦合关系,两个对象之间的耦合就成为朋友关系,这种关系的类型有很多,例如组合、聚合、依赖等。
光说不练很抽象呐,下面我们就以租房为例来讲讲迪米特原则。
“北漂”的同学比较了解,在北京租房绝大多数都是通过中介找房。我们设定的情境为:我只要求房间的面积和租金,其他的一概不管,中介将符合我要求的房子提供给我就可以。下面我们看看这个示例:
<code class="language-java hljs has-numbering"><span class="hljs-javadoc">/** * 房间 */</span> <span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">Room</span> {</span> <span class="hljs-keyword">public</span> <span class="hljs-keyword">float</span> area; <span class="hljs-keyword">public</span> <span class="hljs-keyword">float</span> price; <span class="hljs-keyword">public</span> <span class="hljs-title">Room</span>(<span class="hljs-keyword">float</span> area, <span class="hljs-keyword">float</span> price) { <span class="hljs-keyword">this</span>.area = area; <span class="hljs-keyword">this</span>.price = price; } <span class="hljs-annotation">@Override</span> <span class="hljs-keyword">public</span> String <span class="hljs-title">toString</span>() { <span class="hljs-keyword">return</span> <span class="hljs-string">"Room [area="</span> + area + <span class="hljs-string">", price="</span> + price + <span class="hljs-string">"]"</span>; } } <span class="hljs-javadoc">/** * 中介 */</span> <span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">Mediator</span> {</span> List<Room> mRooms = <span class="hljs-keyword">new</span> ArrayList<Room>(); <span class="hljs-keyword">public</span> <span class="hljs-title">Mediator</span>() { <span class="hljs-keyword">for</span> (inti = <span class="hljs-number">0</span>; i < <span class="hljs-number">5</span>; i++) { mRooms.add(<span class="hljs-keyword">new</span> Room(<span class="hljs-number">14</span> + i, (<span class="hljs-number">14</span> + i) * <span class="hljs-number">150</span>)); } } <span class="hljs-keyword">public</span> List<Room><span class="hljs-title">getAllRooms</span>() { <span class="hljs-keyword">return</span> mRooms; } } <span class="hljs-javadoc">/** * 租户 */</span> <span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">Tenant</span> {</span> <span class="hljs-keyword">public</span> <span class="hljs-keyword">float</span> roomArea; <span class="hljs-keyword">public</span> <span class="hljs-keyword">float</span> roomPrice; <span class="hljs-keyword">public</span> <span class="hljs-keyword">static</span> <span class="hljs-keyword">final</span> <span class="hljs-keyword">float</span> diffPrice = <span class="hljs-number">100.0001</span>f; <span class="hljs-keyword">public</span> <span class="hljs-keyword">static</span> <span class="hljs-keyword">final</span> <span class="hljs-keyword">float</span> diffArea = <span class="hljs-number">0.00001</span>f; <span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">rentRoom</span>(Mediator mediator) { List<Room>rooms = mediator.getAllRooms(); <span class="hljs-keyword">for</span> (Room room : rooms) { <span class="hljs-keyword">if</span> (isSuitable(room)) { System.out.println(<span class="hljs-string">"租到房间啦! "</span> + room); <span class="hljs-keyword">break</span>; } } } <span class="hljs-keyword">private</span> <span class="hljs-keyword">boolean</span> <span class="hljs-title">isSuitable</span>(Room room) { <span class="hljs-keyword">return</span> Math.abs(room.price - roomPrice) < diffPrice &&Math.abs(room.area - roomArea) < diffArea; } }</code>
从上面的代码中可以看到,Tenant不仅依赖了Mediator类,还需要频繁地与Room类打交道。租户类的要求只是通过中介找到一间适合自己的房间罢了,如果把这些检测条件都放在Tenant类中,那么中介类的功能就被弱化,而且导致Tenant与Room的耦合较高,因为Tenant必须知道许多关于Room的细节。当Room变化时Tenant也必须跟着变化。Tenant又与Mediator耦合,就导致了纠缠不清的关系。这个时候就需要我们分清谁才是我们真正的“朋友”,在我们所设定的情况下,显然是Mediator(虽然现实生活中不是这样的)。上述代码的结构如图1-5所示。
▲图1-5
既然是耦合太严重,那我们就只能解耦了,首先要明确地是,我们只和我们的朋友通信,这里就是指Mediator对象。必须将Room相关的操作从Tenant中移除,而这些操作案例应该属于Mediator,我们进行如下重构:
<code class="language-java hljs has-numbering"><span class="hljs-javadoc">/** * 中介 */</span> <span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">Mediator</span> {</span> List<Room> mRooms = <span class="hljs-keyword">new</span> ArrayList<Room>(); <span class="hljs-keyword">public</span> <span class="hljs-title">Mediator</span>() { <span class="hljs-keyword">for</span> (inti = <span class="hljs-number">0</span>; i < <span class="hljs-number">5</span>; i++) { mRooms.add(<span class="hljs-keyword">new</span> Room(<span class="hljs-number">14</span> + i, (<span class="hljs-number">14</span> + i) * <span class="hljs-number">150</span>)); } } <span class="hljs-keyword">public</span> Room <span class="hljs-title">rentOut</span>(<span class="hljs-keyword">float</span> area, <span class="hljs-keyword">float</span> price) { <span class="hljs-keyword">for</span> (Room room : mRooms) { <span class="hljs-keyword">if</span> (isSuitable(area, price, room)) { <span class="hljs-keyword">return</span> room; } } <span class="hljs-keyword">return</span> <span class="hljs-keyword">null</span>; } <span class="hljs-keyword">private</span> <span class="hljs-keyword">boolean</span> <span class="hljs-title">isSuitable</span>(<span class="hljs-keyword">float</span> area, <span class="hljs-keyword">float</span> price, Room room) { <span class="hljs-keyword">return</span> Math.abs(room.price - price) < Tenant.diffPrice && Math.abs(room.area - area) < Tenant.diffPrice; } } <span class="hljs-javadoc">/** * 租户 */</span> <span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">Tenant</span> {</span> <span class="hljs-keyword">public</span> <span class="hljs-keyword">float</span> roomArea; <span class="hljs-keyword">public</span> <span class="hljs-keyword">float</span> roomPrice; <span class="hljs-keyword">public</span> <span class="hljs-keyword">static</span> <span class="hljs-keyword">final</span> <span class="hljs-keyword">float</span> diffPrice = <span class="hljs-number">100.0001</span>f; <span class="hljs-keyword">public</span> <span class="hljs-keyword">static</span> <span class="hljs-keyword">final</span> <span class="hljs-keyword">float</span> diffArea = <span class="hljs-number">0.00001</span>f; <span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">rentRoom</span>(Mediator mediator) { System.out.println(<span class="hljs-string">"租到房啦 "</span> + mediator.rentOut(roomArea, roomPrice)); } }</code>
重构后的结构图如图1-6所示。
▲图1-6
只是将对于Room的判定操作移到了Mediator类中,这本应该是Mediator的职责,他们根据租户设定的条件查找符合要求的房子,并且将结果交给租户就可以了。租户并不需要知道太多关于Room的细节,比如与房东签合同、房东的房产证是不是真的、房内的设施坏了之后我要找谁维修等,当我们通过我们的“朋友”中介租了房之后,所有的事情我们都通过与中介沟通就好了,房东、维修师傅等这些角色并不是我们直接的“朋友”。“只与直接的朋友通信”这简单的几个字就能够将我们从乱七八糟的关系网中抽离出来,使我们的耦合度更低、稳定性更好。
通过上述示例以及小民的后续思考,迪米特原则这把利剑在小民的手中已经舞得风生水起。就拿sd卡缓存来说吧,ImageCache就是用户的直接朋友,而SD卡缓存内部却是使用了jake wharton的DiskLruCache实现,这个DiskLruCache就不属于用户的直接朋友了,因此,用户完全不需要知道它的存在,用户只需要与ImageCache对象打交道即可。例如将图片存到SD卡中的代码如下。
<code class="language-java hljs has-numbering"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">put</span>(String url, Bitmap value) { DiskLruCache.Editor editor = <span class="hljs-keyword">null</span>; <span class="hljs-keyword">try</span> { <span class="hljs-comment">// 如果没有找到对应的缓存,则准备从网络上请求数据,并写入缓存</span> editor = mDiskLruCache.edit(url); <span class="hljs-keyword">if</span> (editor != <span class="hljs-keyword">null</span>) { OutputStream outputStream = editor.newOutputStream(<span class="hljs-number">0</span>); <span class="hljs-keyword">if</span> (writeBitmapToDisk(value, outputStream)) { <span class="hljs-comment">// 写入disk缓存</span> editor.commit(); } <span class="hljs-keyword">else</span> { editor.abort(); } CloseUtils.closeQuietly(outputStream); } } <span class="hljs-keyword">catch</span> (IOException e) { e.printStackTrace(); } }</code>
用户在使用SD卡缓存时,根本不知晓DiskLruCache的实现,这就很好地对用户隐藏了具体实现。当小民已经“牛”到可以自己完成SD卡的rul实现时,他就可以随心所欲的替换掉jake wharton的DiskLruCache。小民的代码大体如下:
<code class="language-java hljs has-numbering"><span class="hljs-annotation">@Override</span> <span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">put</span>(String url, Bitmap bmp) { <span class="hljs-comment">// 将Bitmap写入文件中</span> FileOutputStream fos = <span class="hljs-keyword">null</span>; <span class="hljs-keyword">try</span> { <span class="hljs-comment">// 构建图片的存储路径 ( 省略了对url取md5)</span> fos = <span class="hljs-keyword">new</span> FileOutputStream(<span class="hljs-string">"sdcard/cache/"</span> + imageUrl2MD5(url)); bmp.compress(CompressFormat.JPEG, <span class="hljs-number">100</span>, fos); } <span class="hljs-keyword">catch</span> (FileNotFoundException e) { e.printStackTrace(); } <span class="hljs-keyword">finally</span> { <span class="hljs-keyword">if</span> ( fos != <span class="hljs-keyword">null</span> ) { <span class="hljs-keyword">try</span> { fos.close(); } <span class="hljs-keyword">catch</span> (IOException e) { e.printStackTrace(); } } } <span class="hljs-comment">// end if finally</span> }</code>
SD卡缓存的具体实现虽然被替换了,但用户根本不会感知到。因为用户根本不知道DiskLruCache的存在,他们没有与DiskLruCache进行通信,他们只认识直接“朋友”ImageCache,ImageCache将一切细节隐藏在了直接“朋友”的外衣之下,使得系统具有更低的耦合性和更好的可扩展性。
7、总结
在应用开发过程中,最难的不是完成应用的开发工作,而是在后续的升级、维护过程中让应用系统能够拥抱变化。拥抱变化也就意味着在满足需求且不破坏系统稳定性的前提下保持高可扩展性、高内聚、低耦合,在经历了各版本的变更之后依然保持清晰、灵活、稳定的系统架构。当然,这是一个比较理想的情况,但我们必须要朝着这个方向去努力,那么遵循面向对象六大原则就是我们走向灵活软件之路所迈出的第一步。