시작하며...
스프링 부트 공부 중 도메인 설계에 들어가는 반복적인 코드들을 간결하게 만들어야 할 필요성을 느껴 롬복을 적용하기 위한 롬복 설치 방법 및 적용하는 법에 대해 정리해 봅니다.
Lombok
롬복은 컴파일러 동작 전에 애너테이션을 기반으로 코드 생성하여,
코드의 중복과 불필요한 부분(getter, setter, toString, hashCode, 생성자, equals 메서드 등)을 제거해 간결하게 만드는 이점이 있습니다.
IDE(STS4)에 롬복 적용하기
1. STS에 Lombok이 설치 되어 있는지 확인
2. 롬복 홈페이지(https://projectlombok.org/download)에서 lombok.jar 다운로드
3. 다운로드 받은 폴더로 가서 Shift + 우클릭 하여 "여기서 명령(PowerShell) 창 열기" 후 jar 파일 실행
java -jar lombok.jar
4. Installer가 자동으로 IDE를 찾아주지만 STS가 없으므로 "Specify location" 버튼을 클릭해서 설치되어 있는 STS 선택 후 "Install / Update" 버튼 클릭하여 설치
5. STS에 Lombok이 설치되어 있는지 확인
6. pom.xml 파일 수정을 통해 롬복 종속성을 프로젝트에 추가
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
7. Lombok 테스트
@Data를 추가 후, Outline 창에 getter, setter, equals, hashcode, toString 등이 추가된 것을 확인할 수 있습니다.
마무리
롬복은 자바에서 DTO, VO, Domain Class 등을 작성할 때, 멤버 변수에 대한 Getter, Setter, Equals, Hashcode, ToString과 같은 메서드와 생성자 등을 자동으로 생성하여 코드를 간결하게 만들고 코드 양을 줄일 수 있는 장점이 있습니다.
하지만, 편리한 만큼 사용상 주의를 요하는 부분도 있다는 것을 생각하며 사용해야 될 것 같습니다.
아래의 링크는 롬복 사용 시 주의해야 될 내용을 잘 정리한 블로그 입니다.
- Lombok 사용상 주의점 (https://kwonnam.pe.kr/wiki/java/lombok/pitfall)
- 실무에서 Lombok 사용법 (https://www.popit.kr/실무에서-lombok-사용법)