싱글톤 컨테이너

웹 애플리케이션과 싱글톤

<aside> ✨ 싱글톤? 객체가 하나만 있어야 하는 패턴

싱글톤 패턴은 객체 지향 프로그래밍에서 특정 클래스가 단 하나만의 인스턴스를 생성하여 사용하기 위한 패턴이다. 생성자를 여러 번 호출하더라도 인스턴스가 하나만 존재하도록 보장하여 애플리케이션에서 동일한 객체 인스턴스에 접근할 수 있도록 한다.

싱글톤 패턴을 사용하는 이유 커넥션 풀, 스레드 풀, 디바이스 설정 객체 등과 같은 경우 인스턴스를 여러 개 만들게 되면 불필요한 자원을 사용하게 되고, 프로그램이 예상치 못한 결과를 낳을 수 있다. 따라서 객체를 필요할 때마다 생성하는 것이 아닌 단 한 번만 생성하여 전역에서 이를 공유하고 사용할 수 있게 하기 위해 싱글톤 패턴을 사용한다.

장점 유일한 인스턴스 : 싱글톤 패턴이 적용된 클래스의 인스턴스는 애플리케이션 전역에서 단 하나만 존재하도록 보장한다. 이는 객체의 일관된 상태를 유지하고 전역에서 접근 가능하도록 한다. 메모리 절약 : 인스턴스가 단 하나뿐이므로 메모리를 절약할 수 있다. 생성자를 여러 번 호출하더라도 새로운 인스턴스를 생성하지 않아 메모리 점유 및 해제에 대한 오버헤드를 줄인다. 지연 초기화 : 인스턴스가 실제로 사용되는 시점에 생성하여 초기 비용을 줄일 수 있다.

단점 결합도 증가 : 싱글톤 패턴은 전역에서 접근을 허용하기 때문에 해당 인스턴스에 의존하는 경우 결합도가 증가할 수 있다. 테스트 복잡성 : 싱글톤 패턴은 단 하나의 인스턴스만을 생성하고 자원을 공유하기 때문에 싱글톤 클래스를 의존하는 클래스는 결합도 증가로 인해 테스트가 어려울 수 있다. 상태 관리의 어려움 : 만약, 싱글톤 클래스가 상태를 가지고 있는 경우 전역에서 사용되어 변경될 수 있다. 이로 인해 예상치 못한 동작이 발생할 수 있다. 전역에서 접근 가능 : 애플리케이션 내 어디서든 접근이 가능한 경우, 무분별한 사용을 막기 힘들다. 이로 인해 변경에 대한 복잡성이 증가할 수 있다.

[IT is True:티스토리]

</aside>

스프링은 태생이 기업용 온라인 서비스 기술을 지원하기 위해 탄생하였다. 대부분의 스프링 애플리케이션은 웹 애플리케이션이다. (물론 다른 개발도 얼마든지 가능) 웹 애플리케이션은 보통 여러 고객이 동시에 요청을 한다.

아래 그림처럼!!

동시에 요청이 오는 경우, (우리가 이전에 만들었던 AppConfig의 )DI 컨테이너는 요청이 올때마다 새로운 객체를 생성하게 된다.

그렇다면 어떠한 문제가 생길까?

웹 애플리케이션은 고객이 계속 요청을 하는 애플리케이션이다. 따라서 요청이 올때마다 객체를 만드는 것이 문제라고 할 수 있다.

스프링이 없는 순수한 DI 컨테이너를 한번 만들어서 테스트를 해보자.

두 개의 memberService 를 요청한 뒤, 참조 값을 확인 해보면

memberService1: hello.core.member.MemberServiceImpl@123f1134
memberService2: hello.core.member.MemberServiceImpl@7d68ef40

참조값이 다르다. 글면 jvm 메모리에 계속 생성된 객체가 올라갈 거다.

자, 정리해보면

• 우리가 만든 스프링 없는 순수한 DI 컨테이너인 AppConfig는 요청을 할 때마다 객체를 새로 생성한다.
• 고객 트래픽이 초당 100이 나오면 초당 100개 객체가 생성되고 소멸된다! → 메모리 낭비 심함
• 해결방안은 해당 객체가 딱 1개만 생성되고, 공유하도록 설계하면 된다. → 싱글톤 패턴

싱글톤 패턴

• 클래스의 인스턴스가 딱 1개만 생성되는 것을 보장하는 디자인 패턴이다.
• 그래서 객체 인스턴스를 2개 이상 생성하지 못하도록 막아야 한다.
  • private 생성자를 사용해서 외부에서 임의로 new 키워드를 사용하지 못하도록 막아야 한다.

<aside> ✨ static: 클래스에 고정되어 있는 변수나 메서드

1. 메모리에 고정적으로 할당됨
2. 객체 생성 없이 사용할 수 있음
3. 프로그램이 시작되면 메모리의 static영역에 적재되고, 프로그램이 종료될 때 해제됨
4. Static 메서드 내에서는 인스턴스 변수를 사용할 수 없음

</aside>

package hello.core.singleton;

public class SingletonService {

    private static final SingletonService instance = new SingletonService();
    
    public static SingletonService getInstance() {
        return instance;
    }
}

자바를 실행하면 SingletonService의 static 영역을 내부적으로 실행하여

객체(자기자신)를 생성한 다음, instance에 참조를 넣어놓는다.

package hello.core.singleton;

public class SingletonService {

    // 1. static 영역에 객체를 딱 1개만 생성해둔다.
    private static final SingletonService instance = new SingletonService();

    // 2. public으로 열어서 객체 인스턴스가 필요하면 이 static 메서드를 통해서만 조회하도록 허용한다.
    public static SingletonService getInstance() {
        return instance;
    }

    // 3. 생성자를 private 으로 선언해서 외부에서 new 키워드를 사용한 객체 생성을 못하게 막는다.
    private SingletonService() {}

    public void logic() {
        System.out.println("싱글톤 객체 로직 호출");
    }
}

간단하게 설명해보면

1. static 영역에 객체 instance 를 미리 하나 생성해서 올려둔다.
2. 이 객체 인스턴스가 필요하면 오직 getInstance()메서드를 통해서만 조회할 수 있다. 그리고 이 메서드를 호출하면 항상 같은 인스턴스를 반환한다.
3. 딱 1개의 객체 인스턴스만 존재해야 하므로, 생성자를 private 으로 막아서 혹시라도 외부에서 new 키워드로 객체 인스턴스가 생성되는 것을 막는다.

singletonService1: hello.core.singleton.SingletonService@105fece7
singletonService2: hello.core.singleton.SingletonService@105fece7

참조값이 같은 것을 확인할 수 있음

그러면 이제 appconfig로 가서 싱글톤 패턴으로 다 바꿔줘야 하냐????

아니다. 스프링 컨테이너를 쓰면 기본적으로 객체를 다 싱글톤으로 만들어서 관리해준다.

<aside> ✨ 싱글톤 패턴을 구현하는 방법에는 여러가지가 있다. 한 번 찾아봐라 https://readystory.tistory.com/116

</aside>

싱글톤 패턴의 문제점

• 싱글톤 패턴을 구현하는 코드 자체가 많이 들어간다.
• 의존관계상 클라이언트가 구체 클래스에 의존한다.(DIP 위반)
• 클라이언트가 구체 클래스에 의존해서 OCP를 위반한 가능성이 🆙
• 유연하게 테스트하기 어려움(인스턴스를 미리 박아서 설정하기 때문에)
• 내부 속성을 변경하거나 초기화하기 어려움(인스턴스를 미리 박아서 설정하기 때문에)
• private 생성자로 자식 클래스를 만들기 어려움
• 결론적으로 유연성이 떨어짐
• 안티패턴으로도 불림

근데 스프링프레임워크는 이 문제점을 전부 해결함. 다음시간부터 알아보자.

싱글톤 컨테이너

스프링 컨테이너는 싱글톤 패턴의 문제점을 해결하면서, 객체 인스턴스를 싱글톤(1개만 생성)으로 관리한다. 지금까지 우리가 학습한 스프링 빈이 바로 싱글톤으로 관리되는 빈이다.

• 스프링 컨테이너는 싱글톤 패턴을 적용하지 않아도, 객체 인스턴스를 싱글톤으로 관리한다.
• 스프링 컨테이너는 싱글톤 컨테이너 역할을 한다. 이렇게 싱글톤 객체를 생성하고 관리하는 기능을 싱글톤 레지스트리라고 한다.
• 스프링 컨테이너의 이런 기능 덕분에 싱글톤 패턴의 모든 단점을 해결하면서 객체를 싱글톤으로 유지할 수 있다.

바로 테스트를 해보자.

고객이 요청할때마다 객체를 생성하는 것이 아닌, 이미 만들어진 객체를 공유하여 효율적으로 재사용할 수 있다.

싱글톤 방식의 주의점

싱글톤 패턴이든, 스프링 같은 싱글톤 컨테이너를 사용하든, 객체 인스턴스를 하나만 생성해서 공유하는 싱글톤 방식은 여러 클라이언트가 하나의 같은 객체 인스턴스를 공유하기 때문에 싱글톤 객체는 상태를 유지하게 설계하면 안된다.

즉, 무상태로 설계해야 한다

• 특정 클라이언트에 의존적인 필드가 있으면 안된다.
• 특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안된다.
• 가급적 읽기만 가능해야 한다.
• 필드 대신에 자바에서 공유되지 않는, 지역변수, 파라미터, ThreadLocal 등을 사용해야 한다.

잘못된 예시를 들어보자.

package hello.core.singleton;

import org.junit.jupiter.api.Test;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Bean;

import static org.junit.jupiter.api.Assertions.*;

class StatefulServiceTest {

    @Test
    void statefulServiceSingleton() {
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(TestConfig.class);
        StatefulService statefulService1 = ac.getBean(StatefulService.class);
        StatefulService statefulService2 = ac.getBean(StatefulService.class);

        // ThreadA: A사용자 10000원 주문
        statefulService1.order("userA",10000);
        // ThreadB: B 사용자 20000원 주문
        statefulService2.order("userB",20000);

        // ThreadA: 사용자 A 주문 금액 조회
        int price = statefulService1.getPrice();
        System.out.println("price: " + price);
    }

    static class TestConfig {

        @Bean
        public StatefulService statefulService() {
            return new StatefulService();
        }
    }
}

여기서 테스트를 했을 때 우리가 기대하는건 price가 사용자 A의 가격에 맞게 10000이 나와야하는데 실제 테스트를 해보면 20000이 나온다.

인스턴스가 같기 때문에..

스프링 빈은 꼭 무상태를 유지한다는 것을 기억하자!!!!!

@Configuration과 싱글톤

@configuration은 사실 싱글톤을 위해 존재한다.

이 역할을 알아보기 위해 appconfig로 가보면

package hello.core;

import hello.core.discount.DiscountPolicy;
import hello.core.discount.RateDiscountPolicy;
import hello.core.member.MemberRepository;
import hello.core.member.MemberService;
import hello.core.member.MemberServiceImpl;
import hello.core.member.MemoryMemberRepository;
import hello.core.order.OrderService;
import hello.core.order.OrderServiceImpl;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class AppConfig {

    //@Bean memberService -> new MemoryMemberRepository()
    //@Bean orderService ->  new MemoryMemberRepository()
    @Bean
    public MemberService memberService() {
        return new MemberServiceImpl(memberRepository());
    }

    @Bean
    public MemberRepository memberRepository() {
        return new MemoryMemberRepository();
    }

    @Bean
    public OrderService orderService() {
        return new OrderServiceImpl(memberRepository(), discountPolicy());
    }

    @Bean
    public DiscountPolicy discountPolicy() {
        return new RateDiscountPolicy();
    }
}

여기서 MemberService 랑 OrderService 만 호출해도 MemoryMemberRepository가 두번 호출된다. 그렇다면 싱글톤이 깨지는 것처럼 보인다. 스프링 컨테이너는 이 문제를 어떻게 해결하는 걸까????? 직접 테스트를 해보자.

package hello.core.singleton;

import hello.core.AppConfig;
import hello.core.member.MemberRepository;
import hello.core.member.MemberService;
import hello.core.member.MemberServiceImpl;
import hello.core.order.OrderServiceImpl;
import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

public class ConfigurationSingletonTest {
    
    @Test
    void configurationTest() {
        ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);

        MemberServiceImpl memberService = ac.getBean("memberService", MemberServiceImpl.class);
        OrderServiceImpl orderService = ac.getBean("orderService", OrderServiceImpl.class);
        MemberRepository memberRepository = ac.getBean("memberRepository", MemberRepository.class);

        MemberRepository memberRepository1 = memberService.getMemberRepository();
        MemberRepository memberRepository2 = orderService.getMemberRepository();

        System.out.println("memberService -> memberRepository: " + memberRepository1);
        System.out.println("orderService -> memberRepository: " + memberRepository2);
        System.out.println("memberRepository: " + memberRepository);
    }
    
}

이 테스트를 수행하면 3개의 스프링빈 다 같은 인스턴스가 조회된다.

즉, MemberRepository 인스턴스는 모두 같은 인스턴스가 공유되어 사용된다.

Appconfig의 자바코드를 보면 분명히 각각 2번 new MemoryMemberRepository를 호출해서 다른 인스턴스가 생성되어야 하는디? 왜일까?

실험을 통해 확인해본다.

스프링 컨테이너가 각각 bean호출해서 스프링 빈을 생성한다. 그래서 memberRepository()는 다음과 같이 총 3번 호출되어야 하는 것이 아닐까?

1. 스프링 컨테이너가 스프링 빈에 등록하기위해 bean이 붙어있는 memberRepository()호출
2. memberService()로직에서 memberRepository()호출
3. orderService()로직에서 memberRepository() 호출

그런데 출력결과는 모두 1번만 호출된다.

@Configuration과 바이트 코드 조작의 마법

스프링 컨테이너는 싱글톤 레지스트리이다. 따라서 스프링 빈이 싱글톤이 되도록 보장해주어야 한다. 그런데 스프링이 자바 코드까지 어떻게 하기는 어렵다. 저 자바코드를 보면 분명 3번 호출되어야 하는 것이 맞다.

그래서 스프링은 클래스의 바이트코드를 조작하는 라이브러리를 사용한다.

모든 비밀은 @Configuration을 적용한 Appconfig에 있다.

Appconfig의 스프링빈을 조회해서 클래스정보를 출력해보면

bean: class hello.core.AppConfig$$SpringCGLIB$$0

기대했던 class hello.core.AppConfig가 아니라 뒤에 뭐가 더 붙은 것을 볼 수 있다. 이것은 스프링이 CGLIB이라는 바이트코드 조작 라이브러리를 사용해서 AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들고, 그 다른 클래스를 스프링 빈으로 등록한 것이다!

따라서 내가 만든 객체가 아닌 임의의 다른 클래스가 싱글톤이 되도록 보장해준다.

로직을 간단하게 얘기해보면

MemoryMemberRepository가 이미 스프링 컨테이너에 등록되어 있으면, 스프링컨테이너에서 찾아서 반환하고,

스프링 컨테니어네 없으면 기존 로직을 호출해서 MemoryMemberrepository를 생성하고 스프링 컨테이너에 등록한다.

만약에 골뱅이configuration을 안 붙이고 골뱅이bean만 붙이면 어떻게 될까?

안 붙여도 스프링 컨테이너에 스프링 빈으로 알아서 등록된다. 근데 문제는 순수한 자바코드가 돌기 때문에 싱글톤이 깨지게 된다.

문제를 해결하는 방법에 뒤에서 배울건데 골뱅이autowired쓰는 것도 있다.

참고용

https://refactoring.guru/ko/design-patterns/catalog

📢해당 글은 김영한님의 스프링 핵심 원리 강좌를 기반으로 작성되었습니다.

웹 애플리케이션과 싱글톤

<aside> ✨ 싱글톤? 객체가 하나만 있어야 하는 패턴

싱글톤 패턴은 객체 지향 프로그래밍에서 특정 클래스가 단 하나만의 인스턴스를 생성하여 사용하기 위한 패턴이다. 생성자를 여러 번 호출하더라도 인스턴스가 하나만 존재하도록 보장하여 애플리케이션에서 동일한 객체 인스턴스에 접근할 수 있도록 한다.

싱글톤 패턴을 사용하는 이유 커넥션 풀, 스레드 풀, 디바이스 설정 객체 등과 같은 경우 인스턴스를 여러 개 만들게 되면 불필요한 자원을 사용하게 되고, 프로그램이 예상치 못한 결과를 낳을 수 있다. 따라서 객체를 필요할 때마다 생성하는 것이 아닌 단 한 번만 생성하여 전역에서 이를 공유하고 사용할 수 있게 하기 위해 싱글톤 패턴을 사용한다.

장점 유일한 인스턴스 : 싱글톤 패턴이 적용된 클래스의 인스턴스는 애플리케이션 전역에서 단 하나만 존재하도록 보장한다. 이는 객체의 일관된 상태를 유지하고 전역에서 접근 가능하도록 한다. 메모리 절약 : 인스턴스가 단 하나뿐이므로 메모리를 절약할 수 있다. 생성자를 여러 번 호출하더라도 새로운 인스턴스를 생성하지 않아 메모리 점유 및 해제에 대한 오버헤드를 줄인다. 지연 초기화 : 인스턴스가 실제로 사용되는 시점에 생성하여 초기 비용을 줄일 수 있다.

단점 결합도 증가 : 싱글톤 패턴은 전역에서 접근을 허용하기 때문에 해당 인스턴스에 의존하는 경우 결합도가 증가할 수 있다. 테스트 복잡성 : 싱글톤 패턴은 단 하나의 인스턴스만을 생성하고 자원을 공유하기 때문에 싱글톤 클래스를 의존하는 클래스는 결합도 증가로 인해 테스트가 어려울 수 있다. 상태 관리의 어려움 : 만약, 싱글톤 클래스가 상태를 가지고 있는 경우 전역에서 사용되어 변경될 수 있다. 이로 인해 예상치 못한 동작이 발생할 수 있다. 전역에서 접근 가능 : 애플리케이션 내 어디서든 접근이 가능한 경우, 무분별한 사용을 막기 힘들다. 이로 인해 변경에 대한 복잡성이 증가할 수 있다.

[IT is True:티스토리]

</aside>

스프링은 태생이 기업용 온라인 서비스 기술을 지원하기 위해 탄생하였다. 대부분의 스프링 애플리케이션은 웹 애플리케이션이다. (물론 다른 개발도 얼마든지 가능) 웹 애플리케이션은 보통 여러 고객이 동시에 요청을 한다.

아래 그림처럼!!

동시에 요청이 오는 경우, (우리가 이전에 만들었던 AppConfig의 )DI 컨테이너는 요청이 올때마다 새로운 객체를 생성하게 된다.

그렇다면 어떠한 문제가 생길까?

웹 애플리케이션은 고객이 계속 요청을 하는 애플리케이션이다. 따라서 요청이 올때마다 객체를 만드는 것이 문제라고 할 수 있다.

스프링이 없는 순수한 DI 컨테이너를 한번 만들어서 테스트를 해보자.

두 개의 memberService 를 요청한 뒤, 참조 값을 확인 해보면

memberService1: hello.core.member.MemberServiceImpl@123f1134
memberService2: hello.core.member.MemberServiceImpl@7d68ef40

참조값이 다르다. 글면 jvm 메모리에 계속 생성된 객체가 올라갈 거다.

자, 정리해보면

• 우리가 만든 스프링 없는 순수한 DI 컨테이너인 AppConfig는 요청을 할 때마다 객체를 새로 생성한다.
• 고객 트래픽이 초당 100이 나오면 초당 100개 객체가 생성되고 소멸된다! → 메모리 낭비 심함
• 해결방안은 해당 객체가 딱 1개만 생성되고, 공유하도록 설계하면 된다. → 싱글톤 패턴

싱글톤 패턴

• 클래스의 인스턴스가 딱 1개만 생성되는 것을 보장하는 디자인 패턴이다.
• 그래서 객체 인스턴스를 2개 이상 생성하지 못하도록 막아야 한다.
  • private 생성자를 사용해서 외부에서 임의로 new 키워드를 사용하지 못하도록 막아야 한다.

<aside> ✨ static: 클래스에 고정되어 있는 변수나 메서드

1. 메모리에 고정적으로 할당됨
2. 객체 생성 없이 사용할 수 있음
3. 프로그램이 시작되면 메모리의 static영역에 적재되고, 프로그램이 종료될 때 해제됨
4. Static 메서드 내에서는 인스턴스 변수를 사용할 수 없음

</aside>

package hello.core.singleton;

public class SingletonService {

    private static final SingletonService instance = new SingletonService();
    
    public static SingletonService getInstance() {
        return instance;
    }
}

자바를 실행하면 SingletonService의 static 영역을 내부적으로 실행하여

객체(자기자신)를 생성한 다음, instance에 참조를 넣어놓는다.

package hello.core.singleton;

public class SingletonService {

    // 1. static 영역에 객체를 딱 1개만 생성해둔다.
    private static final SingletonService instance = new SingletonService();

    // 2. public으로 열어서 객체 인스턴스가 필요하면 이 static 메서드를 통해서만 조회하도록 허용한다.
    public static SingletonService getInstance() {
        return instance;
    }

    // 3. 생성자를 private 으로 선언해서 외부에서 new 키워드를 사용한 객체 생성을 못하게 막는다.
    private SingletonService() {}

    public void logic() {
        System.out.println("싱글톤 객체 로직 호출");
    }
}

간단하게 설명해보면

1. static 영역에 객체 instance 를 미리 하나 생성해서 올려둔다.
2. 이 객체 인스턴스가 필요하면 오직 getInstance()메서드를 통해서만 조회할 수 있다. 그리고 이 메서드를 호출하면 항상 같은 인스턴스를 반환한다.
3. 딱 1개의 객체 인스턴스만 존재해야 하므로, 생성자를 private 으로 막아서 혹시라도 외부에서 new 키워드로 객체 인스턴스가 생성되는 것을 막는다.

singletonService1: hello.core.singleton.SingletonService@105fece7
singletonService2: hello.core.singleton.SingletonService@105fece7

참조값이 같은 것을 확인할 수 있음

그러면 이제 appconfig로 가서 싱글톤 패턴으로 다 바꿔줘야 하냐????

아니다. 스프링 컨테이너를 쓰면 기본적으로 객체를 다 싱글톤으로 만들어서 관리해준다.

<aside> ✨ 싱글톤 패턴을 구현하는 방법에는 여러가지가 있다. 한 번 찾아봐라 https://readystory.tistory.com/116

</aside>

싱글톤 패턴의 문제점

• 싱글톤 패턴을 구현하는 코드 자체가 많이 들어간다.
• 의존관계상 클라이언트가 구체 클래스에 의존한다.(DIP 위반)
• 클라이언트가 구체 클래스에 의존해서 OCP를 위반한 가능성이 🆙
• 유연하게 테스트하기 어려움(인스턴스를 미리 박아서 설정하기 때문에)
• 내부 속성을 변경하거나 초기화하기 어려움(인스턴스를 미리 박아서 설정하기 때문에)
• private 생성자로 자식 클래스를 만들기 어려움
• 결론적으로 유연성이 떨어짐
• 안티패턴으로도 불림

근데 스프링프레임워크는 이 문제점을 전부 해결함. 다음시간부터 알아보자.

싱글톤 컨테이너

스프링 컨테이너는 싱글톤 패턴의 문제점을 해결하면서, 객체 인스턴스를 싱글톤(1개만 생성)으로 관리한다. 지금까지 우리가 학습한 스프링 빈이 바로 싱글톤으로 관리되는 빈이다.

• 스프링 컨테이너는 싱글톤 패턴을 적용하지 않아도, 객체 인스턴스를 싱글톤으로 관리한다.
• 스프링 컨테이너는 싱글톤 컨테이너 역할을 한다. 이렇게 싱글톤 객체를 생성하고 관리하는 기능을 싱글톤 레지스트리라고 한다.
• 스프링 컨테이너의 이런 기능 덕분에 싱글톤 패턴의 모든 단점을 해결하면서 객체를 싱글톤으로 유지할 수 있다.

바로 테스트를 해보자.

고객이 요청할때마다 객체를 생성하는 것이 아닌, 이미 만들어진 객체를 공유하여 효율적으로 재사용할 수 있다.

싱글톤 방식의 주의점

싱글톤 패턴이든, 스프링 같은 싱글톤 컨테이너를 사용하든, 객체 인스턴스를 하나만 생성해서 공유하는 싱글톤 방식은 여러 클라이언트가 하나의 같은 객체 인스턴스를 공유하기 때문에 싱글톤 객체는 상태를 유지하게 설계하면 안된다.

즉, 무상태로 설계해야 한다

• 특정 클라이언트에 의존적인 필드가 있으면 안된다.
• 특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안된다.
• 가급적 읽기만 가능해야 한다.
• 필드 대신에 자바에서 공유되지 않는, 지역변수, 파라미터, ThreadLocal 등을 사용해야 한다.

잘못된 예시를 들어보자.

package hello.core.singleton;

import org.junit.jupiter.api.Test;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Bean;

import static org.junit.jupiter.api.Assertions.*;

class StatefulServiceTest {

    @Test
    void statefulServiceSingleton() {
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(TestConfig.class);
        StatefulService statefulService1 = ac.getBean(StatefulService.class);
        StatefulService statefulService2 = ac.getBean(StatefulService.class);

        // ThreadA: A사용자 10000원 주문
        statefulService1.order("userA",10000);
        // ThreadB: B 사용자 20000원 주문
        statefulService2.order("userB",20000);

        // ThreadA: 사용자 A 주문 금액 조회
        int price = statefulService1.getPrice();
        System.out.println("price: " + price);
    }

    static class TestConfig {

        @Bean
        public StatefulService statefulService() {
            return new StatefulService();
        }
    }
}

여기서 테스트를 했을 때 우리가 기대하는건 price가 사용자 A의 가격에 맞게 10000이 나와야하는데 실제 테스트를 해보면 20000이 나온다.

인스턴스가 같기 때문에..

스프링 빈은 꼭 무상태를 유지한다는 것을 기억하자!!!!!

@Configuration과 싱글톤

@configuration은 사실 싱글톤을 위해 존재한다.

이 역할을 알아보기 위해 appconfig로 가보면

package hello.core;

import hello.core.discount.DiscountPolicy;
import hello.core.discount.RateDiscountPolicy;
import hello.core.member.MemberRepository;
import hello.core.member.MemberService;
import hello.core.member.MemberServiceImpl;
import hello.core.member.MemoryMemberRepository;
import hello.core.order.OrderService;
import hello.core.order.OrderServiceImpl;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class AppConfig {

    //@Bean memberService -> new MemoryMemberRepository()
    //@Bean orderService ->  new MemoryMemberRepository()
    @Bean
    public MemberService memberService() {
        return new MemberServiceImpl(memberRepository());
    }

    @Bean
    public MemberRepository memberRepository() {
        return new MemoryMemberRepository();
    }

    @Bean
    public OrderService orderService() {
        return new OrderServiceImpl(memberRepository(), discountPolicy());
    }

    @Bean
    public DiscountPolicy discountPolicy() {
        return new RateDiscountPolicy();
    }
}

여기서 MemberService 랑 OrderService 만 호출해도 MemoryMemberRepository가 두번 호출된다. 그렇다면 싱글톤이 깨지는 것처럼 보인다. 스프링 컨테이너는 이 문제를 어떻게 해결하는 걸까????? 직접 테스트를 해보자.

package hello.core.singleton;

import hello.core.AppConfig;
import hello.core.member.MemberRepository;
import hello.core.member.MemberService;
import hello.core.member.MemberServiceImpl;
import hello.core.order.OrderServiceImpl;
import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

public class ConfigurationSingletonTest {
    
    @Test
    void configurationTest() {
        ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);

        MemberServiceImpl memberService = ac.getBean("memberService", MemberServiceImpl.class);
        OrderServiceImpl orderService = ac.getBean("orderService", OrderServiceImpl.class);
        MemberRepository memberRepository = ac.getBean("memberRepository", MemberRepository.class);

        MemberRepository memberRepository1 = memberService.getMemberRepository();
        MemberRepository memberRepository2 = orderService.getMemberRepository();

        System.out.println("memberService -> memberRepository: " + memberRepository1);
        System.out.println("orderService -> memberRepository: " + memberRepository2);
        System.out.println("memberRepository: " + memberRepository);
    }
    
}

이 테스트를 수행하면 3개의 스프링빈 다 같은 인스턴스가 조회된다.

즉, MemberRepository 인스턴스는 모두 같은 인스턴스가 공유되어 사용된다.

Appconfig의 자바코드를 보면 분명히 각각 2번 new MemoryMemberRepository를 호출해서 다른 인스턴스가 생성되어야 하는디? 왜일까?

실험을 통해 확인해본다.

스프링 컨테이너가 각각 bean호출해서 스프링 빈을 생성한다. 그래서 memberRepository()는 다음과 같이 총 3번 호출되어야 하는 것이 아닐까?

1. 스프링 컨테이너가 스프링 빈에 등록하기위해 bean이 붙어있는 memberRepository()호출
2. memberService()로직에서 memberRepository()호출
3. orderService()로직에서 memberRepository() 호출

그런데 출력결과는 모두 1번만 호출된다.

@Configuration과 바이트 코드 조작의 마법

스프링 컨테이너는 싱글톤 레지스트리이다. 따라서 스프링 빈이 싱글톤이 되도록 보장해주어야 한다. 그런데 스프링이 자바 코드까지 어떻게 하기는 어렵다. 저 자바코드를 보면 분명 3번 호출되어야 하는 것이 맞다.

그래서 스프링은 클래스의 바이트코드를 조작하는 라이브러리를 사용한다.

모든 비밀은 @Configuration을 적용한 Appconfig에 있다.

Appconfig의 스프링빈을 조회해서 클래스정보를 출력해보면

bean: class hello.core.AppConfig$$SpringCGLIB$$0

기대했던 class hello.core.AppConfig가 아니라 뒤에 뭐가 더 붙은 것을 볼 수 있다. 이것은 스프링이 CGLIB이라는 바이트코드 조작 라이브러리를 사용해서 AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들고, 그 다른 클래스를 스프링 빈으로 등록한 것이다!

따라서 내가 만든 객체가 아닌 임의의 다른 클래스가 싱글톤이 되도록 보장해준다.

로직을 간단하게 얘기해보면

MemoryMemberRepository가 이미 스프링 컨테이너에 등록되어 있으면, 스프링컨테이너에서 찾아서 반환하고,

스프링 컨테니어네 없으면 기존 로직을 호출해서 MemoryMemberrepository를 생성하고 스프링 컨테이너에 등록한다.

만약에 골뱅이configuration을 안 붙이고 골뱅이bean만 붙이면 어떻게 될까?

안 붙여도 스프링 컨테이너에 스프링 빈으로 알아서 등록된다. 근데 문제는 순수한 자바코드가 돌기 때문에 싱글톤이 깨지게 된다.

문제를 해결하는 방법에 뒤에서 배울건데 골뱅이autowired쓰는 것도 있다.

참고용

https://refactoring.guru/ko/design-patterns/catalog

📢해당 글은 김영한님의 스프링 핵심 원리 강좌를 기반으로 작성되었습니다.

웹 애플리케이션과 싱글톤

<aside> ✨ 싱글톤? 객체가 하나만 있어야 하는 패턴

싱글톤 패턴은 객체 지향 프로그래밍에서 특정 클래스가 단 하나만의 인스턴스를 생성하여 사용하기 위한 패턴이다. 생성자를 여러 번 호출하더라도 인스턴스가 하나만 존재하도록 보장하여 애플리케이션에서 동일한 객체 인스턴스에 접근할 수 있도록 한다.

싱글톤 패턴을 사용하는 이유 커넥션 풀, 스레드 풀, 디바이스 설정 객체 등과 같은 경우 인스턴스를 여러 개 만들게 되면 불필요한 자원을 사용하게 되고, 프로그램이 예상치 못한 결과를 낳을 수 있다. 따라서 객체를 필요할 때마다 생성하는 것이 아닌 단 한 번만 생성하여 전역에서 이를 공유하고 사용할 수 있게 하기 위해 싱글톤 패턴을 사용한다.

장점 유일한 인스턴스 : 싱글톤 패턴이 적용된 클래스의 인스턴스는 애플리케이션 전역에서 단 하나만 존재하도록 보장한다. 이는 객체의 일관된 상태를 유지하고 전역에서 접근 가능하도록 한다. 메모리 절약 : 인스턴스가 단 하나뿐이므로 메모리를 절약할 수 있다. 생성자를 여러 번 호출하더라도 새로운 인스턴스를 생성하지 않아 메모리 점유 및 해제에 대한 오버헤드를 줄인다. 지연 초기화 : 인스턴스가 실제로 사용되는 시점에 생성하여 초기 비용을 줄일 수 있다.

단점 결합도 증가 : 싱글톤 패턴은 전역에서 접근을 허용하기 때문에 해당 인스턴스에 의존하는 경우 결합도가 증가할 수 있다. 테스트 복잡성 : 싱글톤 패턴은 단 하나의 인스턴스만을 생성하고 자원을 공유하기 때문에 싱글톤 클래스를 의존하는 클래스는 결합도 증가로 인해 테스트가 어려울 수 있다. 상태 관리의 어려움 : 만약, 싱글톤 클래스가 상태를 가지고 있는 경우 전역에서 사용되어 변경될 수 있다. 이로 인해 예상치 못한 동작이 발생할 수 있다. 전역에서 접근 가능 : 애플리케이션 내 어디서든 접근이 가능한 경우, 무분별한 사용을 막기 힘들다. 이로 인해 변경에 대한 복잡성이 증가할 수 있다.

[IT is True:티스토리]

</aside>

스프링은 태생이 기업용 온라인 서비스 기술을 지원하기 위해 탄생하였다. 대부분의 스프링 애플리케이션은 웹 애플리케이션이다. (물론 다른 개발도 얼마든지 가능) 웹 애플리케이션은 보통 여러 고객이 동시에 요청을 한다.

아래 그림처럼!!

동시에 요청이 오는 경우, (우리가 이전에 만들었던 AppConfig의 )DI 컨테이너는 요청이 올때마다 새로운 객체를 생성하게 된다.

그렇다면 어떠한 문제가 생길까?

웹 애플리케이션은 고객이 계속 요청을 하는 애플리케이션이다. 따라서 요청이 올때마다 객체를 만드는 것이 문제라고 할 수 있다.

스프링이 없는 순수한 DI 컨테이너를 한번 만들어서 테스트를 해보자.

두 개의 memberService 를 요청한 뒤, 참조 값을 확인 해보면

memberService1: hello.core.member.MemberServiceImpl@123f1134
memberService2: hello.core.member.MemberServiceImpl@7d68ef40

참조값이 다르다. 글면 jvm 메모리에 계속 생성된 객체가 올라갈 거다.

자, 정리해보면

• 우리가 만든 스프링 없는 순수한 DI 컨테이너인 AppConfig는 요청을 할 때마다 객체를 새로 생성한다.
• 고객 트래픽이 초당 100이 나오면 초당 100개 객체가 생성되고 소멸된다! → 메모리 낭비 심함
• 해결방안은 해당 객체가 딱 1개만 생성되고, 공유하도록 설계하면 된다. → 싱글톤 패턴

싱글톤 패턴

• 클래스의 인스턴스가 딱 1개만 생성되는 것을 보장하는 디자인 패턴이다.
• 그래서 객체 인스턴스를 2개 이상 생성하지 못하도록 막아야 한다.
  • private 생성자를 사용해서 외부에서 임의로 new 키워드를 사용하지 못하도록 막아야 한다.

<aside> ✨ static: 클래스에 고정되어 있는 변수나 메서드

1. 메모리에 고정적으로 할당됨
2. 객체 생성 없이 사용할 수 있음
3. 프로그램이 시작되면 메모리의 static영역에 적재되고, 프로그램이 종료될 때 해제됨
4. Static 메서드 내에서는 인스턴스 변수를 사용할 수 없음

</aside>

package hello.core.singleton;

public class SingletonService {

    private static final SingletonService instance = new SingletonService();
    
    public static SingletonService getInstance() {
        return instance;
    }
}

자바를 실행하면 SingletonService의 static 영역을 내부적으로 실행하여

객체(자기자신)를 생성한 다음, instance에 참조를 넣어놓는다.

package hello.core.singleton;

public class SingletonService {

    // 1. static 영역에 객체를 딱 1개만 생성해둔다.
    private static final SingletonService instance = new SingletonService();

    // 2. public으로 열어서 객체 인스턴스가 필요하면 이 static 메서드를 통해서만 조회하도록 허용한다.
    public static SingletonService getInstance() {
        return instance;
    }

    // 3. 생성자를 private 으로 선언해서 외부에서 new 키워드를 사용한 객체 생성을 못하게 막는다.
    private SingletonService() {}

    public void logic() {
        System.out.println("싱글톤 객체 로직 호출");
    }
}

간단하게 설명해보면

1. static 영역에 객체 instance 를 미리 하나 생성해서 올려둔다.
2. 이 객체 인스턴스가 필요하면 오직 getInstance()메서드를 통해서만 조회할 수 있다. 그리고 이 메서드를 호출하면 항상 같은 인스턴스를 반환한다.
3. 딱 1개의 객체 인스턴스만 존재해야 하므로, 생성자를 private 으로 막아서 혹시라도 외부에서 new 키워드로 객체 인스턴스가 생성되는 것을 막는다.

singletonService1: hello.core.singleton.SingletonService@105fece7
singletonService2: hello.core.singleton.SingletonService@105fece7

참조값이 같은 것을 확인할 수 있음

그러면 이제 appconfig로 가서 싱글톤 패턴으로 다 바꿔줘야 하냐????

아니다. 스프링 컨테이너를 쓰면 기본적으로 객체를 다 싱글톤으로 만들어서 관리해준다.

<aside> ✨ 싱글톤 패턴을 구현하는 방법에는 여러가지가 있다. 한 번 찾아봐라 https://readystory.tistory.com/116

</aside>

싱글톤 패턴의 문제점

• 싱글톤 패턴을 구현하는 코드 자체가 많이 들어간다.
• 의존관계상 클라이언트가 구체 클래스에 의존한다.(DIP 위반)
• 클라이언트가 구체 클래스에 의존해서 OCP를 위반한 가능성이 🆙
• 유연하게 테스트하기 어려움(인스턴스를 미리 박아서 설정하기 때문에)
• 내부 속성을 변경하거나 초기화하기 어려움(인스턴스를 미리 박아서 설정하기 때문에)
• private 생성자로 자식 클래스를 만들기 어려움
• 결론적으로 유연성이 떨어짐
• 안티패턴으로도 불림

근데 스프링프레임워크는 이 문제점을 전부 해결함. 다음시간부터 알아보자.

싱글톤 컨테이너

스프링 컨테이너는 싱글톤 패턴의 문제점을 해결하면서, 객체 인스턴스를 싱글톤(1개만 생성)으로 관리한다. 지금까지 우리가 학습한 스프링 빈이 바로 싱글톤으로 관리되는 빈이다.

• 스프링 컨테이너는 싱글톤 패턴을 적용하지 않아도, 객체 인스턴스를 싱글톤으로 관리한다.
• 스프링 컨테이너는 싱글톤 컨테이너 역할을 한다. 이렇게 싱글톤 객체를 생성하고 관리하는 기능을 싱글톤 레지스트리라고 한다.
• 스프링 컨테이너의 이런 기능 덕분에 싱글톤 패턴의 모든 단점을 해결하면서 객체를 싱글톤으로 유지할 수 있다.

바로 테스트를 해보자.

고객이 요청할때마다 객체를 생성하는 것이 아닌, 이미 만들어진 객체를 공유하여 효율적으로 재사용할 수 있다.

싱글톤 방식의 주의점

싱글톤 패턴이든, 스프링 같은 싱글톤 컨테이너를 사용하든, 객체 인스턴스를 하나만 생성해서 공유하는 싱글톤 방식은 여러 클라이언트가 하나의 같은 객체 인스턴스를 공유하기 때문에 싱글톤 객체는 상태를 유지하게 설계하면 안된다.

즉, 무상태로 설계해야 한다

• 특정 클라이언트에 의존적인 필드가 있으면 안된다.
• 특정 클라이언트가 값을 변경할 수 있는 필드가 있으면 안된다.
• 가급적 읽기만 가능해야 한다.
• 필드 대신에 자바에서 공유되지 않는, 지역변수, 파라미터, ThreadLocal 등을 사용해야 한다.

잘못된 예시를 들어보자.

package hello.core.singleton;

import org.junit.jupiter.api.Test;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Bean;

import static org.junit.jupiter.api.Assertions.*;

class StatefulServiceTest {

    @Test
    void statefulServiceSingleton() {
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(TestConfig.class);
        StatefulService statefulService1 = ac.getBean(StatefulService.class);
        StatefulService statefulService2 = ac.getBean(StatefulService.class);

        // ThreadA: A사용자 10000원 주문
        statefulService1.order("userA",10000);
        // ThreadB: B 사용자 20000원 주문
        statefulService2.order("userB",20000);

        // ThreadA: 사용자 A 주문 금액 조회
        int price = statefulService1.getPrice();
        System.out.println("price: " + price);
    }

    static class TestConfig {

        @Bean
        public StatefulService statefulService() {
            return new StatefulService();
        }
    }
}

여기서 테스트를 했을 때 우리가 기대하는건 price가 사용자 A의 가격에 맞게 10000이 나와야하는데 실제 테스트를 해보면 20000이 나온다.

인스턴스가 같기 때문에..

스프링 빈은 꼭 무상태를 유지한다는 것을 기억하자!!!!!

@Configuration과 싱글톤

@configuration은 사실 싱글톤을 위해 존재한다.

이 역할을 알아보기 위해 appconfig로 가보면

package hello.core;

import hello.core.discount.DiscountPolicy;
import hello.core.discount.RateDiscountPolicy;
import hello.core.member.MemberRepository;
import hello.core.member.MemberService;
import hello.core.member.MemberServiceImpl;
import hello.core.member.MemoryMemberRepository;
import hello.core.order.OrderService;
import hello.core.order.OrderServiceImpl;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class AppConfig {

    //@Bean memberService -> new MemoryMemberRepository()
    //@Bean orderService ->  new MemoryMemberRepository()
    @Bean
    public MemberService memberService() {
        return new MemberServiceImpl(memberRepository());
    }

    @Bean
    public MemberRepository memberRepository() {
        return new MemoryMemberRepository();
    }

    @Bean
    public OrderService orderService() {
        return new OrderServiceImpl(memberRepository(), discountPolicy());
    }

    @Bean
    public DiscountPolicy discountPolicy() {
        return new RateDiscountPolicy();
    }
}

여기서 MemberService 랑 OrderService 만 호출해도 MemoryMemberRepository가 두번 호출된다. 그렇다면 싱글톤이 깨지는 것처럼 보인다. 스프링 컨테이너는 이 문제를 어떻게 해결하는 걸까????? 직접 테스트를 해보자.

package hello.core.singleton;

import hello.core.AppConfig;
import hello.core.member.MemberRepository;
import hello.core.member.MemberService;
import hello.core.member.MemberServiceImpl;
import hello.core.order.OrderServiceImpl;
import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

public class ConfigurationSingletonTest {
    
    @Test
    void configurationTest() {
        ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);

        MemberServiceImpl memberService = ac.getBean("memberService", MemberServiceImpl.class);
        OrderServiceImpl orderService = ac.getBean("orderService", OrderServiceImpl.class);
        MemberRepository memberRepository = ac.getBean("memberRepository", MemberRepository.class);

        MemberRepository memberRepository1 = memberService.getMemberRepository();
        MemberRepository memberRepository2 = orderService.getMemberRepository();

        System.out.println("memberService -> memberRepository: " + memberRepository1);
        System.out.println("orderService -> memberRepository: " + memberRepository2);
        System.out.println("memberRepository: " + memberRepository);
    }
    
}

이 테스트를 수행하면 3개의 스프링빈 다 같은 인스턴스가 조회된다.

즉, MemberRepository 인스턴스는 모두 같은 인스턴스가 공유되어 사용된다.

Appconfig의 자바코드를 보면 분명히 각각 2번 new MemoryMemberRepository를 호출해서 다른 인스턴스가 생성되어야 하는디? 왜일까?

실험을 통해 확인해본다.

스프링 컨테이너가 각각 bean호출해서 스프링 빈을 생성한다. 그래서 memberRepository()는 다음과 같이 총 3번 호출되어야 하는 것이 아닐까?

1. 스프링 컨테이너가 스프링 빈에 등록하기위해 bean이 붙어있는 memberRepository()호출
2. memberService()로직에서 memberRepository()호출
3. orderService()로직에서 memberRepository() 호출

그런데 출력결과는 모두 1번만 호출된다.

@Configuration과 바이트 코드 조작의 마법

스프링 컨테이너는 싱글톤 레지스트리이다. 따라서 스프링 빈이 싱글톤이 되도록 보장해주어야 한다. 그런데 스프링이 자바 코드까지 어떻게 하기는 어렵다. 저 자바코드를 보면 분명 3번 호출되어야 하는 것이 맞다.

그래서 스프링은 클래스의 바이트코드를 조작하는 라이브러리를 사용한다.

모든 비밀은 @Configuration을 적용한 Appconfig에 있다.

Appconfig의 스프링빈을 조회해서 클래스정보를 출력해보면

bean: class hello.core.AppConfig$$SpringCGLIB$$0

기대했던 class hello.core.AppConfig가 아니라 뒤에 뭐가 더 붙은 것을 볼 수 있다. 이것은 스프링이 CGLIB이라는 바이트코드 조작 라이브러리를 사용해서 AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들고, 그 다른 클래스를 스프링 빈으로 등록한 것이다!

따라서 내가 만든 객체가 아닌 임의의 다른 클래스가 싱글톤이 되도록 보장해준다.

로직을 간단하게 얘기해보면

MemoryMemberRepository가 이미 스프링 컨테이너에 등록되어 있으면, 스프링컨테이너에서 찾아서 반환하고,

스프링 컨테니어네 없으면 기존 로직을 호출해서 MemoryMemberrepository를 생성하고 스프링 컨테이너에 등록한다.

만약에 골뱅이configuration을 안 붙이고 골뱅이bean만 붙이면 어떻게 될까?

안 붙여도 스프링 컨테이너에 스프링 빈으로 알아서 등록된다. 근데 문제는 순수한 자바코드가 돌기 때문에 싱글톤이 깨지게 된다.

문제를 해결하는 방법에 뒤에서 배울건데 골뱅이autowired쓰는 것도 있다.

참고용

https://refactoring.guru/ko/design-patterns/catalog

📢해당 글은 김영한님의 스프링 핵심 원리 강좌를 기반으로 작성되었습니다.