聊一聊代码重构——封装集合和替换算法的代码实践
创始人
2024-06-02 03:07:33
0

代码重构相关内容

聊一聊代码重构——我们为什么要代码重构

聊一聊代码重构——代码中究竟存在哪些坏代码

聊一聊代码重构——关于变量的代码实践

聊一聊代码重构——关于循环逻辑的代码实践

聊一聊代码重构——关于条件表达式的代码实践

聊一聊代码重构——程序方法上的代码实践

聊一聊代码重构——程序方法和类上的代码实践

聊一聊代码重构——存在继承关系类上的代码实践

聊一聊代码重构——封装集合和替换算法的代码实践


封装集合

对集合属性进行封装

很多时候我们封装了对象属性的访问,这能提供属性的安全性,但是对于集合,我们一般会将集合作为一个整体来控制。这使得我们可以直接访问并修改集合,这使得集合变得脆弱。而很多时候我们更加在意的是集合内部的元素的操作,而不是对集合本身进行修改。所以在对象存在集合属性时,需要对集合进行特殊的封装。

需要那些封装

  1. 在getter方法中,返回集合的一个只读拷贝,以防止外部代码修改集合。
  2. 在setter方法中,进控制,将对集合的修改限制在元素上的修改。
  3. 对集合添加对集合元素内操作的方法。

就像下面对属性的封装

public class ShoppingCart {private List items = new ArrayList<>();public void addItem(Item item) {items.add(item);}public void removeItem(Item item) {items.remove(item);}public double getTotalPrice() {double total = 0;for (Item item : getItems()) {total += item.getPrice();}return total;}public List getItems() {return Collections.unmodifiableList(items);}private void setItems(List items) {this.items = items;}
}

在上面的示例中,我们将 items 属性设置为私有,并创建了 getter 和 setter 方法。我们在 setter 方法中添加了一些逻辑,以确保集合只能通过该方法进行修改。在 getter 方法中,我们返回集合的一个只读拷贝,以防止外部代码修改集合。在 getTotalPrice 方法中,我们通过 getItems 方法来访问集合。最终,我们可以逐步修改代码中所有直接访问 items 属性的地方,使其改为通过 getter 和 setter 方法进行访问。

替换算法

很多时候在最开始实现业务的时候对业务最终展现的形式不是很清晰,或者因为时间原因我们只能选择最快实现业务的方式。但是这些内容有可能并不是最好的方式,在原先的做法之外,可能存在更简单的解决方案,此时在重构代码时需要尝试对原来算法进行重构。比如使用更高效的算法替代低效算法,使用已经存在的三方库中方法替代自己编写的方法等。

如何进行算法替换

  1. 选择一个可以替换当前算法的新算法。
  2. 如果新的算法不是三方库中已有的内容,则将新算法实现为一个新的方法。
  3. 在原方法调用地方切换为新方法。
  4. 测试正确性,比较新算法的性能。

什么样的内容要替换算法

  1. 使用高效算法替换低效的算法

  2. 使用高可读性的算法替换低可读性算法

引入特例

特殊的逻辑

正常业务中,即使逻辑分支不同,但是其需要经历的流程大多是类似的,这个时候我们使用一些系列公共逻辑将其抽象。后来的开发同学在理解这些内容时会更加容易。但是某些时候,总会有某个特殊的逻辑分支在业务逻辑或者涉及数据范围都和其他分支差异巨大。为了不破坏原有代码结构和设计,又不想在父类中添加太多的特定逻辑。我们可以声明一个特殊标记的专门类来处理这个逻辑,需要处理这个逻辑的地方调用这个特例类的方法。这个特例类通常是一个继承自父类的子类,但是只包含特定的逻辑处理,不包含其他的业务逻辑。这样既完成了特殊处理,又保持原有的代码结构和设计,避免对原有代码的影响和破坏。但是,过度使用引入特例可能会导致代码过于复杂和难以维护,因此需要根据具体情况进行选择和使用。

下面情况下可以考虑使用引入特例的重构

  1. 如果业务分支中,存在大量针对特殊情况的判断和处理,并且这些特殊情况的处理逻辑相同。

  2. 特殊分支处理逻辑和正常情况的处理逻辑内容迥异,其逻辑会影响对正常逻辑的理解和扩展。

尝试引入特例的

  1. 审查代码,找出代码中符合上面描述的特殊情况。
  2. 创建一个特例类,该类应该继承自原来的类,并重写特殊情况下的方法。
  3. 在原来的类中添加一个方法,用于判断当前是否为特殊情况。
  4. 在原来的类中,将特殊情况下的代码替换为使用特例类的代码。如果当前为特殊情况,则创建特例类的实例并调用其方法,否则调用原来的方法。
  5. 测试

下面是一个使用特例方式重构的demo

原始代码中getTotalPrice(),当检测到特殊产品ID时候会使用与正常计算规则不同的计算方式。如果一个系统中是通过优惠标记来进行产品折扣的,那么这种固定产品ID进行折扣的方式,显然和产品正常涉及的逻辑不相符合。这个时候我们可以提供一个特殊的对象,将其内部处理逻辑和正常逻辑隔离出来

public class Order {private int productId;private int quantity;private double price;public Order(int productId, int quantity, double price) {this.productId = productId;this.quantity = quantity;this.price = price;}public double getTotalPrice() {if (productId == 1) {return quantity * price * 0.9;} else {return quantity * price;}}
}

在下面新建一个继承于新对象的SpecialPriceOrder,初始化时使用新的对象取代原始对象。将正常的代码逻辑和特殊的代码逻辑隔离出来

public class SpecialPriceOrder extends Order {public SpecialPriceOrder(int productId, int quantity, double price) {super(productId, quantity, price);}@Overridepublic double getTotalPrice() {return super.getTotalPrice() * 0.9;}
}public class Order {private int productId;private int quantity;private double price;public Order(int productId, int quantity, double price) {this.productId = productId;this.quantity = quantity;this.price = price;if (productId == 1) {this.setSpecialOrder(new SpecialPriceOrder(productId, quantity, price));}}......
}

相关内容

热门资讯

杭州山沟沟概况导游词 杭州山沟沟概况导游词  作为一名默默奉献的导游,总归要编写导游词,导游词作为一种解说的文体,它的作用...
我是大连小导游作文共60篇 我是大连小导游作文 第一篇亲爱的朋友们,旅途辛苦了,欢迎来到我的家乡—福州永泰,我是今天的小导游,大...
呼和浩特大昭寺导游词 呼和浩特大昭寺导游词  大昭寺成为藏式宗教建筑的千古典范,是旅游的胜地,吸引了很多游客来参观,导游要...
逍遥津导游词 逍遥津导游词位于合肥市旧城的东北角,是一座约20万平方米的城市公园。逍遥津古为淝水上的一个津渡。公园...
导游词开场白 导游词开场白导游词开场白有一句广告词说:心随我动,沟通无限,那我与在座各位朋友的沟通就从我的自我介绍...
苏州盘门三景导游词 苏州盘门三景导游词范例  苏州历史文化名城遐迩闻名在于她的历史悠久、人文荟萃、风景优美。盘门景区位于...
游长城导游词 游长城导游词  长城是世界七大奇迹之一。它像一条巨龙盘踞在中国北方的辽阔的土地上。它是中国古代劳动人...
颐和园导游词400字 颐和园导游词400字  一、颐和园简介  颐和园,中国清朝时期皇家园林,前身为清漪园,坐落在北京西郊...
辽宁省五女山导游词 辽宁省五女山导游词  作为一名具备丰富知识的导游,时常需要用到导游词,导游词的主要特点是口语化,此外...
介绍平遥古城导游词 介绍平遥古城导游词(通用15篇)  作为一位杰出的导游,往往需要进行导游词编写工作,导游词是导游员进...
太乙洞导游词 太乙洞导游词1、[洞口太乙神像]亲爱的游客,大家好!热烈欢迎观光!我们太乙洞有360万年历史,主洞全...
沈阳故宫导游词 沈阳故宫导游词  作为一名专门为游客提供帮助的导游,就有可能用到导游词,导游词具有注重口语化、精简凝...
广化寺导游词 广化寺导游词  广化寺,又称莆田南山广化寺,大家不妨来看看小编推送的广化寺导游词,希望给大家带来帮助...
学校的导游词 学校的导游词  作为一名专门引导游客、助人为乐的导游,就不得不需要编写导游词,导游词事实上是一种对旅...
云冈石窟介绍导游词 云冈石窟介绍导游词(精选10篇)  作为一无名无私奉献的导游,常常需要准备导游词,导游词是讲解当地的...
福建鼓山十八景精彩导游词参考 福建鼓山十八景精彩导游词参考  各位游客朋友们,大家早上好!欢迎你们来到鼓山十八景,我是你们的导游小...
成都武侯祠导游词 成都武侯祠导游词精选  成都武侯祠号称“三国圣地”,是全国保存最好的纪念三国文化的地方。保存得好的原...
富春江导游词 富春江导游词范文  富春江的导游词篇一:富春江导游词  各位游客,现在我们正置身于有“奇山异水,天下...
安徽九华山导游词150字 九华山在皖南青阳县境内,是我国四大佛教名山之一,唐代文学家刘禹锡,登上九华山后,对其赞叹不已,认为天...
西安古城墙介绍导游词 西安古城墙介绍导游词  作为一名优秀的旅游从业人员,总归要编写导游词,导游词的主要特点是口语化,此外...