享元模式 | Footprints of Growth

设计模式之享元模式

定义

享元模式(Flyweight Pattern)：运用共享技术有效地支持大量细粒度对象的复用。系统只使用少量的对象，而这些对象都很相似，状态变化很小，可以实现对象的多次复用。由于享元模式要求能够共享的对象必须是细粒度对象，因此它又称为轻量级模式，它是一种对象结构型模式。

了解

当一个软件系统在运行时产生的对象数量太多，将导致运行代价过高，带来系统性能下降等问题。比如在一个文本字符串中存在很多重复的字符，如果每一个字符都用一个单独的对象来表示，将会占用非常多的内存空间。
享元模式通过共享技术实现相同或相似对象的重用。仍拿字符串为例，在逻辑上每一个出现的字符都有一个对象与之对应，然而在物理上它们却共享同一个享元对象，这个对象可以出现在一个字符串的不同地方，相同的字符对象都指向同一个实例，在享元模式中，存储这些共享实例对象的地方称为享元池(Flyweight Pool)。我们可以针对每一个不同的字符创建一个享元对象，将其放在享元池中，需要时再从享元池取出。
享元模式以共享的方式高效地支持大量细粒度对象的重用，享元对象能做到共享的关键是区分了内部状态(Intrinsic State)和外部状态(Extrinsic State)。

内部状态是存储在享元对象内部并且不会随环境改变而改变的状态，内部状态可以共享。如字符串中字符的内容，不会随外部环境的变化而变化，无论在任何环境下字符“a”始终是“a”，都不会变成“b”；
外部状态是随环境改变而改变的、不可以共享的状态。享元对象的外部状态通常由客户端保存，并在享元对象被创建之后，需要使用的时候再传入到享元对象内部。一个外部状态与另一个外部状态之间是相互独立的。如：字符串中字符的颜色，可以在不同的地方有不同的颜色，例如有的“a”是红色的，有的“a”是绿色的，字符的大小也是如此，有的“a”是五号字，有的“a”是四号字。而且字符的颜色和大小是两个独立的外部状态，它们可以独立变化，相互之间没有影响，客户端可以在使用时将外部状态注入享元对象中。

因此可以将具有相同内部状态的对象存储在享元池中，享元池中的对象是可以实现共享的，需要的时候就将对象从享元池中取出，实现对象的复用。通过向取出的对象注入不同的外部状态，可以得到一系列相似的对象，而这些对象在内存中实际上只存储一份。

结构图

享元模式一般结合工厂模式一起使用，在它的结构图中包含了一个享元工厂类：

Flyweight（抽象享元类）：通常是一个接口或抽象类，在抽象享元类中声明了具体享元类公共的方法，这些方法可以向外界提供享元对象的内部数据（内部状态），同时也可以通过这些方法来设置外部数据（外部状态）。
ConcreteFlyweight（具体享元类）：它实现了抽象享元类，其实例称为享元对象；在具体享元类中为内部状态提供了存储空间。通常我们可以结合单例模式来设计具体享元类，为每一个具体享元类提供唯一的享元对象。
UnsharedConcreteFlyweight（非共享具体享元类）：并不是所有的抽象享元类的子类都需要被共享，不能被共享的子类可设计为非共享具体享元类；当需要一个非共享具体享元类的对象时可以直接通过实例化创建。
FlyweightFactory（享元工厂类）：结合工厂模式进行设计，享元工厂类用于创建并管理享元对象，它针对抽象享元类编程，将各种类型的具体享元对象存储在一个享元池中，享元池一般设计为一个存储“键值对”的集合（也可以是其他类型的集合)；当用户请求一个具体享元对象时，享元工厂提供一个存储在享元池中已创建的实例，如果不存在的话,创建返回一个新的实例并将其存储在享元池中。

典型代码

// 享元工厂类
class FlyweightFactory {
       //定义一个HashMap用于存储享元对象，实现享元池
       private HashMap flyweights = newHashMap();

       public Flyweight getFlyweight(String key){
              //如果对象存在，则直接从享元池获取
              if(flyweights.containsKey(key)){
                     return(Flyweight)flyweights.get(key);
              }
              //如果对象不存在，先创建一个新的对象添加到享元池中，然后返回
              else {
                     Flyweight fw = newConcreteFlyweight();
                     flyweights.put(key,fw);
                     return fw;
              }
       }
}

在享元模式中引入了享元工厂类，享元工厂类的作用在于提供一个用于存储享元对象的享元池，当用户需要对象时，首先从享元池中获取，如果享元池中不存在，则创建一个新的享元对象返回给用户，并在享元池中保存该新增对象。

// 抽象享元类
class Flyweight {
       //内部状态intrinsicState作为成员变量，同一个享元对象其内部状态是一致的
       private String intrinsicState;

       public  Flyweight(String intrinsicState) {
              this.intrinsicState=intrinsicState;
       }

        //外部状态extrinsicState在使用时由外部设置，不保存在享元对象中，即使是同一个对象，在每一次调用时也可以传入不同的外部状态
       public void operation(String  extrinsicState) {
              ......
       }
}

示例

单纯享元模式和复合享元模式

标准的享元模式既包含具体享元类，也包含非共享具体享元类，也可以有另外两种特殊的享元模式：

单纯享元模式

单纯享元模式只包含可以共享的具体享元类：

复合享元模式

将一些单纯享元对象使用组合模式加以组合，还可以形成复合享元对象，这样的复合享元对象本身不能共享，但是它们可以分解成可共享的单纯享元对象。
复合享元模式可以确保复合享元类CompositeConcreteFlyweight中所包含的每个单纯享元类ConcreteFlyweight都具有相同的外部状态，而这些单纯享元的内部状态往往可以不同。如果希望为多个内部状态不同的享元对象设置相同的外部状态，可以考虑使用复合享元模式。

与其他设计模式联用

享元工厂类中通常提供一个静态的工厂方法用于返回享元对象，一般使用简单工厂模式来生成享元对象；
一个系统通常只维护一个享元工厂，因此可以使用单例模式进行享元工厂类的设计；
可以结合组合模式形成复合享元模式，统一对（不同内部状态的）多个享元对象设置外部状态；

String类

如果每次执行类似String str1=”abcd”的操作时都创建一个新的字符串对象将导致内存开销很大，因此如果第一次创建了内容为”abcd”的字符串对象str1，下一次再创建内容相同的字符串对象str2时会将它的引用指向”abcd”，不会重新分配内存空间，从而实现了”abcd”在内存中的共享。

总结

当系统中存在大量相同或者相似的对象时，享元模式是一种比较好的解决方案，它通过共享技术实现相同或相似的细粒度对象的复用，从而节约了内存空间，提高了系统性能。相比其他结构型设计模式，享元模式的使用频率并不算太高，但是作为一种以“节约内存，提高性能”为出发点的设计模式，它在软件开发中还是得到了一定程度的应用。

优点

可以极大减少内存中对象的数量，使得相同或相似对象在内存中只保存一份，从而可以节约系统资源，提高系统性能。
享元模式的外部状态相对独立，而且不会影响其内部状态，从而使得享元对象可以在不同的环境中被共享。

缺点

享元模式使得系统变得复杂，需要分离出内部状态和外部状态，这使得程序的逻辑复杂化。
为了使对象可以共享，享元模式需要将享元对象的部分状态外部化，而读取外部状态将使得运行时间变长。

适用场景

一个系统有大量相同或者相似的对象，造成内存的大量耗费。
对象的大部分状态都可以外部化，可以将这些外部状态传入对象中。
在使用享元模式时需要维护一个存储享元对象的享元池，而这需要耗费一定的系统资源，因此，应当在需要多次重复使用享元对象时才值得使用享元模式。

code

/**
 * @author Wangzy
 * @Description: 客户端类
 * @date 11:23 2020/1/8
 */
@SuppressWarnings("ALL")
public class Client {

    public static void main(String[] args) {

        // 创建享元工厂类
        IgoChessmanFactory factory = IgoChessmanFactory.getFactory();

        // 创建享元对象
        IgoChessman igoChessman = factory.getIgoChessman("black");
        IgoChessman igoChessman1 = factory.getIgoChessman("black");
        IgoChessman igoChessman2 = factory.getIgoChessman("white");
        IgoChessman igoChessman3 = factory.getIgoChessman("white");

        System.out.println(igoChessman == igoChessman1);

        System.out.println(igoChessman2 == igoChessman3);

        igoChessman.display(new Coordinates(1,1));
        igoChessman1.display(new Coordinates(2,1));
        igoChessman2.display(new Coordinates(1,3));
        igoChessman3.display(new Coordinates(2,2));

    }
}

/**
 * @author Wangzy
 * @Description: 抽象享元类
 * @date 11:24 2020/1/8
 */
abstract class IgoChessman {

    /**
     * @Description: 提供对象的内部数据（在此指颜色）
     * @author Wangzy
     * @date 13:32 2020/1/8
     */
    abstract String getColor();

    /**
     * @Description: （设置外部状态）coordinate参数为客户端传入的外部状态
     * @author Wangzy
     * @date 13:28 2020/1/8
     */
    void display(Coordinates coordinates) {
        System.out.println("在（" + coordinates.getX() + ", " + coordinates.getY() + "）显示" + this.getColor() + "棋子!");
    }
}

/**
 * @author Wangzy
 * @Description: 具体享元类（黑色棋子）
 * @date 11:29 2020/1/8
 */
public class BlackIgoChessman extends IgoChessman {

    @Override
    String getColor() {
        return "黑色";
    }
}

/**
 * @author Wangzy
 * @Description: 具体享元类（白色棋子）
 * @date 11:29 2020/1/8
 */
public class WhiteIgoChessman extends IgoChessman {

    @Override
    String getColor() {
        return "白色";
    }
}

import java.util.Hashtable;

/**
 * @author Wangzy
 * @Description: 享元工厂类
 * @date 11:30 2020/1/8
 */
public class IgoChessmanFactory {

    // 饿汉式单例模式创建享元工厂对象
    private static IgoChessmanFactory factory = new IgoChessmanFactory();

    // hashtable充当享元池
    private static Hashtable<String, Object> hashtable;

    private IgoChessmanFactory() {
        hashtable = new Hashtable();
        // 提前创建享元对象并放入享元池
        IgoChessman blackIgoChessman = new BlackIgoChessman();
        hashtable.put("black", blackIgoChessman);
        IgoChessman whiteIgoChessman = new WhiteIgoChessman();
        hashtable.put("white", whiteIgoChessman);
    }

    public static IgoChessmanFactory getFactory() {
        return factory;
    }


    /**
     * @Description: 创建享元对象
     * @author Wangzy
     * @date 11:35 2020/1/8
     */
    public static IgoChessman getIgoChessman(String color) {
        return (IgoChessman) hashtable.get(color);
    }
}

/**
 * @author Wangzy
 * @Description: 外部状态类（棋子坐标）
 * @date 13:25 2020/1/8
 */
public class Coordinates {

    private Integer x;
    private Integer y;

    public Coordinates(Integer x, Integer y) {
        this.x = x;
        this.y = y;
    }

    public Integer getX() {
        return x;
    }

    public void setX(Integer x) {
        this.x = x;
    }

    public Integer getY() {
        return y;
    }

    public void setY(Integer y) {
        this.y = y;
    }
}