[Spring] 롬복(Lombok), @RequiredArgsConstructor를 사용한 생성자 주입

🔹 롬복(Lombok)이란 ?

Lombok은 어노테이션 기반으로 코드를 자동 생성해 주는 Java 라이브러리다.

Lombok을 이용하면 코드를 줄여 가독성을 높이고, 개발자의 생산성을 향상시킨다.

 

🔸 Lombok의 장점

• 보일러플레이트 코드 제거 : Getter, Setter, 생성자 등을 자동 생성해 코드 중복을 줄일 수 있다.
• 가독성 향상 : 코드가 간결해지고 유지 보수가 쉬워진다.
• 생산성 향상 : 반복적인 메서드 작성 없이 핵심 로직에 집중할 수 있다.

 

🔍 보일러플레이트 코드(Boilerplate Code)

• 보일러플레이트 코드란 반복적으로 작성해야 하는 코드를 의미한다.
• Java 같은 정적 타입 언어에서는 Getter, Setter, 생성자, toString() 등이 대표적인 보일러플레이트 코드다.
• Lombok 같은 라이브러리를 활용하면 보일러플레이트 코드를 줄이고 생산성을 높일 수 있다.

 

✅ 예제 코드 (Lombok 적용 전) 

public class User {
    private String name;
    private String email;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }
}

✅ Lombok 적용 후 (@Getter, @Setter)

import lombok.Getter;
import lombok.Setter;

@Getter
@Setter
public class User {
    private String name;
    private String email;
}

이렇게 Lombok을 활용하면, Getter와 Setter를 자동 생성하여 코드가 훨씬 간결해진다.

 

🔹 @RequiredArgsConstructor

@RequiredArgsConstructor는 final 필드와 @NonNull이 붙은 필드만을 포함한 생성자를 자동 생성하는 어노테이션이다.

 

🔸 @RequiredArgsConstructor 특징

• final 또는 @NonNull이 붙은 필드만 포함된 생성자를 만든다.
• 일반적인 변수(final 또는 @NonNull이 없는 변수)는 생성자에 포함되지 않는다.
• Spring 프레임워크와 함께 사용하면 생성자 주입을 쉽게 적용할 수 있다.

 

✅ Lombok 적용 전

public class User {
    private final String email;
    private final String name;

    public User(String email, String name) {
        this.email = email;
        this.name = name;
    }
}

✅ Lombok 적용 후 (@RequiredArgsConstructor)

import lombok.RequiredArgsConstructor;

@RequiredArgsConstructor
public class User {
    private final String email;
    private final String name;
}

Lombok이 자동으로 User(String email, String name) 생성자를 만들어 준다.

 

🔹 스프링 프레임워크에서 Lombok을 활용한 생성자 주입

1️⃣ 스프링 프레임워크에서의 생성자 주입

스프링 프레임워크는 생성자 주입을 권장하고 있으며, 일반적으로 아래와 같이 구현한다.

@Service
public class UserService {

    private UserRepository userRepository;
    private PasswordEncoder passwordEncoder;

    @Autowired
    public UserService(UserRepository userRepository, PasswordEncoder passwordEncoder) {
        this.userRepository = userRepository;
        this.passwordEncoder = passwordEncoder;
    }
}

@Autowired를 통해 Spring 컨테이너에서 관리하는 빈(Bean)을 주입할 수 있다.

그러나 매번 생성자를 직접 작성하는 것은 반복적이고 번거로운 작업이 될 수 있다.

 

2️⃣ final 키워드를 활용한 불변성 유지

UserRepository와 PasswordEncoder는 Spring 컨테이너가 관리하는 싱글톤 객체이므로 불변성을 유지하는 것이 좋다.

final 키워드를 사용하면 한 번 할당된 후 변경할 수 없도록 보장된다.

@Service
public class UserService {

    private final UserRepository userRepository;
    private final PasswordEncoder passwordEncoder;

    @Autowired
    public UserService(UserRepository userRepository, PasswordEncoder passwordEncoder) {
        this.userRepository = userRepository;
        this.passwordEncoder = passwordEncoder;
    }
}

💡 final 키워드를 사용하면?

필드가 한 번 초기화되면 변경할 수 없으므로 불변성이 유지된다.

필드 값이 변경될 여지가 없으므로 안정적인 코드 유지가 가능하다.

Lombok과 함께 사용하면 생성자 주입을 더욱 간편하게 구현 가능하다.

 

3️⃣ Lombok을 활용한 생성자 자동 생성

위와 같은 생성자 주입 코드를 모든 서비스 클래스마다 직접 작성하는 것은 비효율적이다.

이때 Lombok의 @RequiredArgsConstructor를 사용하면 자동으로 생성자 주입을 처리할 수 있다.

@Service
@RequiredArgsConstructor
public class UserService {

    private final UserRepository userRepository;
    private final PasswordEncoder passwordEncoder;

}

 

🔥 Lombok + Spring의 강력한 조합

@RequiredArgsConstructor는 모든 final 필드를 포함하는 생성자를 자동 생성한다.

Spring4.3부터는 생성자가 하나만 존재하면 @Autowired를 생략해도 자동으로 주입된다.

따라서 @RequiredArgsConstructor를 사용하면 불필요한 생성자 코드 없이 깔끔한 코드를 유지할 수 있다.

 

 

 

 

 

📃 reference

• https://mangkyu.tistory.com/155