23种设计模式-结构型模式-享元

简介

亦称：缓存、Cache、Flyweight。享元是一种结构型设计模式，它摒弃了在每个对象中保存所有数据的方式，通过共享多个对象所共有的相同状态，让你能在有限的内存容量中载入更多对象。

问题

假如你开发了一款简单的游戏：玩家可以在地图上移动并相互射击，比如刺激战场。你决定实现一个真实的粒子系统。大量的子弹、导弹和爆炸弹片会在整个地图上穿行，给玩家提供刺激的游戏体验。
开发完成后，你编译好打包然后发送给了一个朋友进行测试。尽管这个游戏在你的电脑上正常运行，但是你的朋友却无法长时间进行游戏：游戏总是会在他的电脑上运行几分钟后崩溃。在研究了调试信息后，你发现导致游戏崩溃的原因是电脑内存容量不足。朋友的设备性能远比不上你的电脑，所以游戏运行之后很快就会出现问题。

真正的问题其实是跟粒子系统有关。每个粒子（一颗子弹、一枚导弹或一块弹片）都由包含完整数据的独立对象来表示，如下图，每个粒子占用约21KB内存。当玩家打到高潮的时候（粒子数大约有1000000），会占用大约21GB的内存，这时内存已经不能再容纳新粒子了，于是程序就崩溃了。

解决方案

仔细观察粒子Par­ti­cle类，你可能会注意到颜色（color）和纹理图（sprite）这两个成员变量所消耗的内存要比其他变量多得多。而且对于所有的粒子来说，这两个成员变量所存储的数据几乎完全一样（比如所有子弹的颜色和纹理图都一样），如下图(Particle)。

每个粒子的另一些状态（坐标、移动矢量和速度）则是不同的（MovingParticle）。因为这些成员变量的数值会不断变化。这些数据能够代表粒子在创建之后不断变化的情景，但每个粒子的颜色和纹理图其实会保持不变。
我们知道，对象的常量数据通常被称为内在状态，它在对象里面，其他对象只能读取但不能修改他的数值。而对象的其他状态常常能被其他对象“从外部”改变，因此被称为外在状态。
享元模式建议不在对象中存储外在状态，而是把他传递给依赖于它的一个特殊方法。程序只在对象里保存内在状态，以方便在不同情景下重用。这些对象的区别仅在于他的内在状态（和外在状态相比，内在状态的变化要少很多），因此你所需的对象数量会大大削减。
让我们回到游戏的示例。假如能从粒子类里抽出外在状态（MovingParticle），那么我们只需要三个不同的对象（子弹、导弹和弹片）就能表示游戏中的所有粒子。如下图，我们把MovingParticle从Particle中抽出来之后，只要一个Particle对象存储颜色和纹理图（21KB）即可， 其余外在状态都存储在MovingParticle对象中（32B），MovingParticle 对象会共享这一个Particle对象。你现在很可能已经猜到了，我们把这样一个仅存储内在状态(Particle)的对象称为享元。

享元与不可变性

由于享元对象可以在不同的情景中使用，你必须确保他的状态不能被修改。享元类的状态只能由构造函数的参数进行一次性初始化，它不能对其他对象公开他的setter或公有成员变量。

享元工厂

为了能更方便地访问各种享元，你可以创建一个工厂方法来管理已有享元对象的缓存池。工厂方法从客户端处接收目标享元对象的内在状态作为参数，如果它能在缓存池中找到所需享元，就把它返回给客户端；如果没有找到，它就会新建一个享元，并把他添加到缓存池里。
你可以选择在程序的不同地方放入这个函数。最简单的选择就是把他放在享元容器里。除此之外，你还可以新建一个工厂类，或者创建一个静态的工厂方法并把它放在实际的享元类里。

代码

// 粒子内在状态
final class ParticleType {
    private final String color;  // 不可变特征
    private final String texture;
    private final String effectType;

    public ParticleType(String color, String texture, String effectType) {
        this.color = color;
        this.texture = texture;
        this.effectType = effectType;
    }

    public void render(String position, double velocity) {
        System.out.printf("绘制%s特效: 位置%s | 速度%.1fm/s | 材质[%s]%n",
            effectType, position, velocity, texture);
    }
}

// 粒子外在状态载体
class Particle {
    private double x, y;
    private double velocity;
    private final ParticleType type; // 共享引用

    public Particle(double x, double y, double v, ParticleType type) {
        this.x = x;
        this.y = y;
        this.velocity = v;
        this.type = type;
    }

    public void display() {
        type.render(String.format("(%.1f, %.1f)", x, y), velocity);
    }
}

// 享元工厂
class ParticleFactory {
    private static final Map<String, ParticleType> pool = new HashMap<>();

    public static ParticleType getType(String color, String texture, String effect) {
        String key = color + "_" + texture + "_" + effect;
        // 池化检测逻辑
        if (!pool.containsKey(key)) {
            pool.put(key, new ParticleType(color, texture, effect));
        }
        return pool.get(key);
    }
}

// 粒子系统管理
class ParticleSystem {
    private List<Particle> particles = new ArrayList<>();

    public void addParticle(double x, double y, double v,
                          String color, String texture, String effect) {
        ParticleType type = ParticleFactory.getType(color, texture, effect);
        particles.add(new Particle(x, y, v, type));
    }

    public void simulate() {
        particles.forEach(Particle::display);
    }
}

// 运行示例
class GameEngine {
    public static void main(String[] args) {
        ParticleSystem system = new ParticleSystem();
        
        // 添加火焰粒子
        system.addParticle(10.5, 20.3, 5.2, "橙红", "fire_tex", "火焰");
        system.addParticle(15.1, 18.7, 4.8, "橙红", "fire_tex", "火焰");
        
        // 添加冰雪粒子
        system.addParticle(30.0, 50.0, 2.1, "冰蓝", "snow_tex", "冰霜");
        
        system.simulate();
    }
}

总结

1. 享元模式只是一种优化。在应用这个模式之前，你要确定程序里存在内存消耗问题，并且这个问题是跟大量类似对象同时占用内存相关的，同时确保这个问题没办法用其他更好的方式来解决。
2. 享元（Fly­weight）类包含原始对象里部分能在多个对象中共享的状态。同一享元对象可以在许多不同情景中使用。享元中存储的状态被称为“内在状态”。
3. 情景（Con­text）类包含原始对象里各不相同的外在状态。情景和享元对象组合在一起就能表示原始对象的全部状态。
4. 通常情况下，原始对象的行为会保留在享元类中。因此调用享元的方法必须提供部分外在状态作为参数。但你也可把行为移动到情景类里，然后把连入的享元作为单纯的数据对象。
5. 客户端（Client）负责计算或存储享元的外在状态。在客户端看来，享元是一种可以在运行时进行配置的模板对象，具体的配置方式就是向他的方法里面传入一些情景数据参数。
6. 享元工厂（Fly­weight Fac­to­ry）会对已有享元的缓存池进行管理。有了工厂后，客户端就无需直接创建享元，它们只需调用工厂并且向他传递目标享元的一些内在状态就可以了。工厂会根据参数在之前已创建的享元中进行查找，如果找到满足条件的享元就直接返回；如果没有找到就根据参数新建享元。