如何把if-else代码重构成高质量代码

时间:2022-05-11 08:43:59

原文:https://blog.csdn.net/qq_35440678/article/details/77939999

本文提纲:

为什么我们写的代码都是if-else?

这样的代码有什么缺点?

是否有优化的方法?如何重构?

异常逻辑处理型重构方法

状态处理型重构方法

为什么我们写的代码都是if-else?

程序员想必都经历过这样的场景:刚开始自己写的代码很简洁,逻辑清晰,函数精简,没有一个if-else,

可随着代码逻辑不断完善和业务的瞬息万变:比如需要对入参进行类型和值进行判断;这里要判断下对象是否为null;不同类型执行不同的流程。

落地到具体实现只能不停地加if-else来处理,渐渐地,代码变得越来越庞大,函数越来越长,文件行数也迅速突破上千行,维护难度也越来越大,到后期基本达到一种难以维护的状态。

虽然我们都很不情愿写出满屏if-else的代码,可逻辑上就是需要特殊判断,很绝望,可也没办法避免啊。

其实回头看看自己的代码,写if-else不外乎两种场景:异常逻辑处理和不同状态处理。

两者最主要的区别是:异常逻辑处理说明只能一个分支是正常流程,而不同状态处理都所有分支都是正常流程。

怎么理解?举个例子:

//举例一:异常逻辑处理例子
Object obj = getObj();
if (obj != null) {
//do something
}else{
//do something
} //举例二:状态处理例子
Object obj = getObj();
if (obj.getType == 1) {
//do something
}else if (obj.getType == 2) {
//do something
}else{
//do something
}

第一个例子if (obj != null)是异常处理,是代码健壮性判断,只有if里面才是正常的处理流程,else分支是出错处理流程;

而第二个例子不管type等于1,2还是其他情况,都属于业务的正常流程。对于这两种情况重构的方法也不一样。

代码if-else代码太多有什么缺点?

缺点相当明显了:

  • 最大的问题是代码逻辑复杂,维护性差,极容易引发bug。
  • 如果使用if-else,说明if分支和else分支的重视是同等的,但大多数情况并非如此,容易引起误解和理解困难。

是否有好的方法优化?如何重构?

方法肯定是有的。重构if-else时,心中无时无刻把握一个原则:

尽可能地维持正常流程代码在最外层。

意思是说,可以写if-else语句时一定要尽量保持主干代码是正常流程,避免嵌套过深。

实现的手段有:减少嵌套、移除临时变量、条件取反判断、合并条件表达式等。

下面举几个实例来讲解这些重构方法:

异常逻辑处理型重构方法实例一:

重构前:

double disablityAmount(){
if(_seniority < 2)
return 0; if(_monthsDisabled > 12)
return 0; if(_isPartTime)
return 0; //do somethig }

重构后:

double disablityAmount(){
if(_seniority < 2 || _monthsDisabled > 12 || _isPartTime)
return 0; //do somethig
}

这里的重构手法叫合并条件表达式:如果有一系列条件测试都得到相同结果,将这些结果测试合并为一个条件表达式。

这个重构手法简单易懂,带来的效果也非常明显,能有效地较少if语句,减少代码量逻辑上也更加易懂。

异常逻辑处理型重构方法实例二:

重构前:

double getPayAmount(){
double result;
if(_isDead) {
result = deadAmount();
}else{
if(_isSeparated){
result = separatedAmount();
}
else{
if(_isRetired){
result = retiredAmount();
else{
result = normalPayAmount();
}
}
}
return result;

重构后:

double getPayAmount(){
if(_isDead)
return deadAmount(); if(_isSeparated)
return separatedAmount(); if(_isRetired)
return retiredAmount(); return normalPayAmount();
}

怎么样?比对两个版本,会发现重构后的版本逻辑清晰,简洁易懂。

和重构前到底有什么区别呢?

最大的区别是减少if-else嵌套。

可以看到,最初的版本if-else最深的嵌套有三层,看上去逻辑分支非常多,进到里面基本都要被绕晕。其实,仔细想想嵌套内的if-else和最外层并没有关联性的,完全可以提取最顶层。

改为平行关系,而非包含关系,if-else数量没有变化,但是逻辑清晰明了,一目了然。

另一个重构点是废除了result临时变量,直接return返回。好处也显而易见直接结束流程,缩短异常分支流程。原来的做法先赋值给result最后统一return,那么对于最后return的值到底是那个函数返回的结果不明确,增加了一层理解难度。

总结重构的要点:如果if-else嵌套没有关联性,直接提取到第一层,一定要避免逻辑嵌套太深。尽量减少临时变量改用return直接返回。

异常逻辑处理型重构方法实例三:

重构前:

public double getAdjustedCapital(){
double result = 0.0;
if(_capital > 0.0 ){
if(_intRate > 0 && _duration >0){
resutl = (_income / _duration) *ADJ_FACTOR;
}
}
return result;
}

第一步,运用第一招:减少嵌套和移除临时变量:

public double getAdjustedCapital(){
if(_capital <= 0.0 ){
return 0.0;
}
if(_intRate > 0 && _duration >0){
return (_income / _duration) *ADJ_FACTOR;
}
return 0.0;
}

这样重构后,还不够,因为主要的语句(_income / _duration) *ADJ_FACTOR;在if内部,并非在最外层,根据优化原则(尽可能地维持正常流程代码在最外层),可以再继续重构:

public double getAdjustedCapital(){
if(_capital <= 0.0 ){
return 0.0;
}
if(_intRate <= 0 || _duration <= 0){
return 0.0;
} return (_income / _duration) *ADJ_FACTOR;
}

这才是好的代码风格,逻辑清晰,一目了然,没有if-else嵌套难以理解的流程。

这里用到的重构方法是:将条件反转使异常情况先退出,让正常流程维持在主干流程。

异常逻辑处理型重构方法实例四:

重构前:

   /* 查找年龄大于18岁且为男性的学生列表 */
public ArrayList<Student> getStudents(int uid){
ArrayList<Student> result = new ArrayList<Student>();
Student stu = getStudentByUid(uid);
if (stu != null) {
Teacher teacher = stu.getTeacher();
if(teacher != null){
ArrayList<Student> students = teacher.getStudents();
if(students != null){
for(Student student : students){
if(student.getAge() > = 18 && student.getGender() == MALE){
result.add(student);
}
}
}else {
logger.error("获取学生列表失败");
}
}else {
logger.error("获取老师信息失败");
}
} else {
logger.error("获取学生信息失败");
}
return result;
}

典型的"箭头型"代码,最大的问题是嵌套过深,解决方法是异常条件先退出,保持主干流程是核心流程:

重构后:

   /* 查找年龄大于18岁且为男性的学生列表 */
public ArrayList<Student> getStudents(int uid){
ArrayList<Student> result = new ArrayList<Student>();
Student stu = getStudentByUid(uid);
if (stu == null) {
logger.error("获取学生信息失败");
return result;
} Teacher teacher = stu.getTeacher();
if(teacher == null){
logger.error("获取老师信息失败");
return result;
} ArrayList<Student> students = teacher.getStudents();
if(students == null){
logger.error("获取学生列表失败");
return result;
} for(Student student : students){
if(student.getAge() > 18 && student.getGender() == MALE){
result.add(student);
}
}
return result;
}

状态处理型重构方法实例一

重构前:

double getPayAmount(){
Object obj = getObj();
double money = 0;
if (obj.getType == 1) {
ObjectA objA = obj.getObjectA();
money = objA.getMoney()*obj.getNormalMoneryA();
}
else if (obj.getType == 2) {
ObjectB objB = obj.getObjectB();
money = objB.getMoney()*obj.getNormalMoneryB()+1000;
}
}

重构后:

double getPayAmount(){
Object obj = getObj();
if (obj.getType == 1) {
return getType1Money(obj);
}
else if (obj.getType == 2) {
return getType2Money(obj);
}
} double getType1Money(Object obj){
ObjectA objA = obj.getObjectA();
return objA.getMoney()*obj.getNormalMoneryA();
} double getType2Money(Object obj){
ObjectB objB = obj.getObjectB();
return objB.getMoney()*obj.getNormalMoneryB()+1000;
}

这里使用的重构方法是:把if-else内的代码都封装成一个公共函数。函数的好处是屏蔽内部实现,缩短if-else分支的代码。代码结构和逻辑上清晰,能一下看出来每一个条件内做的功能。

状态处理型重构方法实例二

针对状态处理的代码,一种优雅的做法是用多态取代条件表达式(《重构》推荐做法)。

你手上有个条件表达式,它根据对象类型的不同而选择不同的行为。将这个表达式的每个分支放进一个子类内的覆写函数中,然后将原始函数声明为抽象函数。

重构前:

double getSpeed(){
switch(_type){
case EUROPEAN:
return getBaseSpeed();
case AFRICAN:
return getBaseSpeed()-getLoadFactor()*_numberOfCoconuts;
case NORWEGIAN_BLUE:
return (_isNailed)?0:getBaseSpeed(_voltage);
}
}

重构后:

class Bird{
abstract double getSpeed();
} class European extends Bird{
double getSpeed(){
return getBaseSpeed();
}
} class African extends Bird{
double getSpeed(){
return getBaseSpeed()-getLoadFactor()*_numberOfCoconuts;
}
} class NorwegianBlue extends Bird{
double getSpeed(){
return (_isNailed)?0:getBaseSpeed(_voltage);
}
}

可以看到,使用多态后直接没有了if-else,但使用多态对原来代码修改过大,需要一番功夫才行。最好在设计之初就使用多态方式。

总结

if-else代码是每一个程序员最容易写出的代码,同时也是最容易被写烂的代码,稍不注意,就产生一堆难以维护和逻辑混乱的代码。

针对条件型代码重构把握一个原则:

尽可能地维持正常流程代码在最外层,保持主干流程是正常核心流程。

为维持这个原则:合并条件表达式可以有效地减少if语句数目;减少嵌套能减少深层次逻辑;

异常条件先退出自然而然主干流程就是正常流程。

针对状态处理型重构方法有两种:一种是把不同状态的操作封装成函数,简短if-else内代码行数;另一种是利用面向对象多态特性直接干掉了条件判断。

现在回头看看自己的代码,犯了哪些典型错误,赶紧运用这些重构方法重构代码吧!!

如何把if-else代码重构成高质量代码的更多相关文章

  1. 6个实例详解如何把if-else代码重构成高质量代码

    本文提纲: 为什么我们写的代码都是if-else?这样的代码有什么缺点?是否有优化的方法?如何重构?异常逻辑处理型重构方法状态处理型重构方法为什么我们写的代码都是if-else?程序员想必都经历过这样 ...

  2. 编写高质量代码改善C&num;程序的157个建议——建议154:不要过度设计,在敏捷中体会重构的乐趣

    建议154:不要过度设计,在敏捷中体会重构的乐趣 有时候,我们不得不随时更改软件的设计: 如果项目是针对某个大型机构的,不同级别的软件使用者,会提出不同的需求,或者随着关键岗位人员的更替,需求也会随个 ...

  3. 编写高质量代码改善C&num;程序的157个建议——建议147:重构多个相关属性为一个类

    建议147:重构多个相关属性为一个类 若存在多个相关属性,就应该考虑是否将其重构为一个类.查看如下类: class Person { public string Address { get; set; ...

  4. 编写高质量代码改善C&num;程序的157个建议——建议91:可见字段应该重构为属性

    建议91:可见字段应该重构为属性 字段和属性的本质区别就是属性是方法. 查看下面这个Person类型: class Person { public string Name { get; set; } ...

  5. 编写高质量代码:改善Java程序的151个建议(第一章:JAVA开发中通用的方法和准则)

    编写高质量代码:改善Java程序的151个建议(第一章:JAVA开发中通用的方法和准则) 目录 建议1: 不要在常量和变量中出现易混淆的字母 建议2: 莫让常量蜕变成变量 建议3: 三元操作符的类型务 ...

  6. (第一章)改善JavaScript,编写高质量代码。

    根据<编写高质量代码改善JavaScript程序的188个建议>这本书,来记录我目前所了解的建议方式. 建议1:警惕Unicode乱码 根据ECMA标准规定JavaScript语言可以使用 ...

  7. 编写高质量代码改善C&num;程序的157个建议——建议155:随生产代码一起提交单元测试代码

    建议155:随生产代码一起提交单元测试代码 首先提出一个问题:我们害怕修改代码吗?是否曾经无数次面对乱糟糟的代码,下决心进行重构,然后在一个月后的某个周一,却收到来自测试版的报告:新的版本,没有之前的 ...

  8. 编写高质量代码改善C&num;程序的157个建议——建议132:考虑用类名作为属性名

    建议132:考虑用类名作为属性名 一般来说,若果属性对应一个类型,应该直接用类型名命名属性名.如下: class Person { public Company Company { get; set; ...

  9. 编写高质量代码改善C&num;程序的157个建议——建议102:区分接口和抽象类的应用场合

    建议102:区分接口和抽象类的应用场合 接口和抽象类有一些显而易见的区别: 接口支持多继承,抽象类则不能. 接口可以包含方法.属性.索引器.事件的签名,但不能有实现,抽象类则可以. 接口在增加新方法后 ...

随机推荐

  1. Spring 和SpringMVC 的父子容器关系

      Spring和SpringMVC作为Bean管理容器和MVC层的默认框架,已被众多WEB应用采用,而实际使用时,由于有了强大的注解功能,很多基于XML的配置方式已经被替代,但是在实际项目中,同时配 ...

  2. Docker实例教程&lbrack;超详细&rsqb;&lpar;一&rpar;

    Docker Docker 是一个开源的应用容器引擎,让开发者可以打包他们的应用以及依赖包到一个可移植的容器中,然后发布到任何流行的 Linux 机器上,也可以实现虚拟化.容器是完全使用沙箱机制,相互 ...

  3. 解决mac下eclipse字体模糊

    在eclipse.app右键,单击“显示包内容”,如下图: 2.找到"info.plist"文件并打开,在文件最后插入配置“<key>NSHighResolutionC ...

  4. 在ubuntu系统荣品开发配套JDK安装

    chmod 755 jdk-6u29-linux-i586.bin ./jdk-6u29-linux-i586.bin

  5. mt7601 driver

    http://download.csdn.net/detail/u011500307/7011649 http://my.oschina.net/fgq611/blog/180750 http://b ...

  6. android开发之蓝牙配对连接的方法

    最近在做蓝牙开锁的小项目,手机去连接单片机总是出现问题,和手机的连接也不稳定,看了不少蓝牙方面的文档,做了个关于蓝牙连接的小结. 在做android蓝牙串口连接的时候一般会使用 ? 1 2 3 4 5 ...

  7. 理解Java的NIO

    同步与阻塞 同步和异步是针对应用程序和内核的交互而言的. 同步:执行一个操作之后,进程触发IO操作并等待(阻塞)或者轮询的去查看IO的操作(非阻塞)是否完成,等待结果,然后才继续执行后续的操作. 异步 ...

  8. certificate &amp&semi; encryption

    openssl commonly used commands before use Configure to generate Makefile, should notice follow optio ...

  9. sql查询&lpar;转)

    http://www.51testing.com/html/41/n-4421541.html 1 负向条件查询(例如:!=.not in.not exists)都是不能使用索引,少用 可以使用:se ...

  10. Spring &commat;Valid

    @Valid基本用法 强烈推荐如果要学习@Valid JSR303, 建议看这里的API  Bean Validation规范 ! Controller控制器中在需要校验的实体类上添加  @Valid ...