[Java] Lombok 라이브러리를 사용한 JDBC 프로그래밍

[ Lombok 이란? ]

@어노테이션 기반으로 코드를 자동완성 해주는 라이브러리이다. Lombok을 이용하면 Model 클래스의 getter,setter 등 다양한

메서드들을 작성하지 않아도 자동완성 시켜주기 때문에 코드가 간결하고 단순화되는 장점이 있다. 

 

[ Lombok 사용 예제 ]

Lombok 사용 ❌

☑️ Lombok을 사용하지 않으면 Getter, Setter 메서드를 아래와 같이 작성해야 한다.(코드가 길어진다)

public class TodoDTO {
    private Long tno;
    private String title;
    private LocalDate dueDate;
    private boolean finished;

    public Long getTno() {
        return tno;
    }
 
	...생략...

    public boolean isFinished() {
        return finished;
    }

    public void setFinished(boolean finished) {
        this.finished = finished;
    }
}

Lombok 사용 ⭕

☑️ Lombok을 사용하면 @Getter , @Setter 어노테이션을 선언해주면 아래와 같이 간결한 코드 작성이 가능하다.

☑️ 코드 다이어트 효과

@Getter
@Setter
public class TodoDTO {
    private Long tno;
    private String title;
    private LocalDate dueDate;
    private boolean finished;
}

[ Lombok의 장점 ]

• 어노테이션 기반의 코드 자동 생성을 통한 생산성 향상
• 반복되는 코드 다이어트를 통한 가독성 및 유지보수성 향상
• Getter, Setter 외에 빌더 패턴이나 로그 생성 등 다양한 방면으로 활용 가능

---

[ 자주 사용되는 Lombok 어노테이션 ]

 

@NorgsConstructor	파라미터가 없는 기본 생성자 생성
@AllArgsConstructor	모든 필드 값을 파라미터로 받는 생성자 생성
@RequiredArgsConstructor	final 이나 @NonNull 필드 값만 파라미터로 받는 생성자 생성
@EqualsAndHashCode	equals와 hashcode를 자동으로 생성해주는 어노테이션
@Data	Getter, Setter, RequiredArgsConstructor, ToString, EqualsAndHashCode를 한번에 설정해주는 어노테이션
@Builder	자동으로 해당 클래스에 빌더 추가
@Cleanup	close()처리 코드를 자동으로 컴파일 시점에 완성, try ~ catch 문이 필요하지 않는 간결한 코드 지원
@Getter	자동으로 해당 클래스에 getter 추가
@Setter	자동으로 해당 클래스에 setter 추가

---

@Builder 어노테이션

@Builder는 객체를 생성할 때 유연하게 값을 설정할 수 있도록 도와준다. 이걸 빌더 패턴이라고 한다.

 

기존 방식(생성자 사용) ❌

☑️ 아래는 builder 어노테이션을 사용하지 않고 기존의 방식대로 생성자를 사용하는 방법이다.

☑️ 매개변수의 순서를 꼭 지켜야하는 점과 모든 값을 한 번에 넣어야 한다

TodoVO vo = new TodoVO(tno, title, dueDate, finished);

 

빌더 패턴 사용 ⭕

☑️ 빌더 패턴을 사용하면 필요한 필드만 선택적으로 설정할 수 있고 가독성이 좋다.

☑️ 또한 새로운 필드가 추가되더라도 쉽게 수정할 수 있어 유지보수에 용이하다.

TodoVO vo = TodoVO.builder()
        .tno(resultSet.getLong("tno"))
        .title(resultSet.getString("title"))
        .dueDate(resultSet.getDate("dueDate").toLocalDate())
        .finished(resultSet.getBoolean("finished"))
        .build();

 

빌더 패턴을 사용하려면 @Builder 어노테이션 을 사용하거나, 직접 빌더 클래스를 만들어서 사용한다.

import lombok.Builder;
import lombok.Data;

@Data
@Builder
public class TodoVO {
    private Long tno;
    private String title;
    private LocalDate dueDate;
    private boolean finished;
}

---

@Cleanup 어노테이션

@cleanup 은 자동으로 리소스를 close() 해주는 역할을 한다.

 

기존 방식 ❌

☑️ 기존 방식에서는 finally 블록에서 close()를 수동으로 호출해야 한다.

☑️ try-catch 문을 여러 번 사용해야 해서 코드가 길어지고 가독성이 떨어진다.

    public String getTime(){
        String now = null;

        try(Connection connection = ConnectionUtil.INSTANCE.getConnection();
            PreparedStatement preparedStatement = connection.prepareStatement("select now()");
            ResultSet resultSet = preparedStatement.executeQuery();
        ){

            resultSet.next();

            now = resultSet.getString(1);
        } catch (Exception e){
            e.printStackTrace();
        }
        return now;
    }

 

@cleanup 사용 ⭕

☑️ 자동으로 close()를 호출하고, try-finally 없이도 코드 작성이 가능하다.

☑️ 가독성이 좋아지고 코드가 간결해진다.

	public String getTime2() throws Exception {
        @Cleanup Connection connection = ConnectionUtil.INSTANCE.getConnection();
        @Cleanup PreparedStatement preparedStatement = connection.prepareStatement("select now()");
        @Cleanup ResultSet resultSet = preparedStatement.executeQuery();

        resultSet.next();

        String now = resultSet.getString(1);

        return now;

    }

---

🌟 정리

✅ JDBC 프로그래밍 과정에서 리소스를 안전하게 정리하는데 도움을 준다

✅ 가독성이 좋아지고 코드가 간결해진다 

✅ 필드가 많거나 선택적으로 값을 넣고 싶을 때 유용하다