远离代码“大类”的秘诀

后端

2023-10-11 07:52:25

破解大类难题：打造整洁、可维护的代码

在软件开发的广阔世界中，编写整洁、可维护的代码是一项至关重要的任务。然而，随着项目的不断壮大，代码的复杂性也会随之增加，导致一种常见的“罪魁祸首”出现——大类。大类就像代码中的庞然大物，拥有过多的功能和职责，给维护带来诸多不便。

大类的症状

大类通常表现为两种典型症状：

长函数： 函数代码行数过多，超过 100 行甚至更多，让人望而生畏，难以理解和修改。
字段和函数过多： 类中包含大量的字段和函数，即使每个函数的代码量不大，但数量众多也会让类变得臃肿不堪。

大类的危害

大类的存在会带来一系列问题，严重影响代码的可维护性：

难以理解： 庞大复杂的类结构使得理解和修改代码变得十分困难，就像走进了一座迷宫。
难以测试： 大类通常会包含多种不同的功能，这会增加单元测试的复杂性，就像试图同时测试多个不同的组件。
难以重构： 由于大类高度耦合，对类进行修改或重构往往会带来意想不到的后果，就像牵一发而动全身。
代码重复： 不同的功能被集中在一个大类中，容易导致代码重复，影响代码的简洁性和可维护性，就像一个杂乱无章的仓库。

化解大类难题

要化解大类难题，关键在于遵循单一职责原则（SRP） ，即每个类只负责一项单一的功能。具体来说，我们可以采取以下措施：

将长函数拆分成小函数： 就像将一头大象分成几块小肉块，我们将庞大的函数拆分成多个较小的函数，每个函数负责特定子任务，方便管理和理解。
提取基类： 就像从一棵大树中提取树干，我们将类中通用的功能提取到一个基类中，子类继承这些通用功能，专注于自己的特定职责，形成一个清晰的层级结构。
使用合成： 与其将多种功能集中在一个大类中，不如将这些功能拆分成独立的小类，然后通过合成的方式组合使用，就像用乐高积木搭建不同的结构。
使用委托： 对于一些相对独立的功能，可以将它们委托给其他小类或外部库，避免在主类中直接实现，就像外包给专业人士处理，提高效率和质量。

示例实践

为了更好地理解如何将大类拆分成小类，让我们来看一个实际示例：

大类：

public class CustomerService {
    private List<Customer> customers;

    public void addCustomer(Customer customer) {
        // ...
    }

    public void removeCustomer(Customer customer) {
        // ...
    }

    public void updateCustomer(Customer customer) {
        // ...
    }

    public List<Customer> getCustomers() {
        // ...
    }

    // 其他功能...
}

拆分后的类：

public class CustomerManager {
    private List<Customer> customers;

    public void addCustomer(Customer customer) {
        // ...
    }

    public void removeCustomer(Customer customer) {
        // ...
    }

    public void updateCustomer(Customer customer) {
        // ...
    }
}

public class CustomerRepository {
    public List<Customer> getCustomers() {
        // ...
    }
}

// 其他小类...