由学习《软件设计重构》所想到的代码review(二)

我们接第一篇由学习《软件设计重构》所想到的代码review(一)

来继续说明在代码review中,有哪些属于“层次结构”中的坏味道。

注:通过上图咱们看到了在层次结构中有九大问题点,咱们就从中找出三个典型的问题点给与分析和解释。

一、缺失的层次结构

  • 问题点:
public Insets getBorderInsets(Component c, Insets insets) {
    if(c instanceof AbstractButton) {
        margin = ((AbstractButton)c).getMargin();
    } else if(c instanceof JToolBar) {
        margin = ((JToolBar)c).getMargin();
    } else if(c instanceof JTextComponent) {
        margin = ((JTextComponent)c).getMargin();
    }

注:串接的if else语句显示的检查类型AbstractButton,JToolBar和JTextCompont并在各种条件下调用方法getMargin(),这种造成的情况是将来可能在代码中的其他地方也会出现。

  • 重构建议:

1、如果条件检查中的多个实现调用方法相同,可引入相关的接口来抽象共同的协议。

2、如果代码中包含可转换为类的条件语句,可采用重构手法“提取层次结构”来创建一个类层次结构,其中每个类都表示条件检查中的一种情形。

二、未归并层次结构

  • 问题点:

AbstractQueuedSynchronizer和AbstractQueuedLongSynchronizer类都是直接从AbstractOwnableSynchronizer派生而来的(这些类都包含在java.util.concurrent.locks包),这二个子类的很多代码都是重复的,每个类都包含2110行代码,但重复的代码多达1278行。

显然,这二个类的代码绝大部分是相同的,只是在AbstractQueuedLongSynchronizer中使用的是long而不是int,那么我们看这二个类的继承类图如下:

  • 重构方案

对于AbstractOwnableSynchronizer,由于子类型中的方法定义相同,因此可采用重构手法上移,将相同的方法定义移到超类中。

三、支离破碎的层次结构

这种层次结构主要体现在,虽然超类和子类之间不存在is-a的关系,但是超类的方法对于子类来说是适用或者相关的。

  • 问题点:

注:java.util.Date这个类不仅提供了日期功能,如getDate(),getYeah()等方法,还提供了getTime(),getHours()等时间方法,但是它的二个子类java.sql.Date不支持与时间有关的功能,而java.sql.Time不支持与日期有关的功能,于是java.sql.Date拒绝了从超类继承的所有与时间有关的方法,java.sql.Time拒绝了继承的所有与日期有关的方法。

看一段简单的代码:

java.util.Date date = new java.util.Date();
int dateValue = date.getDate(); //不报错,一切正常

date = new java.sql.Time(10,10,10);
dateValue = date.getDate(); //将引发IllegalArgumentException异常
  • 重构方案

超类和子类之间并不存在is-a的关系,它们在设计中使用继承只是为了能够利用抽象提供的功能,其实在相关类之间建立关联关系也可以达到这样的目的,采用重构手法”以委拖取代继承”,应用hash-a的关系取代is-a的关系。

四、小结

在第二篇中我们重点介绍了关于类层次结构方面的坏味道,那么我们将在第三篇中介绍关于封装类方面的故事。

时间: 2024-08-01 22:47:56

由学习《软件设计重构》所想到的代码review(二)的相关文章

由学习《软件设计重构》所想到的代码review(一)

前言 对于一个程序员来讲如何来最直接的来衡量他的技术能力和产出呢?我想最直观的作法是看他的代码编写能力,就拿我经常接触的一些程序员来看,他们买了很多技术重构类书籍,但是看完后代码编写能力并没有显著提高.有人说可以用代码review工具啊,但是像市面上的这些代码review工具,只能帮助我们解决表面的bug和规范点,还无法帮助我们发现更深层次的设计问题. 下面我将结合<软件设计重构>这本书谈谈在进行代码review的时候,需要关注的哪些点. 一.技术债务 何为技术债务? 技术债务是有意或无意的做

130242014045 林承晖 实验报告一 软件设计的网络支持环境

实验报告一 课程  软件系统设计与体系结构   实验名称   软件设计的网络支持环境     第      页 专业___软件工程_____  班级_ 2班____  学号____130242014045___   姓名  林承晖 实验日期:  2017  年 09  月 14  日 --    年   月   日 一.实验目的 了解主流软件体系结构与设计技术网站,不断丰富软件体系结构和软件设计技术最新知识的学习方法. 二.实验内容 1.概念理解 (1)请根据你的理解和看法,给出'软件体系结构'

重构——让你的代码接近框架源码

前一段我们的项目搞了一次重构,我简单做了一个ppt,下面我们来一起分享下 代码的坏味道 1.重复代码(难维护) ?提取公共函数 2.函数过长(难理解) ?拆成若干函数 3.类过大(难理解) ?拆成若干类 4.参数多(难用) ?将参数封装成结构或类 5.万能类(改动频繁) ?拆,将总是一起变化的东西放在一块儿,合久必分 6.天女散花逻辑(需求变动改很多类) ?将各个修改点,集中起来,抽象成一个新类. 7.红杏出墙的函数(使用了大量其他类的成员) ?将这个函数挪到那个类里面. 8.数据团(常一起出现

软件设计与实现总结

本周学习了<软件设计与实现>的章节,了解了一些常用的分析和设计方法和开发阶段的一些管理方法: 1.分析和设计方法: 写软件就是为了解决用户的需求,所以我们首先了解用户需求即需求分析. 方法:(1)以文字为主的文档(2)以图形为主的构造模型(3)数学语言(4)类+代码(5)源代码+注释 2.从Spec到实现 (1)估计开发任务所需时间(2)分析需求(3)生成设计文档(4)和同事审核文档(5)编写代码(6)代码复审,代码重构 3.开发人员的标准工作流程(附图片) BTV测试又称冒烟测试 4.开发阶

学习软件开发应该看的书

学习软件开发应该看的书 来源: 李越甲的日志 1. C语言提升 <c和指针> <c缺陷和陷阱> <c专家编程> 这三本书是一个初级C程序员必看的三本书,同时也是应届新员工必须好好学习的教材,非常适合刚毕业的大学生学习 2.  C++语言提升 <Effective C++:改善程序与设计的55个具体做法> <More Effective C++:35个改善编程与设计的有效方法(中文版)> <C++沉思录> <C++Template

《重构-改善既有代码的设计》读书笔记

重构,第一个案例 1.1 起点 如果发现现有的代码结构使你无法很方便地添加新特性,那就先重构,使特性的添加比较容易进行后,再添加特性; 1.2 重构的第一步 为即将修改的代码建立可靠的测试环境 – 是人就会犯错,所以需要可靠的测试; 测试结果能够自我检验 – 成功"OK",失败列出失败清单并打印行号 (自动化对比测试结果是提高效率的前提); 1.3 分解并重组"巨型"函数 切分提炼长函数(Extract Method),并移至更合适的类(Move Method) –

一些软件设计原则【转载】

本文一定要转,总结得非常好, 设计必读. 转自陈皓老师的 <一些软件设计的原则>,根据自己的理解调整了下顺序,少部分字句做了修改. 一个好的程序员通常由其操作技能.知识水平,经验层力和能力四个方面组成.在这里想和大家说说设计中的一些原则,我认为这些东西属于长期经验总结出来的知识.这些原则,每一个程序员都应该了解.但是请不要教条主义,在使用的时候还是要多多考虑实际情况.其实,下面这些原则,不单单只是软件开发,可以推广到其它生产活动中,甚至我们的生活中. 根本设计原则 根本设计原则是我认为的最最基

实践提高《重构改善既有代码的设计第2版》PDF中文+PDF英文+对比分析

重构是编程的基础,是在不改变外部行为的前提下,有条不紊地改善代码.编程爱好者都知道,Martin Fowler 的<重构:改善既有代码的设计>已经成为全球有经验的程序员手中的利器,既可用来改善既有代码的设计.提升软件的可维护性,又可用于使既有代码更易理解.焕发出新的活力. <重构改善既有代码的设计(第2版)>在第1 版的基础上做了全面修订,反映了编程领域业已发生的许多变化.第2 版中介绍的重构列表更加内聚,并用JavaScript 语言重写了代码范例.此外,第2 版中还新增了与函数

软件设计

软件设计 一定是创建订单的时候填充market字段,我曾经一度打算在回调的时候再根据回调方来填充Market,但是如果没有回调呢?Market这样的标志性字段一定要依赖于靠谱的操作: 对于重载方法要注意,尤其套调用的重载方法,对于某些核心校验必须要放置在里层方法调用,否则因为重载都是public出去的,都可以被外界调用,如果在外层方法实现校验,里层重载方法被外界直接调用,校验会被跳过:考虑CheckMarket是放在CreateOrder(String encryptedString)还是Cre