享元模式

思考并回答以下问题：

• 提供了一个享元池用于存储已经创建好的享元对象。怎么理解？

本章导学

当系统中存在大量相同或者相似的对象时，享元模式是一种值得考虑的解决方案，它通过共享技术实现相同或相似的细粒度对象的复用，从而节约内存空间，提高系统性能。在享元模式中提供了一个享元池用于存储已经创建好的享元对象，并通过享元工厂类将享元对象提供给客户端使用。

本章将学习享元模式的定义与结构，学习如何设计享元池和享元工厂，并结合实例学习如何实现无外部状态的享元模式以及有外部状态的享元模式。

本章知识点

• 享元模式的定义
• 享元模式的结构
• 享元模式的实现
• 享元模式的应用
• 享元模式的优缺点
• 享元模式的适用环境
• 有外部状态的享元模式
• 单纯享元模式与复合享元模式

享元模式概述

如果一个软件系统在运行时所创建的相同或相似的对象数量太多，将导致运行代价过高，带来系统资源浪费、性能下降等问题。例如在一个文本字符串中存在很多重复的字符，如果每一个字符都用一个单独的对象来表示，将会占用较多的内存空间，那么如何避免系统中出现大量相同或相似的对象，同时又不影响客户端程序通过面向对象的方式对这些对象进行操作呢？享元模式正是为解决这一类问题而“诞生”。享元模式通过共享技术实现相同或相似对象的重用，在逻辑上每一个出现的字符都有一个对象与之对应，然而在物理上它们却共享同一个享元对象，这个对象可以出现在一个字符串的不同地方，相同的字符对象都指向同一个实例。在享元模式中，存储这些共享实例对象的地方称为享元池（Flyweight Pool），用户可以针对每一个不同的字符创建一个享元对象，将其放在享元池中，待需要时再从享元池中取出。字符享元对象示意图如图1所示。

图1 字符享元对象示意图

享元模式以共享的方式高效地支持大量细粒度对象的重用，享元对象能做到共享的关键是区分了内部状态（Intrinsic State）和外部状态（Extrinsic State）。下面对享元的内部状态和外部状态进行简单的介绍。

(1)内部状态是存储在享元对象内部并且不会随环境改变而改变的状态，内部状态可以共享。例如字符的内容，不会随外部环境的变化而变化，无论在任何环境下字符“a”始终是“a”，都不会变成“b”。

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

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

享元模式的定义如下：

运用共享技术有效地支持大量细粒度对象的复用。

享元模式要求能够被共享的对象必须是细粒度对象，它又称为轻量级模式，享元模式是一种对象结构型模式。

享元模式的结构与实现

享元模式的结构

享元模式结构较为复杂，通常结合工厂模式一起使用，在它的结构图中包含了一个享元工厂类，其结构如图2所示。

图2 享元模式结构图

由图2可知，享元模式包含以下4个角色。

(1)Flyweight（抽象享元类）：它通常是一个接口或抽象类，在抽象享元类中声明了具体享元类公共的方法，这些方法可以向外界提供享元对象的内部数据（内部状态），同时也可以通过这些方法设置外部数据（外部状态）。

(2)ConcreteFlyweight（具体享元类）：它实现了抽象享元类，其实例称为享元对象，并在具体享元类中为内部状态提供了存储空间。通常可以结合单例模式来设计具体享元类，为每一个具体享元类提供唯一的享元对象。

(3)UnsharedConcretelyweight（非共享具体享元类）：并不是所有的抽象享元类的子类都需要被共享，用户可以将不能被共享的子类设计为非共享具体享元类，当需要一个非共享具体享元类的对象时可以直接通过实例化创建。

(4)FlyweightFactory（享元工厂类）：享元工厂类用于创建并管理享元对象，它针对抽象享元类编程，将各种类型的具体享元对象存储在一个享元池中，享元池一般设计为一个存储“键值对”的集合（也可以是其他类型的集合），可以结合工厂模式进行设计。当用户请求一个具体享元对象时，享元工厂提供一个存储在享元池中已创建的实例或者创建一个新的实例（如果不存在），返回新创建的实例并将其存储在享元池中。

享元模式的实现

享元类Flyweight的设计是享元模式的要点之一，为了提高系统的可扩展性，通常要定义一个抽象享元类作为所有具体享元类的公共父类。典型的抽象享元类代码如下：

abstract class Flyweight
{
    public abstract void Operation(string extrinsicState);
}

在具体享元类ConcreteFlyweight中要将内部状态和外部状态分开处理，通常将内部状态作为具体享元类的成员变量，而将外部状态通过注入的方式添加到具体享元类中。典型的具体享元类代码如下：

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

    public ConcreteFlyweight(string intrinsicState) 
    {
	    this.intrinsicState = intrinsicState;
    }

    // 外部状态extrinsicState在使用时由外部设置，不保存在享元对象中，即使是同一个对象，在每一次调用时可以传入不同的外部状态
    public override void Operation(string extrinsicState) 
    {
	    //实现业务方法
    }	
}

除了可以共享的具体享元类以外，用户在使用享元模式时，有时还需要处理不需要共享的抽象享元类Flyweight的子类，这些子类被定义为非共享具体享元类UnsharedConcreteFlyweight。其典型代码如下：

class UnsharedConcreteFlyweight : Flyweight
{
    public override void Operation(string extrinsicState)
    {
        // 实现业务方法
    }
}

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

class FlyweightFactory
{
    // 定义一个Hashtable用于存储享元对象，实现享元池
    private Hashtable flyweights = new Hashtable();

    public Flyweight GetFlyweight(string key)
    {
        // 如果对象存在，则直接从享元池获取
        if (flyweights.ContainsKey(key))
        {
            return (Flyweight)flyweights[key];
        }
        else // 如果对象不存在，先创建一个新的对象添加到享元池中，然后返回
        {
            Flyweight fw = new ConcreteFlyweight("state");
            flyweights.Add(key,fw);
            return fw;
        }
    }
}

享元模式的应用实例

下面通过一个应用实例来进一步学习和理解享元模式。

1.实例说明

某软件公司要开发一个围棋软件，其界面效果如图3所示。

图3 围棋软件界面效果图

该软件公司开发人员通过对围棋软件进行分析发现，在图3中，围棋棋盘中包含大量的黑子和白子，它们的形状、大小都一模一样，只是出现的位置不同而已。如果将每一个棋子都作为一个独立的对象存储在内存中，将导致该围棋软件在运行时所需的内存空间较大，如何降低运行代价、提高系统性能是需要解决的一个问题。为了解决该问题，现使用享元模式来设计该围棋软件的棋子对象。

2.实例类图

通过分析，本实例的结构如图4所示。

图4 围棋棋子结构图

在图4中，IgoChessman充当抽象享元类，BlackIgoChessman和WhiteIgoChessman充当具体享元类，IgoChessmanFactory充当享元工厂类。

3.实例代码

(1)IgoChessman：围棋棋子类，充当抽象享元类。

using System;

namespace FlyweightSample
{
    abstract class IgoChessman
    {
        public abstract string GetColor();

        public void Display() 
        {
            Console.WriteLine("棋子颜色：" + this.GetColor());   
        }
    }
}

(2)BlackIgoChessman：黑色棋子类，充当具体享元类。

namespace FlyweightSample
{
    class BlackIgoChessman : IgoChessman
    {
        public override string GetColor()
        {
            return "黑色";
        }   
    }
}

(3)WhiteIgoChessman：白色棋子类，充当具体享元类。

namespace FlyweightSample
{
    class WhiteIgoChessman : IgoChessman
    {
        public override string GetColor()
        {
            return "白色";
        }
    }
}

(4)IgoChessmanFactory：围棋棋子工厂类，充当享元工厂类，使用单例模式对其进行设计。

using System.Collections;

namespace FlyweightSample
{
    class IgoChessmanFactory
    {
        private static IgoChessmanFactory instance = new IgoChessmanFactory();
        private Hashtable ht; // 使用Hashtable来存储享元对象，充当享元池

        private IgoChessmanFactory()
        {
            ht = new Hashtable();
            IgoChessman black, white;
            black = new BlackIgoChessman();
            ht.Add("b", black);
            white = new WhiteIgoChessman();
            ht.Add("w", white);
        }

        // 返回享元工厂类的唯一实例
        public static IgoChessmanFactory GetInstance()
        {
            return instance;
        }

        // 通过key来获取存储在Hashtable中的享元对象
        public IgoChessman GetIgoChessman(string color)
        {
            return (IgoChessman)ht[color];
        }
    }
}

(5)Program：客户端测试类。

using System;

namespace FlyweightSample
{
    class Program
    {
        static void Main(string[] args)
        {
            IgoChessman black1,black2,black3,white1,white2;
            IgoChessmanFactory factory;
        
            // 获取享元工厂对象
            factory = IgoChessmanFactory.GetInstance();

            // 通过享元工厂获取三颗黑子
            black1 = factory.GetIgoChessman("b");
            black2 = factory.GetIgoChessman("b");
            black3 = factory.GetIgoChessman("b");
            Console.WriteLine("判断两颗黑子是否相同：" + (black1 == black2));

            // 通过享元工厂获取两颗白子
            white1 = factory.GetIgoChessman("w");
            white2 = factory.GetIgoChessman("w");
            Console.WriteLine("判断两颗白子是否相同：" + (white1 == white2));

            // 显示棋子
            black1.Display();
            black2.Display();
            black3.Display();
            white1.Display();
            white2.Display();
             
            Console.Read();
        }
    }
}

4.结果及分析

编译并运行程序，输出结果如下：

判断两颗黑子是否相同：True
判断两颗白子是否相同：True
棋子颜色：黑色 
棋子颜色：黑色  
棋子颜色：黑色  
棋子颜色：白色  
棋子颜色：白色

从输出结果可以看出，虽然在客户端代码中获取了3个黑子对象和两个白子对象，但是3个黑子的内存地址相同，两个白子的内存地址也相同，也就是说，实际上只有两个对象。在实现享元工厂类时使用了单例模式和简单工厂模式，确保了享元工厂对象的唯一性，并提供了工厂方法向客户端返回享元对象。

有外部状态的享元模式

在上一节的应用实例中，对围棋棋子进行进一步分析，不难发现，虽然黑色棋子和白色棋子可以共享，但是它们将显示在棋盘的不同位置，如何让相同的黑子或者白子能够多次重复显示但位于一个棋盘的不同地方？解决方法之一就是将棋子的位置定义为棋子的一个外部状态，在需要时再进行设置。因此，在图4的基础上增加了一个新的类Coordinates（坐标类），用于存储每一个棋子的位置，修改之后的结构如图5所示。

图5 引入外部状态之后的围棋棋子结构图

在图5中，除了增加一个坐标类Coordinates以外，抽象享元类IgoChessman中的Display()方法也将对应增加一个Coordinates类型的参数，用于在显示棋子时指定其坐标。Coordinates类的代码如下：

namespace FlyweightSample
{
    class Coordinates
    {
        private int x;
        private int y;

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

        public int X
        {
            get { return x; }
            set { x = value; }
        }   

        public int Y
        {
            get { return y; }
            set { y = value; }
        }
    }
}

修改之后的IgoChessman类代码如下：

using System;

namespace FlyweightSample
{
    abstract class IgoChessman
    {
        public abstract string GetColor();

        public void Display(Coordinates coord)
        {
            Console.WriteLine("棋子颜色：{0}，棋子位置：{1}，{2}", this.GetColor(),coord.X,coord.Y);    
        }
    }
}

将客户端测试代码修改如下：

using System;

namespace FlyweightSample
{
    class Program
    {
        static void Main(string[] args)
        {
            IgoChessman black1,black2,black3,white1,white2;
            IgoChessmanFactory factory;
        
            // 获取享元工厂对象
            factory = IgoChessmanFactory.GetInstance();

            // 通过享元工厂获取三颗黑子
            black1 = factory.GetIgoChessman("b");
            black2 = factory.GetIgoChessman("b");
            black3 = factory.GetIgoChessman("b");
            Console.WriteLine("判断两颗黑子是否相同：" + (black1 == black2));

            // 通过享元工厂获取两颗白子
            white1 = factory.GetIgoChessman("w");
            white2 = factory.GetIgoChessman("w");
            Console.WriteLine("判断两颗白子是否相同：" + (white1 == white2));

            // 显示棋子，同时设置棋子的坐标位置
            black1.Display(new Coordinates(1, 2));
            black2.Display(new Coordinates(3, 4));
            black3.Display(new Coordinates(1, 3));
            white1.Display(new Coordinates(2, 5));
            white2.Display(new Coordinates(2, 4));

            Console.Read();
        }
    }
}

编译并运行程序，输出结果如下：

判断两颗黑子是否相同：True
判断两颗白子是否相同：True
棋子颜色：黑色，棋子位置：1，2 
棋子颜色：黑色，棋子位置：3，4  
棋子颜色：黑色，棋子位置：1，3
棋子颜色：白色，棋子位置：2，5
棋子颜色：白色，棋子位置：2，4

从输出结果可以看到，在每次调用Display()方法时，都设置了不同的外部状态——坐标值，因此相同的棋子对象虽然具有相同的颜色，但是它们的坐标值不同，将显示在棋盘的不同位置。

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

标准的享元模式结构图中既包含可以共享的具体享元类，也包含不可以共享的非共享具体享元类。但是在实际使用的过程中，有时候会用到两种特殊的享元模式：单纯享元模式和复合享元模式，下面对这两种特殊的享元模式进行简单的介绍。

1.单纯享元模式

在单纯享元模式中，所有的具体享元类都是可以共享的，不存在非共享具体享元类。单纯享元模式的结构如图6所示。

图6 单纯享元模式结构图

2.复合享元模式

将一些单纯享元对象使用组合模式加以组合，还可以形成复合享元对象，这样的复合享元对象本身不能共享，但是它们可以分解成单纯享元对象，而后者则可以共享。复合享元模式的结构如图7所示。

图7 复合享元模式结构图

通过使用复合享元模式，可以让复合享元类CompositeConcreteFlyweight中所包含的每个单纯享元ConcreteFlyweight都具有相同的外部状态，而这些单纯享元的内部状态往往不同。如果希望为多个内部状态不同的享元对象设置相同的外部状态，可以考虑使用复合享元模式。

享元模式的优缺点与适用环境

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

享元模式的优点

享元模式的主要优点如下：

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

享元模式的缺点

享元模式的主要缺点如下：

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

享元模式的适用环境

在以下情况下可以考虑使用享元模式：

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

本章小结

(1)享元模式运用共享技术有效地支持大量细粒度对象的复用。通过使用享元模式，系统只需使用少量的对象，而这些对象都很相似，状态变化很小，因此可以实现对象的多次复用，享元模式是一种对象结构型模式。

(2)享元模式包含抽象享元类、具体享元类、非共享具体享元类和享元工厂类4个角色。其中，在抽象享元类中声明了具体享元类公共的方法；具体享元类实现了抽象享元接口，为内部状态提供了存储空间；非共享具体享元是不能被共享的抽象享元类的子类；享元工厂类用于创建并管理享元对象，它针对抽象享元类编程，将各种类型的具体享元对象存储在一个享元池中。

(3)享元模式的主要优点是可以极大地减少内存中对象的数量，使得相同或相似的对象在内存中只保存一份，从而节约系统资源，提高系统性能。其主要缺点是使得系统变得复杂，需要分离出内部状态和外部状态，这使得程序的逻辑复杂化；此外，享元模式需要将享元对象的部分状态外部化，而读取外部状态将使得运行时间变长。

(4)享元模式适用的环境：一个系统有大量相同或者相似的对象，造成内存的大量耗费；对象的大部分状态都可以外部化，可以将这些外部状态传入对象中；需要多次重复使用享元对象。

(5)享元模式以共享的方式高效地支持大量细粒度对象的重用，享元对象能做到共享的关键是区分了内部状态和外部状态。内部状态是存储在享元对象内部并且不会随环境改变而改变的状态，内部状态可以共享；外部状态是随环境改变而改变的、不可以共享的状态。

(6)在单纯享元模式中，所有的具体享元类都是可以共享的，不存在非共享具体享元类。将一些单纯享元对象使用组合模式加以组合，还可以形成复合享元对象。