[Spring Study] JPA와 Lombok을 이용하여 테이블 생성하고 테스트하기

안녕하세요, 오늘은 스프링 부트 프로젝트 내에서 Entity 클래스를 생성하고 테스트하는 방법에 대해서 공부한 내용을 정리해보려고 합니다. 우선 저는 실습 프로젝트에서 JPA와 Lombok를 사용하였습니다. 먼저 JPA와 Lombok 이란 무엇인지 간단하게 알아보고 스프링 부트 프로젝트 내에 세팅 방법에 대해서 정리해보도록 하겠습니다.

JPA(Java Persistence API)

JPA(Java Persistence API)는 자바 애플리케이션에서 데이터베이스와 상호작용하기 위한 표준 API입니다. SQL 쿼리를 직접 작성하지 않고도 자바 객체와 데이터베이스 테이블 간의 매핑을 관리할 수 있습니다. 또 데이터베이스와의 상호작용을 객체 지향적으로 처리할 수 있게 도와줍니다.

JPA 주요 개념

엔티티(Entity)

데이터베이스 테이블에 매핑되는 자바 클래스입니다. 각 엔티티 인스턴스는 데이터베이스의 한 행(row)에 해당합니다.

필드(Field)와 열(Column)

엔티티 클래스의 각 필드는 데이터베이스 테이블의 열(column)에 매핑됩니다. 필드에 @Column 애노테이션을 사용하여 매핑 정보를 지정할 수 있습니다.

기본 키(Primary Key)

엔티티 인스턴스의 고유 식별자입니다. @Id 애노테이션을 사용하여 기본 키를 지정합니다.

엔티티 매니저(Entity Manager)

엔티티 인스턴스를 생성, 삭제, 검색 및 관리하는 인터페이스입니다.

영속성 컨텍스트(Persistence Context)

엔티티 인스턴스가 관리되는 환경입니다. 엔티티 매니저가 엔티티 인스턴스를 영속성 컨텍스트에 저장하고 관리합니다.

JPA 주요 애노테이션

@Entity: 클래스를 엔티티로 지정

@Table: 엔티티와 매핑될 테이블 정보를 지정

@Id: 기본 키 지정

@GeneratedValue: 기본 키의 생성 전략 지정

@Column: 필드를 열과 매핑하고, 열의 속성을 지정

@OneToOne, @OneToMany, @ManyToOne, @ManyToMany: 엔티티 간의 관계 지정

JPA 세팅하기

우선 프로젝트 내의 build.gradle (또는 pom.xml) 에 의존성을 추가해야 합니다.

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
    implementation 'org.springframework.boot:spring-boot-starter-web'
}

Lombok

롬복(Lombok)은 자바 애플리케이션에서 반복적인 코드를 줄여주기 위해 사용되는 라이브러리입니다. 롬복을 사용하면 getter, setter, toString, equals, hashCode 등의 메서드를 자동으로 생성할 수 있으며, 빌더 패턴, 로그 생성 등 다양한 기능을 제공하여 코드의 가독성과 유지보수성을 높여줍니다. 이제 롬복에 대해 자세히 설명하겠습니다.

롬복의 주요 기능과 애노테이션

Getter와 Setter 자동 생성

@Getter: 클래스나 필드에 붙여서 getter 메서드를 자동으로 생성

@Setter: 클래스나 필드에 붙여서 setter 메서드를 자동으로 생성

생성자 자동 생성

@NoArgsConstructor: 파라미터가 없는 기본 생성자를 생성

@AllArgsConstructor: 모든 필드를 파라미터로 받는 생성자 생성

@RequiredArgsConstructor: final 필드나 @NonNull 애노테이션이 붙은 필드를 파라미터로 받는 생성자 생성

toString, equals, hashCode 자동 생성

@ToString: toString 메서드 자동으로 생성

@EqualsAndHashCode: equals와 hashCode 메서드 자동으로 생성

빌더 패턴 생성

@Builder: 빌더 패턴을 적용하여 객체를 생성

Lombok 세팅하기

저는 Gradle을 사용하고 있기 때문에 build.gradle 파일에 다음과 같이 의존성을 추가하였습니다.

dependencies {
    compileOnly 'org.projectlombok:lombok:1.18.24'
    annotationProcessor 'org.projectlombok:lombok:1.18.24'
}

추가로 테스트 환경을 위해 다음과 같은 의존성도 추가하였습니다. 이렇게 하면 테스트 코드를 작성할 때 롬복의 기능을 사용할 수 있습니다.

Entity 생성하기

저의 실습코드와 함께 엔티티 생성과정에 대해서 정리하도록 하겠습니다.

우선, @Entity 애노테이션을 사용하여 이 클래스가 JPA 엔티티임을 나타냅니다. 그 다음 @Table(name = “tbl_todo”) 애노테이션을 통해 이 엔티티가 데이터베이스의 tbl_todo 테이블과 매핑됨을 나타냈습니다.

@ToString, @Getter, @Builder, @AllArgsConstructor, @NoArgsConstructor 을 사용하여 자동으로 toString(), getter, 빌더 패턴, 모든 필드를 사용하는 생성자, 기본 생성자를 생성하도록 하였습니다.

만약 테이블이 없는 상태로 프로젝트 실행 시 아래와 같이 create table 쿼리가 실행되며,