3. private 생성자나 열거 타입으로 싱글턴임을 보증하라
안녕하세요, 이번 포스팅은 세번째 아이템인 싱글톤에 관련하여 포스팅을 하겠습니다.
포스팅하기 앞서, 깃허브 커밋이나... 벨로그 활동을 약 사흘동안 하지 못했습니다.
(아니 사실 안한겁니다...)
연휴로 인해 본가인 대구로 내려가 좋은 시간을 보내고 왔습니다 ㅎㅎ
재충전의 시간이라 생각하고 다시 열심히 달리겠습니다!!
Singleton Pattern
싱글턴은 Item 1의 정적 팩터리 메서드에 잠깐 나왔는데, 드디어 포스팅을 하게 되었습니다.
말 그대로 인스턴스를 오직 하나만 생성할 수 있는 클래스를 말합니다.
DB의 Connection Pool 에서도 사용하여 관리하는게 효율적입니다.
호출 시 매번 생성하는 것이 아닌, 미리 생성해둔 인스턴스를 반환하기 때문입니다.
여담으로, 대학교 프로젝트 당시 해당 문제로 되게 골머리를 앓았습니다.
간단한 게임 프로젝트로, RDS와 연동하여 이루어진 게임이였는데, 이놈의 DB 접근이 문제였습니다.
로그인, 게임 시작, 게임 끝, 아이템 조회, 구매...
모든 활동에서의 DB 접근이 로그로 찍히면서, 어떤 방법을 사용해야 하는지 고민했는데, 그때 싱글턴 패턴을 알았다면 훨씬 좋았을 것 같습니다.
싱글턴을 만드는 방식의 대표적인 예시는 두가지입니다.
두 방법 모두 생성자를 private로 감추고, 유일하게 인스턴스에 접근하기 위해 static 멤버를 하나 마련합니다.
아래는, public static 멤버가 final 필드인 경우의 예시입니다.
package item3;
public class Parrineau {
//public static final 필드 방식의 싱글턴
public static final Parrineau INSTANCE = new Parrineau();
private String name;
private int age;
private Parrineau() {
name = "Developer";
age = 25;
}
public void startIntelliJ() {
System.out.println("PARRINEAU, IntelliJ를 시작합니다.");
}
}클라이언트가 객체를 얻고 싶을 때, public static final 필드인 Parrineau.INSTANCE를 초기화할 때 딱 한번 private 생성자가 호출됩니다.
물론 public이나 protected 생성자가 없으므로 인스턴스가 전체 시스템에서 단 하나뿐임이 보장됩니다.
이 방식의 큰 장점은, 해당 클래스가 싱글턴임이 API에 명백히 드러납니다.
두 번째로, 아래의 정적 팩터리 방식보다 간결합니다.
예외는 단 한가지, 리플렉션 API인 AccessibleObject.setAccessible을 사용(Effective Java. Item 65)하여 private 생성자를 호출할 수 있습니다. 이런 공격 방어를 위해 생성자에서 두 번째 객체가 생성될 때 예외를 던지게 하면 됩니다.
리플렉션 관련 포스팅은 다시 학습 후 게시하여 링크를 걸어두도록 하겠습니다.
아래는, 정적 팩터리 메서드를 제공하는 방식입니다.
package item3;
public class Parrineau2 {
//정적 팩터리 방식의 싱글턴
private static final Parrineau2 INSTANCE = new Parrineau2();
public static Parrineau2 getInstance() {
return INSTANCE;
}
private String name;
private int age;
private Parrineau2() {
name = "Developer";
age = 25;
}
public void startIntelliJ() {
System.out.println("PARRINEAU2, IntelliJ를 시작합니다.");
}
}마찬가지로 Parrineau.getInstance는 항상 객체의 참조를 반환하므로, 객체의 동일성을 보장합니다. (앞서 말한 리플렉션은 예외입니다.)
이 방식의 장점은 API 명세를 바꾸지 않고도 싱글턴이 아니게 변경할 수 있습니다.
정적 팩터리 메서드가 호출하는 스레드별로 다른 인스턴스를 넘겨주게 할 수 있기 때문입니다.
두번째로, 정적 팩터리 메서드를 제네릭 싱글턴 팩터리로 만들 수 있다고 합니다.
(Effective Java. Item 30)
세번째로, 정적 팩터리 메서드 참조를 공급자(supplier)로 사용할 수 있습니다.
가령 Parrineau::getInstance를 Supplier<Parrineau>로 사용하는 식입니다. (Effective Java. Item 43, 44)
둘 중 하나의 방식으로 만든 싱글턴 클래스를 직렬화하려면(Effective Java. Item 12), 단순히 Serializable을 구현하고 선언하는 것만으론 부족합니다. 모든 인스턴스 필드를 일시적(transient)이라고 선언하고, readResolve 메서드를 제공해야 합니다. (Effective Java. Item 89).
이렇게 하지 않으면, 역직렬화 시 새로운 인스턴스가 만들어집니다.
정적 팩터리의 에에서, 가짜 Parrineau 생성을 예방하고 싶다면, 다음의 readResolve 메서드를 추가합니다.
private Object readResolve() {
// 진짜 Parrineau를 반환하고, 가짜 Parrineau는 가비지 컬렉터에게 맡김
return INSANCE;마지막으로 싱글턴을 만드는 방식에서 신기한 패턴이 있었는데, 바로 원소가 하나인 열거 타입을 선언하는 것입니다.
package item3;
public enum Parrineau3 {
INSTANCE;
public void startIntelliJ() {
System.out.println("PARRINEAU3, IntelliJ를 시작합니다.");
}
}public 필드 방식과 비슷하지만, 더 간결하고 추가 노력 없이 직렬화를 할 수 있습니다. 리플렉션 공격에도 제2의 인스턴스가 생기는 일을 막아줍니다.
대부분 상황에서는, 원소가 하나뿐인 열거 타입이 싱글턴을 만드는 가장 좋은 방법이라고 합니다.
하지만, 싱글턴이 Enum 외의 클래스를 상속해야 한다면, 이 방법은 사용할 수 없습니다. (열거 타입이 다른 인터페이스를 구현하도록 선언할 수는 있습니다.)
추가 노력 없이 직렬화를 할 수 있다는 점이 궁금했는데, 흥미로운 사실을 발견했습니다.
Class Enum<E extends Enum<E>>
java.lang.Object
java.lang.Enum<E>
Type Parameters:
E - The enum type subclass
All Implemented Interfaces:
Serializable, Comparable<E>protected final Object clone()
throws CloneNotSupportedException
Throws CloneNotSupportedException. This guarantees that enums are never cloned, which is necessary to preserve their "singleton" status.
Overrides:
clone in class Object
Returns:
(never returns)
Throws:
CloneNotSupportedException - if the object's class does not support the Cloneable interface. Subclasses that override the clone method can also throw this exception to indicate that an instance cannot be cloned.
See Also:
Cloneablehttps://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html 에서 찾아봤는데, Serialziable이 구현 되어 있고, clone메서드를 final로 막아놨기 때문에, (reflection 상황 시) 좋은 방법이라고 감히 예상(?) 합니다.
회고
이번 챕터는 리플렉션이나, readResolve등 생소한 기술이 나와 이해하기 다소 어려웠습니다. 싱글턴 패턴은 그저 '객체를 하나만 준다!!!!' 라고 알고 있었는데...
리플렉션이라는 기술이 자주 등장하니까, 필수적으로 학습해야 하는 기술인 것 같고, 무엇보다 좌절이 아닌, 좀 더 자극을 주는 아이템이 아니였나 싶습니다... ㅎㅎ
