1. JPA 는 어떻게 탄생 하였을 까 ?
JPA (Java Persistence API) 는 ORM (Object Relational Mapping) 기술로 ORM 기술을 기원으로 하고 있다. ORM 기술의 역사를 살펴보면 대형 소프트웨어 기업들의 상업적 목적에 의하여 기술이 좌지우지 되는 것을 목도할 수 있다.
Toplink 을 시작으로 ORM 이 시작되었지만, 대형 소프트웨어 벤더(IBM, BEA, Sun, Oracle ) 주도하에 나중에 시작된 기술인 EJB 2.0 기술이 폭팔적으로 성장하기 시작하였다. (당시는 자바 기반의 응용 프로그램을 개발하려면 대부분 사용 WAS 제품을 사용해야 했기 때문에 대형 소프트웨어 회사의 영향력이 아주 강력했다. Toplink 를 개발한 Objectivity 는 1999년 Oracle 에 인수되었다.)
1.1 ORM
Object Relational Mapping (이하 ORM) 은 객체 지향 프로그램 과 (보통) 관계형 데이터베이스 (테이블) 간의 데이터 변환을 위한 기술을 의미한다. 간단히 말해, ORM은 객체를 관계형 모델(데이터베이스 테이블) 에 매핑하거나 그 반대로 매핑하는 작업을 구현하기 위한 기술이라고 할 수 있다. 
ORM 도구는 모델에 해당하는 클래스가 데이터베이스에서 테이블이 되고 각 인스턴스가 테이블의 행이 되는 방식으로 매핑을 수행한다. Java 언어에서 사용할 수 있는 ORM 도구로는 Hibernate, Oracle TopLink, EclipseLink, Apache OpenJPA 등 여러 가지가 있다.
1.2 JPA (Java Persistence API)
JPA는 Java Persistence API(Application Programming Interface)의 약자로 2006년 5월 11일에 처음 출시되었다. ORM 도구에 몇 가지 기능과 표준을 제공하는 사양 으로 자바 객체와 관계형 데이터베이스 간의 데이터를 검사, 제어 및 보존하는 데 사용된다. 자바에서는 객체 관계형 매핑의 표준 기술로 간주된다.JPA는 자바 표준을 의미하며 구현자체를 의미하는 것은 아니다. Object Relational Mapping (이하 ORM) 을 구현하기 위한 인터페이스를 설정하기 위한 일련의 규칙과 지침이다. 이런 이유에서 JPA 기술을 사용하려고 한다면 Hibernate 와 같은 구현체가 필요하다. (Spring DATA Jpa 역시 Jpa 구현을 위하여 Hibernate 기술을 사용한다.)
1.3 Hibernate
Hibernate는 2001년 Gavin King 이 Cirrus Technologies 출신의 동료들과 함께 복잡성을 줄이고 일부 누락된 기능을 추가하여 EJB2보다 더 나은 지속성 기능을 제공할 목적으로 출발하였다. 이 프레임워크는 당시 매우 인기 있고 필요성이 높았기 때문에 많은 아이디어가 채택되어 첫 번째 JPA 사양에 코드화되었다.서로 얽혀 있는 역사로 인해 Hibernate 와 JPA는 종종 혼동되기도 하지만 Hibernate 는 수많은 JPA 도구 중 하나일 뿐이다.
오늘날 Hibernate ORM 은 가장 성숙한 JPA 구현 중 하나이며, 여전히 Java 에서 ORM 구현을 위한 인기 있는 옵션이다.
2. Spring Data JPA
Spring Data JPA는 리포지토리( Repository , JPA를 한단계 더 추상화한계층 ) 를 통하여 데이터 액세스 로직을 캡슐화하고 비즈니스 로직과 데이터 액세스 코드를 명확하게 분리하는 것을 이론을 기반으로 한다.
3. Spring Data JPA 시작하기
◼︎ 환경
- Model : MacBook Pro (14-inch, 2021)
- CPU : Apple M1 Pro
- MENORY : 16GB
- DISK : 512 GB SSD
- OS : macOS 13.2.4 (22F66)
- TOOLS : Visual Studio Code, Java 11, Gradle, Docker
- Version Control : GitHub
- Programming Language : Java
- Framework : Spring Boot 2.7.12
- DBMS : MySql 8.0.33
dependencies {
implementation 'org.springframework.boot:spring-boot-starter-web'
implementation 'org.springframework.boot:spring-boot-starter-freemarker'
implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
다음으로 ❷ Spring Boot applicaiton.properties 또는 application.yml 파일에 JAP 관련 설정을 추가한다.
---
spring:
### JPA Setting ###
jpa:
database-platform: org.hibernate.dialect.MySQLInnoDBDialect
show-sql: true
- spring.jpa.database-platform : SQL 문을 생성할 때 Spring Data JPA가 사용해야 하는 데이터베이스 플랫폼으로 org.hibernate.dialect.Dialect 을 구현하는 클래스 이름. → https://javabydeveloper.com/what-is-dialect-in-hibernate-and-list-of-dialects/
- spring.jpa.defer-datasource-initialization : DataSource 초기화를 지연시키는 여부를 제어하는 속성. (디폴트 : false) 이 옵션을 사용하면 데이터베이스가 초기화될 때까지 JPA 리소스가 초기화되지 않는다. 이는 데이터베이스 초기화가 오래 걸리는 경우 JPA 리소스가 초기화되는 동안 응답이 지연하는 것을 방지하는 데 도움을 줌.
- spring.jpa.generate-ddl : 이터베이스를 초기화할지 여부를 제어하는 속성으로 디폴트는 fasle. 스키마를 자동으로 생성하는 것은 성능 등의 여러 이슈가 주의가 필요.
- spring.jpa.open-in-view : 트랜잭션이 완료된 후에도 엔티티를 열린 상태로 유지할지 여부를 결정. (디폴트 : true)
- spring.jpa.show-sql: SQL 로그 출력 여부 (디폴트 : false)
4. Entity
4.1 Entity 클래스
Spring Data JPA 는 엔터티 클래스는 다음과 같은 방법으로 생성한다.
- @Entity 어노테이션을 클래스에 추가.
- @Id 어노테이션을 클래스의 기본 키 속성에 추가. (PK)
- @GeneratedValue 어노테이션을 클래스의 기본 키 속성에 추가하여 기본 키를 생성하는 방법을 지정.
- 클래스의 다른 속성에 @Column 어노테이션을 추가하여 데이터베이스 컬럼을 매핑.
import java.util.Date;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.Table;
import org.springframework.data.annotation.CreatedDate;
import org.springframework.data.annotation.LastModifiedDate;
@Entity(name="role")
@Table(name = "AC_UI_ROLE")
public class Role {
@Id // tell persistence provider 'id' is primary key
@Column(name = "ROLE_ID", nullable = false)
@GeneratedValue( // tell persistence provider that value of 'id' will be generated
strategy = GenerationType.IDENTITY // use RDBMS unique id generator
)
private long roleId;
@Column(name = "NAME", nullable = false)
private String name;
@Column(name = "DESCRIPTION", nullable = false)
private String description;
}
이 코드는 Role 클래스를 생성하고 roleId, name, description 속성을 정의한다. roleId 속성은 기본 키이고 GeneratedValue 어노테이션을 사용하여 AUTO 전략으로 생성된다. name 과 description 속성은 Column 어노테이션을 사용하여 데이터베이스 컬럼 NAME 과 DESCRIPTION 에 매핑된다.
4.2 기본키 생성 방법 정의
Spring Data JPA 는 엔터티 클래스의 기본 키 생성하는 방법을 정의하는 @GeneratedValue 어노테이션을 제공한다. GeneratedValue 어노테이션은 strategy 속성을 사용하여 키를 생성하는 방법을 지정한다.
- IDENTITY - 데이터베이스에서 기본 키를 자동으로 생성.
- SEQUENCE - 시퀀스를 사용하여 기본 키를 생성.
- TABLE - 테이블을 사용하여 기본 키를 생성. (데이터베이스 기능을 사용하는 것을 권고)
- AUTO - 데이터베이스에서 기본 키를 자동으로 생성하거나 시퀀스를 사용하여 기본 키를 생성.
기본 키를 생성하는 방법을 선택할 때는 데이터베이스의 특성과 요구 사항을 고려해야 한다. 예를 들어, 데이터베이스가 기본 키를 자동으로 생성하는 기능을 지원하지 않는 경우 SEQUENCE 또는 TABLE 전략을 사용해야 한다.
Lombok 은 자바 코드에서 일반적으로 사용되는 코드를 자동으로 생성하는 도구이다. Lombok 을 사용하면 Spring DATA JPA Entity를 생성하는 데 필요한 코드의 양을 줄일 수 있다.
5. Repository
5.1 Repository 인터페이스Spring 에서 @Repository 어노테이션은 다양한 방법으로 구현될 수 있는 인터페이스를 정의하기 위해 데이터 액세스 계층에서 사용된다. 이를 통하여 서비스 구현 코드에 영향을 주지 않고 다른 데이터 액세스 API 및 프레임워크를 유연하게 선택할 수 있다.public interface CustomerRepository extends JpaRepository<Customer, Long> {
// repository methods
}
// repository methods
}
- CrudRepository : JPA 엔터티에 대한 기초적인 CRUD (create, read, update, delete) 기능을 제공.
- PagingAndSortingRepository : CrudRepository 을 확장하고 페이징과 소팅 기능을 추가.
- JpaRepository : PagingAndSortingRepository 을 확장하고 데이터베이스에 변경 사항을 반영하고 지속성 컨텍스트에서 엔티티를 분리하는 기능과 같은 JPA 전용 기능을 추가.
- CRUD 작업: JpaRepository는 저장, 찾기 ById, 삭제 등과 같은 JPA 엔터티에 대한 일반적인 CRUD 작업에 대한 함수를 제공.
- Query 함수: JpaRepository는 함수 이름 규칙 또는 어노테이션을 사용하여 Query 함수를 정의하는 메커니즘을 제공.
- 페이징 및 정렬 : JpaRepository는 데이터의 패이징 처리 및 정렬을 지원하여 대규모 데이터 세트를 효율적으로 검색할 수 있다.
- 배치 작업: JpaRepository는 일괄 작업을 수행할 수 있는 메커니즘을 제공하여 데이터베이스 호출 횟수를 줄여 성능을 개선.
- 파생 쿼리: JpaRepository는 함수 이름과 매개 변수에서 쿼리를 파생할 수 있어 SQL 문을 작성하지 않고도 사용자 정의 쿼리를 쉽게 작성할 수 있다.
- 감사 (Auditing) : JpaRepository는 감사(Audit) 기능을 지원하여 엔티티 생성, 수정 및 삭제를 추적할 수 있다.
- 표준 지원 : JpaRepository는 표준을 지원하여 JPA API 로 복잡한 쿼리를 생성.
5.2 Query DSL
public interface CustomerRepository extends JpaRepository<Customer, Long> {
List<Customer> findByName(String name);
}
findByName 함수는 지정된 name 값을 가진 Customer 객체 목록을 검색하는 조회 함수이다. 내부적으로 Spring Data 는 함수 이름과 엔터티 속성의 이름을 기반으로하여 JPA 쿼리를 생성하며, 이는 다음 JPQL 과 같다.
SELECT u FROM User u WHERE u.name = :name
name 변수는 같은 이름의 함수 인자 값으로 바인딩 되고, 함수는 쿼리 조건과 일치하는 Customer 객체 목록을 리턴하게 된다. 함수 이름을 사용하여 쿼리 정의하는 것을 Query DSL (Domain Specific Language) 라고 한다.
함수 이름으로 자동 생성되는 쿼리는 "Spring Data JPA - Reference Documentation 5.1.3 Query Methods" 규칙을 따른다. 참고 ➜ https://docs.spring.io/spring-data/jpa/docs/current/reference/html/#jpa.query-methods.query-creation
AND — OR
findByFirstNameAndLastName(String firstName, String lastName)→ JPQL :
SELECT e FROM EntityClass e WHERE e.firstName = :firstName AND e.lastName = :lastName
→ SQL :
SELECT * FROM entity_table WHERE first_name = ? AND last_name = ?
5.3 @Query
@Query("select u.userId from LocalUser u where u.username like CONCAT('%', :keyword, '%')
or u.name like CONCAT('%', :keyword, '%')
or u.email like CONCAT('%', :keyword, '%')")
public Page<Long> findAllUserIdByNameOrUsernameOrEmail(
@Param("keyword") String keyString, Pageable pageable);
@Param 어노테이션을 사용 사용자 정의 JPQL 쿼리에서 이름을 사용하여 파라메터 값을 지정할 수 있다. 아래와 같이 함수 인자로 전달된 파라메터 순서 값을 사용할 수 도 있다.
@Query("select gr.roleId from GroupRoles gr join GroupMembership gm
on (gr.groupId = gm.groupId ) where gm.userId = ?1")
List<Long> findRoleIdsByUserId(long userId);
5.4 @Modifying
사용자 정의 쿼리를 사용한 데이터 업데이트는 @Modifying 어노테이션을 추가한다.
?1 은 함수의 첫번째 인자 값을 의미한다.
@Modifying
@Query("update role r set r.description = ?1")
int updateDescription( String description );
?1 은 함수의 첫번째 인자 값을 의미한다.
5.5 페이징과 정렬
페이징과 정렬은 Pageable 인터페이스를 사용하며 Pageable 는 PageRequest 클래스를 사용 생성하여 사용한다. 결과 값은 Page 인터페이스 사용한다.
Pageable 인터페이스는 다음과 같은 속성을 가지고 있다.
@Repository
public interface LocalUserRepository extends JpaRepository<LocalUser, Long> {
@Query("select u.userId from LocalUser u")
public List<Long> findAllUserIdAsList(Pageable pageable);
@Query("select u.userId from LocalUser u")
public Page<Long> findAllUserId(Pageable pageable);
}
Page<Long> foundIDs =
localUserRepository.findAllUserId(PageRequest.of(1, 10) );
예제는 페이지 번호가 1 (즉, 두 번째 페이지)이고 페이지 크기가 10인 PageRequest 객체를 생성한다. findAllUserId() 함수는 전체 건수와 페이징 처리되어 조회된 결과를 포함한 Page<Long> 객체를 리턴한다.
- pageNumber - 페이지 번호
- pageSize - 페이지 크기
- sort - 정렬 순서
PageRequest 클래스는 Pageable 인터페이스의 구현이다. PageRequest 클래스는 다음과 같은 생성자를 가지고 있다.
- PageRequest(int pageNumber, int pageSize)
- PageRequest(int pageNumber, int pageSize, Sort sort)
- content - 페이징 된 결과
- number - 페이지 번호
- size - 페이지 크기
- totalElements - 총 요소 수
- totalPages - 총 페이지 수
Controller 에서는 @PageableDefault 어노테이션을 사용하면 요청된 파라메터 값에서 Pagable 객체를 생성하고 이를 서비스 객체에 인자로 전달하여 페이징된 결과를 조회할 수 있다.
@GetMapping("/categories")
ItemList findAll( @PageableDefault(size=100, sort="categoryId", direction = Sort.Direction.DESC) Pageable pageable ) {
Page<Category> page = categoryService.findAll(pageable);
return new ItemList(page.getContent(), (int)page.getTotalElements());
}
GET /categories?page=0&size=30&sort=categoryId,DESC 호출은 페이지 크기가 30개인 첫번쩨 페이지를 categoryId 값이 작은 순서로 정렬하여 결과를 리턴하게 된다.
참고자료
- What is JPA? Introduction to Java persistence
- JPA, Hibernate, 그리고 Spring Data JPA의 차이점
- Spring Data JPA - Reference Documentation
- JAVA A brief history of Object Relational Mapping
- Spring Data JPA (By Pankaj)
- Spring Data JPA (By Sachintha Hewawasam)
- Spring Data JPA Custom Queries using @Query Annotation
- 롬복 어노테이션 프로세서
댓글 없음:
댓글 쓰기