Project Lombok은 자바 코드의 반복적인 작업을 줄이고, 생산성을 향상시키는 라이브러리입니다. Lombok은 어노테이션(Annotation)을 통해 getter, setter, constructor 등의 보일러플레이트 코드를 자동으로 생성해줍니다.
Lombok을 사용하는 이유
- 코드 간소화:
toString(), equals(), hashCode(), getters, setters 등의 일반적인 메서드를 자동으로 생성합니다.
- 가독성 향상: 불필요한 코드가 줄어들어 코드의 의도가 더 명확하게 드러납니다.
- 개발 시간 단축: 작성해야 할 코드가 줄어들어 비즈니스 로직에 집중할 수 있습니다.
- 리팩토링 용이성: 필드 이름을 변경하더라도 getter/setter를 따로 수정할 필요가 없습니다.
Lombok의 주요 기능
Lombok은 수많은 주석을 제공합니다. 다음은 몇 가지 주요 기능을 살펴보겠습니다.
@Data
모든 필드에 대한 getter를 생성하고, toString(), equals(), hashCode() 메서드와 생성자를 자동으로 만듭니다. 또한, final 필드에 대해 setter도 생성합니다.
1
2
3
4
5
| @Data
public class User {
private String name;
private String email;
}
|
생성되는 코드:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
| 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;
}
@Override
public boolean equals(Object o) {
}
@Override
public int hashCode() {
}
@Override
public String toString() {
return "User{" +
"name='" + name + '\'' +
", email='" + email + '\'' +
'}';
}
}
|
2. @NonNull
메서드 또는 생성자의 매개변수에 대해 null 체크를 자동으로 추가합니다.
1
2
3
| public void setUsername(@NonNull String username) {
this.username = username;
}
|
3. @Cleanup
특정 리소스를 자동으로 정리하여 리소스 누수를 방지합니다.
1
2
3
4
| public void readData(String path) throws IOException {
@Cleanup InputStream in = new FileInputStream(path);
}
|
4. @SneakyThrows
메서드 선언에 throws를 명시하지 않고도 체크 예외를 던질 수 있습니다.
1
2
3
4
| @SneakyThrows
public void readFile(String path) {
Files.readAllBytes(Paths.get(path));
}
|
5. @Builder
객체 생성을 위한 빌더 패턴을 자동으로 구현합니다.
1
2
3
4
5
| @Builder
public class User {
private String name;
private String email;
}
|
생성되는 코드:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
| public class User {
private String name;
private String email;
public static UserBuilder builder() {
return new UserBuilder();
}
public static class UserBuilder {
private String name;
private String email;
public UserBuilder name(String name) {
this.name = name;
return this;
}
public UserBuilder email(String email) {
this.email = email;
return this;
}
public User build() {
return new User(name, email);
}
}
}
|
6. @Value
@Data의 불변(immutable) 버전으로, 모든 필드를 private 및 final로 설정하며 setter를 생성하지 않습니다.
1
2
3
4
5
| @Value
public class User {
String name;
String email;
}
|
7. 생성자 어노테이션
Lombok은 생성자를 자동으로 생성하는 여러 어노테이션을 제공합니다.
@NoArgsConstructor
인수 없는 생성자를 생성합니다. 프레임워크(JPA 등)에서 필요한 경우 유용합니다.
1
2
3
4
5
6
7
| @NoArgsConstructor
public class User {
private String name;
private String email;
public User() {}
}
|
@RequiredArgsConstructor
final 필드 및 @NonNull 필드에 대해 생성자를 생성합니다.
1
2
3
4
5
6
7
8
9
10
| @RequiredArgsConstructor
public class User {
@NonNull private final String name;
private String email;
public User(@NonNull String name) {
if (name == null) throw new NullPointerException("name");
this.name = name;
}
}
|
@AllArgsConstructor
모든 필드에 대한 생성자를 생성합니다.
1
2
3
4
5
6
7
8
9
10
| @AllArgsConstructor
public class User {
private String name;
private String email;
public User(String name, String email) {
this.name = name;
this.email = email;
}
}
|
IntelliJ 및 Eclipse에서 Lombok 설정
IntelliJ IDEA
- 플러그인 설치: 마켓플레이스에서 Lombok 플러그인을 설치합니다.
- 어노테이션 프로세싱 활성화:
Settings > Build, Execution, Deployment > Compiler > Annotation Processors에서 활성화.
Eclipse
- Lombok JAR 다운로드 및 실행: Eclipse 설치 경로에 Lombok을 통합합니다.
- 재시작 및 설정 확인: 프로젝트 속성에서 어노테이션 프로세싱 활성화.
Maven 및 Gradle 통합
1
2
3
4
5
6
| <dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.22</version>
<scope>provided</scope>
</dependency>
|
1
2
3
4
| dependencies {
compileOnly 'org.projectlombok:lombok:1.18.22'
annotationProcessor 'org.projectlombok:lombok:1.18.22'
}
|
결론
Lombok은 특히 Spring Boot 생태계에서 자바 개발자에게 필수적인 도구로 자리 잡았습니다. 보일러플레이트 코드를 줄이고 유지보수를 간소화하며, 코드 생산성을 크게 향상시킵니다.
Lombok을 제대로 이해하고 활용하면, Spring Boot 애플리케이션 개발의 효율성이 크게 향상될 것입니다.