목차
웹 어플리케이션과 싱글톤
지금까지 자바 기반 설정파일과 XML기반 설정파일을 읽어 BeanDefinition을 만들어 스프링 컨테이너를 생성하며 학습을 해보았다. 그럼으로써 OCP, DIP원칙을 지키며 객체지향 프로그래밍 원칙인 SOLID도 지킬 수 있었다.
하지만, 아직 고려해야할 부분이 많다. 그 중 하나가 구성영역의 appConfig.class 코드쪽인데, 우리는 보통 스프링 애플리케이션을 웹용으로 사용한다. (웹이 아닌경우도 있지만 보편적으로)
그럼 이런 웹 어플리케이션은 동시에 얼마나 많은 사람이 사용할까? 어느정도 인기가 있어서 한 순간 오만명이상이 동시에 요청을 한다고 생각해보자.
그럼 스프링 컨테이너에서 서비스 계층으로 주입되어야 할 객체들은 몇 번 생성되야하는가? 한 서비스 계층당 하나의 빈들만 주입해야한다고해도 5만번 이상 객체가 생성되서 사용되고 참조가 해제되어 GC에 수집어 정리가 되는 과정을 거쳐야 한다. 이는 몹시 비효율적이고 메모리낭비이다.
게다가 해당 빈들은 굳이 사용자마자 다른 인자값을 가지는 인스턴스가 될 일도 없다. 모두 동일한 빈 사용을위해 서비스 호출때마다 새로운 빈들이 생성 - 삭제가 되어야 한다는 것이다.
확인 코드 작성
package hello.core.singleton;
import hello.core.AppConfig;
import hello.core.member.MemberService;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import static org.assertj.core.api.Assertions.assertThat;
public class SingleToneTest {
@Test
@DisplayName("스프링 없는 순수한 DI 컨테이너")
void pureContainer() {
AppConfig appConfig = new AppConfig();
//1. 조회: 호출할 때 마다 객체 생성
MemberService memberService1 = appConfig.memberService();
//2. 조회: 호출할 때 마다 객체 생성
MemberService memberService2 = appConfig.memberService();
//3. 참조값 확인
System.out.println("memberService1 = " + memberService1);
System.out.println("memberService2 = " + memberService2);
//memberService != memberService2
assertThat(memberService1).isNotSameAs(memberService2);
}
}
Java
복사
[실행 결과]
그렇기에 우리는 싱글톤 패턴을 사용해 하나의 객체를 재사용하는 식으로 이런 메모리낭비를 막아야한다.
싱글톤 패턴
싱글톤 패턴에대한 자세한 내용은 이전에 포스팅했던 아래 링크를 통해 확인할 수 있다.
이제 싱글톤구조의 서비스를 하나 만들어보자
package hello.core.singleton;
public class SingletonService {
private static final SingletonService instance = new SingletonService();
private SingletonService() {
}
public static SingletonService getInstance() {
return instance;
}
public void logic() {
System.out.println("called singleton");
}
}
Java
복사
•
기본 생성자를 private로 만들어서 외부에서 해당 서비스를 생성할 수 없도록 막아놨다.
•
프로젝트 구동시 최초 1회 생성되고 그 이후 어디서도 해당 서비스를 생성할 수 없다.
•
해당 서비스가 필요하면 getInstance() 메서드를 통해서 해당 서비스를 조회해서 사용할 수 있고, 이는 항상 같은 인스턴스를 반환한다.
그럼 이번에는 싱글톤 패턴으로 작성한 SingletonService를 테스트 코드를 통해 정말 동일한 인스턴스를 반환하는지 확인해보자.
@Test
@DisplayName("싱글톤 패턴을 적용한 객체 사용")
void singletonService() {
SingletonService instance1 = SingletonService.getInstance();
SingletonService instance2 = SingletonService.getInstance();
System.out.println("instance1 = " + instance1);
System.out.println("instance2 = " + instance2);
assertThat(instance1).isSameAs(instance2);
}
Java
복사
[실행 결과]
•
isSameAs는 동일성비교로 연산자 == 와 동일하며 isEqualTo가 동등비교로 equals연산자와 동일하다.
간단히 말해 동일비교는 참조값 비교, 동등비교는 내용물(값) 비교그럼 이제 내가 생성한 구성정보의 모든 빈들을 싱글톤으로 만들어야할까?
물론, 그렇지는 않다. 스프링 컨테이너를 쓰면 자체적으로 빈들을 싱글톤으로 만들어서 사용한다. 그렇기에 실제로 스프링 컨테이너를 사용할때는 스프링 빈들을 다 싱글톤으로 만들어줄 필요는 없다.
But
싱글톤 패턴은 많은 문제들을 가지고 있다.
•
싱글톤 패턴을 적용하기 위해 구현할 코드양이 많아지면서 비용이 늘어난다.
•
의존관계상 클라이언트가 구현체에 의존하면서 DIP를 위반하게 된다.
•
DIP를 위반하면 자연스럽게 OCP를 위반할 가능성도 높아진다.
•
테스트가 어려워진다.
⇒ 인스턴스를 미리 다 받아서 설정이 끝난 상태이기에 유연한 테스트가 힘들다.
•
내부 속성을 변경하거나 초기화가 어렵다.
•
private생성자로 자식 클래스를 만들기 어렵다.
•
유연성이 떨어진다.
•
안티패턴으로 불리기도 한다.
하지만, 스프링 컨테이너에서는 싱글톤의 이른 단점을 모두 제거하고 장점만 가지는 싱글톤을 사용한다.
이를 알아보자.
싱글톤 컨테이너
스프링 컨테이너는 스프링의 많은 단점들을 해결하면서 객체 인스턴스를 싱글톤으로 관리한다.
•
스프링 컨테이너는 싱글톤 패턴을 적용하지 않아도 싱글톤으로 객체들을 관리한다.
•
스프링 컨테이너는 싱글톤 컨테이너 역할을 한다. 이처럼 싱글톤 객체를 생성및 관리하는 기능을 싱글톤 레지스트리라 한다.
•
이렇게 스프링 컨테이너에서 싱글톤 컨테이너 역할을 해줌으로써 싱글톤 패턴의 단점을 없애고 객체의 단일성을 유지할 수 있다.
⇒ 그렇기에 각각의 빈들은 싱글톤 패턴 적용을 위한 코드를 작성할 필요가 없다.
⇒ 더하여 DIP, OCP, 테스트, private 생성자를 고민하지 않아도 된다.
스프링 컨테이너를 직접 호출해서 이런 내용들이 맞는지 확인해보자.
@Test
@DisplayName("스프링 컨테이너와 싱글톤")
void springContainer() {
ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);
MemberService memberService1 = ac.getBean("memberService", MemberService.class);
MemberService memberService2 = ac.getBean("memberService", MemberService.class);
//3. 참조값 확인
System.out.println("memberService1 = " + memberService1);
System.out.println("memberService2 = " + memberService2);
//memberService != memberService2
assertThat(memberService1).isSameAs(memberService2);
}
Java
복사
이처럼 싱글톤 컨테이너가 적용되면 많은 사용자가 각각 요청을 할 때마다 하나의 인스턴스를 공유해서 사용함으로써 효율적으로 재사용이 가능해진다.
•
물론 싱글톤 방식이 아닌 요청할 때마다 새로운 객체를 생성하는 것 역시 가능하다. 이는 빈 스코프챕터에서 설명한다.
싱글톤 방식의 주의점
싱글톤 컨테이너든, 싱글톤 패턴이든 싱글톤을 사용한다면 주의해야하는 부분이 있다.
싱글톤 패턴에서는 객체 인스턴스를 하나만 생성해서 공유하는 방식이기 때문에 여러 클라이언트에서 해당 인스턴스를 공유하게된다. 그렇기 때문에 해당 객체가 상태를 유지하는 stateful 방식의 객체이면 문제가 발생한다.
그렇기 때문에 상태를 유지하지 않는 stateless 상태로 객체를 설계해야 한다.
상태를 유지하지 않는 객체를 설계하기 위해서는
•
특정 클라이언트에 의존적인 필드가 있으면 안된다.
•
특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안된다.
•
가급적 읽기만 가능해야 한다.
•
필드 대신 자바에서 공유되지 않는, 지역변수, 파라미터, ThreadLocal등을 사용해야 한다.
이제 코드를 직접작성하면서 싱글톤 객체가 상태를 유지할 경우 어떤 문제가 발생하는지 알아보자.
•
StatefulService
package hello.core.singleton;
public class StatefulService {
private int price; // 상태를 유지하는 필드
public void order(String name, int price) {
System.out.println("name = " + name + " price = " + price);
this.price = price;
}
public int getPrice() {
return price;
}
}
Java
복사
•
StatefulServiceTest
package hello.core.singleton;
import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Bean;
import static org.assertj.core.api.Assertions.assertThat;
public class StatefulServiceTest {
@Test
void statefulServiceSingleton() {
ApplicationContext ac = new AnnotationConfigApplicationContext(TestConfig.class);
StatefulService statefulService1 = ac.getBean("statefulService", StatefulService.class);
StatefulService statefulService2 = ac.getBean("statefulService", StatefulService.class);
statefulService1.order("userA", 10000);
statefulService2.order("userB", 20000);
System.out.println("statefulService1.getPrice() = " + statefulService1.getPrice());
assertThat(statefulService1.getPrice()).isEqualTo(20000);
}
static class TestConfig{
@Bean
public StatefulService statefulService() {
return new StatefulService();
}
}
}
Java
복사
여기서 테스트 코드를 보면서 의문점이 생기지 않으면 안된다.
분명 10000원을 주만한 userA의 pirce를 조회하는데 어째서 값이 20000원일까?
이는 두 개의 객체 인스턴스인 statefulService1과 statefulService2가 같은 객체 인스턴스 StatefulService 객체를 바라보기 때문인데, statefulService1에서 userA가 10000원을 주문하면서 price에 10000원이 대입되었지만, 그 뒤 statefulService2에서 userB가 20000원을 주문했다. 그래서 price에는 20000원이 대입되는데 여기서 price 필드는 싱글톤으로 하나의 객체 인스턴스를 통해 공유되기 때문에 userA는 자신이 주문한 뒤 주문한 userB의 금액이 입력되는 것이다.
statefulService에서 공유필드 price가 오염되는 과정
그렇기에, 싱글톤을 사용할때는 해당 객체 인스턴스에 공유필드가 있어서는 안된다.
즉, 싱글톤을 사용하려면 상태가 없어야(stateless)한다.
@Configuration과 싱글톤
스프링 컨테이너는 즉 싱글톤 컨테이너 역할을해서 빈들을 하나만 생성해 관리한다고 했다.
그럼 이쯤에서 이전에 작성했던 구성영역 AppConfig의 소스코드를 다시 한 번 살펴보자
@Configuration
public class AppConfig {
@Bean
public MemberService memberService() {
return new MemberServiceImpl(memberRepository());
}
@Bean
public OrderService orderService() {
return new OrderServiceImpl(memberRepository(), discountPolicy());
}
@Bean
public MemberRepository memberRepository() {
return new MemoryMemberRepository();
}
@Bean
public DiscountPolicy discountPolicy() {
return new RateDiscountPolicy();
}
}
Java
복사
여기서 memberService와 orderService를 보자. 각각 자신의 구현체를 생성해서 반환하는데, 그 내부 파라미터를 보면 둘 다 memberRepository를 호출하고있다.
그런데, 여기서 memberRepository내부 코드는 MemoryMemberRepository 인스턴스를 생성해 반환하는 것이다. 그럼 memberService, orderService, memberRepository에서 총 세 번 내부 코드가 실행되는데, 싱글톤이 어떻게 유지되는지 의아할 것이다. 우리의 생각대로라면 해당 구성정보의 빈들이 등록되면 memberService와 orderService, memberRepository에서 꺼낸 각각의 memberRepository의 객체 참조주소가 달라야 한다. 이를 코드를 통해 바로 확인해보자.
MemberServiceImpl
OrderServiceImpl
ConfigurationSingletonTest
실행결과를 보면 세가지 빈의 memberRepository의 참조값이 모두 같은걸 알 수 있다.
코드상으로 memberRepository가 3번 호출되면 MemoryMemberRepository 객체 인스턴스는 세개가 생겨야 맞는데 어째서 모두가 동일한 것인가?
이를 확인하기위해 AppConfig에 로깅 코드를 넣어서 확인해보자.
AppConfig
출력 결과를 확인해보면
우리의 예상과는 다르게 memberRepository 메서드는 단 한번만 호출되었다. 어째서 그럴까?
@Configuration과 바이트코드 조작의 마법
이 의문점에 대한 정답은 @Configuration 어노테이션에 있다.
다음 테스트를 실행해보면서 @Configuration 어노테이션을 적용한 AppConfig.class의 클래스타입을 확인해보자.
public class ConfigurationSingletonTest {
@Test
void configurationDeep() {
ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);
AppConfig bean = ac.getBean(AppConfig.class);
System.out.println("bean = " + bean.getClass());
}
}
Java
복사
위 코드를 실행했을때 나오는 결과는 우리의 생각에는 무엇일까?
우리가 만든 AppConfig.class 라면 hello.core.AppConfig 가 나와야 정상이다. 하지만, 실행결과는
AppConfig뒤에 접미사가 많이 붙어있다. 왜이런걸까? 이유는 스프링에서 CGLIB 라는 바이트코드 조작 라이브러리를 사용해서 AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들고, 그 다른 클래스를 스프링 빈으로 등록했기 때문이다. (바이트 코드 조작에 대해 더 알고싶다면 이 글을 참고하자.)
이렇게 바이트코드 조작을 통해 만들어진 AppConfig@CGLIB에서 싱글톤이 보장되도록 해준다. 그러면서도 해당 객체는 AppConfig의 자식 타입으로 만들어져 AppConfig타입으로 조회가 가능하다.
내부 로직은 아마도 스프링 빈이 없으면 기존 클래스의 생성로직을 수행하고, 스프링 빈이 있을 경우 존재하는 스프링 빈을 반환하도록 로직이 되어있을 것이다.
그렇다면 @Configuration을 적용하지 않고 @Bean만 적용한다면?
AppConfig에서 @Configuration 어노테이션을 뺀 상태로 실행을 해보자.
그럼 실행결과는 다음과 같이 나온다.
내가 만들었던 AppConfig가 그대로 출력된다.
그럼 이제 다시 memberRepositor의 참조주소값이 어떻게 바뀌는지 확인해보자. 위에서 작성한 코드
를 실행해보면 이런 실행결과가 나온다.
memberRepository는 3번 호출되었고 각각의 서비스에 등록된 memberRepository의 참조주소값이 모두 다르다. 그렇기에 테스트는 실패하고 각각 모두 다른 MemoryMemberRepository인스턴스를 갖게된다.
즉 @Bean 으로만 등록해도 스프링 빈으로 등록은 되지만 스프링은 보장되지 않기에, 스프링 설정정보는 항상 @Configuration을 사용하도록 하자.
