Lombok 설치 및 STS 연동

Lombok이란?

Getter/Setter/ToString과 같은 매서드를 자동으로 생성/연결해주는 자바 라이브러리로 사용 시 코드량을 줄이는데 도움을 받을 수 있다.

 

설치 방법

홈페이지에 접속하여, 원하는 버전을 선택한 이후 Maven 탭의 dependency 내용을 복사하여, pom.xml에 입력하면 된다.

https://mvnrepository.com/artifact/org.projectlombok/lombok 

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.20</version>
    <scope>provided</scope>
</dependency>

위와 같은 형태로, 보통은 버전 정보만 본인이 사용하려고 하는 버전으로 입력해주면 된다.

 

Lombok은 @Data 어노테이션을 사용하여 getter, setter 생성자를 자동으로 생성할 수 있지만, 별도의 jar 파일을 다운로드하지 않으면 어노테이션은 사용할 수 있으나 생성자가 생성되지 않는 것을 확인할 수 있다. 

package com.land.domain;

import java.sql.Date;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@AllArgsConstructor
@NoArgsConstructor
public class Member {
	private Long idx;
	private String userId;
	private Date regDate;
	private Date modDate;
}

 

해당 문제를 해결하기 위하여, 별도의 jar 파일을 다운로드하여 설정하여야한다.

 

두 가지 방법이 존재하는데, 

• https://projectlombok.org/all-versions 에서 원하는 버전을 다운로드하여서 jar 파일을 사용하거나,
• Maven을 이용해 다운로드한 경우 maven repository 내 lombok 디렉토리에 jar 파일을 찾는다. (사용자\사용자명\.m2\repository\org\projectlombok\lombok\버전)

위와 같이 jar 파일을 다운로드하면, cmd (명령 프롬프트)를 실행하여 jar 파일을 실행시킨다.

 

Specify location을 클릭하여, STS(eclipse) 실행 파일을 선택한 뒤에, Install / Update를 누르면 정상적으로 lombok을 설치할 수 있다.

 

 

정상적으로 설치되는 경우, @Data 어노테이션을 설정하면, Outline에 정상적으로 getter 및 setter 등이 생성되는 것을 확인할 수 있다.

 

 

에러 해결

위와 같이 설정을 하는 경우 대부분 lombok 라이브러리를 정상적으로 사용할 수 있으나, 사용이 되지 않는 경우 STS가 설치된 폴더로 들어가서 SpringToolSuite4.ini 파일을 실행하여 -vmargs 아래 위치에 설정을 추가하면, 정상적으로 라이브러리를 사용할 수 있다.

 

-javaagent:lombok.jar
-Xbootclasspath/a:lombok.jar

 

혹은 아래와 같이, lombok.jar 파일의 위치를 직접 지정하여 설정하는 것도 가능하다.

 

-javaagent:C:\DEV\sts-4.5.1.RELEASE\lombok.jar