重构与优化-条件表达式优化(4)

Decompose Conditional

"Decompose Conditional"(分解条件)是一种代码重构技术,用于简化复杂的条件语句,使其更易于理解和维护。当一个if语句或者switch语句包含多个条件分支,并且这些分支逻辑相对独立或复杂时,使用该重构技术可以将大的条件判断分解为多个小的、更容易管理的部分。这样不仅可以提高代码的可读性,还能增强代码的模块化,便于未来的修改和扩展。

重构步骤

  1. 识别复杂条件:首先,找到那些包含多个逻辑条件的大型if语句或switch语句。

  2. 提取方法或函数:对于每个逻辑分支,创建一个新的方法或函数,将该分支的逻辑移动到新方法中。新方法的命名应该清晰反映它所执行的功能。

  3. 调用新方法:原条件语句的位置,替换为对新方法的调用。如果原始条件有返回值,确保新方法也返回相应的值,并在主调处正确处理这些返回值。

  4. 简化条件表达式:如果可能,简化主条件表达式,移除已经提取到新方法中的逻辑判断。

示例

假设我们有一个复杂的条件检查函数,它根据用户的角色和状态决定是否允许访问某个功能:

复制代码
public boolean canAccessFeature(User user) {
    if (user != null && user.getRole() == Role.ADMIN && 
        (user.getStatus() == Status.ACTIVE || user.getSpecialPermission())) {
        return true;
    } else if (user != null && user.getRole() == Role.USER && 
               user.getStatus() == Status.ACTIVE) {
        return true;
    }
    return false;
}

分解后的代码

我们可以将这个条件分解为几个更简单的部分:

复制代码
public boolean isUserActive(User user) {
    return user != null && user.getStatus() == Status.ACTIVE;
}

public boolean isAdminOrHasSpecialPermission(User user) {
    return user != null && (user.getRole() == Role.ADMIN || user.getSpecialPermission());
}

public boolean canAccessFeature(User user) {
    return (isAdminOrHasSpecialPermission(user) && isUserActive(user)) ||
           (user.getRole() == Role.USER && isUserActive(user));
}

在这个例子中,我们创建了两个辅助方法isUserActiveisAdminOrHasSpecialPermission,它们分别检查用户是否活跃以及用户是否是管理员或拥有特殊权限。然后,我们将原来的复杂条件语句分解,直接调用这些辅助方法,使得canAccessFeature函数更加清晰易懂。

优点

  • 提高可读性:每个辅助方法都专注于单一职责,使代码逻辑更易于理解。

  • 便于测试:单独的方法更易于单元测试,可以针对各种边界条件进行验证。

  • 增强复用性:分解出的方法可以在其他地方重用,减少代码重复。

注意事项

  • 不要过度分解,保持方法粒度适中,避免为了分解而分解,导致过多的小方法,反而降低代码的可读性。

  • 确保分解后的方法命名准确反映其功能,便于其他开发者理解。

Comsolidate Conditional Expression

"Consolidate Conditional Expression"(合并条件表达式)是一种代码重构技术,旨在减少代码中条件判断的冗余,提高代码的可读性和可维护性。此重构方法主要应用于存在多个相似或重复条件检查的地方,通过合并这些条件到一起,可以减少代码的复杂度并消除重复代码。

重构步骤

  1. 识别重复条件:首先,识别代码中出现多次的相同或非常相似的条件表达式。这些条件可能分布在多个if语句、循环条件或是其他逻辑判断中。

  2. 提取公共条件:将重复的条件表达式提取出来,定义为一个独立的布尔变量或方法,以便于重用。这个新变量或方法的命名应清楚表明它的用途或所代表的条件意义。

  3. 替换原有条件:将原代码中所有出现的重复条件表达式替换为新定义的布尔变量或方法的调用。

  4. 优化逻辑:检查并调整因条件合并后可能产生的逻辑结构变化,确保代码行为仍然符合预期。有时候,这可能意味着进一步简化条件逻辑或重新组织代码结构。

示例

假设有一个代码片段,其中包含多个检查用户是否满足特定条件的if语句,这些条件中有重复的部分:

复制代码
if (user != null && user.isLoggedIn() && user.isPremium()) {
    // 提供高级功能
}

if (user != null && user.isLoggedIn() && user.isActive()) {
    // 更新用户活跃状态
}

合并后的代码

通过"合并条件表达式"重构,我们可以减少重复的条件检查:

复制代码
boolean isLoggedInAndNotNull = user != null && user.isLoggedIn();

if (isLoggedInAndNotNull && user.isPremium()) {
    // 提供高级功能
}

if (isLoggedInAndNotNull && user.isActive()) {
    // 更新用户活跃状态
}

在这个例子中,我们首先识别到user != null && user.isLoggedIn()这个条件在两个if语句中重复出现,于是我们将其提取为一个名为isLoggedInAndNotNull的布尔变量。这样不仅减少了代码重复,也让每个if语句关注于各自独特的条件检查,提高了代码的可读性。

优点

  • 减少重复:去除重复的条件检查,使代码更加简洁。

  • 提高可读性:通过提炼出清晰命名的布尔变量或方法,使代码意图更加明显。

  • 易于维护:集中管理共享条件,未来若条件逻辑发生变化,只需在一个地方修改即可。

注意事项

  • 在合并条件时,确保不会无意中改变原有逻辑。

  • 避免过度抽象,保持代码的直观性,不要为了追求极致的DRY(Don't Repeat Yourself)原则而牺牲代码的可读性。

Consolidate Duplicate Conditional Fragments

"Consolidate Duplicate Conditional Fragments"(合并重复的条件片段)是代码重构的一个策略,用于消除代码中重复出现的相同或非常相似的条件分支逻辑。这种重构尤其适用于那些执行相似或相同操作的不同条件语句中。通过合并重复的条件片段,可以减少代码冗余,提高代码的可读性和维护性。

重构步骤

  1. 识别重复:首先,仔细审查代码,寻找具有相同或非常相似条件判断和执行体的代码段。这些重复可能出现在多个if语句、case语句或循环中。

  2. 抽象共性:确定哪些条件和执行逻辑是可以抽象出来的。创建一个新的方法或函数,将这些共性的条件判断和执行逻辑封装进去。这个新方法的名称应当能准确描述其执行的操作或决策。

  3. 替换原位置的重复代码:在原代码中,用新创建的方法替换掉那些重复的条件片段。确保所有必要的参数传递给新方法,以保持逻辑的一致性。

  4. 测试与验证:重构后,彻底测试代码以验证重构没有引入错误,并且原有功能依然正常工作。

示例

假设我们有一段代码,其中包含几个处理不同类型订单的逻辑,但是处理逻辑中有一部分是相同的:

复制代码
if (order.getType() == OrderType.NEW) {
    processNewOrder(order);
    logOrderActivity(order, "New order processed");
} else if (order.getType() == OrderType.RETURN) {
    processReturnOrder(order);
    logOrderActivity(order, "Return order processed");
} else if (order.getType() == OrderType.EXCHANGE) {
    processExchangeOrder(order);
    logOrderActivity(order, "Exchange order processed");
}

合并后的代码

观察到logOrderActivity(order, ...)这一段代码在每个条件分支中都重复出现了。我们可以通过提取这部分重复逻辑来简化代码:

复制代码
void processOrder(Order order) {
    switch (order.getType()) {
        case NEW:
            processNewOrder(order);
            break;
        case RETURN:
            processReturnOrder(order);
            break;
        case EXCHANGE:
            processExchangeOrder(order);
            break;
        // 可能还有其他类型处理...
    }
    logOrderActivity(order, order.getType().getDescription() + " order processed");
}

// 调用方式
processOrder(order);

在这个例子中,我们创建了一个新的processOrder方法来处理不同类型的订单,并将日志记录的重复操作移到该方法的末尾。通过order.getType().getDescription()动态获取描述信息,保持了日志消息的灵活性。这样不仅减少了代码重复,还使得每个订单类型的处理逻辑更加集中和清晰。

优点

  • 减少冗余:消除重复代码,降低维护成本。

  • 提高可读性:使代码逻辑更加清晰,易于理解。

  • 易于维护和扩展:修改或增加新的逻辑时,只需要在一个地方操作,降低了出错的可能性。

注意事项

  • 确保在合并时不会影响原有的控制流程或业务逻辑。

  • 不要盲目合并,需确保合并后的代码结构仍然合理且易于理解。

Remove Control Flag

"Remove Control Flag"(移除控制标志)是代码重构中的一种技术,用于消除代码中用来控制流程走向的布尔型变量(通常称为控制标志)。这些控制标志往往随着代码的迭代逐渐增多,导致代码难以理解和维护。通过移除这些控制标志,可以简化逻辑结构,提升代码的清晰度和可维护性。

重构目的

  • 减少复杂度:控制标志增加了代码的逻辑复杂度,尤其是当它们遍布在多个方法和类中时。

  • 提高可读性:直接表达意图的代码比依赖隐含状态(即控制标志的状态)的代码更易于理解。

  • 促进函数职责单一:每个函数或方法应该只做一件事情,过多依赖控制标志可能会让函数承担多种职责。

重构步骤

  1. 识别控制标志:找出代码中用来控制流程的布尔变量,特别是那些作为多个判断条件出现的变量。

  2. 分析控制流:理解控制标志如何影响程序的控制流程,包括它在哪里被设置,以及基于它的值执行了哪些不同的逻辑路径。

  3. 直接表达条件:将基于控制标志的条件判断转换为直接表达逻辑意图的条件结构或方法调用。可能需要引入新的方法来封装特定逻辑。

  4. 重构逻辑结构:根据需要调整代码结构,可能涉及拆分或合并方法,以消除对控制标志的依赖。

  5. 测试验证:确保重构后代码的行为与之前一致,进行充分的测试。

示例

原始代码示例
复制代码
public void processData(boolean isSpecialCase) {
    boolean processed = false;
    
    if (isSpecialCase) {
        // 特殊情况处理逻辑
        specialProcess();
        processed = true;
    } else {
        // 一般情况处理逻辑
        normalProcess();
        processed = true;
    }

    if (processed) {
        // 共同的后续处理逻辑
        finalProcessing();
    }
}

在这个例子中,processed是一个控制标志,用来表示数据是否已经被处理过。虽然在这个简单场景下它的作用似乎不大,但在更复杂的代码中,这类控制标志会增加不必要的复杂度。

重构后的代码
复制代码
public void processData(boolean isSpecialCase) {
    if (isSpecialCase) {
        // 特殊情况处理逻辑
        specialProcess();
    } else {
        // 一般情况处理逻辑
        normalProcess();
    }

    // 移除控制标志,直接执行共同的后续处理逻辑
    finalProcessing();
}

在这个重构版本中,我们直接移除了processed控制标志,因为无论isSpecialCase的值如何,finalProcessing()都会被执行。这样的改动简化了代码,使其更直接地表达了业务逻辑。

注意事项

  • 确保重构不会改变原有代码的功能和逻辑。

  • 考虑到所有使用控制标志的场景,避免遗漏任何逻辑路径。

  • 在复杂的控制流中,可能需要逐步重构,每次专注于一个控制标志,逐步简化代码结构。

Replace Nested Conditional with Guard Clauses

"Replace Nested Conditional with Guard Clauses"(使用卫语句替换嵌套条件)是一种代码重构技巧,旨在提高代码的可读性和可维护性。嵌套条件(即在一个if语句内部再有其他的if语句)可能导致代码难以跟踪和理解,尤其是在多层嵌套的情况下。卫语句(Guard Clause)是一种简单的条件检查,用于提前返回或跳出函数,从而减少嵌套,使得代码逻辑更加清晰。

重构目的

  • 减少嵌套:嵌套条件结构会使代码阅读和理解变得困难,尤其是在逻辑复杂时。

  • 提高可读性:卫语句使得每个条件判断独立且直接,易于理解每个分支的作用。

  • 简化错误处理:通过尽早处理不满足条件的情况,可以让主要逻辑更加专注和清晰。

重构步骤

  1. 识别嵌套条件:找到代码中包含多层嵌套的if语句。

  2. 提取卫语句:将最外层条件判断中最简单或最容易处理的情况提取出来,使用单独的if语句并在条件满足时直接返回或抛出异常。

  3. 重复步骤2:对于剩余的嵌套条件,继续应用此过程,直到所有嵌套条件都被处理成卫语句。

  4. 优化逻辑:检查并整理剩下的代码,确保逻辑依然正确无误,同时考虑是否有必要进一步简化。

示例

原始代码示例
复制代码
def calculateDiscount(customer):
    discount = 0
    if customer.isLoyal():
        if customer.totalPurchases() > 1000:
            if customer.hasActiveMembership():
                discount = 0.20
            else:
                discount = 0.10
        elif customer.totalPurchases() > 500:
            discount = 0.05
    return discount

这段代码中,为了计算客户的折扣,有多层的嵌套条件判断,这使得逻辑不易于理解和维护。

重构后的代码
复制代码
def calculateDiscount(customer):
    if not customer.isLoyal():
        return 0  # 卫语句:非忠诚客户直接返回0折扣

    if customer.hasActiveMembership() and customer.totalPurchases() > 1000:
        return 0.20  # 卫语句:满足最佳条件直接返回20%折扣

    if customer.totalPurchases() > 1000:
        return 0.10  # 卫语句:满足一定条件但会员状态不活跃,返回10%折扣

    if customer.totalPurchases() > 500:
        return 0.05  # 卫语句:其他条件下的5%折扣

    return 0  # 默认情况,没有满足以上任何条件

在这个重构后的版本中,通过使用卫语句,我们消除了嵌套条件,使得每个条件检查及其对应的处理逻辑都变得更加直观和易于理解。每个if语句都是一个独立的逻辑判断,一旦条件满足就立即执行相应的操作并返回结果,大大提高了代码的可读性和维护性。

Replace Conditional with Polymorrphism

"Replace Conditional with Polymorphism"(使用多态替换条件语句)是一种面向对象设计原则的应用,旨在通过子类继承和多态性减少代码中的条件判断,提高代码的灵活性、可扩展性和可维护性。该原则主张利用面向对象的继承结构来处理不同类型的对象,而不是在代码中使用条件语句来区分不同情况的处理逻辑。

重构目的

  • 减少条件逻辑:条件语句(如if-else或switch-case)会随着功能的增加而迅速复杂化,多态允许通过对象自身的行为来处理差异,从而简化代码。

  • 增强可扩展性:新增类型时,只需添加新类并实现相应接口或重写方法,无需修改现有逻辑,降低了模块间的耦合度。

  • 提高代码复用:共享的接口或基类代码可以被多个子类复用,减少重复代码。

  • 提高可读性:代码意图更加清晰,每个类或对象负责自己的行为,减少了阅读者理解代码的负担。

重构步骤

  1. 识别变化点:找到代码中基于对象类型进行条件判断的地方。

  2. 抽象公共行为:定义一个接口或抽象类,声明所有子类共有的行为方法。

  3. 创建具体子类:为每种情况创建一个子类,并实现上述接口或抽象类中的方法,根据具体类型提供不同的行为实现。

  4. 替换条件逻辑:原本的条件判断处,通过工厂模式、策略模式或其他方式创建对应类型的对象,并直接调用其行为方法,让对象自己决定如何行动。

示例

原始代码示例
复制代码
class OrderProcessor {
    public void process(Order order) {
        if (order.getType() == OrderType.NORMAL) {
            handleNormalOrder(order);
        } else if (order.getType() == OrderType.PRIORITY) {
            handlePriorityOrder(order);
        } else {
            throw new IllegalArgumentException("Unsupported order type.");
        }
    }

    private void handleNormalOrder(Order order) {
        // 正常订单处理逻辑
    }

    private void handlePriorityOrder(Order order) {
        // 优先级订单处理逻辑
    }
}
重构后的代码
复制代码
interface OrderHandler {
    void handle(Order order);
}

class NormalOrderHandler implements OrderHandler {
    @Override
    public void handle(Order order) {
        // 正常订单处理逻辑
    }
}

class PriorityOrderHandler implements OrderHandler {
    @Override
    public void handle(Order order) {
        // 优先级订单处理逻辑
    }
}

class OrderProcessor {
    private Map<OrderType, OrderHandler> handlers;

    public OrderProcessor() {
        handlers = new HashMap<>();
        handlers.put(OrderType.NORMAL, new NormalOrderHandler());
        handlers.put(OrderType.PRIORITY, new PriorityOrderHandler());
    }

    public void process(Order order) {
        OrderHandler handler = handlers.get(order.getType());
        if (handler == null) {
            throw new IllegalArgumentException("Unsupported order type.");
        }
        handler.handle(order);
    }
}

在重构后的代码中,我们首先定义了一个OrderHandler接口,然后为每种订单类型创建了具体的处理器类(NormalOrderHandlerPriorityOrderHandler),实现了该接口。OrderProcessor类中使用一个映射表来存储不同订单类型对应的处理器,处理订单时直接通过订单类型获取对应的处理器并调用其handle方法,从而消除了条件判断,利用多态性实现了逻辑的动态分派。

Introduce Null Object

"Introduce Null Object"(引入空对象)是一种设计模式,用于替换代码中null值的使用,以避免因null引发的NullPointerException以及简化对null情况的处理逻辑。空对象模式通过创建一个具体类来代表"无意义"或"缺失"的对象实例,这个类与正常对象拥有相同的接口,但在其方法实现上可能不做任何操作或者提供默认行为,以此来优雅地处理那些原本需要特殊检查null值的场景。

重构目的

  • 避免空指针异常:通过返回一个行为类似于真实对象但实际上不执行任何操作或提供默认行为的空对象,可以消除因null引用导致的运行时错误。

  • 简化代码逻辑:无需在每个使用对象的地方都进行null检查,使得代码更简洁,逻辑更集中于业务本身。

  • 提高代码的健壮性与可读性:使得代码对于null的处理更加一致和可预测,易于理解和维护。

实现步骤

  1. 识别null情况:找到代码中频繁出现null检查的地方,尤其是那些因为null值需要特殊处理的逻辑。

  2. 定义Null对象接口:确保你的接口或抽象类定义了所有相关的行为,包括空对象也应遵循的默认行为。

  3. 创建Null对象类:实现上述接口或继承抽象类,为每个方法提供一个合理的默认实现或无操作实现(例如,返回默认值、记录日志或什么也不做)。

  4. 替换null返回:在原本可能返回null的地方,改为返回空对象实例。

  5. 测试与调整:确保替换后,原有逻辑依然正确执行,必要时调整空对象的行为以满足特定需求。

示例

假设有一个Logger接口,通常情况下我们可能会这样使用:

复制代码
public interface Logger {
    void log(String message);
}

public class ConsoleLogger implements Logger {
    @Override
    public void log(String message) {
        System.out.println(message);
    }
}

public class SomeService {
    private Logger logger;

    public SomeService(Logger logger) {
        this.logger = logger; // 可能传入null
    }

    public void doSomething() {
        // ...业务逻辑...
        if (logger != null) { // 这里需要检查null
            logger.log("Did something.");
        }
    }
}

引入空对象模式后,我们可以这样做:

复制代码
// 空对象实现
public class NullLogger implements Logger {
    @Override
    public void log(String message) {
        // 默认行为:不做任何操作
    }
}

// 修改SomeService构造函数以处理null情况
public SomeService(Logger logger) {
    this.logger = logger != null ? logger : new NullLogger(); // 如果传入null,则自动替换为NullLogger
}

// 现在doSomething方法中无需null检查
public void doSomething() {
    // ...业务逻辑...
    logger.log("Did something."); // 即使logger是NullLogger,也不会抛出NullPointerException
}

通过引入NullLogger,我们不仅消除了对null的显式检查,还使得SomeService的使用更加安全和简洁,无需担心因null引起的异常,提高了代码的健壮性和可读性。

Introduce Assertion

"Introduce Assertion"(引入断言)是一种编程实践,用于在代码中明确表达和验证关于程序状态的假设或不变量。断言主要用于开发阶段,帮助开发者发现错误,它们不是用来处理程序运行时的正常流程控制,而是作为一种调试辅助工具,确保代码逻辑的前提条件或后置条件得到满足。在Java中,可以使用assert关键字来实现断言。

目的

  • 提升代码质量:通过在关键位置加入断言,确保数据的正确性和程序逻辑的合理性,有助于提前发现问题。

  • 文档作用:断言可以作为代码的注释,表明开发者对程序状态的预期,便于他人理解代码逻辑。

  • 简化调试:当程序行为不符合预期时,断言失败可以快速定位问题所在,特别是在复杂系统中。

使用场景

  • 前提条件检查:在函数或方法开始时,验证传入参数的有效性。

  • 后置条件确认:在函数或方法执行完毕后,确认结果状态满足预期。

  • 不变量维护:在循环体或复杂逻辑块中,确保某些状态在整个过程中保持不变。

示例

假设我们正在编写一个计算两个整数相除的函数,希望确保除数不为0。

未使用断言的情况:

复制代码
public double divide(int dividend, int divisor) {
    if (divisor == 0) {
        throw new IllegalArgumentException("Divisor cannot be zero");
    }
    return (double) dividend / divisor;
}

使用断言的情况:

复制代码
public double divide(int dividend, int divisor) {
    assert divisor != 0 : "Divisor must not be zero"; // 断言:确保除数不为0
    return (double) dividend / divisor;
}

请注意,Java中的断言默认是禁用的,需要通过命令行参数-ea(enable assertions)来启用。因此,在生产环境中,断言不会执行,不会影响性能,也不应该被用作处理程序中可能出现的正常错误情况。断言更多是作为开发和测试阶段的辅助工具。

注意事项

  • 不要依赖断言进行错误处理:断言是用来捕获不应该发生的错误,而不是处理可预见的异常情况。

  • 谨慎使用:过度使用断言可能导致难以维护的代码,尤其是在那些条件容易改变或难以确定是否永远为真的地方。

  • 了解运行环境:确保了解断言在不同环境(如开发、测试、生产)下的行为,避免因断言启用状态的不同引起的问题。

总之,引入断言是一种提升代码质量和开发效率的有效手段,但需合理运用,以达到最佳效果。

相关推荐
腾讯TNTWeb前端团队7 小时前
helux v5 发布了,像pinia一样优雅地管理你的react状态吧
前端·javascript·react.js
mghio8 小时前
Dubbo 中的集群容错
java·微服务·dubbo
范文杰10 小时前
AI 时代如何更高效开发前端组件?21st.dev 给了一种答案
前端·ai编程
拉不动的猪10 小时前
刷刷题50(常见的js数据通信与渲染问题)
前端·javascript·面试
拉不动的猪10 小时前
JS多线程Webworks中的几种实战场景演示
前端·javascript·面试
FreeCultureBoy11 小时前
macOS 命令行 原生挂载 webdav 方法
前端
uhakadotcom12 小时前
Astro 框架:快速构建内容驱动型网站的利器
前端·javascript·面试
uhakadotcom12 小时前
了解Nest.js和Next.js:如何选择合适的框架
前端·javascript·面试
uhakadotcom12 小时前
React与Next.js:基础知识及应用场景
前端·面试·github