设计模式（十一）Composite模式

　　Composite模式模式能够使容器与内容具有一致性，创造出递归结构。有时，与将文件夹和文件都作为目录条目看待一样，将容器和内容作为同一种东西看待，可以帮助我们方便地处理问题。在容器中既可以放入内容，也可以放入小容器，然后在那个小容器中，又可以放入更小的容器。这样，就形成了容器结构、递归结构。

　　示例程序类图如上图。

package bigjunoba.bjtu.composite;

public abstract class Entry {
    public abstract String getName();                               // 获取名字
    public abstract int getSize();                                  // 获取大小
    public Entry add(Entry entry) throws FileTreatmentException {   // 加入目录条目
        throw new FileTreatmentException();
    }
    public void printList() {                                       // 为一览加上前缀并显示目录条目一览
        printList("");
    }
    protected abstract void printList(String prefix);               // 为一览加上前缀
    public String toString() {                                      // 显示代表类的文字
        return getName() + " (" + getSize() + ")";
    }
}

　　Entry类是一个表示目录条目的抽象类。为了能将文件夹Directory和文件File统一起来，所以设计了Entry类。其中printList方法有两种形式，称为重载。其中带参数的printList方法可见性是protected，即只能被Entry类的子类调用。

package bigjunoba.bjtu.composite;

public class File extends Entry {
    private String name;
    private int size;
    public File(String name, int size) {
        this.name = name;
        this.size = size;
    }
    public String getName() {
        return name;
    }
    public int getSize() {
        return size;
    }
    protected void printList(String prefix) {
        System.out.println(prefix + "/" + this);
    }
}

　　File类是表示文件的类，调用构造函数，就会根据传入的文件名和文件大小生成文件实例。其中的this表示父类中的toString方法。

package bigjunoba.bjtu.composite;

import java.util.Iterator;
import java.util.ArrayList;

public class Directory extends Entry {
    private String name;                    // 文件夹的名字
    private ArrayList<Entry> directory = new ArrayList<Entry>();      // 文件夹中目录条目的集合
    public Directory(String name) {         // 构造函数
        this.name = name;
    }
    public String getName() {               // 获取名字
        return name;
    }
    
    public int getSize() {                  // 获取大小
        int size = 0;
        Iterator<Entry> it = directory.iterator();
        while (it.hasNext()) {
            Entry entry = (Entry)it.next();
            size += entry.getSize();
        }
        return size;
    }
    
    public Entry add(Entry entry) {         // 增加目录条目
        directory.add(entry);
        return this;
    }
    
    protected void printList(String prefix) {       // 显示目录条目一览
        System.out.println(prefix + "/" + this);
        Iterator<Entry> it = directory.iterator();
        while (it.hasNext()) {
            Entry entry = (Entry)it.next();
            entry.printList(prefix + "/" + name);
        }
    }
}

　　Directory类是表示文件夹的类。这里用泛型集合来保存文件夹中的目录条目。getSize方法返回集合中所有元素的大小的总和。

　　这里注意size += entry.getSize();不管entry是哪个类的实例，都可以通过getSize方法得到它的大小。这就是该模式的特征--容器与内容一致性-的表现。

　　注意这里使用了递归，如果entry是Directory类的实例，调用 entry.getSize()时会将该文件夹下的所有目录条目的大小加起来，如果还有子文件夹，又会调用子文件夹的getSize方法。即getSize方法的递归调用与Composite模式的结构是相对应的。

　　add方法不会判断接收到的是文件夹还是文件，而是通过委托给ArrayList类来实现。printList方法也会递归调用，不多解释了。

package bigjunoba.bjtu.composite;

public class FileTreatmentException extends RuntimeException {
    public FileTreatmentException() {
    }
    public FileTreatmentException(String msg) {
        super(msg);
    }
}

　　由于调用add方法抛出的异常类并非Java类库的自带异常类，所以要编写自己的异常类。

package bigjunoba.bjtu.composite;

public class Main {
    public static void main(String[] args) {
        try {
            System.out.println("Making root entries...");
            Directory rootdir = new Directory("root");
            Directory bindir = new Directory("bin");
            Directory tmpdir = new Directory("tmp");
            Directory usrdir = new Directory("usr");
            rootdir.add(bindir);
            rootdir.add(tmpdir);
            rootdir.add(usrdir);
            bindir.add(new File("vi", 10000));
            bindir.add(new File("latex", 20000));
            rootdir.printList();

            System.out.println("");
            System.out.println("Making user entries...");
            Directory yuki = new Directory("yuki");
            Directory hanako = new Directory("hanako");
            Directory tomura = new Directory("tomura");
            usrdir.add(yuki);
            usrdir.add(hanako);
            usrdir.add(tomura);
            yuki.add(new File("diary.html", 100));
            yuki.add(new File("Composite.java", 200));
            hanako.add(new File("memo.tex", 300));
            tomura.add(new File("game.doc", 400));
            tomura.add(new File("junk.mail", 500));
            rootdir.printList();
        } catch (FileTreatmentException e) {
            e.printStackTrace();
        }
    }
}

　　Main类作为测试类，也不做过多解释。

Making root entries...
/root (30000)
/root/bin (30000)
/root/bin/vi (10000)
/root/bin/latex (20000)
/root/tmp (0)
/root/usr (0)

Making user entries...
/root (31500)
/root/bin (30000)
/root/bin/vi (10000)
/root/bin/latex (20000)
/root/tmp (0)
/root/usr (1500)
/root/usr/yuki (300)
/root/usr/yuki/diary.html (100)
/root/usr/yuki/Composite.java (200)
/root/usr/hanako (300)
/root/usr/hanako/memo.tex (300)
/root/usr/tomura (900)
/root/usr/tomura/game.doc (400)
/root/usr/tomura/junk.mail (500)

 　　测试结果如上图，一目了然。