前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >《实现模式》读书总结

《实现模式》读书总结

作者头像
MelonTeam
发布2018-01-04 15:09:36
1.5K0
发布2018-01-04 15:09:36
举报
文章被收录于专栏:MelonTeam专栏MelonTeam专栏

导语 这是一本关于如何写好代码的书,是一本关于“如何编写别人能看懂的代码”的书。从价值观、原则、模式三个层面解读如何优化代码结构,减少代码维护成本。

关于这本书

  1. 作者简介 Kent Beck,软件开发方法学的泰山北斗,是最早研究软件开发的模式和重构的人之一,是敏捷开发的开创者之一,更是极限编程和测试驱动开发的创始人。
  2. 这本书的目标 这本书的目标是帮助你通过代码表达自己的意图。
  3. 章节概览
章节概述
章节概述

[ 章节概述 ]

模式

模式就是我们在编写代码时固定的规则(force)。

模式
模式

[ 模式 ]

举个栗子:chestnut: 编程中,我们想写一个函数,需要给它命名。那么映入我们脑海的是:

给函数命名的模式
给函数命名的模式

[ 给函数命名的模式 ]

  1. 模式让你感觉到束手束脚,但可以帮你节省时间和经历,提高效率。
  2. 模式的种类繁多,众多模式构成了一种编程风格

一种编程理论

价值观

编程理论-
价值观
编程理论- 价值观

[ 编程理论-价值观 ]

原则

编程理论-
原则
编程理论- 原则

[ 编程理论-原则 ]

小结

上面提到了个关键词,分别是:模式、原则、价值观。

模式是编码是的一些约束(force),众多的模式共同构筑了一种编程风格。

价值观是编程过程中统一支配性主题,影响了我们在编程中所作的每个决策。

原则是模式和价值观之间搭建的桥梁,在遇到没有现有模式可以解决的问题的时候,原则往往可以让我们“无中生有”的创造一些东西,而这些东西往往都是很不错的。

模式-原则-
价值观
模式-原则- 价值观

[ 模式-原则-价值观 ]

摘录书中的一句总结:模式描述了要做什么,价值观提供了动机,原则把动机转化成了实际行动。

动机

由上面的讨论可以知道,价值观为模式的形成提供了动机。那么主要的动机之一是软件设计应该致力于减少整体成本。

costtotal=costdevelop+costmaintain cost{total} = cost{develop} + cost_{maintain} costtotal=costdevelop+cost​maintain​​

经过统计,人们发现,维护成本远远高于初始成本。也就是说维护的代价很大。因为理解现有代码需要耗费很多时间,而且容易出错,改动之后还需要重新测试和部署。

costmaintain=costunderstand+costchange+costtest+costdevelop cost{maintain} = cost{understand} + cost{change} + cost{test} + cost_{develop} costmaintain=costunderstand+costchange+costtest+cost​develop​​

通过合理的模式的使用,可以降低经济成本。

关于类,书中讲解了很多细小的点。有的比较有意思,值得一说。

通读本章后,进行了梳理整合,做如下总结。

  • 类的命名

类的名字应该是简明扼要,简短而有表现力。一个好的命名可以大大增加理解代码的容易度。

  • 针对接口编程,不针对现实编程

对操作进行抽象,由子类实现各自的具体逻辑。 interface(接口)对扩展开放,对修改关闭。比如想给一个interface增加一个函数,不能直接添加, 要重新写个interface继承它。如果直接在原interface增加函数,就要导致所有实现了本接口的地方都要修改,这个代价是非常大的。

  • 当我们从其他地方复制了一大段代码

如果有两个地方的代码非常相似甚至相同,那就要考虑是否可以抽取到公共父类或者工具类中。直接拷贝一份的弊端很明显,维护起来很困难,比如其中一个地方需要修改,那么另外一个地方是不是也要修改呢。而且增加了代码的阅读难度,这明显和模式的原则不符。

  • 内部类和匿名内部类

内部类当被实例化之后,会获得创建它的外部类对象的引用,所以可以直接访问后者的数据而不用建立额外的连接。 但是这中对象持有操作有内存泄漏的风险。比如在手Q中ThreadManager.post中就有特殊的操作来避免内存泄漏。

  • 逻辑委派和可插拔的选择器

把相同的逻辑统一处理,然后把不同的逻辑发放给不同的模块去处理。在手Q中,不同的回报消息在统一处理之后发放给不同的回调逻辑,也是一种实际应用。

逻辑委派
逻辑委派

[ 逻辑委派 ]

可插拔的选择器和逻辑委派很相似,比如有一个打印类的函数列表的工具方法,传给它不同的类名,就打印不同的类的函数信息。

  • 类库实现模式、实现模式、

把一些公共的方法放到一个公共的类中,声明为static,当成工具来调用。可以简化代码,看起来更清晰。

状态

  • 直接访问与间接访问

在类中有很多变量,每一个变量都会存在很多状态,比如boolean有true和false两种状态,一般类的范围内进行直接访问,对外部的访问一般强制间接访问,也就是通过public的函数访问。 比如下面这种方式一般是类内访问。

代码语言:javascript
复制
     door.isOpen = true

而下面这种方式一般用在类外访问。

代码语言:javascript
复制
     public boolean isOpen() {
     return this.isOpen;
 }

其实就是合理使用Java中的private、protected、public修饰。

  • 变量的分块

在一个类中有很多变量,比如private成员变量、static静态变量、public公共变量,除了变量名命名要规范外,还要分区分块。比如static类型的应该放到最上面,并且与其他类型的变量隔开。

  • 参数

一个变量想传递到其他地方有很多方法。比如可以设置成public+static,让别人直接访问。但是这种方式耦合程度太高,比如改一个变量名,所有引用的地方都要修改。可以使用参数,直接把一个状态传递到另外一个地方,而不涉及二者之间的耦合。

  • 变量的初始化:及早初始化和延迟初始化

初始化就是给变量一个默认的状态。 对于对性能影响较低的初始化可以及早初始化,可以保证变量在后续的使用过程中是已经初始化了的。并且变量的初始化要尽量放到一起,这样逻辑更清晰,也更美观。比如Android中的findViewById()在初始化时就要尽量放到一起。 延迟初始化是考虑到了性能问题,如果初始化成本很高,就可以考虑通过延迟初始化来实现快速启动。

行为

  • 主体流

虽然Java是面向对象编程,但是在一个函数中,也是由上到下依次执行。主体流中包含了一些异常判断和卫述句(guard clause)。

  • 卫述句

卫述句是异常检查的一种方式。在程序的主体流中,需要判断某些不适用主体流的情况。

代码语言:javascript
复制
     void init() {
     if (isInited) {
         return;
     }
     ....
 }

我们习惯了if-then- else这种约束,当看到if的时候,很容易就想到需要else语句。卫述句则不需要else子句,它是表达的另一种情形,只是一次主体流中的异常判断。

  • 异常传播

当程序发生异常,不能直接将日志信息输出,这样被有心之人抓取到了会产生安全隐患。同样也不能置之不理,这样后面排查问题就很困难。正确的做法是调用异常处理工具,比如写入日志文件等等。

方法

把大块的逻辑分成许多块,每一块都是一个方法,每个方法起一个顾名思义的名称。这样的代码理解起来更容易,更易于维护和重用。

  • 安全复制

如果在一个类中有一个List,存放着若干个类Demo的对象实例,比如

代码语言:javascript
复制
     List list = new ArrayList();

如果外界想访问这个列表呢,通常的做法是这样的

代码语言:javascript
复制
     public List getDemoList() {
     return this.list;
 }

这样的话会有安全隐患,我们必须要考虑,外界的逻辑是否会对我们的数据产生影响

代码语言:javascript
复制
     getDemoList().clear(); // 数据被莫名修改,会发生一些问题。

考虑更高的安全性,我们可以这么做

代码语言:javascript
复制
     public List getDemoList() {
     List copyList = new ArrayList();
     copyList.addAll(this.list);
     return copyList;
 }

当然,安全复制不可滥用,如果数据很大,这种复制会占用耗费的内存和性能,所以更好的做法是综合考虑安全性和性能的平衡。

  • 方法注释

对于沟通良好的代码来说,很多注释完全是多余的。在强调命名的沟通性和表达性的时候,注释显得处在一个很别扭的层次上。注释不是越多越好,在必要的时候添加适当的注释是合理的。当然,在后期的代码修改的时候,记得及时更新代码注释,否则注释不正确反倒对阅读人造成了误解。

容器

  • 使用容器应该关心的一个问题

在将容器暴露给外界使用的时候,需要考虑外界是否可以对容器进行修改。比如Iterable无法保证容器中的数据不被修改,外界可以直接调用它的remove方法进行修改,而不通知容器所有者,这样会出现问题。解决办法之一就是返回一个安全拷贝。

  • 不可变的容器

当只想把容器暴露给外界而不希望被修改时,除了安全拷贝外,还可以创建不可修改的容器,当容器的元素被外界修改时,程序会throw exception。

不可变的容器
不可变的容器

[ 不可变的容器 ]

  • 容器的继承和委派

有时候我们可能需要继承一个容器类。比如新建一个书籍列表的类Library,我们的目的是给他提供类似集合一样的增删改查操作。一个很直接的想法是让它继承ArrayList。

代码语言:javascript
复制
public class Library extends ArrayList{
    ....
}

这种操作实现了Library的add、remove、迭代以及其他容器操作,但是这种方式会带来一些问题。比如一般我们不需要ArrayList的toArray操作,但是如何避免用户调用呢,总不能把所有不需要的方法都加以实现并抛出UnsupportedOperationException来取消继承。

这里可以使用委派来实现这种操作。

代码语言:javascript
复制
public class Library{
    Collection books = new ArrayList();
}

使用这种方式可以只暴露一些需要的方法。我在头像墙widget中就是这样做的。

代码语言:javascript
复制
public class AvatarWallViewPager{
    protected RollViewPager mViewPager;
}

改进框架

  • 更新框架时的向前兼容性

在更新框架的时候,一个非常重要的点就是向后兼容。更新框架的功能不能影响到现有代码的逻辑。在设计框架的时候,保持代码尽可能简单的同时,也要尽可能提高代码的适用范围,考虑后续框架的更新是否容易。

  • 兼容性更新—增量式更新

包(package)为框架代码的增量式更新提供了一条途径,可以在新的包下创建相同类名的新类。比如把更新后的org.junit.Assert放到org.junit.improved.Assert这个类中,这样的话客户代码只需要更新imports语句就可以实现更新。修改import更加简单,影响更小。

  • 抽象—接口和抽象类

多使用接口和抽象类可以提高框架的灵活度。只将必要的逻辑暴露给外部使用,内部逻辑是private的。当修改框架代码时,只要接口和抽象类的抽象方法不变,其他的逻辑可以灵活修改,外部调用者不会受到任何影响。

附录 A

这部分主要是介绍了一个度量操作性能的框架。介绍了设计框架时要注意的一些事情。

设计操作度量框架要注意以下几个要点:

  1. 将操作执行多次,取平均值,克服精度问题。
  2. 在测量时要考虑Java的自动优化机制会不会影响操作执行的时间。

总结

这本书主要是着力于编程时的思维层面上的考虑。开发者大脑中要时刻铭记沟通、简单、灵活的价值观,遵循实现模式,并学会在遇到前所未有的问题时,能在价值观的指导下,利用现有原则找到更为恰当的解决方案。

ps:KM的MarkDown渲染貌似有些问题,某些效果没有我本地MarkDown编辑器渲染的好。附件里提供PDF文档,有需要的可以直接下载了看。

本文参与 腾讯云自媒体分享计划,分享自作者个人站点/博客。
原始发表:2017-08-14,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 关于这本书
  • 模式
  • 一种编程理论
    • 价值观
      • 原则
        • 小结
        • 动机
        • 状态
        • 行为
        • 方法
        • 容器
        • 改进框架
        • 附录 A
        • 总结
        相关产品与服务
        对象存储
        对象存储(Cloud Object Storage,COS)是由腾讯云推出的无目录层次结构、无数据格式限制,可容纳海量数据且支持 HTTP/HTTPS 协议访问的分布式存储服务。腾讯云 COS 的存储桶空间无容量上限,无需分区管理,适用于 CDN 数据分发、数据万象处理或大数据计算与分析的数据湖等多种场景。
        领券
        问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档