[Java] Lombok 롬복에 대해 알아보기

Java/Spring으로 프로젝트를 하면서 Lombok 라이브러리를 많이 사용했었다.

Lombok 덕분에 코드를 작성할 때 편했지만, 무지성으로 막 갖다쓰다가 낭패를 본 경우도 있었다.(toString 순환 참조, 생성자 순서 안맞음...)

 

 

Lombok에 대해 다시 정리해보고, 단점과 주의사항에 대해서도 알아보고자 한다!

 

 

 

 

 

https://plugins.jetbrains.com/files/6317/502595/icon/pluginIcon.png

 

 

 

 

 

 Lombok은 인도네시아에 있는 Lombok 섬에서 이름을 따서 만들었다는데, 왜 아이콘은 Red chilli일까 궁금해졌다.

Project Lombok의 슬로건을 보면 'Spice up your java(자바에 맛을 더하다)'인데, 'Spice(향신료)' 때문에 Red chilli 아이콘을 쓰는 것 같다! (추측)

 

 

 

 

 

 

Lombok 이란?

---

 Lombok은 자동적으로 `getter`, `setter`, `toString()`, `생성자` 등을 생성해주는 자바 라이브러리이다.

 

코드를 작성할 때 클래스에 @어노테이션만 붙인다면, 컴파일하는 과정에서 알아서 해당 코드가 생성된다.

 

 

 

 

 

Lombok 적용 전

public class Person {
    private String name;
    private int age;

    public String getName() {return name;}

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

    public int getAge() {return age;}

    public void setAge(int age) {this.age = age;}

    public Person() {}

    public Person(String name, int age) {
        this.name = name;
        this.age = age;
    }

    @Override
    public String toString() {
        return "Person{" + "name='" + name + '\'' + ", age=" + age + '}';
    }
}

 

 

 

Lombok 적용 후

import lombok.*;

@Getter
@Setter
@ToString
@NoArgsConstructor
@AllArgsConstructor
public class Person {
    private String name;
    private int age;
}

 

 

 

 

 

 

@어노테이션 종류

---

@Getter / @Setter

`getter`와 `setter`를 생성해준다.

 

public String getName() {
	return name;
}

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

 

 

 

 

 

@ToString

`toString()` 메소드를 생성해준다.

@Override
public String toString() {
	return "Person{" + "name='" + name + '\'' + ", age=" + age + '}';
}

 

 

 

 

@EqualsAndHashCode

`equals(o)` 메소드와 `hashCode()` 메소드를 생성해준다.

 

@Override
public boolean equals(Object o) {
	if (this == o) return true;
    if (o == null || getClass() != o.getClass()) return false;
    Person person = (Person) o;
    return age == person.age && Objects.equals(name, person.name);
}

@Override
public int hashCode() {
	return Objects.hash(name, age);
}

 

 

 

 

 

@NoArgsConstructor, @AllArgsConstructor

각각 빈 생성자, 필드가 모두 들어간 생성자를 생성해준다.

//@NoArgsConstructor
public Person() {}

//@AllArgsConstructor
public Person(String name, int age) {
	this.name = name;
    this.age = age;
}

 

 

 

@RequiredArgsConstructor

`final`이 붙거나 `@NotNull`이 붙은 필드의 생성자를 생성해준다.

@Service
@RequiredArgsConstructor
public class PersonService {
    private final PersonRepository personRepository;
}

 

 

Spring 의존성 주입 방식 중 하나인 생성자 주입 방식을 대체한다.

@Service
public class PersonService {
    private final PersonRepository personRepository;

    @Autowired
    public PersonService(PersonRepository personRepository) {
        this.personRepository = personRepository;
    }
}

 

 

 

 

@Data

`@Getter`, `@Setter`, `@ToString`, `@EqualsAndHashCode`, `@RequiredArgsConstructor` 를 모두 포함한다.

 

@Getter
@Setter
@ToString
@EqualsAndHashCode
@RequiredArgsConstructor
public class Person {
    private String name;
    private int age;
}

 

 

 

 

@Builder

Person.builder()
	.name("giraffe")
	.age("1")
	.build();

 

 

 

@Log

private static final java.util.logging.Logger log = java.util.logging.Logger.getLogger(LogExample.class.getName());

 

`@Log4j` 와 같은 로그도 쓸 수 있다.

 

 

 

 

 

 

 

그 외의 어노테이션에 대해서 알고 싶다면 공식 홈페이지를 참고하면 된다.

 

 

 

 

 

Lombok 장점

---

• 어노테이션만 쓰면 알아서 자동으로 메소드를 생성해주기 때문에 편하다.
• 반복적인 코드를 줄일 수 있다. 코드량이 줄어든다.

 

 

 

 

 

Lombok 단점과 주의사항

---

• IDE에서 플러그인을 설치해야 지원된다. 만약 다른 개발환경에서 Lombok 플러그인을 설치하지 않았다면, Lombok으로 개발했던 코드는 Lombok을 인식하지 못해 에러가 난다.

 

• Lombok을 쓰게 되면, 코드가 생략되기 때문에 코드가 어떻게 작동되고 있는지 이해하기가 어렵다. 만약 `toString`, `equals`, `hasCode`와 같이 오버라이딩해서 쓰는 메소드에서 디폴트와 다르게 재정의 할 필요가 있는 경우도 있기 때문에 주의해야 한다. 

 

• `@Data`는 `@RequiredArgsConstructor`도 포함하는데, `@RequiredArgsConstructor`를 사용하면 생성자의 파라미터 순서가 정해져 있기 때문에 변경될 경우 불편하다. 그래서 보통 `@Builder`를 많이 쓴다.

 

• `@ToString` 같은 경우는 순환 참조의 원인이 될 수 있다.

 

 

 

 

 

참고

---

• Project Lombok 공식홈페이지 : https://projectlombok.org
• Lombok 너무 편리하기 때문에 주의해야 한다. (Lombok 주의점) : https://lkhlkh23.tistory.com/159