49、组合模式

1、组合模式的原理与实现

在 GoF 的《设计模式》一书中，组合模式是这样定义的
Compose objects into tree structure to represent part-whole hierarchies.
Composite lets client treat individual objects and compositions of objects uniformly.
翻译成中文就是：将一组对象组织（Compose）成树形结构，以表示一种 "部分 - 整体" 的层次结构
组合让客户端（在很多设计模式书籍中，"客户端" 代指代码的使用者）可以统一单个对象和组合对象的处理逻辑

1.1、示例

假设我们有这样一个需求：设计一个类来表示文件系统中的目录，能方便地实现下面这些功能

• 动态地添加、删除某个目录下的子目录或文件
• 统计指定目录下的文件个数
• 统计指定目录下的文件总大小

在下面的代码实现中，我们把文件和目录统一用 FileSystemNode 类来表示，并且通过 isFile 属性来区分

public class FileSystemNode {
 
    private String path;
    private boolean isFile;
    private List<FileSystemNode> subNodes = new ArrayList<>();
 
    public FileSystemNode(String path, boolean isFile) {
        this.path = path;
        this.isFile = isFile;
    }
 
    // 统计指定目录下的文件个数
    public int countNumOfFiles() {
        if (isFile) return 1;
 
        int numOfFiles = 0;
        for (FileSystemNode fileOrDir : subNodes) {
            numOfFiles += fileOrDir.countNumOfFiles();
        }
        return numOfFiles;
    }
 
    // 统计指定目录下的文件总大小
    public long countSizeOfFiles() {
        if (isFile) {
            File file = new File(path);
            if (!file.exists()) return 0;
            return file.length();
        }
 
        long sizeofFiles = 0;
        for (FileSystemNode fileOrDir : subNodes) {
            sizeofFiles += fileOrDir.countSizeOfFiles();
        }
        return sizeofFiles;
    }
 
    public String getPath() {
        return path;
    }
 
    public void addSubNode(FileSystemNode fileOrDir) {
        subNodes.add(fileOrDir);
    }
 
    public void removeSubNode(FileSystemNode fileOrDir) {
        int size = subNodes.size();
        int i;
        for (i = 0; i < size; i++) {
            if (subNodes.get(i).getPath().equalsIgnoreCase(fileOrDir.getPath())) {
                break;
            }
        }
        if (i < size) subNodes.remove(i);
    }
}

1.2、重构

单纯从功能实现角度来说，上面的代码没有问题，已经实现了我们想要的功能
但是如果我们开发的是一个大型系统，从扩展性（文件或目录可能会对应不同的操作）、业务建模（文件和目录从业务上是两个概念）、代码的可读性（文件和目录区分对待更加符合人们对业务的认知）的角度来说，我们最好对文件和目录进行区分设计，定义为 File 和 Directory 两个类

按照这个设计思路，我们对代码进行重构，重构之后的代码如下所示

public abstract class FileSystemNode {
 
    protected String path;
 
    public FileSystemNode(String path) {
        this.path = path;
    }
 
    public abstract int countNumOfFiles();
 
    public abstract long countSizeOfFiles();
 
    public String getPath() {
        return path;
    }
}

public class File extends FileSystemNode {
 
    public File(String path) {
        super(path);
    }
 
    @Override
    public int countNumOfFiles() {
        return 1;
    }
 
    @Override
    public long countSizeOfFiles() {
        File file = new File(path);
        if (!file.exists()) return 0;
        return file.length();
    }
}

public class Directory extends FileSystemNode {
 
    private List<FileSystemNode> subNodes = new ArrayList<>();
 
    public Directory(String path) {
        super(path);
    }
 
    @Override
    public int countNumOfFiles() {
        int numOfFiles = 0;
        for (FileSystemNode fileOrDir : subNodes) {
            numOfFiles += fileOrDir.countNumOfFiles();
        }
        return numOfFiles;
    }
 
    @Override
    public long countSizeOfFiles() {
        long sizeofFiles = 0;
        for (FileSystemNode fileOrDir : subNodes) {
            sizeofFiles += fileOrDir.countSizeOfFiles();
        }
        return sizeofFiles;
    }
 
    public void addSubNode(FileSystemNode fileOrDir) {
        subNodes.add(fileOrDir);
    }
 
    public void removeSubNode(FileSystemNode fileOrDir) {
        int size = subNodes.size();
        int i;
        for (i = 0; i < size; i++) {
            if (subNodes.get(i).getPath().equalsIgnoreCase(fileOrDir.getPath())) {
                break;
            }
        }
        if (i < size) subNodes.remove(i);
    }
}

1.3、使用

文件和目录类都设计好了，我们来看如何用它们来表示一个文件系统中的目录树结构

public class Demo {
    public static void main(String[] args) {
        /*
         * /wz/a.txt
         * /wz/b.txt
         * /wz/movies/c.avi
         * /xzg/docs/d.txt
         */
        Directory fileSystemTree = new Directory("/");
        Directory node_wz = new Directory("/wz/");
        Directory node_xzg = new Directory("/xzg/");
        fileSystemTree.addSubNode(node_wz);
        fileSystemTree.addSubNode(node_xzg);
 
        File node_wz_a = new File("/wz/a.txt");
        File node_wz_b = new File("/wz/b.txt");
        Directory node_wz_movies = new Directory("/wz/movies/");
        node_wz.addSubNode(node_wz_a);
        node_wz.addSubNode(node_wz_b);
        node_wz.addSubNode(node_wz_movies);
 
        File node_wz_movies_c = new File("/wz/movies/c.avi");
        node_wz_movies.addSubNode(node_wz_movies_c);
 
        Directory node_xzg_docs = new Directory("/xzg/docs/");
        node_xzg.addSubNode(node_xzg_docs);
        File node_xzg_docs_d = new File("/xzg/docs/d.txt");
        node_xzg_docs.addSubNode(node_xzg_docs_d);
 
        System.out.println("/ files num:" + fileSystemTree.countNumOfFiles());
        System.out.println("/wz/ files num:" + node_wz.countNumOfFiles());
    }
}

我们对照着这个例子再重新看一下组合模式的定义
将一组对象（文件和目录）组织成树形结构，以表示一种 "部分 - 整体" 的层次结构（目录与子目录的嵌套结构）
组合模式让客户端可以统一单个对象（文件）和组合对象（目录）的处理逻辑（递归遍历）

刚才讲的这种组合模式的设计思路，与其说是一种设计模式，倒不如说是对业务场景的一种数据结构和算法的抽象
其中数据可以表示成树这种数据结构，业务需求可以通过在树上的递归遍历算法来实现

2、组合模式的应用场景举例

刚刚我们讲了文件系统的例子，对于组合模式，我这里再举一个例子，搞懂了这两个例子，你基本上就算掌握了组合模式
在实际的项目中，遇到类似的可以表示成树形结构的业务场景，你只要 "照葫芦画瓢" 去设计就可以了

假设我们在开发一个 OA 系统（办公自动化系统），公司的组织结构包含部门和员工两种数据类型，其中部门又可以包含子部门和员工
在数据库中的表结构如下所示

我们希望在内存中构建整个公司的人员架构图（部门、子部门、员工的隶属关系），并且提供接口计算出部门的薪资成本（隶属于这个部门的所有员工的薪资和）

• 部门包含子部门和员工，这是一种嵌套结构，可以表示成树这种数据结构
• 计算每个部门的薪资开支这样一个需求，也可以通过在树上的遍历算法来实现
• 所以从这个角度来看，这个应用场景可以使用组合模式来设计和实现

这个例子的代码结构跟上一个例子的很相似，代码实现我直接贴在了下面，你可以对比着看一下

• HumanResource 是部门类（Department）和员工类（Employee）抽象出来的父类，为的是能统一薪资的处理逻辑
• Demo 中的代码负责从数据库中读取数据并在内存中构建组织架构图

public abstract class HumanResource {
 
    protected long id;
    protected double salary;
 
    public HumanResource(long id) {
        this.id = id;
    }
 
    public long getId() {
        return id;
    }
 
    public abstract double calculateSalary();
}

public class Employee extends HumanResource {
 
    public Employee(long id, double salary) {
        super(id);
        this.salary = salary;
    }
 
    @Override
    public double calculateSalary() {
        return salary;
    }
}

public class Department extends HumanResource {
 
    private List<HumanResource> subNodes = new ArrayList<>();
 
    public Department(long id) {
        super(id);
    }
 
    @Override
    public double calculateSalary() {
        double totalSalary = 0;
        for (HumanResource hr : subNodes) {
            totalSalary += hr.calculateSalary();
        }
        this.salary = totalSalary;
        return totalSalary;
    }
 
    public void addSubNode(HumanResource hr) {
        subNodes.add(hr);
    }
}

// 构建组织架构的代码
public class Demo {
 
    private static final long ORGANIZATION_ROOT_ID = 1001;
    private DepartmentRepo departmentRepo; // 依赖注入
    private EmployeeRepo employeeRepo;     // 依赖注入
 
    public void buildOrganization() {
        Department rootDepartment = new Department(ORGANIZATION_ROOT_ID);
        buildOrganization(rootDepartment);
    }
 
    private void buildOrganization(Department department) {
        List<Long> subDepartmentIds = departmentRepo.getSubDepartmentIds(department.getId());
        for (Long subDepartmentId : subDepartmentIds) {
            Department subDepartment = new Department(subDepartmentId);
            department.addSubNode(subDepartment);
            buildOrganization(subDepartment);
        }
        List<Long> employeeIds = employeeRepo.getDepartmentEmployeeIds(department.getId());
        for (Long employeeId : employeeIds) {
            double salary = employeeRepo.getEmployeeSalary(employeeId);
            department.addSubNode(new Employee(employeeId, salary));
        }
    }
}

我们再拿组合模式的定义跟这个例子对照一下
将一组对象（员工和部门）组织成树形结构，以表示一种 "部分 - 整体" 的层次结构（部门与子部门的嵌套结构）
组合模式让客户端可以统一单个对象（员工）和组合对象（部门）的处理逻辑（递归遍历）

3、图示