본문 바로가기
BackEnd/Spring

[스프링 기본] 객체 지향 원리 적용

by 개발 Blog 2024. 7. 5.

공부 내용을 정리하고 앞으로의 학습에 이해를 돕기 위해 작성합니다.

 

새로운 할인 정책 개발

실무에서 기획자가 할인 정책을 지금처럼 고정된 금액 할인이 아니라 좀 더 합리적인 주문 금액당 할인하는 정률% 할인으로 변경하고 싶다고 요청했다.

 

1. 객체지향 설계 원칙을 잘 준수했는지 확인하기 위해 주문한 금액의 %를 할인해 주는 새로운 정률 할인 정책을 추가한다.

2. RateDiscountPolicy 클래스를 만든다.

package hello.core.discount;

import hello.core.member.Grade;
import hello.core.member.Member;

public class RateDiscountPolicy implements DiscountPolicy{

    private int discountPercent = 10;

    @Override
    public int discount(Member member, int price) {
        if (member.getGrade() == Grade.VIP) {
            return price * discountPercent / 100;
        }
        else{
            return 0;
        }
    }
}

 

3. 테스트 코드를 작성한다.

package hello.core.discount;

import hello.core.member.Grade;
import hello.core.member.Member;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;

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

class RateDiscountPolicyTest {

    RateDiscountPolicy discountPolicy = new RateDiscountPolicy();

    @Test
    @DisplayName("VIP는 10% 할인이 적용되어야 한다.")
    void vip_o(){
        //given
        Member member = new Member(1L, "memberVIP", Grade.VIP);

        //when
        int discount = discountPolicy.discount(member, 10000);

        //then
        assertThat(discount).isEqualTo(1000);
    }

    @Test
    @DisplayName("VIP가 아니면 할인이 적용되지 않아야 한다.")
    void vip_x(){
        //given
        Member member = new Member(2L, "memberBASIC", Grade.BASIC);

        //when
        int discount = discountPolicy.discount(member, 10000);

        //then
        assertThat(discount).isEqualTo(0);
    }
}
  • assertThat은 static import로 깔끔하게 정리한다.

 

새로운 할인 정책 적용과 문제점 (중요한 챕터)

할인 정책을 변경하려면 클라이언트인 OrderServiceImpl 코드를 고쳐야 한다.

 

문제점 

- 역할과 구현을 충실하게 분리했다. (O)

- 다형성도 활용하고, 인터페이스와 구현 객체를 분리했다. (O)

- OCP, DIP 같은 객체지향 설계 원칙을 충실히 준수했나?? (X)

인프런 스프링 핵심 원리(김영한)

- OrderServiceImpl은 추상 인터페이스에도 의존하고, 구현 클래스에도 의존하고 있다. (DIP 위반)

- 지금 코드는 기능을 확장해서 변경하면, 클라이언트 코드에 영향을 준다. (OCP 위반)

 

인프런 스프링 핵심 원리(김영한)

- 그래서 FixDiscountPolicy를 RateDiscountPolicy로 변경하는 순간 OrderServiceImpl의 소스코드도 함께 변경해야 한다.

 

문제 해결 방법

- 클라이언트 코드인 OrderServiceImpl은 DiscountPolicy의 인터페이스 뿐만 아니라 구체 클래스도 함께 의존한다.

- 그래서 구체 클래스를 변경할 때 클라이언트 코드도 함께 변경해야 한다.

- DIP 위반 -> 추상에만 의존하도록 변경(인터페이스에만 의존)

- DIP를 위반하지 않도록 인터페이스에만 의존하도록 의존관계를 변경하면 된다.

 

인프런 스프링 핵심 원리(김영한)

- 인터페이스에만 의존하도록 설계와 코드를 변경했다.

- 실행해보면 null pointer exception이 발생한다.

- 구현체가 없어서 실행할 수 없다.

 

-> 이 문제를 해결하려면 누군가 클라이언트인 OrderServiceImpl에 DiscountPolicy의 구현 객체를 대신 생성하고 주입해주어야 한다.

 

관심사의 분리

 

관심사를 분리하자

- 애플리케이션을 하나의 공연이라 생각해 보자.. 각각의 인터페이스를 배역(배우 역할)이라 생각하자. 그런데 실제 배역 맞는 배우를 선택하는 것은 누가 하는가?

- 로미오와 줄리엣 공연을 하면 로미오 역할을 누가 할지 줄리엣 역할을 누가 할지는 배우들이 정하는 게 아니다. 이 전 코드는 마치 로미오 역할(인터페이스)을 하는 레오나르도 디카프리오(구현체, 배우)가 줄리엣 역할(인터페이)을 하는 여자 주인공(구현체, 배우)을 직접 초빙하는 것과 같다. 디카프리오는 공연도 해야하고 동시에 여자 주인공도 공연에 직접 초빙해야 하는 다양한 책임을 가지고 있다.

 

AppConfig 등장

- 애플리케이션의 전체 동작 방식을 구성(config) 하기(config) 위해, 구현 객체를 생성하고, 연결하는 책임을 가지는 별도의 설정 클래스를 만들자

 

package hello.core;

import hello.core.discount.FixDiscountPolicy;
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;

public class AppConfig {

    public MemberService memberService(){
        return new MemberServiceImpl(new MemoryMemberRepository());
    }

    public OrderService orderService(){
        return new OrderServiceImpl(new MemoryMemberRepository(), new FixDiscountPolicy());
    }
}

- AppConfig는 애플리케이션의 실제 동작에 필요한 구현 객체를 생성한다.

  ㄴMemberServiceImpl

  ㄴ MemoryMemberRepository

  ㄴ OrderServiceImpl

  ㄴ FixDiscountPolicy

 

- AppConfig는 생성한 객체 인스턴스의 참조(레퍼런스)생성자를 통해서 주입(연결)해준다.

  ㄴ MemberServiceImpl -> MemoryMemberRepository

  ㄴ OrderServiceImpl -> MemoryMemberRepository, FixDiscountPolicy

 

MemberServiceImpl - 생성자 주입

package hello.core.member;

public class MemberServiceImpl implements MemberService {

    private final MemberRepository memberRepository;

    public MemberServiceImpl(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
    }

    @Override
    public void join(Member member) {
        memberRepository.save(member);
    }

    @Override
    public Member findMember(Long memberId) {
        return memberRepository.findById(memberId);
    }
}

- 설계 변경으로 MemberServiceImplMemoryMemberRepository MemoryMemberRepository를 의존하지 않는다. 단지 MemberRepository 인터페이스만 의존한다.

- MemberServiceImpl 입장에서 생성자를 통해 어떤 구현 객체가 들어올지(주입될지)는 알 수 없다.

- MemberServiceImpl의 생성자를 통해서 어떤 구현 객체를 주입할지는 오직 외부(AppConfig)에서 결정된다.

- MemberServiceImpl 은 이제부터 의존관계에 대한 고민은 외부에 맡기고 실행에만 집중하면 된다.

 

인프런 스프링 핵심 원리

- 객체의 생성과 연결은 AppConfig가 담당한다.

- DIP 완성: MemberServiceImpl MemberRepository인 추상에만 의존하면 된다. 이제 구체 클래스를 몰라도 된다.

- 관심사의 분리: 객체를 생성하고 연결하는 역할과 실행하는 역할이 명확히 분리되었다.

 

인프런 스프링 핵심 원리

- appConfig 객체는 memoryMemberRepository 객체를 생성하고 그 참조값을 memberServiceImpl을 생성하면서 생성자로 전달한다.

- 클라이언트인 memberServiceImpl 입장에서 보면 의존관계를 마치 외부에서 주입해 주는 것 같다고 해서 DI(Dependency Injection) 우리말로 의존관계 주입 또는 의존성 주입이라 한다.

 

OrderServiceImpl - 생성자 주입

package hello.core.order;

import hello.core.discount.DiscountPolicy;
import hello.core.member.Member;
import hello.core.member.MemberRepository;

public class OrderServiceImpl implements OrderService{

    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;

    public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
        this.memberRepository = memberRepository;
        this.discountPolicy = discountPolicy;
    }

    @Override
    public Order createOrder(Long memberId, String itemName, int itemPrice) {
        Member member = memberRepository.findById(memberId);
        int discountPrice = discountPolicy.discount(member, itemPrice);

        return new Order(memberId, itemName, itemPrice, discountPrice);
    }
}

- 설계 변경으로 OrderServiceImpleFixDiscountPolicy를 의존하지 않고, DiscountPolicy 인터페이스만 의존한다.

- OrderServiceImpl 입장에서 생성자를 통해 어떤 구현 객체가 들어올지(주입될지)는 알 수 없다.

- OrderServiceImpl의 생성자를 통해서 어떤 구현 객체를 주입할지는 오직 외부(AppConfig)에서 결정한다.

- OrderServiceImpl은 실행에만 집중하면 된다.

- OrderServiceImpl에는 MemoryMemberRepository, FixDiscountPolicy 객체의 의존관계가 주입된다.

 

APPConfig실행 (MemberApp, OrderApp)

package hello.core;

import hello.core.member.Grade;
import hello.core.member.Member;
import hello.core.member.MemberService;

public class MemberApp {
    public static void main(String[] args) {
        AppConfig appconfig = new AppConfig();
        MemberService memberService = appconfig.memberService();
//        MemberService memberService = new MemberServiceImpl();

        Member member = new Member(1L, "memberA", Grade.VIP);
        memberService.join(member);

        Member findMember = memberService.findMember(1L);
        System.out.println("new member = " + member.getName());
        System.out.println("find Member = " + findMember.getName());

    }
}
package hello.core;

import hello.core.member.Grade;
import hello.core.member.Member;
import hello.core.member.MemberService;
import hello.core.order.Order;
import hello.core.order.OrderService;

public class OrderApp {
    public static void main(String[] args) {
        AppConfig appConfig = new AppConfig();
        MemberService memberService = appConfig.memberService();
        OrderService orderService = appConfig.orderService();

        Long memberId = 1L;
        Member member = new Member(memberId, "memberA", Grade.VIP);
        memberService.join(member);

        Order order = orderService.createOrder(memberId, "itemA", 10000);

        System.out.println("order = " + order);
    }
}

 

테스트 코드 오류 수정 (MemberServiceTest, OrderServiceTest)

package hello.core.member;

import hello.core.AppConfig;
import hello.core.order.OrderService;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

public class MemberServiceTest {

    MemberService memberService;
    OrderService orderService;

    @BeforeEach
    public void beforeEach(){
        AppConfig appConfig = new AppConfig();
        memberService = appConfig.memberService();
        orderService = appConfig.orderService();
    }

    @Test
    void join(){
        //given
        Member member = new Member(1L, "memberA", Grade.VIP);

        //when
        memberService.join(member);
        Member findMember = memberService.findMember(1L);

        //then
        Assertions.assertThat(member).isEqualTo(findMember);
    }
}
package hello.core.order;

import hello.core.AppConfig;
import hello.core.member.Grade;
import hello.core.member.Member;
import hello.core.member.MemberService;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

public class OrderServiceTest {
    MemberService memberService;
    OrderService orderService;

    @BeforeEach
    public void beforeEach(){
        AppConfig appConfig = new AppConfig();
        memberService = appConfig.memberService();
        orderService = appConfig.orderService();
    }

    @Test
    void createOrder() {
        Long memberId = 1L;
        Member member = new Member(memberId, "memberA", Grade.VIP);
        memberService.join(member);

        Order order = orderService.createOrder(memberId, "itemA", 10000);
        Assertions.assertThat(order.getDiscountPrice()).isEqualTo(1000);
    }
}

- @BeforeEach는 각 테스트 실행하기 전에 호출된다.

 

정리

- Appconfig를 통해서 관심사를 확실하게 분리했다.

- Appconfig는 구체 클래스를 선택한다. 애플리케이션이 어떻게 동작해야 할지 전체 구성을 책임진다.

- 이제 각 운전자들은 담당 기능을 실행하는 책임만 지면 된다.

- OrderServiceImpl은 기능을 실행하는 책임만 지면 된다.

 

AppConfig 리팩터링

AppConfig의 중복을 제거하고 역할에 따른 구현을 명확하게 한다.

 

수정전

package hello.core;

import hello.core.discount.DiscountPolicy;
import hello.core.discount.FixDiscountPolicy;
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;

public class AppConfig {

    public MemberService memberService(){
        return new MemberServiceImpl(new MemoryMemberRepository());
    }

    public OrderService orderService(){
        return new OrderServiceImpl(new MemoryMemberRepository(), new FixDiscountPolicy());
    }
}

 

수정후

package hello.core;

import hello.core.discount.DiscountPolicy;
import hello.core.discount.FixDiscountPolicy;
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;

public class AppConfig {
    public MemberService memberService() {
        return new MemberServiceImpl(memberRepository());
    }

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

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

    public DiscountPolicy discountPolicy() {
        return new FixDiscountPolicy();
    }
}

- new MemoryMemberRepository()이 부분이 중복 제거되었다. 이제 MemoryMemberRepository다른 구현체로 변경할 때 한 부분만 변경하면 된다.

- AppConfig를 보면 역할과 구현 클래스가 한눈에 들어온다. 애플리케이션 전체 구성이 어떻게 되어있는지 빠르게 파악할 수 있다.

 

새로운 구조와 할인 정책 적용

- 할인 정책을 변경해 보자

- AppConfig의 FixDiscountPolicy -> RateDiscountPolicy로 수정하면 끝이다.

- AppConfig의 등장으로 애플리케이션이 크게 사용 영역과, 객체를 생성하고 구성(Configuration)하는 영역으로 분리되었다.

- FixDiscountPolicy -> RateDiscountPolicy로 변경해도 구성 영역만 영향을 받고, 사용 영역은 전혀 영향을 받지 않는다.

 

좋은 객체 지향 설계의 5가지 원칙의 적용

 

SRP단일 책임 원칙 

한 클래스는 하나의 책임만 가져야 한다.

- 클라이언트 객체는 직접 구현 객체를 생성하고, 연결하고, 실행하는 다양한 책임을 가진다.

- SRP 단일 책임 원칙을 따르면서 관심사를 분리했다.

- 구현 객체를 생성하고 연결하는 책임은 AppConfig가 담당한다.

- 클라이언트 객체는 실행하는 책임만 담당한다.

 

DIP 의존 관계 역전 원칙

프로그래머는 "추상화에 의존해야지, 구체화에 의존하면 안 된다." 의존성 주입은 이 원칙을 따르는 방법 중 하나다.

- 새로운 할인 정책을 개발하고, 적용하려고 하니 클라이언트 코드도 변경해야 했다. 기존 클라이언트 코드(OrderServiceImpl)는 DIP를 지키며 DiscountPolicy 추상화 인터페이스에 의존하는 것 같았지만, FixDiscountPolicy 구체화 구현 클래스에도 함께 의존했다.

- 클라이언트 코드가 DiscountPolicy 추상화 인터페이스에만 의존하도록 코드를 변경하고 AppConfig가 FixDiscountPolicy 객체 인스턴스를 클라이언트 코드 대신 생성해서 클라이언트 코드에 의존관계를 주입했다.

- DIP 원칙도 따르고 문제도 해결했다.

 

OCP

소프트웨어 요소는 확장에는 열려 있으나 변경에는 닫혀 있어야 한다.

- 다형성을 사용하고 클라이언트가 DIP를 지켰다.

- 애플리케이션을 사용 영역과 구성 영역으로 나눴다.

- AppConfig가 의존관계를 FixDiscountPolicy -> RateDiscountPolicy로 변경해서 클라이언트 코드에 주입하므로 클라이언트 코드는 변경하지 않아도 된다.

- 소프트웨어 요소를 새롭게 확장해도 사용 영역의 변경은 닫혀있다.

 

IoC, DI, 그리고 컨테이너

 

1. 제어의 역전 IoC

- 기존 프로그램에서는 클라이언트 구현 객체가 필요한 서버 객체를 직접 생성, 연결, 실행하며 프로그램의 제어 흐름을 관리했다. 이는 개발자에게 자연스러운 흐름이다.

- AppConfig 등장 이후, 구현 객체는 자신의 로직만 실행하고, 프로그램의 제어 흐름은 AppConfig가 관리한다. 예를 들어, OrderServiceImpl은 필요한 인터페이스를 호출하지만 어떤 구현 객체가 실행될지는 모른다.

- 프로그램의 제어 흐름 권한은 모두 AppConfig가 가지며, OrderServiceImpl도 AppConfig가 생성한다. AppConfig는 OrderServiceImpl이 아닌 다른 구현 객체를 생성할 수도 있지만, OrderServiceImpl은 이를 알지 못한 채 자신의 로직을 실행한다.

- 이처럼 프로그램의 제어 흐름을 직접 제어하지 않고 외부에서 관리하는 것을 제어의 역전(IoC)이라 한다.

 

2. 프레임워크 vs 라이브러리

- 프레임워크가 내가 작성한 코드를 제어하고, 대신 실행하면 그것은 프레임워크가 맞다. (JUnit)
반면에 내가 작성한 코드가 직접 제어의 흐름을 담당한다면 그것은 프레임워크가 아니라 라이브러리다.

 

3. 의존관계 주입 DI

- OrderServiceImpl은 DiscountPolicy 인터페이스에 의존하며, 실제 어떤 구현 객체가 사용될지는 모른다. 

- 의존관계는 정적인 클래스 의존 관계실행 시점에 결정되는 동적인 객체(인스턴스) 의존 관계로 분리해서 생각해야 한다.

 

정적인 클래스 의존관계

- 클래스가 사용하는 import 코드만 보고 의존관계를 쉽게 판단할 수 있다. 정적인 의존관계는 애플리케이션을 실행하지 않아도 분석할 수 있다. 클래스 다이어그램을 보자

- OrderServiceImplMemberRepository, DiscountPolicy에 의존한다는 것을 알 수 있다. 그런데 이러한 클래스 의존관계 만으로는 실제 어떤 객체가 OrderServiceImpl에 주입될지 알 수 없다.

 

동적인 객체 인스턴스 의존 관계

- 애플리케이션 실행 시점에 실제 생성된 객체 인스턴스의 참조가 연결된 의존 관계다.

- 애플리케이션 실행 시점에 외부에서 구현 객체를 생성하고 클라이언트에 전달하여 실제 의존관계를 연결하는 것을 의존관계 주입이라 한다.

- 이를 통해 클라이언트 코드를 변경하지 않고도 호출 대상의 타입 인스턴스를 변경할 수 있으며, 정적인 클래스 의존관계를 변경하지 않고 동적인 객체 의존관계를 쉽게 변경할 수 있다.

 

4. IoC 컨테이너, DI 컨테이너

- AppConfig처럼 객체를 생성하고 관리하면서 의존관계를 연결해 주는 것을 IoC 컨테이너 또는 DI 컨테이너라 한다.

- 의존관계 주입에 초점을 맞춰 최근에는 주로 DI 컨테이너라 하며, 어셈블러, 오브젝트 팩토리 등으로도 불린다.

 

스프링으로 전환하기

지금까지 순수한 자바 코드만으로 DI를 적용했다. 

스프링을 사용해 보자

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
    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();
    }
}

- @Configuration은 스프링에서 해당 클래스가 스프링 빈 설정을 제공하는 설정 클래스임을 나타내는 애노테이션이다.

- 각 메서드에 @Bean을 붙여준다. 이렇게 하면 스프링 컨테이너에 스프링 빈으로 등록한다.

 

package hello.core;

import hello.core.member.Grade;
import hello.core.member.Member;
import hello.core.member.MemberService;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

public class MemberApp {
    public static void main(String[] args) {
//        AppConfig appconfig = new AppConfig();
//        MemberService memberService = appconfig.memberService();

        ApplicationContext applicationContext = new AnnotationConfigApplicationContext(AppConfig.class);
        MemberService memberService = applicationContext.getBean("memberService", MemberService.class);

        Member member = new Member(1L, "memberA", Grade.VIP);
        memberService.join(member);

        Member findMember = memberService.findMember(1L);
        System.out.println("new member = " + member.getName());
        System.out.println("find Member = " + findMember.getName());

    }
}
package hello.core;

import hello.core.member.Grade;
import hello.core.member.Member;
import hello.core.member.MemberService;
import hello.core.order.Order;
import hello.core.order.OrderService;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

public class OrderApp {
    public static void main(String[] args) {
//        AppConfig appConfig = new AppConfig();
//        MemberService memberService = appConfig.memberService();
//        OrderService orderService = appConfig.orderService();

        ApplicationContext applicationContext = new AnnotationConfigApplicationContext(AppConfig.class);

        MemberService memberService = applicationContext.getBean("memberService", MemberService.class);
        OrderService orderService = applicationContext.getBean("orderService", OrderService.class);

        Long memberId = 1L;
        Member member = new Member(memberId, "memberA", Grade.VIP);
        memberService.join(member);

        Order order = orderService.createOrder(memberId, "itemA", 10000);

        System.out.println("order = " + order);
    }
}

 

스프링 컨테이너

- ApplicationContext는 스프링 컨테이너이다.

- 이전에는 AppConfig를 사용해 개발자가 직접 객체를 생성하고 DI를 했지만, 이제는 스프링 컨테이너를 사용한다.

- 스프링 컨테이너는 @Configuration이 붙은 AppConfig를 설정 정보로 사용하고, @Bean이 붙은 메서드를 호출해 반환된 객체를 스프링 빈으로 등록한다.

- 스프링 빈은 @Bean 메서드의 이름을 사용하며, applicationContext.getBean() 메서드로 조회할 수 있다.

- 개발자가 직접 모든 것을 처리하던 방식에서 스프링 컨테이너를 통해 스프링 빈을 등록하고 사용하는 방식으로 변경되었다.