设计模式之组合模式

组合模式定义：
将对象组合成树形结构以表示“部分整体”的层次结构。组合模式使得用户对单个对象和组合对象的使用具有一致性。

也可以理解成部分-整体模式，它使我们在树型结构的问题中，模糊了简单元素和复杂元素的概念，客户程序可以像处理简单元素一样来处理复杂元素，从而使得客户程序与复杂元素的内部结构解耦。

组合模式让你可以优化处理递归或分级数据结构。有许多关于分级数据结构的例子，使得组合模式非常有用武之地。关于分级数据结构的一个普遍性的例子是你每次使用电脑时所遇到的文件系统。文件系统由目录和文件组成。每个目录可以包含多个文件。目录的内容可以是文件，也可以是目录。按照这种方式，计算机的文件系统就是以递归结构来组织的。如果你想要描述这样的数据结构，那么你可以使用组合模式Composite。

image.png

涉及角色：
1.Component 是组合中的对象声明接口，在一般情况下，实现所有类共有接口的默认行为。声明一个接口用于访问和管理Component子部件。
2.Leaf 在组合中表示叶子结点对象，叶子结点没有子结点。
3.Composite 非叶子节点，可以包含叶子节点，在Component接口中实现与子部件有关操作，如增加(add)和删除(remove)等。

下面针对文件系统，使用组合模式进行实现。
在文件系统中，具体文件(Leaf)是叶子节点，文件夹(Composite)是非叶子节点，对于Component接口，就是指文件和文件夹二者的共性，比如二者都可以进行复制、删除、重命名等，二者不同的是，如果是文件进行删除的时候，直接删除即可，如果是文件夹进行删除的时候，则需要先删除该文件夹下所有的文件及文件夹，然后再删除该文件夹。
从上面类图可以看到，暴露给客户端的是Component对象，也就意味着客户端不需要知道当前操作的是文件还是文件夹，它只管进行对应的操作即可，包括删除、命名等，具体进行什么样的操作由程序去处理。

组合模式使用场景：

1、需要表达“部分-整体”层次结构，例如树形结构。
2、希望客户端不用关注是组合对象还是单个对象，将统一地使用组合结构中的所有对象。

组合模式优点:

1、高层模块调用简单。一棵树形机构中的所有节点都是Component，局部和整体对调用者来说没有任何区别，高层模块不必关心自己处理的是单个对象还是整个组合结构。
2、更容易在组合体内加入对象，客户端不必因为加入了新的对象而更改原有代码。

组合模式不足:

1、组合模式中安全性和透明性只能选其一，安全性指在Component接口中只声明叶子节点和非叶子节点共有特性，透明性指在Component中声明了非叶子节点属性。
2、设计较复杂，客户端需要花更多时间理清类之间的层次关系；

组合模式模拟实现文件系统操作：
先定义一个Component接口，包含文件与文件夹的公共特性。

public interface FileComponent {

    /** 定义文件和文件夹共有的特性*/
    void delete();
    String fileName();

    /** 下面定义文件夹的特性, 这里使用的是透明方式，
     * 如果去掉下面文件夹的特性，只保留共性，则属于安全模式，那么客户端在调用的时候，则需要判断是否是文件夹，增加客户端的调用难度*/
    void deleteFile(String fileName);

    void createFile(String fileName);

    FileComponent getFileComponent(int fileIndex);
    
    int fileSize();
}

定义文件夹实现类

public class Folder implements FileComponent {

    private static Logger logger = LoggerFactory.getLogger(Folder.class);

    private String folderName;
    private List files; // 文件夹下面的文件列表
    private FileComponent folder; // 文件夹下面可以继续创建文件夹

    public Folder(String folderName, FileComponent folder) {
        this.folderName = folderName;
        this.folder = folder;
        files = new ArrayList<>();
    }

    public Folder(String folderName) {
        this(folderName, null);
    }

    /**
     * 文件夹的删除，先删除该文件夹下的文件，然后再删除该文件夹
     */
    @Override
    public void delete() {
        for (FileComponent fileComponent : files) {
            fileComponent.delete();
        }
        if (folder != null) {
            folder.deleteFile(folderName);
        }
    }

    @Override
    public String fileName() {
        return folderName;
    }


    @Override
    public void deleteFile(String fileName) {
        for (FileComponent file : files) {
            if (file.fileName().equals(fileName)) {
                files.remove(file);
            }
        }
    }

    /**
     * 创建文件操作，可以是文件，也可以是文件夹
     * 这里指定，如果fileName中包含".",则属于文件，否则属于文件夹
     * @param fileName
     */
    @Override
    public void createFile(String fileName) {
        if (fileName.contains(".")) {
            files.add(new File(fileName, this));
            return;
        }
        files.add(new Folder(fileName, this));
    }

    @Override
    public FileComponent getFileComponent(int fileIndex) {
        return files.get(fileIndex);
    }

    @Override
    public int fileSize() {
        return files.size();
    }

}

定义文件实现类：

public class File implements FileComponent {

    private String fileName;
    /** 当前文件所属的文件夹*/
    private FileComponent folder;

    public File(String fileName, FileComponent folder) {
        this.fileName = fileName;
        this.folder = folder;
    }

    @Override
    public void delete() {
        folder.deleteFile(fileName);
    }

    @Override
    public String fileName() {
        return fileName;
    }


    /**
     * 文件不支持删除文件操作
     * @param fileName
     */
    @Override
    public void deleteFile(String fileName) {
        throw new UnsupportedOperationException();
    }

    /**
     * 文件不支持创建文件操作
     * @param fileName
     */
    @Override
    public void createFile(String fileName) {
        throw new UnsupportedOperationException();
    }

    /**
     * 文件不支持获取文件操作
     * @param fileIndex
     * @return
     */
    @Override
    public FileComponent getFileComponent(int fileIndex) {
        throw new UnsupportedOperationException();
    }

    @Override
    public int fileSize() {
        return 1;
    }

}

定义运行的客户端

public class Client {
    private static final Logger logger = LoggerFactory.getLogger(Client.class);
    public static void main(String[] args) {
        FileComponent folder = new Folder("rootFolder");
        folder.createFile("subFolder");
        folder.getFileComponent(0).createFile("subtest0.txt");
        folder.createFile("test1.txt");
        folder.createFile("test2.txt");

        show(folder);
        folder.deleteFile("test1.txt");
        show(folder);
    }

    public static void show(FileComponent fileComponent) {
        logger.info("fileComponent name:{}", fileComponent.fileName());
        if (fileComponent instanceof Folder) {
            int fileIndex = 0;
            while (true) {
                if (fileIndex < fileComponent.fileSize()) {
                    if (fileComponent.getFileComponent(fileIndex) != null) {
                        show(fileComponent.getFileComponent(fileIndex));
                    }
                    fileIndex ++;
                } else {
                    break;
                }
            }
        }
    }
}

输出的日志信息如下：

22:37:09.252 [main] INFO com.codingroad.designpattern.component.Client - fileComponent name:rootFolder
22:37:09.259 [main] INFO com.codingroad.designpattern.component.Client - fileComponent name:subFolder
22:37:09.260 [main] INFO com.codingroad.designpattern.component.Client - fileComponent name:subtest0.txt
22:37:09.260 [main] INFO com.codingroad.designpattern.component.Client - fileComponent name:test1.txt
22:37:09.260 [main] INFO com.codingroad.designpattern.component.Client - fileComponent name:test2.txt
删除test1.txt后
22:37:09.260 [main] INFO com.codingroad.designpattern.component.Client - fileComponent name:rootFolder
22:37:09.260 [main] INFO com.codingroad.designpattern.component.Client - fileComponent name:subFolder
22:37:09.260 [main] INFO com.codingroad.designpattern.component.Client - fileComponent name:subtest0.txt
22:37:09.260 [main] INFO com.codingroad.designpattern.component.Client - fileComponent name:test2.txt