Taxol

I’ve always been.

Effective Java - Item 3

Updated:

Effective Java

Item 3. private 생성자나 열거 타입으로 싱글턴임을 보증하라

싱글턴(SingleTon)

싱글턴이란 인스턴스를 오직 하나만 생성할 수 있는 클래스 를 말한다.
싱글턴의 전형적인 예로는 함수와 같은 무상태(stateless) 객체나 설계상 유일해야하는 시스템 컴포넌트 등이 있다.
다만, 클래스를 싱글턴으로 생성하면 이를 사용하는 클라이언트를 테스트하기 어려워 질 수 있다.
왜냐하면 타입을 인터페이스로 정의한 다음 그 인터페이스를 구현해서 만든 싱글턴이 아니라면, 싱글턴 인스턴스를 mock 구현으로 대체할 수 없기 때문이다.

싱글턴을 만드는 방식은 보통 두 중 하나인데, 둘다 생성자는 private으로 감춰두고, 유일한 인스턴스에 접근할 수있는 수단으로 public static 맴버를 마련해 둔다.

public static final 필드 방식의 싱글턴

public class SingleTon {
	public static class Elvis {
		public static final Elvis instance = new Elvis();
		public int var = 0;
		private Elvis() { }

		public void leaveTheBuilding() { }
	}
	
	public static void main(String[] args) {
		Elvis elvis1 = Elvis.instance;
		Elvis elvis2 = Elvis.instance;
		
		elvis1.var = 20;
		elvis2.var = 10;
		
		// 두 객체의 주소가 같다
		System.out.println(elvis1);	
		System.out.println(elvis2);	
		
		System.out.println(elvis1.var);	// 20이 아니라 10이 나온다
	}
}

위 예를 보면, elvis1, elvis2인 두개의 객체를 생성하였지만, 인스턴스는 하나므로 객체의 인스턴스 변수도 동일하다.
private 생성자는 public static final 필드인 Elvis.instance를 초기화 할 때 딱 한번만 호출된다.
즉 public이나 protected 생성자가 없으므로 Elvis 클래스가 초기화될 때 만들어진 인스턴스가 전체 시스템에서 하나뿐임이 보장된다.

장점

  1. public 필드 방식의 큰 장점은 해당 클래스가 싱글턴임이 API에 명백히 드러난다.
    public static 필드가 final이니 절대로 다른 객체를 참조할 수 없다.
  2. 간결함

정적 팩터리 방식의 싱글턴

싱글턴을 만드는 두 번째 방법에서는 정적 팩터리 메서드를 public static 맴버로 제공한다.

public class SingleTon {
	public static class Elvis {
		private String[] album;
		private int var = 0;
		
		private static final Elvis instance = new Elvis();	// instance 생성을 priavte
		private Elvis() { 
			album = new String[100];
		}
		public static Elvis getInstance() {			// 정적 팩터리 메소드로 인스턴스 반환
			return instance;
		}

		public void leaveTheBuilding() { }
	}
	
	public static void main(String[] args) {
		Elvis elvis1 = Elvis.getInstance();
		Elvis elvis2 = Elvis.getInstance();
		
		elvis1.var = 20;
		elvis2.var = 10;
		
		// 2개의 객체의 주소가 같다
		System.out.println(elvis1);	
		System.out.println(elvis2);	

		System.out.println(elvis1.var);	// 20이 아니라 10이 나온다
	}
}

Elvis.getInstance()는 항상 같은 객체의 참조를 반환하므로 제2의 Elvis 인스턴스란 결코 만들어지지 않는다.

장점

  1. (마음이 바뀌면) API를 바꾸지 않고도 싱글턴이 아니게 변경할 수 있다는 점이다.
    유일한 인스턴스를 반환하던 팩터리 메서드가, 호출하는 스레드별로 다른 인스턴스를 넘겨주게 할 수있다.
  2. 정적 팩터리를 제네릭 싱글턴 팩터리로 만들 수 있다.
  3. 정적 팩터리의 메서드 참조를 공금자로 사용할 수 있다.
    Ex) Elvis::getInstance를 Supplier<Elvis>로 사용

싱글턴의 직렬화

싱글턴 클래스를 직렬화 하려면 주의해야한다.
모든 인스턴스 필드를 transient이라고 선언하고 readResolve메서드를 제공해야한다.
이렇게 하지 않으면 직렬화된 인스턴스를 역직렬화할 때 새로운 인스턴스가 만들어진다.

public static class Elvis {
		private String[] album;
		private int var = 0;
		
		private static final Elvis instance = new Elvis();	// instance 생성을 priavte
		private Elvis() { 
			album = new String[100];
		}
		public static Elvis getInstance() {			// 정적 팩터리 메소드로 인스턴스 반환
			return instance;
		}
		private Object readResolve(){		// 싱글턴임을 보장해주는 readResolve 메서드
			return instance;			// 'real' Elvis를 반환하고, 'fake'는 GC가 처리한다.
		}
		public void leaveTheBuilding() { }
	}

열거 타입 방식의 싱글턴

세번째 방법인, 원소가 하나인 열거 타입을 선언하는 것이다.

public class SingleTon {
	public static enum Elvis{
		instance;
		int var;
		
		public void leaveTheBuilding() { }
	}
	
	public static void main(String[] args) {
		Elvis elvis1 = Elvis.instance;
		Elvis elvis2 = Elvis.instance;
		
		elvis1.var = 20;
		elvis2.var = 10;
		// 둘다 `instance`가 나온다
		System.out.println(elvis1);	
		System.out.println(elvis2);	
		
		System.out.println(elvis1.var);	// 20이 아니라 10이 나온다
	}
}

public 필드 방식과 비슷하지만, 더 간결하고, 추가 노력없이 직렬화할 수 있고, 심지어 아주 복잡한 직렬화 상황이나 리플렉션 공격에도 제2의 인스턴스가 생기는 일을 완벽히 막아준다.
대부분 상황에서는 원소가 하나뿐인 열거 타입이 싱글턴을 만드는 가장 좋은 방법 이다.

단, 만들려는 싱글턴이 Enum 외의 클래스를 상속할 수 없다.(열거 타입이 다른 인터페이스를 구현하도록 선언할 수는 있다.)

출처

Joshua Bloch. Effective Java 3/E. n.p.: 인사이트, 2018년 11월 1일.

You may also enjoy