重构·改善既有代码的设计.03之重构手法(上)
1. 前言
之前的重构系列中,介绍了书中提到的重构基础,以及识别代码的坏味道。今天继续第三更,讲述那些重构手法(上)。看看哪些手法对你的项目能有所帮助…
2. 重新组织函数
对函数进行整理,使之更恰当的包装代码。
1、Extract Method 提炼函数。
改造前:
void printInfoAndDetail() {this.printInfo(); System.out.println("this is detail name:" + _name);System.out.println("this is detail account:" + _account);
}
改造后:
void printInfoAndDetail() {this.printInfo(); this.printDetail();
}void printDetail() { System.out.println("this is detail name:" + _name);System.out.println("this is detail account:" + _account);
}
动机:
控制函数的粒度,函数粒度很小,那么被复用的机会就更大;其次会使高层函数读起来就像一系列注释,再次,如果函数都是细粒度,那么函数的覆盖也会更容易。
一个函数多长才算合适?其实长度不是关键问题,关键在于函数名和函数本体之间的语义距离。
做法:
1、创造一个新函数,根据这个函数意图来命名(以它”做什么“来命名,而不是”怎样做“命名)。
只要新的函数名能够以更好的方式昭示代码意图,你也应该提炼他(就算代码只是一条消息,或一个函数调用)。但如果你想不出一个更有意义的名称,就别动。
2、将提炼出来额代码从源函数复制到新建的目标函数中。
3、检查变量。检查提炼出的代码是否引用了源代函数的局部变量或参数。以被提炼函数中是否含有临时变量。
难点:
这个重构手法的难点就在于局部变量的控制,包括传进源函数的参数和源函数所有声明的临时变量。
2、Inline Method 内联函数。
改造前:
int getRating() {return isGe5() ? 2 : 1;
}boolean isGe5(){return _num >= 5;
}
改造后:
int getRating() {return _num >= 5 ? 2 : 1;
}
动机:
移除非必要的间接层。当然间接层有其价值,但不是所有的间接层都有价值,可以去除那些无用的间接层。
做法:
1、检查函数,确定他不具备多态性。如果有子类继承了这个函数,那就不能将此函数内联。因为子类无法覆盖一个根本不存在的函数。如例子中,子类可以重写isGe5(),但内敛之后的_num > 5 ? 2 : 1是无法重写的,除非你重写了getRating()。
2、找出函数的所有被调用点,将这个函数的所有被调用点都替换为函数本体。
3、Inline Temp 内联临时变量。
改造前:
double price = order.price();
return price > 1000;
改造后:
return order.price() > 1000
4、Replace Temp With Query 以查询取代临时变量。
改造前:
double price = _qu * _item;
if(price > 1000){return price * 0.95;
} else {return price * 0.98;
}
改造后:
if(getPrice() > 1000){return getPrice() * 0.95;
} else {return getPrice() * 0.98;
}double getPrice(){return _qu * _item;
}
5、Introduce Explaining Variable 引入解释性变量。
改造前:
if((platform.indexOf("mac") > -1) && (platform.indexOf("ie") > -1) && resize > 0
){// todo...
}
改造后:
final boolean isMac = (platform.indexOf("mac") > -1;
final boolean isIe = (platform.indexOf("ie") > -1;
final boolean resized = resize > 0;if( && isIe && resized){// todo...
}
6、Split Temporary Variable 分解临时变量。
改造前:
double temp = 2 * (_h + _w);
System.out.println(temp);
temp = _h * _w;
System.out.println(temp);
改造后:
final double temp = 2 * (_h + _w);
System.out.println(temp);
final double area = _h * _w;
System.out.println(area);
7、Remove Assignments to Parameters 移除对参数的赋值。
改造前:
int discount(int inputVal) {if(inputVal > 50) inputVal -= 2;
}
改造后:
int discount(int inputVal) {int result = inputVal;if(inputVal > 50) result -= 2;
}
3. 在对象之间搬移特性
“决定把责任放在哪儿”。
1、Move Method 搬移函数。
如果一个类有太多的行为,或如果一个类于另一个类有太多合作而形成高度耦合,尝试搬移函数。将旧函数变成一个单纯的委托函数,或是将旧函数完全移除。
改造前:
class Account {private AccountType _type;private int _dayOverdrawn;double overdraftCharge(){if(_type.isPremium()) {double result = 10;if(_dayOverdrawn > 7) result += (_dayOverdrawn - 7) * 0.85;return result; } else {return _dayOverdrawn * 1.75; }}
}
改造后:
class Account {private AccountType _type;private int _dayOverdrawn;double overdraftCharge(){return _type.overdraftCharge(_dayOverdrawn);}
}class AccountType {double overdraftCharge(int daysOverdrawn){if(isPremium()) {double result = 10;if(dayOverdrawn > 7) result += (dayOverdrawn - 7) * 0.85;return result; } else {return dayOverdrawn * 1.75; }}
}
2、Move Field 搬移字段。
如果一个字段,在其所驻类之外的另一个类中有更多函数使用了它,就要考虑搬移这个字段。这里的使用可能是设值,取值函数间接进行的。
改造前:
class Account {private AccountType _type;private int _rate;double overdraftCharge(double amount, int days){return _rate * amount * days / 365;}
}
改造后:
class Account {private AccountType _type;double overdraftCharge(){return _type.getRate() * amount * days / 365;}
}class AccountType {private double _rate;void setRate(double r) {this._rate = r; }void getRate() {return _rate; }
}
3、Extract Class 提炼类。
建立一个新类,将相关的字段和函数从旧类搬移到新类。一个类应该是一个清楚的抽象,处理一些明确的责任。
改造前:
class Account {private String personName;private String personPhone;private double money;public String getAccountInfo(){return personName + ",联系方式:" + personPhone + ",余额:" + money; }
}
改造后:
class Account {private Person person = new Person();private double money;public String getAccountInfo(){return person.getPersonName() + person.personPhone() + ",余额:" + money; }
}class Person {private String personName;private String personPhone;public String getPersonName(){return "联系人:" + personName;}public String getPersonPhone(){return "联系方式:" + personPhone;}
}
4、Inline Class 将类内联化。
将这个类的所有特性搬移到另一个类中,然后移除原类。与Extract Class相反。
5、Hide Delegate 隐藏“委托关系”。
“封装”即使不是对象的最关键特性,也是最关键特性之一。“封装”意味着每个对象都应该尽可能少了解系统的其他部分。
改造前:
class Person {private Department department;public Department getDepartment(){return department;}
}class Department {private Person manager;public Person getManager(){return manager; }
}// 如果客户希望知道某人的经理是谁,那他的调用关系是:
xxx.getDepartment().getManager();
// 暴露了部门和经理的委托关系
改造后:
class Person {private Department department;public Department getDepartment(){return department;}public Person getManager(){return department.getManager(); }
}class Department {private Person manager;public Person getManager(){return manager; }
}// 如果客户希望知道某人的经理是谁,那他的调用关系是:(隐藏了Department)
xxx.getManager();
6、Remove Middle Man 移除中间人。
某个类做了过多的简单委托动作。
7、Introduce Foreign Method 引入外加函数。
当你需要为提供服务的类增加一个函数,但你无法修改这个类。如果你只使用这个函数一次,那么额外编码工作没什么大不了,升值可能根本不需要原本提供服务的那个类。然而,如果你需要多次使用这个函数,就得不断重复这些代码。重复代码是软件万恶之源。
改造前:
Date newStart = new Date(pre.getYear(), pre.getMethod(), pre.getDate() + 1);
改造后:
Date newStart = nextDay(pre);private static Date nextDay(Date arg) {return new Date(arg.getYear(), arg.getMethod(), arg.getDate() + 1);
}
如真实项目中的案例:
BeanUtil.copyProperties(),原始方法该行为需要抛异常,且被建议不再使用该方法进行bean复制。
于是引入外加函数:
class BeanUtilExt {public static void copyProperties(Object target, Object source) {try {BeanUtil.copyProperties() } catch (Exception) {// ignored... } }
}
这种方式个人不推荐。
8、Introduce Local Extension 引入本地扩展。
当你需要为提供服务的类提供一些额外函数,但你无法修改这个类。
4. 重新组织数据
1、Self Encapsulate Field 自封装字段。
改造前:
private int _low, _high;
boolean includes(int arg){return arg >= _low && arg <= _high;
}
改造后:
private int _low, _high;
boolean includes(int arg){return arg >= getLow() && arg <= getHigh();
}int getLow(){return _low;
}
int getHigh(){return _high;
}
直接访问变量好处:代码容易阅读。
间接访问变量好处:子类可以通过重写(覆盖)一个函数而改变获取数据的途径。
2、Replace Data Value with Object 以对象取代数据值。
开发初期,你往往决定以简单的数据项表示简单的情况。但是,随着开发的进行,你可能会发现,这些简单的数据项不再那么简单了。比如你一开始会用字符串来表示“电话号码”,但是随后你会发现,电话号需要“格式化”,“抽取区号”之类的特殊行为。如果这样的数据项只有一两个,你还可以把相关函数放进数据项所属的对象里,但是Duplicate Code和Feature Envy很快就会表现出来。这时,你就应该将数值变为对象。
3、Change Value toReference 将值对象改为引用对象。
你从一个类衍生出许多批次相等的实例,希望将它们替换为同一个对象。
4、Change Reference to Value 将引用对象改为值对象。
你有一个引用对象,很小且不可变,而且不易管理。
5、Replace Array with Object 以对象取代数组。
你有一个数组,其中的元素各自代表不同的东西。
改造前:
String[] row = new String[3];
row[0] = "liver";
row[1] = "15";
改造后:
Performance row = new Performance();
row.setName("liver");
row.setWins(15);
6、Duplicate Observed Data 复制“被监视数据”。
有一些领域数据置身于GUI组件中,而领域函数需要访问这些数据。
将该数据复制到一个领域对象中。建立一个Observer模式,用以同步领域对象和GUI对象内的重复数据。可以使用事件监听器,诸如JAVAFX中的Property。
7、Change Unidirectional Association to Bidirectional 将单向关联改为双向关联。
两个类都需要使用对方特性,但其间只有一条单向链接。
8、Change Bidirectional Association to Unidirectional 将双向关联改为单向关联。
两个类之间有双向关联,但其中一个类如今不再需要另一个类的特性。
9、Replace Magic Number with Symbolic Constant 以字面常量取代魔法值。
改造前:
double count(double a, double b){return a * 0.95 * b;
}
改造后:
double count(double a, double b){return a * RATE_CONSTANT * b;
}
static final double RATE_CONSTANT = 0.95;
10、Encapsulate Field 封装字段。
即面向对象的首要原则之一:封装,或称为“数据隐藏”。
改造前:
public String _name;
改造后:
private String _name;public String getName() {return _name;
}public void setName(String name) {this._name = name;
}
11、Encapsulate Collection 封装集合。
让这个函数返回该集合的一个只读副本,并在这个类中提供添加/移除集合元素的函数。
改造前:
class Person {List<String> classes;public List<String> getClasses(){return classes; }public void setClasses(List<String> cls){this.classes = cls;}
}
改造后:
class Person {List<String> classes;public List<String> getClasses(){return classes; }// setter方法隐藏,避免用户修改集合内容而一无所知private void setClasses(List<String> cls){this.classes = cls;}public void addClass(String cls) {classes.add(cls);}public void removeClass(String cls) {classes.remove(cls);}
}
12、Replace Record with Data Class 以数据类取代记录。
主要用来应对传统编程环境中的记录结构。
13、Replace Type Code with Class 以类取代类型码。
类中有一个数值类型码,但它并不影响类的行为。
改造前:
class Person {public static final int O = 0;public static final int A = 1;public static final int B = 2;public static final int AB = 3;@Getter@Setterprivate int _bloodGroup;public Person(int bloodGroup) {_bloodGroup = bloodGroup;}
}
改造后:
class Person {public static final int O = BloodGroup.O.getCode();public static final int A = BloodGroup.A.getCode();public static final int B = BloodGroup.B.getCode();public static final int AB = BloodGroup.AB.getCode();@Getterprivate int _bloodGroup;public Person(int bloodGroup) {_bloodGroup = BloodGroup.code(bloodGroup);}public void setBloodGroup(int arg) {_bloodGroup = BloodGroup.code(arg);}
}class BloodGroup {public static final BloodGroup O = new BloodGroup(0);public static final BloodGroup A = new BloodGroup(1);public static final BloodGroup B = new BloodGroup(2);public static final BloodGroup AB = new BloodGroup(3);private static final BloodGroup[] _values = {A, A, B, AB}; @Getterprivate final int _code;private BloodGroup(int code) {_code = code; }public static BloodGroup code(int arg) {return _values[arg]; }}
14、Replace Type Code with Subclasses 以子类取代类型码。
你有一个不可变的类型码,他会影响类的行为。
15、Replace Type Code with State/Strategy 以State/Strategy取代类型码。
你有一个类型码,它会影响类的行为,但你无法通过继承手法消除他。
5. 小结
到此仅汇总了一半的重构手法,个人觉得部分重构手法是以牺牲一定的代码阅读性为代价。且书中提到的多数重构手法还是要视具体编程场景而定。避免错误引用。
重构手法和设计模式一样,均为编程模式中的最佳实践。是符合大多数场景和行为的思想或方法的总结。记住是大多数。了解最佳实践有助于提高平常的编码习惯以及提升代码的维护性,可修改性。但如果被错误引用,程序将因为过度设计或引用而变得臃肿。
持续更新中…将继续更新重构手法(下)…
相关文章:

重构·改善既有代码的设计.03之重构手法(上)
1. 前言 之前的重构系列中,介绍了书中提到的重构基础,以及识别代码的坏味道。今天继续第三更,讲述那些重构手法(上)。看看哪些手法对你的项目能有所帮助… 2. 重新组织函数 对函数进行整理,使之更恰当的…...

闭关修炼(0.0 pytorch基础学习)1
基于官网pytorch.org pytorch 动态 比较优秀 py3.7支持是最多的啦 原来anaconda 是蟒蛇的意思 细思极恐 python 是蛇 yi Introduction to PyTorch Tensors — PyTorch Tutorials 2.0.0cu117 documentation omygaga 英语极差 哈哈哈 tensor 多维数组 矩阵二维数组 Tensor…...

个人-计算机操作系统第一章
一、章节习题 1.操作系统的目标与应用环境有关,如分时系统,希望能提供良好的()能力。 A、批处理B、可靠性C、稳定性D、人-机交互 2.()是应用程序取得OS所有服务的唯一途径。 A、系统调用B、作业调度C、键…...
Python-责任链模式
介绍 责任链模式是一种行为型设计模式,它允许多个对象以链式的形式依次处理请求,直到请求被处理或者无处理对象为止 实现方式 责任链模式由多个处理器组成,每个处理器都可以处理一种请求。如果当前处理器无法处理请求,它将把请…...

HIT 计统实验2 二进制炸弹(gdb破解版) 拆弹过程
CSAPP 实验2是一个很好玩的实验,网上有很多参考资源写的都很好,本文增加了一些具体细节。 想要我的炸弹可以私信我。 还得看形式语言 , 炸弹6 7 有时间再拆 第1章 实验基本信息 1.1 实验目的 熟练掌握计算机系统的ISA指令系统与寻址方式熟练掌握Linu…...

echart 半环渐变仪表盘
实现效果如图: op配置项代码: let Chart this.$echarts.init(document.getElementById(dashboard-1));let option {// backgroundColor: #040d2e,series: [// 中间灰色轴线{type: gauge,radius: 150%, // 位置center: [50%, 90%],startAngle: 180,end…...

【springboot】自动加载分析
文章目录问题SpringBootApplication注解AutoConfigurationPackages.Registrar类AutoConfigurationImportSelector类springboot如何加载其他的starter总结问题 为什么我们在使用springboot的时候,只需要在maven中导入starter就能够使用呢?这里来分析一下…...

ChatGPT批量翻译-ChatGPT批量生成多国语言
ChatGPT翻译的准吗 ChatGPT是一种基于Transformer架构的自然语言处理技术,其翻译准确性取决于所训练的模型和数据集的质量。在特定的语料库和训练数据下,ChatGPT可以实现一定程度的准确翻译。但是,与人工翻译相比,ChatGPT的翻译质…...

Symble
ES6引入了一种新的原始数据类型 Symbol,表示独一无二的值。它是JavaScript语言的第七种数据类型,是一种类似于字符串的数据类型。 Symbol特点 Symbol 的值是唯一的,用来解决命名冲突的问题 Symbol值不能与其他数据进行运算 Symbol定义的对…...

能在家里赚钱的工作有哪些?适合普通人的兼职项目
当下对于普通人而言,想在社会上找到一份舒心安逸的工作很难,特别是在薪酬待遇这方面,更是低得让人心寒。那么,如果能有一份在家就可以做的事情,而且是收入也不少,那将是很多普通人的最佳选择。在这里&#…...
创建SaaS产品帮助中心的关键步骤
帮助中心是一款SaaS产品必不可少的一部分,为了帮助用户更好的解决产品相关问题,提高新用户的使用体验,并且引导用户更好的使用产品,那么应该怎样制作帮助中心呢,每个产品帮助中心都需要有自己的风格,根据产…...

高频算法:Leetcode53 最大子数组和
今天讲的是Leetcode第53题,最大子数组和 首先观察题目,题目需要我们找出具有最大和的连续子数组,直接拿题目中的示例来做一个演示,找一找什么规律下的连续子数组才能得到最大的和 先从-2开始,-2 1 -1 此时我们的和…...

如何编写接口自动化测试框架、
编写接口自动化测试框架需要注意以下几点: 接口选择:首先确定需要测试的接口,包括请求方式、URL、参数、返回值等信息。 框架设计:设计一个灵活的框架,可以根据接口类型(RESTful API、SOAP API等ÿ…...

【Java面试八股文宝典之RabbitMQ篇】备战2023 查缺补漏 你越早准备 越早成功!!!——Day17
大家好,我是陶然同学,软件工程大三即将实习。认识我的朋友们知道,我是科班出身,学的还行,但是对面试掌握不够,所以我将用这100多天更新Java面试题🙃🙃。 不敢苟同,相信大…...

ESP32开发(1)----Espressif-IDE开发环境配置
Espressif-IDE开发环境配置前言一、ESP32-WROOM-32介绍二、IDE环境搭建三、建立第一个项目总结前言 最近得到一块ESP32-WROOM-32的开发板,没有原理图,但板子走线比较简单,看着板子上的布线大致猜一猜连接,然后试玩了一下…...

MyBatisPlus标准数据层开发
MyBatisPlus标准数据层开发2,标准数据层开发2.1 标准CRUD使用2.2 新增2.3 删除2.4 修改2.5 根据ID查询2.6 查询所有2.7 Lombok概念使用步骤步骤1:添加lombok依赖步骤2:安装Lombok的插件步骤3:模型类上添加注解2.8 分页功能步骤1:调用方法传入参数获取返回值步骤2:设…...

C/C++每日一练(20230412)
目录 1. 二维数组找最值 🌟🌟 2. 排序 🌟 3. 二叉树展开为链表 🌟🌟 🌟 每日一练刷题专栏 🌟 Golang每日一练 专栏 Python每日一练 专栏 C/C每日一练 专栏 Java每日一练 专栏 1. 二维…...

Leetcode.1379 找出克隆二叉树中的相同节点
题目链接 Leetcode.1379 找出克隆二叉树中的相同节点 easy 题目描述 给你两棵二叉树,原始树 original和克隆树 cloned,以及一个位于原始树 original中的目标节点 target。 其中,克隆树 cloned是原始树 original的一个 副本 。 请找出在树 …...
2022年团体程序设计天梯赛-总决赛
目录 一、L1-1 今天我要赢 二、L1-2 种钻石 三、L1-3 谁能进图书馆 四、L1-4 拯救外星人 五、L1-5 试试手气 六、L1-6 斯德哥尔摩火车上的题 七、L1-7 机工士姆斯塔迪奥 八、L1-8 静静的推荐 九、L2-1 插松枝 十、L2-2 老板的作息表 十一、L2-3 龙龙送外卖 十二、L…...

大数据技术之Sqoop——SQL to Hadoop
一、简介sqoop (sql to hadoop)是一款开源的工具,主要用于在 Hadoop(Hive)与传统的数据库(mysql、postgresql...)间进行数据的传递,可以将一个关系型数据库(例如 : MSQL,Oracle,Post…...

深入剖析AI大模型:大模型时代的 Prompt 工程全解析
今天聊的内容,我认为是AI开发里面非常重要的内容。它在AI开发里无处不在,当你对 AI 助手说 "用李白的风格写一首关于人工智能的诗",或者让翻译模型 "将这段合同翻译成商务日语" 时,输入的这句话就是 Prompt。…...
React Native 导航系统实战(React Navigation)
导航系统实战(React Navigation) React Navigation 是 React Native 应用中最常用的导航库之一,它提供了多种导航模式,如堆栈导航(Stack Navigator)、标签导航(Tab Navigator)和抽屉…...

Opencv中的addweighted函数
一.addweighted函数作用 addweighted()是OpenCV库中用于图像处理的函数,主要功能是将两个输入图像(尺寸和类型相同)按照指定的权重进行加权叠加(图像融合),并添加一个标量值&#x…...

剑指offer20_链表中环的入口节点
链表中环的入口节点 给定一个链表,若其中包含环,则输出环的入口节点。 若其中不包含环,则输出null。 数据范围 节点 val 值取值范围 [ 1 , 1000 ] [1,1000] [1,1000]。 节点 val 值各不相同。 链表长度 [ 0 , 500 ] [0,500] [0,500]。 …...
Frozen-Flask :将 Flask 应用“冻结”为静态文件
Frozen-Flask 是一个用于将 Flask 应用“冻结”为静态文件的 Python 扩展。它的核心用途是:将一个 Flask Web 应用生成成纯静态 HTML 文件,从而可以部署到静态网站托管服务上,如 GitHub Pages、Netlify 或任何支持静态文件的网站服务器。 &am…...

Python爬虫(一):爬虫伪装
一、网站防爬机制概述 在当今互联网环境中,具有一定规模或盈利性质的网站几乎都实施了各种防爬措施。这些措施主要分为两大类: 身份验证机制:直接将未经授权的爬虫阻挡在外反爬技术体系:通过各种技术手段增加爬虫获取数据的难度…...
linux 下常用变更-8
1、删除普通用户 查询用户初始UID和GIDls -l /home/ ###家目录中查看UID cat /etc/group ###此文件查看GID删除用户1.编辑文件 /etc/passwd 找到对应的行,YW343:x:0:0::/home/YW343:/bin/bash 2.将标红的位置修改为用户对应初始UID和GID: YW3…...

vue3+vite项目中使用.env文件环境变量方法
vue3vite项目中使用.env文件环境变量方法 .env文件作用命名规则常用的配置项示例使用方法注意事项在vite.config.js文件中读取环境变量方法 .env文件作用 .env 文件用于定义环境变量,这些变量可以在项目中通过 import.meta.env 进行访问。Vite 会自动加载这些环境变…...
Android第十三次面试总结(四大 组件基础)
Activity生命周期和四大启动模式详解 一、Activity 生命周期 Activity 的生命周期由一系列回调方法组成,用于管理其创建、可见性、焦点和销毁过程。以下是核心方法及其调用时机: onCreate() 调用时机:Activity 首次创建时调用。…...
使用Matplotlib创建炫酷的3D散点图:数据可视化的新维度
文章目录 基础实现代码代码解析进阶技巧1. 自定义点的大小和颜色2. 添加图例和样式美化3. 真实数据应用示例实用技巧与注意事项完整示例(带样式)应用场景在数据科学和可视化领域,三维图形能为我们提供更丰富的数据洞察。本文将手把手教你如何使用Python的Matplotlib库创建引…...