[Spring] @NoArgsConstructor, @RequiredArgsConstructor, @RequiredArgsConstructor

서론

@NoArgsConstructor, @AllArgsConstructor, @RequiredArgsConstructor 셋 다 Lombok 라이브러리에서 제공하는 어노테이션입니다. 각각의 의미와 언제 사용하는지에 대해 한번 정리해 보겠습니다.

어노테이션	의미
@NoArgsConstructor	파라미터가 없는 기본 생성자를 생성합니다.
@AllArgsConstructor	모든 필드 값을 파라미터로 받는 생성자를 생성합니다.
@RequiredArgsConstructor	final이나 @NonNull인 필드 값만 파라미터로 받는 생성자를 생성합니다.

 

1. @NoArgsConstructor

@NoArgsConstructor은 파라미터가 없는 기본 생성자를 생성합니다. 아래 코드로 한번 설명해 보겠습니다.

import lombok.NoArgsConstructor;

@NoArgsConstructor
public class TestConstructor {
    private String name;
    private int age;

    public TestConstructor(String name, int age) {
        this.name = name;
        this.age = age;
    }
    
    void out() {
        System.out.println("이름: " + name + " 나이: " + age);
    }
}

class TestMain {
    public static void main(String[] args) {
        TestConstructor testConstructor = new TestConstructor();
        testConstructor.out();
    }
}

현재 TestConstructor에는 name과 age를 초기화하는 생성자 메서드가 있습니다. 때문에 원래대로면 인스턴스를 생성할 때 name과 age 파라미터를 넘겨주어야 하는데 위 코드는 넣어주지 않았으니  컴파일 에러를 뱉어냅니다.

하지만 @NoArgsConstructor 애노테이션 덕분에 컴파일 에러 없이 파라미터를 넘겨주지 않더라도 기본 생성자를 생성할 수 있습니다.

 

2. @RequiredArgsConstructor

@RequiredArgsConstructor은 final이나 @NonNull인 필드 값만 파라미터로 받는 생성자를 생성합니다. 

import lombok.RequiredArgsConstructor;

@RequiredArgsConstructor
public class TestConstructor {
    private String name;
    private int age;
    private String sex;

    void out() {
        System.out.println("이름: " + name + " 나이: " + age);
    }
}

class TestMain {
    public static void main(String[] args) {
        TestConstructor testConstructor = new TestConstructor("안주형", 25, "남"); // 컴파일 에러
        testConstructor.out();
    }
}

위 코드는 컴파일 에러가 발생하는 코드입니다. 어디가 잘못되었을까요?

@RequiredArgsConstructor은 final이나 @NonNull인 필드 값만 파라미터로 받는 생성자를 생성한다고 했습니다. 하지만 현재 name, age, sex 변수들은 전부 final도, @NonNull도 아닌 일반 인스턴스 변수 그 자체입니다. 따라서 생성할 수 없는 것입니다. 따라서 아래 코드와 같이 인스턴스 변수를 @NonNull 혹은 final로 지정해주어야 올바르게 컴파일됩니다.

import lombok.NonNull;
import lombok.RequiredArgsConstructor;

@RequiredArgsConstructor
public class TestConstructor {
    @NonNull
    private String name;
    private final int age;
    private final String sex;

    void out() {
        System.out.println("이름: " + name + " 나이: " + age);
    }
}

class TestMain {
    public static void main(String[] args) {
        TestConstructor testConstructor = new TestConstructor("안주형", 25, "남");
        testConstructor.out();
    }
}

 

3. @AllArgsConstructor

@AllArgsConstructor은 모든 필드 값을 파라미터로 받는 생성자를 생성합니다.

import lombok.AllArgsConstructor;

@AllArgsConstructor
public class TestConstructor {
    private String name;
    private int age;
    private String sex;

    void out() {
        System.out.println("이름: " + name + " 나이: " + age);
    }
}

class TestMain {
    public static void main(String[] args) {
        TestConstructor testConstructor = new TestConstructor("안주형", 25, "남");
        testConstructor.out();
    }
}

따로 생성자 메서드를 작성해 주지 않아도 @AllArgsConstructor 어노테이션만 적용하면 생성자 메서드가 작성되어 있는 것처럼 사용할 수 있습니다. 따라서 번거로운 생성자 메서드 작성 작업을 줄일 수 있습니다.

 

참고

https://projectlombok.org/features/constructor