면접 준비 겸 SpringBoot에 대해 제대로 정리해보자

Spring

Spring 사이트에 들어가면 스프링에 대해 다음과 같이 설명한다.

Alt text

스프링(Spring)은 자바 프로그래밍을 더 빠르고, 쉽고, 안전하게 만듭니다. 스프링은 속도, 단순성, 생산성에 중점을 두어 세계에서 가장 인기 있는 자바 프레임워크가 되었습니다. 스프링은 Inversion of Control(IoC)와 Dependency Injection(DI) 기능을 바탕으로 확장 가능한 애플리케이션을 구축할 수 있도록 돕습니다.

위 설명을 읽으면 저체적인 내용이 파악되지만 IoC와 DI 부분은 정확히 이해되지 않았다. Inversion of Control(IoC)와 Dependency Injection(DI) 를 제대로 알고 넘어가자.

IoC(Inversion of Control)란?

IoC는 제어의 역전(Inversion of Control)을 의미합니다. 전통적인 프로그래밍에서는 개발자가 직접 프로그램의 흐름을 제어하지만, IoC에서는 프레임워크가 객체의 생성과 관리를 담당한다. Spring은 IoC를 지원하기 위해 ApplicationContext라는 컨테이너를 제공한다.

IOC 컨테이너란?

Alt text

IoC 컨테이너는 IoC를 제공하는 Bean을 담고 있는 컨테이너이다. Bean은 IoC 컨테이너에서 관리하는 객체를 의미하며, Spring은 이 객체들을 필요에 따라 적절하게 주입하여 사용하게 한다.

이로 인해 개발자는 객체의 생성과 호출 시점에 대해 신경 쓸 필요 없이, 프레임워크가 객체를 생성, 관리, 소멸시키는 역할을 한다.

  • 작업의 구현과 흐름을 분리
  • 모듈 제작 시 결합도 고민 감소
  • 시스템의 동작 방식을 신경 쓰지 않고 협약대로 동작
  • 모듈 변경 시 다른 시스템에 부작용 없음

이 방식은 모듈화를 용이하게 하고, 시스템의 확장성과 유지보수를 개선한다.

DI (Dependency Injection)란?

DI는 객체 간의 의존성을 프레임워크가 주입하는 개념이다. DI는 IoC를 구현하기 위한 하나의 디자인 패턴으로, 객체 간의 의존 관계를 외부에서 주입하는 것을 말한다.

public class Car {
    private final Engine B = new EngineB();
}

위 코드에서는 Car 클래스가 EngineB에 의존합니다. 이를 EngineA로 바꾸려면 Car 클래스를 수정해야 한다.

public class Car {
    private final Engine engine;
    
    public Car(Engine engine){
        this.engine = engine;
    }
}

이 코드에서는 생성자를 통해 외부에서 Engine을 주입받는다. 이렇게 하면 Engine이 교체되어도 Car 클래스 코드를 수정할 필요가 없다.

의존성 주입 방식

  1. 생성자 주입 (Constructor Injection)
  2. 수정자 주입 (Setter Injection)
  3. 필드 주입 (Field Injection)

위 방법 중 스프링에서 권장하는 방법은 생성자 주입이다.

생성자 주입 ( Constructor Injection )

생성자 주입이란 생성자를 통해 의존관계를 주입하는 방법으로 생성자를 호출 시에 딱 한 번만 호출되는 것을 보장한다.

스프링 4.3 버전 이후라면 @Autowired를 생략해도 주입이 되며, 이 방법은 객체가 생성될 때 의존성을 한번에 주입받기 때문에 의존성 주입 후에 변경이 불가능하다는 점에서 불변성을 확보할 수 있다는 장점이 있다.

@Slf4j
@Service
public class AuthServiceImpl implements AuthService {


    private final AuthRepository authRepository;

    //  생성자가 1개인 경우 @Autowired를 생략
    public AuthServiceImpl(AuthRepository authRepository) {
        this.authRepository = authRepository;
    }

    @Override
    public void initializeRoles() throws Exception {
        log.info("[AuthServiceImpl][initializeRoles] Start");
        authRepository.insertRoleAdmin();
    }

}

RequiredArgsConstructor 이용한 생성자 주입

@Slf4j
@Service
@RequiredArgsConstructor
public class AuthServiceImpl implements AuthService {

    private final AuthRepository authRepository;
    
    @Override
    public void initializeRoles() throws Exception {
        log.info("[AuthServiceImpl][initializeRoles] Start");
        authRepository.insertRoleAdmin();
    }

}

Setter 주입(Setter Injection)

Setter 주입은 의존성을 주입받는 클래스의 setter 메서드를 통해 의존성을 주입하는 방법이다 . Setter 주입은 생성자 주입과 다르게 주입받는 객체가 변경될 가능성이 있는 경우에 사용한다. 이 방법은 객체가 생성된 후에도 의존성을 변경할 수 있다는 점에서 유연성을 제공하지만, 의존성이 변경될 가능성이 있기 때문에 불변성을 확보하기 어렵다.


    // @Autowired와 setter는 필드를 final로 선언할 수 없다.
    private  AuthRepository authRepository;

    @Autowired
    public void setAuthRepository(AuthRepository authRepository){
        this.authRepository =authRepository;
    }

@Autowired로 주입할 대상이 없는 경우에는 오류가 발생한다. 주입할 대상이 없어도 동작하도록 하려면 @Autowired(required = false)를 통해 설정할 수 있다.

필드 주입(Field Injection)

필드 주입은 의존성을 주입받는 클래스의 필드에 직접 의존성을 주입하는 방법이다. 이 방법은 코드가 간결하다는 장점이 있지만, 의존성이 변경될 가능성이 있고 테스트하기 어렵다는 단점이 있다.

public class AuthServiceImpl implements AuthService {

    @Autowired
    private  AuthRepository authRepository;

}

코드가 단순해진다는 이유로 내가 자주썼던 방법이다. 하지만 Spring에서 필드 주입을 권장하지 않는다.

필드 주입을 사용하려면 @Autowired를 이용해야 하는데, 이것은 스프링이 제공하는 어노테이션이다. 그러므로 @Autowired 를 사용하면 스프링 의존성이 침투하게 된다.

필드 주입을 사용하면 반드시 DI 프레임워크가 존재해야 하므로 테스트가 어렵다. 객체를 직접 생성하면서 의존성을 주입하는 생성자 주입을 사용하면, 테스트가 더 용이하게 된다.

테스트 코드 예제

1. 필드 주입 예제

// test code 
@RunWith(MockitoJUnitRunner.class)
public class AuthServiceImplTest {

    @Mock
    private AuthRepository authRepositoryMock;

    private AuthServiceImpl authService;

    @Before
    public void setUp() {
        authService = new AuthServiceImpl();
        // authService 객체의 authRepository 필드에 Mock 객체 주입
        ReflectionTestUtils.setField(authService, "authRepository", authRepositoryMock);
    }

    @Test
    public void testAuthenticateUser() {
    }
}

ReflectionTestUtils를 통해 authService 객체의 authRepository 필드에 Mock 객체를 주입하는 추가적인 과정이 필요하다.

2. 생성자 주입 예제

@RunWith(MockitoJUnitRunner.class)
public class AuthServiceImplTest {

    @Mock
    private AuthRepository authRepositoryMock;

    private AuthServiceImpl authService;

    @Before
    public void setUp() {
        authService = new AuthServiceImpl(authRepositoryMock);
    }

    @Test
    public void testAuthenticateUser() {
    }
}

AuthServiceImpl 객체를 생성할 때 생성자를 통해 Mock 객체를 전달하여 간단하게 테스트할 수 있다.

또한, 필드 주입을 사용하면 객체가 생성된 후에도 의존성이 변경될 수 있다. 이는 불변성을 해칠 수 있으므로 객체의 안정성을 보장하기 어다. 이러한 문제를 방지하기 위해서는 생성자 주입을 사용하는 것이 좋다.

생성자 주입을 사용해야 하는 이유

  • 객체의 불변성을 확보할 수 있다.
  • 테스트 코드의 작성이 용이해진다.
  • final 키워드를 사용할 수 있고, Lombok과의 결합을 통해 코드를 간결하게 작성할 수 있다.
  • 스프링에 침투적이지 않은 코드를 작성할 수 있다.
  • 순환 참조 에러를 애플리케이션 구동(객체의 생성) 시점에 파악하여 방지할 수 있다.



코드 리팩토링하기

final 키워드와 Lombok을 이용한 생성자 주입 방식을 적용했다.

1. 필드 주입 방식 리팩토링

기존 코드를 살펴보면 @Autowired 를 이용한 필드 주입 방식을 사용했다.

@Service
public class AuthDaoImpl implements AuthDao{
    
    @Autowired
    private AuthRepository authRepository;

    @PostConstruct
    public void initializeRoles() {
        authRepository.insertRoleUser();
        authRepository.insertRoleAdmin();
    }
}


생성자 주입 방식 적용

@Service
@RequiredArgsConstructor
public class AuthDaoImpl implements AuthDao {

    private final AuthRepository authRepository;

    @PostConstruct
    public void initializeRoles() {
        authRepository.insertRoleUser();
        authRepository.insertRoleAdmin();
    }
}

2. @AllargsConstructor 생성자 주입 방식 리팩토링

@AllArgsConstructor는 클래스에 존재하는 모든 필드에 대한 생성자를 자동으로 생성해주는 어노테이션이므로 필드에 final 키워드와 @NonNull 어노테이션이 붙은 대상에 한해서 생성자를 생성해 주는 @RequiredArgsConstructor를 쓰는것이 바람직하다.

@Service
@AllArgsConstructor
@Slf4j
public class CertificateInfoImpl implements CertificateInfoDao {

    final private CertificateInfoRepository certificateInfoRepository;

}

@RequiredArgsConstructor 을 이용한 생성자 주입 방식 적용

@Service
@RequiredArgsConstructor
@Slf4j
public class CertificateInfoImpl implements CertificateInfoDao {

    final private CertificateInfoRepository certificateInfoRepository;

}



Reference

댓글남기기

참고

[React] React를 이용해 간단한 일기장 만들기

리액트를 이용하여 간단한 일기장을 만들어보는 프로젝트를 진행했다. 코드는 한입크기로 잘라먹는 리액트를 참고했으며, 강의를 완강한 기념으로 관련 내용을 정리하고자한다.

[Spring] 스프링 부트와 내장 톰캣

과거에는 웹 애플리케이션을 개발하고 배포하기 위해 WAR(Web Application Archive) 방식이 표준이었다. 웹 애플리케이션 서버(WAS)와 애플리케이션 빌드 파일(WAR)을 분리해 운영하는 구조였지만 이 방식은 몇 가지 단점이 있다.

[Spring] 웹 서버와 스프링 프레임워크

EJB는 1990년대 후반에 등장했다. 그 목적은 자바 기반의 대규모 엔터프라이즈 애플리케이션을 쉽게 개발하고 배포할 수 있는 표준을 제공하는 것이었지만 여러 문제들이 있었다.