singleton이란 인스턴스를 오직 하나만 생성할 수 있는 클래스이다.
인터페이스를 구현한 Singleton객체가 아니라면 mock 객체를 만들 수 없어 이를 사용하는 클라이언트를 테스트하기 어려워 질 수 있다.
Mock 객체란?
실제 객체를 다양한 조건으로 인해 제대로 구현하기 어려울 경우 가짜 객체를 만들어 사용하는데, 이를 Mock 객체라 한다.Mock 객체가 필요한 경우.
1. 환경 구축이 어려운 경우: 특히 실제 객체가 외부 의존성이 많이 있는 경우, 실제 객체를 사용하기 위해 해당 의존성들을 모두 구축하는 것이 어려울 수 있다. 이런 경우 모킹을 사용하여 가짜 객체를 만들어 테스트 환경을 쉽게 구성할 수 있다.
2. 의존적인 경우: 특정 상황이나 조건에 의존적으로 동작하는 객체의 경우, 해당 조건을 재현하기 어렵거나 번거로울 수 있다. 모킹을 통해 특정 조건을 조작하여 테스트를 진행할 수 있다.
3. 시간이 걸리는 경우: 객체가 시간이 많이 걸리는 작업을 수행하는 경우, 테스트를 빠르게 실행하고자 할 때 해당 객체를 모킹하여 가짜 객체를 사용할 수 있다.
Mocking 예제
// 모킹이 필요한 서비스 인터페이스
public interface ExternalService {
String getData();
}
// 의존성을 가진 서비스 클래스
public class MyService {
private ExternalService externalService;
public MyService(ExternalService externalService) {
this.externalService = externalService;
}
public String processData() {
// 외부 서비스에서 받은 데이터를 가공하는 로직
String data = externalService.getData();
return "Processed: " + data;
}
}
// Mockito를 사용한 모킹 테스트
@RunWith(MockitoJUnitRunner.class)
public class MyServiceTest {
@Mock
private ExternalService mockExternalService;
@InjectMocks
private MyService myService;
@Test
public void testProcessData() {
// 모킹된 외부 서비스의 행동을 정의
Mockito.when(mockExternalService.getData()).thenReturn("Mocked Data");
// 테스트 대상 메서드 호출
String result = myService.processData();
// 결과 검증
assertEquals("Processed: Mocked Data", result);
}
}private 생성자나 열거 타입으로 싱글턴임을 보증하라
제목에서 등장하는 단어들을 모두 알고 있다면 다행이지만,
잘 모르는 사람들은 배경지식을 알고 가는게 좋다.
열거 타입 (Enumerate -> enum)
열거 타입
- 한정된 값만 갖는 데이터 타입.
- 지정한 몇 개의 열거 상수 중에서 하나의 상수를 저장하는 데이터타입.
쉽게 말해, 열거 타입이라는 건 자주 쓰는 일정한 상수들을 나열해 놓고,
필요할 때 하나를 정해서 쓰는 것이다.
다음의 예시를 한번 보도록 하자.
public enum Week {
MONADY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
public static void main(String[] args) {
Week today = Week.SUNDAY;
}
}위와 같은 방식이다.
어차피 일주일에 요일 이름은 변하지 않으므로, 미리 나열해서 저장한거다.
단순히 이정도를 말하려고 한 얘기는 아니고,
여기서 알아야 할 포인트는, 열거 타입의 열거되어 있는 상수는
사실 각자가 하나의 Week 객체라는 것이다.
그래서 MONDAY라는 상수는 MONDAY라는 내용을 담고있는 하나의 Week 객체다.
이 내용을 고려하며 이번 내용을 읽으면 도움이 될 것이다.
아래에 추가로 열거 타입에 대한 내용을 적어본다.
열거 타입의 특징
- 요일이나 계절등을 예시로 생각하면 된다.
- 관례적으로 열거 타입 이름은 첫 문자를 대문자로, 나머지 문자를 소문자로 한다.
- public enum에서 enum은 무조건 소문자이다.
- 열거 타입 이름은 소스 파일명과 대소문자 모두 일치해야 한다.
- 열거 상수는 모두 대문자로만 작성한다.
- 열거 타입 변수는 스택에, 열거 객체는 힙에 저장된다.
- 열거 타입 변수에 저장되는 값은 열거 객체 자체가 아닌, 객체의 번지수이다.
- 열거 타입 안에 상수는 힙에 있는 열거 객체의 번지수로 저장되어있다.
- 그래서 "열거 타입 변수 = 열거타입.열거상수"라고 쓰게 되면,
"열거 상수가 바라보고 있는 열거 객체를, 열거 타입 변수도 같이 바라보게 한다"는 의미이다.
public static final 필드 방식
첫번째 방법의 흐름은 다음과 같다.
- 생성자를 private으로 감춰 외부에서는 생성할 수 없게 한다.
- public static final 필드를 이용해, 객체를 딱 한번만 생성한다.
생각보다 단순한 방식이다.
어차피 public이나 protected로 선언된 생성자가 없으므로,
public static final 필드로 생성되는 인스턴스 외에 더이상 생성되는 것은 없다.
전체 시스템에서 인스턴스가 하나뿐임을 보장받을 수 있는 것이다.
public class Elvis {
public static final Elvis INSTANCE = new Elvis();
private Elvis() {...}
}private 생성자는 public static final 필드인 Elvis.INSTANCE를 초기화할 때 딱 한번 호출된다. public 혹은 protected 생성자가 없으므로, Elvis 클래스가 초기화될 때 만들어진 인스턴스는 하나뿐임이 보장된다.
이 방법의 특징이자 장점은,
해당 클래스가 싱글턴임이 명확하게 드러나고 코드 또한 간결하다는 것이다.
다만 이 방법에는 예외가 한가지 존재하는데 클라이언트가 권한이 충분할 경우, Reflection API인 AccessibleObject.setAccessible을 사용하면 private 생성자에 접근이 가능하다.
하지만 생성자에 두 번째 객체 생성에 대한 예외처리를 하면 되기 때문에,
큰 문제는 되지 않는 것 같다.
장점
- public 필드 방식은 해당 클래스가 싱글턴임이 API에 명백하게 드러난다.(final이므로 다른 객체 참조 불가)
- 간결함
static factory 방식
public class Elvis {
private static final Elvis INSTANCE = new Elvis();
private Elvis() {...}
public static Elvis getInstance() {
return INSTANCE;
}
}또는 이렇게 쓸 수 있을 것이다.
public class Elvis {
private static Elvis INSTANCE = null;
private Elvis() {...}
public static Elvis getInstance() {
if (INSTANCE == null) {
INSTANCE = new Elvis();
}
return INSTANCE;
}
}Elvis.getInnstance()는 항상 같은 객체의 참조를 반환하므로 인스턴스가 하나임을 보장한다.
두 코드는 같은 형태이다. 그런데 아마도 이게 방식 1과 무슨 차이가 있냐고 생각하는 사람들이 있을 수 있다.
비슷하다면 비슷하지만 논리적으로 큰 차이가 존재한다.
방식 1(public static final)의 경우,
외부에서 클래스 내에 직접 접근하여 final 변수로 저장된 인스턴스를 사용한다.
방식 2(static factory)의 경우,
외부에서 직접 접근하지 못하고 정적 팩토리 메서드를 통해 인스턴스를 넘겨받는다.
바로 이런 차이점이 방식 1과는 다른 장점을 만들어낸다.
싱글턴으로 만들었던 클래스를 언제든지 원할 때 싱글턴이 아니게 만들 수 있다는 것이다.
쉬운 말이다. 싱글턴은 하나의 인스턴스만 만들어지게 하면 된다. 정적 팩토리 메서드 방식의 경우, 그 메서드 내용에 로직이 들어간다.
바꿔 말하면, 정적 팩토리 메서드의 내용만 바꾸면 싱글턴이 아니게 만들 수 있다.
추가적으로, 정적 팩토리 메서드 방식 또한 public static final 방식과 마찬가지로, reflection API를 통한 예외는 존재한다.
Reflection API: java에서 클래스의 메타데이터를 확인하고, 클래스의 구조를 동적으로 조사하고 수정할 수 있도록 하는 기능을 제공한다. 싱글톤 패턴을 적용한 클래스의 경우, 리플렉션을 사용하면 싱글톤의 원칙을 우회하고 여러 인스턴스를 생성할 수 있다.
Reflection API를 통한 예외: 리플렉션을 사용하여 클래스의 private 생성자를 호출하고 새로운 인스턴스를 생성하려고 할 때 발생하는 예외를 말한다. 싱글톤 패턴은 클래스의 인스턴스를 하나로 제한하기 위해 생성자를 private으로 선언하고, 인스턴스를 얻을 때는 주로 정적 메서드를 통해 제공하는데, 리플렉션을 사용하면 이 제약을 우회할 수 있다.
싱글톤 클래스에서 리플렉션을 통한 예외가 발생하는 예시를 보자
public class SingletonExample {
private static final SingletonExample INSTANCE = new SingletonExample();
private SingletonExample() {...}
public static SingletonExample getInstance() {
return INSTANCE;
}
public static void main(String[] args) {
// 리플렉션을 통한 인스턴스 생성 시도
try {
Class<?> clazz = SingletonExample.class;
Constructor<?> constructor = clazz.getDeclaredConstructor();
constructor.setAccessible(true); // private 생성자에 접근 가능하도록 설정
SingletonExample newInstance = (SingletonExample) constructor.newInstance();
} catch (Exception e) {
e.printStackTrace();
}
}
}위 예제에서는 SingletonExample 클래스의 private 생성자를 리플렉션을 사용하여 호출하려고 시도하고 있다. 이 시도는 IllegalAccessException이 발생하여 실패할 것이다. 이런 예외가 발생하면 해당 클래스는 리플렉션을 통한 객체 생성을 막고, 싱글톤의 원칙을 지키게 된다.
장점
- 현재는 singleton 객체를 리턴하는 정적 메서드이지만, 향후에 필요에 따라 변경할 수 있는 확장성이 있다. 유일한 메서드를 반환하는 팩터리 메서드가 호출하는 스레드별로 다른 인스턴스를 넘겨주도록 리턴하는 방법과 같이 확장성이 열려있다.
- 정적 팩터리를 제네릭 싱글턴 팩터리(Item30)로 만들 수 있다.
- 정적 팩터리의 메서드 참조를 공급자(supplier)로 사용할 수 있다.(Item43, Item44)
다음과 같은 장점이 필요하지 않다면, public static final 필드 방식이 더 좋다.
Reflection 방어
이때, public static final 방식과 static factory 방식은 권한이 있는 클라이언트가 Reflection API - Item65인 AccessibleObject.setAccessible을 사용해 private 생성자를 호출할 수 있는 문제점이 있다. 이러한 공격을 방어하려면 두번째 객체가 생성되려할 때 다음과 같이 예외처리를 해 막을 수 있다.
public class Elvis {
public static final Elvis INSTANCE = new Elvis();
private Elvis() {
if (INSTANCE != null) {
throw new RuntimeException("Can't create Constructor");
}
}
}Singleton Class 직렬화
Singleton class를 직렬화 하려면 단순히 Serializable을 구현하는 것만으로는 부족하다. 모든 인스턴스 필드를 transient(일시적) 약어를 선언하고 readResolve 메서드를 제공해야 한다.(Item89) 이렇게 하지 않으면, 역직렬화(deserialize)시 새로운 인스턴스가 생성된다.
public class Elvis implements Serializable {
private static final Elvis INSTANCE = new Elvis();
private Elvis() {...}
public static Elvis getInstance() {
return INSTANCE;
}
// singleton임을 보장, 객체가 역직렬화 될 때 호출되는 메서드
private Object readResolve() {
// 역직렬화가 되어 새로운 인스턴스가 생성되더라도 INSTANCE를 반환하여 싱글턴 보장
// 새로운 인스턴스 GC에 의해 UnReachable 형태로 판별되어 제거
return INSTANCE;
}
}- 직렬화: 객체를 다른 형태로 변환하는 프로세스를 의미한다. 이 프로세스를 통해 객체의 상태나 데이터를 파일에 저장하거나 네트워크를 통해 전송할 수 있다. 직렬화된 데이터는 일련의 바이트로 표현된다.
- 역직렬화: 이러한 일련의 바이트로 표현된 데이터를 다시 객체로 변환하는 과정이다.
reflection API를 사용하여 private 생성자로 접근해서 인스턴스를 생성하는 것이 역직렬화 프로세스이기 때문에 reflection을 방어하는 방법 중 하나로 readResolve()를 만들어 방어할 수 있다.
Enum(열거 타입) 방식
public enum Elvis {
INSTANCE;
}원소가 하나인 Enum타입을 선언해 singleton을 만들 수 있다.
이게 왜 싱글턴이 되는지 이해가 안된는 사람이 많을수도 있다.
이건 해당 방식을 이해하기 보다 열거 타입 자체를 이해해야 가능하다.
위의 그림을 보자.
보통 열거 타입 클래스를 만들고 상수를 지정하지만,
그 상수의 내용을 담고 있는 객체를 실체는 저 멀리 heap 영역에 있다.
열거 상수에는 열거 객체를 가르키는 주소가 담겨져 있는 원리이고,
열거 변수에는 열거 상수에 담겨져 있는 열거 객체의 주소값이 들어간다.
결국 열거 변수를 만들어 새로운 객체를 생성하는 것처럼 보여도,
그 실체는 heap 영역에 있는 열거 객체의 주소값을 바라보게 하는 원리다.
그래서 만약 싱글턴으로 만들고자 하는 클래스 타입을 열거 타입으로 지정하고,
그 내에 열거 상수를 한개만 두게 된다면,
자연스럽게 그 클래스 인스턴스는 시스템 전체적으로 오로지 한개만 존재하는 것이다.
장점
- public static 방식보다 더 간결
- 추가 코드없이 직렬화 가능
- Reflection 공격과 아주 복잡한 직렬화 상황에도 제 2의 인스턴스가 생기는 일을 완벽히 방어
대부분의 상황에서는 원소가 하나뿐인 열거 타입이 singleton을 만드는 가장 좋은 방법이다. 하지만, singleton이 Enum 이외에도 클래스를 상속해야 하는 경우 이 방법은 사용할 수 없다.
