重构·改善既有代码的设计.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
    @Setter
    private 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();
    
    @Getter
    private 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}; 
    
    @Getter
    private 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. 小结

到此仅汇总了一半的重构手法,个人觉得部分重构手法是以牺牲一定的代码阅读性为代价。且书中提到的多数重构手法还是要视具体编程场景而定。避免错误引用。
重构手法和设计模式一样,均为编程模式中的最佳实践。是符合大多数场景和行为的思想或方法的总结。记住是大多数。了解最佳实践有助于提高平常的编码习惯以及提升代码的维护性,可修改性。但如果被错误引用,程序将因为过度设计或引用而变得臃肿。
持续更新中…将继续更新重构手法(下)…

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:/a/1122.html

如若内容造成侵权/违法违规/事实不符,请联系我们进行投诉反馈qq邮箱809451989@qq.com,一经查实,立即删除!

相关文章

51单片机入门 -驱动 8x8 LED 点阵屏

硬件型号、软件版本、以及烧录流程 操作系统&#xff1a;Windows 10 x84-64单片机&#xff1a;STC89C52RC编译器&#xff1a;SDCC烧录软件&#xff1a;stcgal 1.6开发板&#xff1a;普中51单片机开发板A2套件&#xff08;2022&#xff09; 在 VS Code 中新建项目到烧录的过程…

[ROC-RK3568-PC] [Firefly-Android] 10min带你了解I2C的使用

&#x1f347; 博主主页&#xff1a; 【Systemcall小酒屋】&#x1f347; 博主追寻&#xff1a;热衷于用简单的案例讲述复杂的技术&#xff0c;“假传万卷书&#xff0c;真传一案例”&#xff0c;这是林群院士说过的一句话&#xff0c;另外“成就是最好的老师”&#xff0c;技术…

5.springcloud微服务架构搭建 之 《springboot集成Hystrix》

1.springcloud微服务架构搭建 之 《springboot自动装配Redis》 2.springcloud微服务架构搭建 之 《springboot集成nacos注册中心》 3.springcloud微服务架构搭建 之 《springboot自动装配ribbon》 4.springcloud微服务架构搭建 之 《springboot集成openFeign》 目录 1.项目…

C语言刷题(7)(字符串旋转问题)——“C”

各位CSDN的uu们你们好呀&#xff0c;今天&#xff0c;小雅兰的内容依旧是复习之前的知识点&#xff0c;那么&#xff0c;就是做一道小小的题目啦&#xff0c;下面&#xff0c;让我们进入C语言的世界吧 实现一个函数&#xff0c;可以左旋字符串中的k个字符。 例如&#xff1a; A…

2023最新性能测试八股文【附答案】,软测人必备!

1. 请描述什么是性能测试、什么是负载测试、什么是压力测试&#xff1f;【参考答案】性能测试&#xff1a;性能测试是和功能测试相对应的。根据用户场景进行的单个用户操作&#xff0c;是属于功能测试领域&#xff0c;主要是验证软件是否可以满足用户的功能需求。比如&#xff…

【刷题之路Ⅱ】LeetCode 11.盛水最多的容器

【刷题之路Ⅱ】LeetCode 11.盛水最多的容器一、题目描述二、解题1、方法1——暴力法1.1、思路分析1.2、代码实现2、方法2——双指针2.1、思路分析2.2、代码实现一、题目描述 原题连接&#xff1a; 11.盛水最多的容器 题目描述&#xff1a; 给定一个长度为 n 的整数数组 height…

44岁了,我从没想过在CSDN创作2年,会有这么大收获

1998年上的大学&#xff0c;02年毕业&#xff0c;就算从工作算起&#xff0c;我也有20余年的码龄生涯了。 但正式开启博文的写作&#xff0c;却是2021年开始的&#xff0c;差不多也就写了2年的博客&#xff0c;今天我来说说我在CSDN的感受和收获。 我是真的没想到&#xff0c;…

QT串口助手开发3串口开发

系列文章目录 QT串口助手开发3串口开发 QT串口助手开发3系列文章目录一、UI界面程序的编写二、发送框程序编写一、UI界面程序的编写 根据上文的未解决问题&#xff1a;我们打开串口按钮打开后只能选择关闭串口&#xff0c;所以这个是循环的过程 上文链接 所以按钮对应的槽函数…

【C++】搜索二叉树(保姆教程)

&#x1f345;二叉树底层是堆&#xff0c;之前学习的简单二叉树不是大堆就是小堆&#xff0c;今天是二叉树进阶&#xff0c;一定要好好掌握&#xff01; 目录 ☃️1.搜索二叉树介绍 ☃️2.底层实现 ☃️3.key模型和key&#xff0c;value模型 ☃️1.搜索二叉树介绍 右>根&…

蜻蜓优化算法Python代码(详细注释)

1.代入例子&#xff0c;目标函数求最优解迭代过程&#xff1a;蜻蜓算法流程&#xff1a;蜻蜓算法&#xff08;Dragonfly Algorithm&#xff09;是一种基于种群的优化算法&#xff0c;灵感来自于蜻蜓的群集行为。该算法通过模拟蜻蜓之间的吸引力和斥力&#xff0c;以及蜻蜓的移动…

IDEA好用插件:MybatisX快速生成接口实体类mapper.xml映射文件

目录 1、在Idea中找到下载插件&#xff0c;Install&#xff0c;重启Idea 2、一个测试java文件&#xff0c;里面有com包 3、在Idea中添加数据库 --------以Oracle数据库为例 4、快速生成entity-service-mapper方法 5、查看生成的代码 6、自动生成&#xff08;增删查改&#xff0…

C++ | 对比inline内联函数和宏的不同点

文章目录一、前言二、宏的优缺点分析1、概念回顾2、宏的缺点3、宏的优点三、inline内联函数1、概念2、特性①&#xff1a;空间换时间&#x1f381;趣味杂谈&#xff1a;庞大的游戏更新包3、特性②&#xff1a;inline实现机制4、特性③&#xff1a;inline的声明与定义反汇编观察…

【链表OJ题(八)】相交链表

​ ​&#x1f4dd;个人主页&#xff1a;Sherry的成长之路 &#x1f3e0;学习社区&#xff1a;Sherry的成长之路&#xff08;个人社区&#xff09; &#x1f4d6;专栏链接&#xff1a;数据结构 &#x1f3af;长路漫漫浩浩&#xff0c;万事皆有期待 文章目录链表OJ题(八)8. 相交…

【C++笔试强训】第三十二天

&#x1f387;C笔试强训 博客主页&#xff1a;一起去看日落吗分享博主的C刷题日常&#xff0c;大家一起学习博主的能力有限&#xff0c;出现错误希望大家不吝赐教分享给大家一句我很喜欢的话&#xff1a;夜色难免微凉&#xff0c;前方必有曙光 &#x1f31e;。 &#x1f4a6;&a…

Spring Bean实例化和初始化的过程

承接上文Spring Bean生命周期应用程序在运行过程中能否去读取当前系统的环境变量或系统属性?这里涉及到一个非常重要的接口Environment&#xff0c;System.getenv&#xff0c;System.getProperties都是获取当前系统环境变量&#xff0c;Environment接口的实现类AbstractEnviro…

浏览器前进与后退的秘密——栈 (栈的理解与实现)

文章目录前言&#xff1a;浏览器与栈的纠缠如何理解“栈”&#xff1f;如何实现一个“栈”&#xff1f;基于数组的顺序栈基于链表的链式栈解答开篇&#x1f431;‍&#x1f409;作者简介&#xff1a;大家好&#xff0c;我是黑洞晓威&#xff0c;一名大二学生&#xff0c;希望和…

每日算法题

题目描述 本题为填空题&#xff0c;只需要算出结果后&#xff0c;在代码中使用输出语句将所填结果输出即可。 作为篮球队教练&#xff0c;你需要从以下名单中选出 11 号位至 55 号位各一名球员&#xff0c;组成球队的首发阵容。 每位球员担任 11 号位至 55 号位时的评分如下…

CCF-CSP真题《202212-3 JPEG 解码》思路+python,c++满分题解

想查看其他题的真题及题解的同学可以前往查看&#xff1a;CCF-CSP真题附题解大全 试题编号&#xff1a;202212-3试题名称&#xff1a;JPEG 解码时间限制&#xff1a;1.0s内存限制&#xff1a;512.0MB问题描述&#xff1a; 问题背景 四年一度的世界杯即将画上尾声。在本…

STM32 OTA应用开发——通过串口/RS485实现OTA升级(方式2)

STM32 OTA应用开发——通过串口/RS485实现OTA升级&#xff08;方式2&#xff09; 目录STM32 OTA应用开发——通过串口/RS485实现OTA升级&#xff08;方式2&#xff09;前言1 环境搭建2 功能描述3 程序编写3.1 BootLoader部分3.2 APP的制作4 修改工程中的内存配置4.1 Bootloader…

面试阿里测开岗失败后,被面试官在朋友圈吐槽了......

前一阵子有个徒弟向我诉苦&#xff0c;说自己在参加某大厂测试面试的时候被面试官怼得哑口无言&#xff0c;场面让他一度十分尴尬印象最深的就是下面几个问题&#xff1a;根据你以前的工作经验和学习到的测试技术&#xff0c;说说你对质量保证的理解&#xff1f;非关系型数据库…