데이터 접근 기술- JPA

  JPA(Java Persistence API)는 자바의 ORM(Object-Relational Mapping) 기술 표준입니다. 즉, 자바 객체와 관계형 데이터베이스를 중간에서 매핑해주는 ORM 프레임워크입니다. JPA에 대해서는 이전에 다룬 내용이 있어 다음 링크를 참고하시면 됩니다. 이번 포스팅에서는 진행 중인 프로젝트에 JPA를 적용하며 전체적인 그림만 보겠습니다.

 

01. JPA(Java Persistence API)

02. JPA Mapping Annotation

03. JPA 연관관계 관리

04. JPA 값 타입

05. JPA 객체지향 쿼리 언어(JPQL)

 

JPA 설정

의존성(build.gradle)

  spring-boot-starter-data-jpa는 spring-boot-starter-jdbc도 함께 포함하기에 이전에 추가한 spring-boot-starter-jdbc는 제거합니다. mybatis-spring-boot-starter도 spring-boot-starter-jdbc를 포함합니다.

//JPA, 스프링 데이터 JPA 추가
implementation 'org.springframework.boot:spring-boot-starter-data-jpa'

//JdbcTemplate 제거
//implementation 'org.springframework.boot:spring-boot-starter-jdbc'

  다음과 같은 라이브러리가 추가됩니다.

• hibernate-core: JPA 구현체인 하이버네이트 라이브러리
• jakarta.persistence-api: JPA 인터페이스
• spring-data-jpa: 스프링 데이터 JPA 라이브러리

 

application.properties

logging.level.org.hibernate.SQL=DEBUG
logging.level.org.hibernate.type.descriptor.sql.BasicBinder=TRACE

• logging.level.org.hibernate.SQL=DEBUG: 하이버네이트가 생성하고 실행하는 SQL을 확인할 수 있습니다.
• logging.level.org.hibernate.type.descriptor.sql.BasicBinder=TRACE: SQL에 바인딩 되는 파라미터를 확인할 수 있습니다.
• spring.jpa.show-sql=true: 이전 설정은 logger를 통해서 SQL이 출력됩니다. 해당 설정은 System.out 콘솔을 통해서 SQL이 출력되기에 권장하지 않습니다.

 

JPA 적용

  객체와 테이블을 매핑하기 위해 Entity 객체를 생성합니다.

package hello.itemservice.domain;

import lombok.Data;

import javax.persistence.*;

@Data
@Entity
public class Item {

    @Id @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    @Column(name = "item_name", length = 10)
    private String itemName;
    private Integer price;
    private Integer quantity;

    public Item() {
    }

    public Item(String itemName, Integer price, Integer quantity) {
        this.itemName = itemName;
        this.price = price;
        this.quantity = quantity;
    }
}

• @Entity: JPA가 사용하는 객체라는 뜻으로, 엔티티라고 합니다.
• @Id: 테이블의 PK와 해당 필드를 매핑합니다.
• @GeneratedValue(strategy = GenerationType.IDENTITY): PK 생성 값을 테이터베이스에서 생성하는 IDENTITY 방식을 사용합니다. 예) MySQL auto increment
• @Column: 객체의 필드를 테이블의 컬럼과 매핑합니다. name에는 테이블의 컬럼명을, length에는 컬럼의 길이를 지정해 주었습니다. @Column을 생략할 경우 객체 필드의 카멜 케이스를 테이블 컬럼의 언더스코어로 자동으로 변환해줍니다.
• JPA는 public 또는 protected의 기본 생성자가 필수입니다. 위 예제처럼 기본 생성자를 넣어주거나 @NoArgsConstructor 애노테이션을 사용합니다.

 

  다음은 ItemRepository의 구현체와 Config 파일을 만들고 적용하는 코드입니다.

package hello.itemservice.repository.jpa;

import hello.itemservice.domain.Item;
import hello.itemservice.repository.ItemRepository;
import hello.itemservice.repository.ItemSearchCond;
import hello.itemservice.repository.ItemUpdateDto;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Repository;
import org.springframework.transaction.annotation.Transactional;
import org.springframework.util.StringUtils;

import javax.persistence.EntityManager;
import javax.persistence.TypedQuery;
import java.util.ArrayList;
import java.util.List;
import java.util.Optional;

@Slf4j
@Repository
@Transactional // JPA 데이터 변경 시 트랜잭션 필수 !!
public class JpaItemRepository implements ItemRepository {

    private final EntityManager em;

    public JpaItemRepository(EntityManager em) {
        this.em = em;
    }

    @Override
    public Item save(Item item) {
        em.persist(item);
        return item;
    }

    @Override
    public void update(Long itemId, ItemUpdateDto updateParam) {
        Item findItem = em.find(Item.class, itemId);
        findItem.setItemName(updateParam.getItemName());
        findItem.setPrice(updateParam.getPrice());
        findItem.setQuantity(updateParam.getQuantity());
    }

    @Override
    public Optional<Item> findById(Long id) {
        Item item = em.find(Item.class, id);
        return Optional.ofNullable(item);
    }

    @Override
    public List<Item> findAll(ItemSearchCond cond) {
        String jpql = "selectxxx i from Item i";

        Integer maxPrice = cond.getMaxPrice();
        String itemName = cond.getItemName();

        if (StringUtils.hasText(itemName) || maxPrice != null) {
            jpql += " where";
        }

        boolean andFlag = false;
        List<Object> param = new ArrayList<>();
        if (StringUtils.hasText(itemName)) {
            jpql += " i.itemName like concat('%',:itemName,'%')";
            param.add(itemName);
            andFlag = true;
        }

        if (maxPrice != null) {
            if (andFlag) {
                jpql += " and";
            }
            jpql += " i.price <= :maxPrice";
            param.add(maxPrice);
        }

        log.info("jpql={}", jpql);

        TypedQuery<Item> query = em.createQuery(jpql, Item.class);
        if (StringUtils.hasText(itemName)) {
            query.setParameter("itemName", itemName);
        }
        if (maxPrice != null) {
            query.setParameter("maxPrice", maxPrice);
        }
        return query.getResultList();
    }
}

• em.persist(item): 객체를 테이블에 저장합니다.
• update(): JPA는 트랜잭션이 커밋되는 시점에 변경된 엔티티 객체가 있는지 확인하고 UPDATE SQL을 실행합니다.
• em.find(): 엔티티 객체를 PK 기준으로 조회합니다.
• findAll: 여러 데이터를 복잡한 조건으로 조회할 경우, JPQL(Java Persistence Query Language)를 사용합니다. 동적 쿼리 문제가 존재합니다.

package hello.itemservice.config;

import hello.itemservice.repository.ItemRepository;
import hello.itemservice.repository.jpa.JpaItemRepository;
import hello.itemservice.repository.mybatis.ItemMapper;
import hello.itemservice.repository.mybatis.MyBatisItemRepository;
import hello.itemservice.service.ItemService;
import hello.itemservice.service.ItemServiceV1;
import lombok.RequiredArgsConstructor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import javax.persistence.EntityManager;

@Configuration
public class JpaConfig {

    private final EntityManager em;

    public JpaConfig(EntityManager em) {
        this.em = em;
    }

    @Bean
    public ItemService itemService() {
        return new ItemServiceV1(itemRepository());
    }

    @Bean
    public ItemRepository itemRepository() {
        return new JpaItemRepository(em);
    }

}

@Import(JpaConfig.class)
@SpringBootApplication(scanBasePackages = "hello.itemservice.web")
public class ItemServiceApplication {}

 

JPA 예외

  JPA는 PersistenceException과 그 하위 예외를 발생시킵니다. 추가로 IllegalStateException, IllegalArgumentException을 발생시킬 수 있습니다. @Repository가 JPA 예외를 스프링 예외 추상화(DataAccessException)로 변환합니다.

 

@Repository

• @Repository가 붙은 클래스는 컴포넌트 대상이 됩니다.
• @Repository가 붙은 클래스는 예외 변환 AOP의 적용 대상이 됩니다.

 

[참고 정보]

스프링 DB 2편 - 데이터 접근 핵심 원리

전체 소스코드