플라이웨이트(FlyWeight) 패턴

의도

공유(sharing)를 통해 많은 수로 쪼개진(fine-grained) 객체들을 효과적으로 지원한다.

활용성

플라이웨이트 패턴은 언제 사용하는가에 따라서 그 효과가 달라지며, 다음과 같은 경우에 사용할 수 있다.

  • 응용프로그램이 대량의 객체를 사용해야 할 때
  • 객체의 수가 너무 많아져 저장 비용이 너무 높아질 때

구조

alt

  • Flyweight
    • Flyweight가 받아들일 수 있고, 부가적 상태에서 동작해야 하는 인터페이스를 선언 
      플라이웨이트 패턴에서 중요한 개념은 본질적(intinsic) 상태와 부가적(extrinsic) 상태의 구분이다.  
본질적 상태는 플라이웨이트 객체에 저장되어야 하며, 이것이 적용되는 상황과 상관없는 본질적 특성 정보들이 객체를 구성한다.
본질적이지 않은 부가적 상태는 플라이웨이트 객체가 사용될 상황에 따라 달라질 수 있고, 그 상황에 종속적이다.  
그러므로 공유될 수 없다. 사용자 객체는 이런 부가적 상태를 그것이 필요한 플라이웨이트 객체에 전달해야하는 책임을 갖는다.
  • ConcreteFlyweight
    • Flyweight 인터페이스를 구현하고 내부적으로 갖고 있어야 하는 본질적 상태에 대한 저장소를 정의한다.
      ConcreteFlyweight 객체는 공유할 수 있는 것이어야 한다. 그러므로 관리하는 어떤 상태라도 본질적인 것이어야 한다.
  • UnsharedConcreteFlyweight
    • Flyweight 인터페이스는 공유를 가능하게 하지만, 모든 플라이웨이트 서브클래스들이 공유될 필요는 없다.
    • UnsharedConcreteFlyweight 객체가 ConcreteFlyweight 객체를 자신의 자식으로 갖는 것은 흔한 경우이다.
  • FlyweightFactory
    • 플라이웨이트 객체를 생성하고 관리하며, 제대로 공유되도록 보장해 준다.
    • Client가 플라이웨이트 객체를 요청하면 FlyweightFactory 객체는 이미 존재하는 인스턴스를 제공하거나 존재하지 않는다면 새로 생성한다.
  • Client
    • 플라이웨이트 객체에 대한 참조자를 관리하며, 플라이웨이트 객체의 부가적 상태를 저장한다.

협력 방법

  • 플라이웨이트 객체가 기능을 수행하는 데 필요한 상태가 본질적인 것인지 부가적인 것인지를 구분해야 한다.
    • 본질적 상태는 ConcreteFlyweight에 저장해야 하고, 부가적인 상태는 사용자가 저장하거나, 연산되어야 하는 다른 상태로 관리해야 한다.
      • 사용자는 연산을 호출할 때 자신에게만 필요한 부가적 상태를 플라이웨이트 객체에 매개변수로 전달한다.
  • 사용자는 ConcreteFlyweight의 인스턴스를 직접 만들 수 없다.
    • 사용자는 ConcreteFlyweight 객체를 FlyweightFactory 객체에서 얻어야 한다. 그렇게 해야 플라이웨이트 객체를 공유할 수 있다.

결과

플라이웨이트 패턴은 모두 본질적인 상태로 저장되어 있던 것을 부가적인 상태로 만들기 때문에, 부가적인 상태의 연산과 전송에 드는 런타임 비용이 추가 될 수 있다.
하지만 이런 비용은 플라이웨이트 객체의 공유를 통해 저장소 절약이라는 반대급부를 가질 수도 있다. 저장소 절약은 여러 면에서 기능적이다.

  • 공유해야 하는 인스턴스의 전체 수를 줄일 수 있다.
  • 객체별 본질적 상태의 양을 줄일 수 있다.
  • 부가적인 상태는 연산되거나 저장될 수 있다.

더 많은 Flyweight가 공유되거나, 공유할 상태가 많아질수록 저장소는 절약된다.

예제 코드

public enum FontEffect {
	BOLD, ITALIC, SUPERSCRIPT, SUBSCRIPT, STRIKETHROUGH
}

public final class FontData {
	/**
	*	weak hash map은 사용하지 않는 FontData의 참조를 제거한다.
	*	weak hash map의 Value objects는 강한 참조에 의해서 유지되기 때문에, Value는 WeakReferences에서 wrapped 되어야 한다.
	*/
	private static final WeakHashMap<FontData, WeakReference<FontData>> flyweightData =
		new WeakHashMap<>();
	private final int pointSize;
	private final String fontFace;
	private final Color color;
	private final Set<FontEffect> effects;
	
	private FontData(int pointSize, String fontFace, Color color, EnumSet<FontEffect> effects) {
		this.pointSize = pointSize;
		this.fontFace = fontFace;
		this.color = color;
		this.effects = Collections.unmodifiableSet(effects);
	}
	
	public static FontData create(int pointSize, String fontFace, Color color, FontEffect... effects) {
		EnumSet<FontEffect> effectsSet = EnumSet.noneOf(FontEffect.class);
		for (FontEffect fontEffect : effects) {
			effectsSet.add(fontEffect);
		}
		
		// 객체를 생성하는 데 드는 비용이나 객체가 차지하는 메모리 공간에 대해 걱정할 필요가 없다.
		FontData data = new FontData(pointSize, fontFace, color, effectsSet);
		if (!flyweightData.containsKey(data)) {
			flyweightData.put(data, new WeakReference(data));
		}
		
		// 해시값에 따라 변경불가능한 단일본을 리턴한다.
		return flyweightData.get(data).get();
	}
	 public boolean equals(Object obj) {
		if (obj instanceof FontData) { 
			if (obj == this) { 
				return true; 
			}
			FontData other = (FontData) obj;
			return other.pointSize == pointSize && other.fontFace.equals(fontFace) 
			&& other.color.equals(color) && other.effects.equals(effects);
		}
		
		return false;
		}

		@Override
		public int hashCode() { 
			return (pointSize * 37 + effects.hashCode() * 13) * fontFace.hashCode();
		}

		// Getters for the font data, but no setters. FontData is immutable.
}