代码简洁之道：类设计中的短小与高内聚

2023-10-30 07:53:31

短小类和高内聚：代码整洁之道的关键原则

在软件开发中，类设计是一个关键因素，因为它决定了代码的可读性、可维护性和可扩展性。《代码整洁之道》一书中强调了类设计中的两个关键原则：短小类和高内聚。遵循这些原则有助于创建更干净、更容易维护和更易于理解的代码，从而为开发人员和项目带来显著好处。

什么是短小类？

短小类是指职责单一、代码行数较少的类。短小类的主要好处是：

易于理解： 由于只专注于一个特定任务，短小类更容易理解。
易于测试： 短小类只包含与特定职责相关的代码，因此更容易进行测试。
易于重用： 短小类可以轻松地与其他类组合，从而提高重用性。

遵循单一职责原则对于创建短小类至关重要。该原则指出，每个类只应该有一个职责，并且这个职责应该被很好地封装在类中。违反单一职责原则会导致类臃肿、难以维护和难以测试。

什么是高内聚？

高内聚是指类中的所有属性和方法都与类的职责紧密相关。高内聚类的优点包括：

低耦合： 高内聚类与其他类之间的耦合度较低，因为它们只包含与自己职责相关的代码。
易于维护： 高内聚类更容易维护，因为对类中一个属性或方法的更改不太可能影响其他属性或方法。
可扩展性： 高内聚类更容易扩展，因为可以轻松地添加与类职责相关的属性和方法，而不会破坏类的内聚性。

为了创建高内聚类，需要仔细考虑类的属性和方法之间的关系。如果发现一个类有太多的属性，则应该思考这些属性之间是否有关联，是否应该拆分类。

实例分析

让我们通过一个实例来理解短小类和高内聚的重要性。考虑一个管理用户数据的类：

public class UserManager {

    private List<User> users;

    public void addUser(User user) {
        users.add(user);
    }

    public void removeUser(User user) {
        users.remove(user);
    }

    public User getUserById(int id) {
        for (User user : users) {
            if (user.getId() == id) {
                return user;
            }
        }
        return null;
    }

    public List<User> getAllUsers() {
        return users;
    }

    // ... 其他方法
}

这个类违反了单一职责原则，因为它包含了多个职责，包括添加、删除、获取和管理用户。这导致了一个臃肿、难以维护和难以测试的类。

我们可以将此类拆分为三个更短小的类：

public class UserRepository {

    private List<User> users;

    public void addUser(User user) {
        users.add(user);
    }

    public void removeUser(User user) {
        users.remove(user);
    }

    // ... 其他方法
}

public class UserService {

    private UserRepository userRepository;

    public User getUserById(int id) {
        return userRepository.getUserById(id);
    }

    public List<User> getAllUsers() {
        return userRepository.getAllUsers();
    }

    // ... 其他方法
}

public class UserPresenter {

    private UserService userService;

    public void displayUser(User user) {
        // ... 展示用户信息
    }

    public void displayAllUsers() {
        // ... 展示所有用户信息
    }

    // ... 其他方法
}