从零开始学习Java设计模式 | 结构型模式篇：组合模式

Posted 2021-12-09 李阿昀

在本讲，我们来学习一下结构型模式里面的第六个设计模式，即组合模式。

概述

在学习组合模式之前，我们先来看下面这张图。

对于以上这张图大家应该很熟悉，我们可以将其看作是一个文件系统，其实说到底它就是Windows系统里面的一个目录结构，只不过对于Windows中的文件系统而言，它里面包含有C盘、D盘、E盘等等盘符，而这里我们只是以它里面的某一个盘符里面的目录结构为例来进行了一个描述。

对于这样的结构我们称之为树形结构。为啥叫树形结构呢？你看一下上图中的左边部分，最上面是不是有一个WINDOWS目录啊，而该WINDOWS目录下面又有很多的子目录或者子文件，这样，我们就能将其描述成上图右边部分的树形结构了，它是不是很像一棵倒着的树啊！既然是一棵树，那么它就只有一个树根了，很明显，这个树根就是最顶层的WINDOWS目录，在该目录下，自然就会生成许多的子文件或者子文件夹了，而如果要是子文件夹的话，那么它下面又可以有许多的子文件或者子文件夹了，以此类推，一棵参天大树就长成了。

对于这样一个文件系统而言，有几个概念大家需要知道一下，文件夹或者文件我们都可称之为节点，但是一般来说，我们称文件为叶子节点，称文件夹为树枝节点，这是因为树枝还可以再去生成子树枝或者子叶子。

在这样一个树形结构中，我们可以通过调用某个方法来遍历整棵树，当我们找到某个叶子节点后，就可以对叶子节点进行相关的操作了。因此，我们不妨将这颗树理解成一个大的容器，容器里面包含有很多的成员对象（其实就是节点对象），这些成员对象既可以是容器对象（即文件夹，当然你也可以把它称作是树枝对象）也可以是叶子对象（即文件）。但是由于容器对象和叶子对象在功能上面有所区别（区别是很明显的，叶子对象，即文件，可以读写数据，但是它下面不可能再有子文件或者子文件夹了；而容器对象，即文件夹，它下面是可以再有子文件或者子文件的，但是它不能进行数据的一个读写操作），使得我们在使用的过程中必须要区分容器对象和叶子对象，但是这样一来就会给客户带来不必要的麻烦，对于客户来说的话，他始终是希望能够一致的对待容器对象和叶子对象。也就是说，对于客户而言，不管是文件夹还是文件，他都希望一致的去对待它们，即把它们都当作同样的一个对象来进行处理。

至此，我们就认识了一下以上树形结构，并且咱们还知道了该树形结构所存在的一个问题。那如何解决该问题呢？很明显，就要用到组合模式了，因为本文讲的就是组合模式嘛！

那什么是组合模式呢？下面我们来看看它的概念。

组合模式又名部分整体模式（啥又叫部分整体模式呢？上面不是说过嘛，我们可以将一棵树理解成一个大的容器，对于该容器而言，它就是整体；然后它下面不是又有子文件或者子文件夹嘛，这些子文件或者子文件夹我们就称之为部分，当然，部分下面是不是还可以再分出部分来啊！），是用于把一组相似的对象当作一个单一的对象。组合模式依据树形结构来组合对象，用来表示部分以及整体层次，这种类型的设计模式属于结构型模式，它创建了对象组的树形结构。

看完以上组合模式的概念之后，相信大家就能知道应该要使用组合模式来解决以上树形结构所存在的问题了，因为对于客户而言，他就能一致的去对待容器对象和叶子对象了，这样，他使用起来也会变得更加简单。

结构

组合模式主要包含有三种角色：

• 抽象根节点（Component）：定义系统各层次对象具有的共有方法和属性，可以预先定义一些默认行为和属性。

  怎么来理解抽象根节点呢？还是通过上图来理解，不管是文件夹还是文件，我们都可以向上抽取，抽取出一个抽象类，而在这个抽象类里面，我们就可以去定义文件和文件夹中的共有行为和属性了。也就是说，正是因为客户他想要一致的去对待容器对象和叶子对象，所以他就可以定义出这么一个公共的抽象类了

• 树枝节点（Composite）：定义树枝节点的行为，即存储子节点，组合树枝节点和叶子节点形成一个树形结构。

• 叶子节点（Leaf）：叶子节点对象，其下再无分支，是系统层次遍历的最小单位。

组合模式案例

接下来，我们就通过一个案例再来理解一下组合模式，这个案例就是软件菜单。

分析

先来看一下下面这张图。

相信大家还是比较熟悉以上这张图的，因为我们在访问别的一些管理系统时，经常可以看到类似的菜单。一个菜单可以包含菜单项（菜单项是指不再包含其他内容的菜单条目），也可以包含带有其他菜单项的菜单，就拿以上系统管理菜单来说，它下面有三个子菜单，分别是菜单管理、权限配置、角色管理，它们都是属于菜单，因为它们下面还可以有子菜单或者子菜单项。对于菜单管理来说，它下面有五个子菜单项，分别是页面访问、展开菜单、编辑菜单、删除菜单、新增菜单，注意了，它们都是菜单项，下面不可能再有子菜单或者子菜单项了，故它们都是属于叶子节点；而系统管理、菜单管理、权限配置、角色管理，它们均属于树枝节点，并且系统管理从根本上来说，它是属于根节点。因此，使用组合模式来描述以上菜单就很恰当了。

这样，我们的需求就是针对一个菜单，例如系统管理，打印出其包含的所有菜单以及菜单项的名称。

需求明确之后，接下来我们就要编写代码解决该需求了。首先，对于该需求，我们先设计出一个如下的类图。

从上图可以看出，不管你是菜单（即Menu），还是菜单项（即MenuItem），都应该继承自MenuComponent抽象类，至于MenuComponent抽象类的话，它就是属于抽象根节点，里面定义了一些共有的功能和属性，也就是有两个protected修饰的成员变量，它们分别是name和level，注意了，name指代的是菜单或者菜单项的名称，因此不管是菜单还是菜单项，它们都应该有name这个属性，而level描述的是菜单的一个层级，这个是什么意思呢？

参照软件菜单图，如果是系统管理菜单的话，那么它就应该是一级菜单，即它的层级就是1；如果是菜单管理、权限配置、角色管理这些菜单的话，那么它们就属于是二级菜单了，即它们的层级就是2；如果是菜单管理、权限配置、角色管理这些菜单里面的菜单项的话，那么它们就属于三级菜单了，即它们的层级就是3。

而且，我们还在MenuComponent抽象类里面定义了添加子菜单或者子菜单项、删除子菜单或者子菜单项、获取子菜单或者子菜单项等这样一些方法。除此之外，我们还在该抽象类里面定义了两个方法，一个是getName，因为不管是菜单还是菜单项，都要有一个方法（即getName）来获取菜单或者菜单项的名称；一个是print，该方法就是来满足我们的需求打印菜单或者菜单项的名称的，当然了，如果某个菜单下还有子菜单或者子菜单项的话，那么也要将它们的名称给打印出来。

看完MenuComponent抽象类之后，咱们再来看一下它下面的两个子类，一个是Menu，表示菜单，注意了，Menu类的一个巧妙之处就是它又聚合了MenuComponent抽象类，也就是说Menu类不仅继承自MenuComponent抽象类，而且还聚合了MenuComponent抽象类，只不过它里面是用一个List集合来表示的，为什么呢？这是因为一个菜单可以包含多个子菜单或者子菜单项。

此外，Menu类里面还提供了一个有参构造，并且重写了父类中的添加子菜单或者子菜单项、删除子菜单或者子菜单项、获取子菜单或者子菜单项等这些方法，当然了，该类最后还重写了父类中的print方法，而父类中的getName方法就不需要咱们去重写了，因为该方法在父类中已经被实现了。

MenuComponent抽象类下面还有一个子类，即MenuItem，表示菜单项。从上图可看出，它里面提供了一个有参构造，并且重写了父类中的print方法。注意了，它里面并没有去重写父类中的添加子菜单或者子菜单项、删除子菜单或者子菜单项、获取子菜单或者子菜单项等这些方法。为什么呢？这是因为对于菜单项来说，它是不可能再有子菜单或者子菜单项的。

至此，我们就明确以上案例的需求了，并且对于所设计出来的类图咱们也详细分析完了，接下来，就是编写代码来实现以上案例了。

实现

首先，打开咱们的maven工程，并在com.meimeixia.pattern包下新建一个子包，即combination，也即组合模式的具体代码我们是放在了该包下。

由于不管是菜单还是菜单项，都应该继承自统一的接口，这里姑且将这个统一的接口称为菜单组件。注意了，这个统一的接口我们是将其声明为了一个抽象类，名字就叫MenuComponent，也即菜单组件。记住，在该菜单组件里面，我们要定义一些共有的属性和方法。

package com.meimeixia.pattern.combination;

/**
 * 菜单组件：属于抽象根节点
 * @author liayun
 * @create 2021-08-01 18:21
 */
public abstract class MenuComponent {

    // 菜单组件的名称
    protected String name;
    // 菜单组件的层级
    protected int level;

    /**
     * 添加子菜单或者子菜单项，也就是说既可以添加菜单，也可以添加菜单项
     *
     * 大家一定要注意，如果是菜单的话，那么可以调用该方法，因为菜单下面是可以有子菜单或者子菜单项的；
     * 但是，如果是菜单项的话，那么就不能调用该方法了，因为对于菜单项来说，它下面是不可以再有子菜
     * 单或者子菜单项的，所以在菜单组件里面，我们给该方法一个默认的实现，即抛出一个不支持的操作的异常。
     */
    public void add(MenuComponent menuComponent) {
        throw new UnsupportedOperationException();
    }

    /**
     * 移除子菜单或者子菜单项
     *
     * 大家一定要注意，如果是菜单的话，那么它底下是可以有子菜单或者子菜单项的，所以就可以移除了；
     * 而如果是菜单项的话，那么它便没有该移除操作了，所以在这儿我们也是抛了一个不支持的操作的异常。
     */
    public void remove(MenuComponent menuComponent) {
        throw new UnsupportedOperationException();
    }

    /**
     * 获取指定的子菜单
     *
     * 大家一定要注意，如果是菜单的话，那么可以调用该方法；而如果是菜单项的话，那么就不能调用该方法了，
     * 所以在这儿我们也是默认抛了一个不支持的操作的异常。
     */
    public MenuComponent getChild(int index) {
        throw new UnsupportedOperationException();
    }

    // 获取菜单或者菜单项的名称
    public String getName() {
        return name;
    }

    /**
     * 打印菜单名称（包含子菜单和子菜单项）
     *
     * 对于菜单和菜单项来说，print方法的实现是不一样的，所以在这里我们就把它定义成抽象方法了。
     */
    public abstract void print();

}

菜单组件类我们定义完毕之后，接下来，我们来定义菜单类（即Menu）。

按照我对以上类图的一个描述，相信大家还是能写出下面这样一个菜单类（即Menu）出来的。

package com.meimeixia.pattern.combination;

import java.util.ArrayList;
import java.util.List;

/**
 * 菜单类：属于树枝节点
 * @author liayun
 * @create 2021-08-01 18:40
 */
public class Menu extends MenuComponent {

    // 因为菜单可以有多个子菜单或者子菜单项，所以在这儿我们声明一个private修饰的List集合，而且List集合里面存储的还要是MenuComponent
    private List<MenuComponent> menuComponentList = new ArrayList<MenuComponent>();

    // 提供一个有参构造。我们可以通过该有参构造给菜单命名以及指定菜单的一个级别
    public Menu(String name, int level) {
        // 为父类中的成员变量进行赋值
        this.name = name;
        this.level = level;
    }

    @Override
    public void add(MenuComponent menuComponent) {
        menuComponentList.add(menuComponent);
    }

    @Override
    public void remove(MenuComponent menuComponent) {
        menuComponentList.remove(menuComponent);
    }

    @Override
    public MenuComponent getChild(int index) {
        return menuComponentList.get(index);
    }

    @Override
    public void print() {
        // 打印菜单名称
        for (int i = 0; i < level; i++) {
            System.out.print("--");
        }
        System.out.println(name);
        // 打印子菜单或者子菜单项名称
        for (MenuComponent component : menuComponentList) {
            component.print();
        }
    }
}

菜单类我们定义完毕之后，接下来，我们来定义菜单项类（即MenuItem）。

同理，按照我对以上类图的一个描述，相信大家能写出下面这样一个菜单项类（即MenuItem）出来。

package com.meimeixia.pattern.combination;

/**
 * 菜单项类：属于叶子节点
 * @author liayun
 * @create 2021-08-01 19:06
 */
public class MenuItem extends MenuComponent {

    // 提供一个有参构造。我们可以通过该有参构造给菜单项命名以及指定菜单项的一个级别
    public MenuItem(String name, int level) {
        // 为父类中的成员变量进行赋值
        this.name = name;
        this.level = level;
    }

    @Override
    public void print() {
        // 打印菜单项的名称
        for (int i = 0; i < level; i++) {
            System.out.print("--");
        }
        System.out.println(name);
    }
}

菜单项类我们定义完毕之后，接下来，我们就要编写一个客户端类（即Client）来进行测试了。

package com.meimeixia.pattern.combination;

/**
 * @author liayun
 * @create 2021-08-01 19:21
 */
public class Client {
    public static void main(String[] args) {
        // 创建菜单树
        MenuComponent menu1 = new Menu("菜单管理", 2);
        menu1.add(new MenuItem("页面访问", 3));
        menu1.add(new MenuItem("展开菜单", 3));
        menu1.add(new MenuItem("编辑菜单", 3));
        menu1.add(new MenuItem("删除菜单", 3));
        menu1.add(new MenuItem("新增菜单", 3));

        MenuComponent menu2 = new Menu("权限配置", 2);
        menu2.add(new MenuItem("页面访问", 3));
        menu2.add(new MenuItem("提交保存", 3));

        MenuComponent menu3 = new Menu("角色管理", 2);
        menu3.add(new MenuItem("页面访问", 3));
        menu3.add(new MenuItem("新增角色", 3));
        menu3.add(new MenuItem("修改角色", 3));

        // 创建一级菜单
        MenuComponent component = new Menu("系统管理", 1);
        // 将二级菜单添加到一级菜单中
        component.add(menu1);
        component.add(menu2);
        component.add(menu3);

        // 打印菜单名称（如果有子菜单，那么一块（递归）打印）
        component.print();
    }
}

此时，运行以上客户端类，打印结果如下图所示，可以看到确实是我们所想要的一个结果，而且打印出来的结果还有层级结构，我们看起来也是一目了然。

注意，在客户端类中去打印菜单名称时，是递归打印哟，这样，我们就不需要再做一些复杂的递归操作了，而是直接调用菜单组件里面的一个方法即可，这是不是简化了客户端代码的编写啊！

至此，我们就使用组合模式实现了以上软件菜单案例，希望通过这个案例大家能对组合模式有一个更加深入的认识。

分类

接下来，我们来看一下组合模式的分类。

在使用组合模式时，根据抽象构件类的定义形式，我们可将组合模式分为透明组合模式和安全组合模式两种形式。注意了，这里说的抽象构件类其实就是咱们上例中的MenuComponent抽象类。

那么，咱们上例中使用的到底是哪种形式的组合模式呢？使用的是透明组合模式，而且透明组合模式也是组合模式里面的标准实现形式。接下来，我们就来具体地聊一聊这两种形式的组合模式。

透明组合模式

在透明组合模式中，抽象根节点角色中声明了所有用于管理成员对象的方法，比如在以上示例中MenuComponent抽象类声明了add、remove 、getChild等方法（我们很明确，只有菜单才拥有这些方法，而对于菜单项来说，它不应该具有这些方法），这样做的好处是确保所有的构件类都有相同的接口。这样的话，当我们去使用的时候，就不需要再去区分到底是菜单还是菜单项了，直接面向抽象编程即可。

透明组合模式也是组合模式的标准形式，所以我们在使用的时候尽量都使用透明组合模式。

透明组合模式的缺点是不够安全，因为叶子对象和容器对象在本质上是有区别的，叶子对象不可能有下一个层次的对象，即不可能包含成员对象，因此为其提供add、remove等方法是没有任何意义的，虽然这在编译阶段不会出错（因为这些方法我们是在抽象类中定义的，而子类是可以直接去继承的），但是在运行阶段如果调用这些方法，那么可能就会出错（如果没有提供相应的错误处理代码），这是因为如果是叶子节点调用这些方法的话，那么就会抛异常，你不妨看一下以上示例中的这些方法的默认实现，是不是都抛了一个异常啊！

安全组合模式

在安全组合模式中，在抽象构件角色中没有声明任何用于管理成员对象的方法，而是在树枝节点Menu类中声明并实现这些方法。

我们不妨看一下以下类图。

可以看到，我们并没有在MenuComponent抽象类里面去声明add、remove 、getChild等方法，这些方法是在具体的菜单类中声明并实现的。

安全组合模式的缺点是不够透明，因为叶子构件和容器构件具有不同的方法，且容器构件中那些用于管理成员对象的方法没有在抽象构件类中定义，因此客户端不能完全针对抽象编程，也就是说咱们必须去区别对待叶子构件和容器构件，因为只有区分开了，才能使用它们对应的那些方法。如果你用多态的形式（即通过父类引用指向子类对象），那么父类中没有定义的方法，子类是不能使用的，所以一旦使用了安全组合模式，那么就不能面向抽象编程了。

优点

组合模式的优点，我总结出了以下四点。

1. 组合模式可以清楚地定义分层次的复杂对象，表示对象的全部或部分层次，它让客户端忽略了层次的差异，方便对整个层次结构进行控制。

   就拿以上示例来说，在设计时，我们是使用聚合方式来实现的树形结构，如此一来，对于客户端而言，全部或部分层次在使用的时候就没有任何差异了。

2. 客户端可以一致地使用一个组合结构或其中单个对象，不必关心处理的是单个对象还是整个组合结构，简化了客户端代码。

   举个例子，比如说现在有一个使用组合模式实现的非常复杂的菜单，当然，它里面必然是有菜单项的，这时，对于客户端而言，菜单和菜单项这俩对象都是一样的，因为它们里面的功能在父类中都已经声明过了，这同时也会简化客户端代码的编写。

3. 在组合模式中增加新的树枝节点和叶子节点都很方便，无须对现有类库进行任何修改，符合"开闭原则"。

4. 组合模式为树形结构的面向对象实现提供了一种灵活的解决方案，通过叶子节点和树枝节点的递归组合（注意，咱们此处的递归组合使用的方式就是聚合），可以形成复杂的树形结构，但对树形结构的控制却非常简单。

   例如，我们去打印菜单名称时，当然，如果有子菜单，那么还须一块递归打印，只需要去调用菜单组件里面的print方法即可，我们并不需要明确该菜单到底有几层以及它里面是怎么实现的。

使用场景

组合模式正是应树形结构而生，所以组合模式的使用场景就是出现树形结构的地方。比如文件目录显示、多级目录呈现等树形结构数据的操作。