设计模式-组合模式学习之旅一、组合模式的引出二、组合模式

“这是我参与8月更文挑战的第21天,活动详情查看:8月更文挑战

一、组合模式的引出

我们知道古代的皇帝想要管理国家,是不可能直接管理到具体每一个老百姓的,因此设置了很多机构,比如说三省六部,这些机构下面又有很多小的组织。他们共同管理着这个国家。再比如说,一个大公司,下面有很多小的部门,每一个部门下面又有很多个部门。说到底这就是组合模式。

二、组合模式的定义

组合模式(Composite Pattern)也称为整体-部分(Part-Whole)模式,它的宗旨是通过将单个对象(叶子节点)和组合对象(树枝节点)用相同的接口进行表示,使得客户对单个对象和组合对象的使用具有一致性,属于结构型模式。

三、组合关系与聚合关系的区别

组合关系:在古代皇帝三宫六院,贵妃很多,但是每一个贵妃只属于皇帝(具有相同的生命周期)。

聚合关系:一个老师有很多学生,但是每一个学生又属于多个老师(具有不同的生命周期)。

四、组合模式涉及的角色

  1. 抽象根节点(Component):定义系统各层次对象的共有方法和属性,可以预先定义一些默认行为和属性。
  2. 树枝节点(Composite):定义树枝节点的行为,存储子节点,组合树枝节点和叶子节点形成一个树形结构。
  3. 叶子节点(Leaf):叶子节点对象,其下再无分支,是系统层次遍历的最小单位。

组合模式在代码具体实现上,有两种不同的方式,分别是透明组合模式和安全组合模式

五、组合模式的应用场景

  1. 希望客户端可以忽略组合对象与单个对象的差异时。
  2. 对象层次具备整体和部分,呈树形结构。

在我们生活中的组合模式也非常常见,比如树形菜单,操作系统目录结构,公司组织架构等。

1. 透明组合模式的写法

比如我们有Java入门课程、人工智能课程、Java设计模式、源码分析、软技能等,而Java设计模式、源码分析、软技能又属于Java架构师系列课程包,每个课程的定价都不一样。但是,这些课程不论怎么组合,都有一些共性,而且是整体和部分的关系,可以用组合模式来设计。

先创建一个顶层的抽象组件CourseComponent类:

public abstract class CourseComponent {

    public void addChild(CourseComponent catalogComponent) {
        throw new UnsupportedOperationException("不支持添加操作");
    }

  public void removeChild(CourseComponent catalogComponent) {
        throw new UnsupportedOperationException("不支持删除操作");
    }

    public String getName(CourseComponent catalogComponent) {
        throw new UnsupportedOperationException("不支持获取名称操作");
    }

    public double getPrice(CourseComponent catalogComponent) {
        throw new UnsupportedOperationException("不支持获取价格操作");
    }

    public void print() {
        throw new UnsupportedOperationException("不支持打印操作");
    }
}
复制代码

把所有可能用到的方法都定义到这个最顶层的抽象类中,但是不写任何逻辑处理的代码,而是直接抛异常,这里,有些小伙伴会有疑惑,为什么不用抽象方法?因为用了抽象方法,其子类就必须实现,这样便体现不出各子类的细微差异。因此,子类继承此抽象类后,只需要重写有差异的方法覆盖父类的方法即可。

下面我们分别创建课程类Course和课程包CoursePackage类,先创建Course类:

public class Course extends CourseComponent {

    private String name;
    private double price;

    public Course(String name, double price) {
        this.name = name;
        this.price = price;
    }

    @Override
    public String getName(CourseComponent catalogComponent) {
        return this.name;
    }

    @Override
    public double getPrice(CourseComponent catalogComponent) {
        return this.price;
    }

    @Override
    public void print() {
        System.out.println(name + "(¥" + price + "元)");
    }
}
复制代码

再创建CoursePackage类:

public class CoursePackage extends CourseComponent {

    private List<CourseComponent> items = new ArrayList<>();
    private String name;
    private Integer level;

    public CoursePackage(String name, Integer level) {
        this.name = name;
        this.level = level;
    }

    @Override
    public void addChild(CourseComponent catalogComponent) {
        items.add(catalogComponent);
    }

    @Override
    public String getName(CourseComponent catalogComponent) {
        return this.name;
    }

    @Override
    public void removeChild(CourseComponent catalogComponent) {
        items.remove(catalogComponent);
    }

    @Override
    public void print() {
        System.out.println(this.name);
        for (CourseComponent catalogComponent : items) {
            //控制显示格式
            if (this.level != null) {
                for (int i = 0; i < this.level; i++) {
                    //打印空格控制格式
                    System.out.print("  ");
                }
                for (int i = 0; i < this.level; i++) {
                    //每一行开始打印一个+号
                    if (i == 0) {
                        System.out.print("+");
                    }
                    System.out.print("-");
                }
            }
            //打印标题
            catalogComponent.print();
        }
    }
}
复制代码

来看测试代码:

public class Test {

    public static void main(String[] args) {
        System.out.println("==============透明组合模式==============");
        CourseComponent javaBean = new Course("Java入门课程", 666);
        CourseComponent ai = new Course("人工智能", 888);

        CourseComponent coursePackage = new CoursePackage("Java架构师课程", 2);
        CourseComponent design = new Course("Java设计模式", 1500);
        CourseComponent source = new Course("源码分析", 2000);
        CourseComponent softKill = new Course("软技能", 3000);

        coursePackage.addChild(design);
        coursePackage.addChild(source);
        coursePackage.addChild(softKill);

        CourseComponent catalog = new CoursePackage("课程主目录", 1);
        catalog.addChild(javaBean);
        catalog.addChild(ai);
        catalog.addChild(coursePackage);

        catalog.print();
    }
}
复制代码

运行结果如下:

image.png

透明组合模式把所有公共方法都定义在Component中,这样做的好处是客户端无需分辨是叶子节点(Leaf)和树枝节点(Composite),它们具备完全一致的接口,缺点是叶子节点(Leaf)会继承得到一些它所不需要(管理子类操作的方法)的方法,这与设计模式接口隔离原则相违背。

2. 安全组合模式的写法

安全组合模式是只规定系统各个层次的最基础的一致行为,而把组合(树节点)本身的方法(管理子类对象的添加、删除等)放到自身当中。

举一个程序员更熟悉的例子,对于程序员来说,电脑是每天都要接触的。电脑的文件系统其实就是一个典型的树形结构,目录包含文件夹和文件,文件夹里面又包含文件夹和文件,文件夹里面有可以包含文件夹和文件,下面我们就用代码来实现一个目录系统。

先创建最顶层的抽象组件Directory类:

public abstract class Directory {
    protected String name;

    public Directory(String name) {
        this.name = name;
    }

    public abstract void show();
}
复制代码

然后分别创建File类和Folder类,先看File类:

public class File extends Directory {

    public File(String name) {
        super(name);
    }

    @Override
    public void show() {
        System.out.println(this.name);
    }
}
复制代码

然后创建Folder类:

public class Folder extends Directory {

    private List<Directory> dirs;
    private Integer level;

    public Folder(String name, Integer level) {
        super(name);
        this.level = level;
        this.dirs = new ArrayList<>();
    }

    @Override
    public void show() {
        System.out.println(this.name);
        for (Directory directory : dirs) {
            //控制显示格式
            if (this.level != null) {
                for (int i = 0; i < this.level; i++) {
                    //打印空格控制格式
                    System.out.print("  ");
                }
                for (int i = 0; i < this.level; i++) {
                    //每一行开始打印一个+号
                    if (i == 0) {
                        System.out.print("+");
                    }
                    System.out.print("-");
                }
            }
            //打印名称
            directory.show();
        }
    }

    public boolean add(Directory dir) {
        return this.dirs.add(dir);
    }

    public boolean remove(Directory dir) {
        return this.dirs.remove(dir);
    }

    public Directory get(int index) {
        return this.dirs.get(index);
    }

    public void list() {
        for (Directory dir : dirs) {
            System.out.println(dir.name);
        }
    }

}
复制代码

注意Folder类不仅覆盖了顶层的show()方法,而且还增加了list()方法,看测试代码:

public class Test {

    public static void main(String[] args) {
        System.out.println("=============安全组合模式================");

        File qq = new File("QQ.exe");
        File wx = new File("微信.exe");

        Folder office = new Folder("办公软件", 2);

        File word = new File("word.exe");
        File ppt = new File("powerpoint.exe");
        File excel = new File("excel.ext");

        office.add(word);
        office.add(ppt);
        office.add(excel);

        Folder wps = new Folder("金山软件", 3);
        wps.add(new File("wps.exe"));
        office.add(wps);

        Folder root = new Folder("根目录", 1);
        root.add(qq);
        root.add(wx);
        root.add(office);

        System.out.println("================show()方法效果======================");
        root.show();
        System.out.println("================list()方法效果======================");
        root.list();
    }
}
复制代码

运行结果如下:

image.png

安全组合模式的好处是接口定义职责清晰,符合设计模式单一职责原则和接口隔离原则,缺点是客户需要区分树枝节点(Composite)和叶子节点(Leaf),这样才能正确处理各个层次的操作,客户端无法依赖抽象(Component),违背了设计模式依赖倒置原则。

六、组合模式在源码中的应用

在这里我们举一个开源框架中非常典型的案例,MyBatis解析各种Mapping文件中的SQL,设计了一个非常关键的类叫做SqlNode,xml中的每个Node都会解析为一个SqlNode对象,最后把所有的SqlNode拼装到一起就成了一条完整的SQL语句,它的顶层设计非常简单,来看源码:

public interface SqlNode {
  boolean apply(DynamicContext context);
}
复制代码

apply()方法会根据传入的参数context,参数解析该SqlNode所记录的SQL片段,并调用DynamicContext.appendSql()方法将解析后的SQL片段追加到DynamicContext的sqlBuilder中保存。当SQL节点下的所有SqlNode完成解析后,可以通过DynamicContext.getSql()方法获取一条完成的SQL语句。

对具体源码实现感兴趣的小伙伴可以去研究一下,我这里给大家展示一下类图:

image.png

七、组合模式的优缺点

优点:

  1. 清楚的定义分层次的复杂对象,表示对象的全部或部分层次。
  2. 让客户端忽略了层次的差异,方便对整个层次结构进行控制。
  3. 简化了客户端代码。
  4. 符合开闭原则。

缺点:

  1. 限制类型时会较为复杂。
  2. 使设计变得更加抽象。

八、友情链接

设计模式-工厂模式学习之旅

设计模式-单例模式学习之旅

设计模式-原型模式学习之旅

设计模式-建造者模式学习之旅

设计模式-代理模式学习之旅

设计模式-门面模式学习之旅

设计模式-装饰器模式学习之旅

设计模式-享元模式学习之旅

欢迎大家关注微信公众号(MarkZoe)互相学习、互相交流。