[Spring DB] 데이터 접근 기술 - JPA

목차

• JPA 시작
• JPA 설정
• JPA 적용1 - 개발
• JPA 적용2 - 리포지토리 분석
• JPA 적용3 - 예외 변환

 

JPA 시작

스프링과 JPA는 자바 엔터프라이즈(기업) 시장의 주력 기술이다.
스프링이 DI 컨테이너를 포함한 애플리케이션 전반의 다양한 기능을 제공한다면, JPA는 ORM 데이터 접근 기술을 제공한다. 실무에서는 JPA를 더욱 편리하게 사용하기 위해 스프링 데이터 JPA와 Querydsl이라는 기술을 함께 사용한다.
중요한 것은 JPA이다. 스프링 데이터 JPA, Querydsl은 JPA를 편리하게 사용하도록 도와주는 도구라 생각하면 된다.

 

 

JPA 설정

spring-boot-starter-data-jpa 라이브러리를 사용하면 JPA와 스프링 데이터 JPA를 스프링 부트와 통합하고, 설정도 아주 간단히 할 수 있다. spring-boot-starter-data-jpa 라이브러리를 사용해서 간단히 설정하는 방법을 알아보자

 

1️⃣ build.gradle 에 다음 의존 관계를 추가한다

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

 

build.gradle 에 다음 의존 관계를 제거한다.

//JdbcTemplate 추가
//implementation 'org.springframework.boot:spring-boot-starter-jdbc'

• spring-boot-starter-data-jpa 는 spring-boot-starter-jdbc 도 함께 포함(의존)한다. 
• 따라서 해당 라이브러리 의존관계를 제거해도 된다. 
• 참고로 mybatis-spring-boot-starter 도 spring-boot-starter-jdbc 를 포함하기 때문에 제거해도 된다.

 

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

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

 

2️⃣ application.properties 에 다음 설정 추가

#JPA 3.0 이상 log
logging.level.org.hibernate.SQL=DEBUG
logging.level.org.hibernate.orm.jdbc.bind=TRACE

#JPA 3.0 이전 log
logging.level.org.hibernate.SQL=DEBUG
logging.level.org.hibernate.type.descriptor.sql.BasicBinder=TRACE

• org.hibernate.SQL=DEBUG : 하이버네이트가 생성하고 실행하는 SQL을 확인할 수 있다.
• org.hibernate.type.descriptor.sql.BasicBinder=TRACE : SQL에 바인딩 되는 파라미터를 확인할 수 있다.
• spring.jpa.show-sql=true : 참고로 이런 설정도 있다. 이전 설정은 logger 를 통해서 SQL이 출력된다. 
• 이 설정은 System.out 콘솔을 통해서 SQL이 출력된다. 따라서 이 설정은 권장하지는 않는다.
• (둘다 켜면 logger , System.out 둘다 로그가 출력되어서 같은 로그가 중복해서 출력된다.)
• 스프링 부트 3.0 이상을 사용하면 하이버네이트 6 버전이 사용되는데, 로그 설정 방식이 달려졌다. 

---

JPA 적용1 - 개발

JPA에서 가장 중요한 부분은 객체와 테이블을 매핑하는 것이다. 

JPA가 제공하는 애노테이션을 사용해서 Item 객체와 테이블을 매핑해보자.

 

Item - ORM 매핑

@Data
@Entity
public class Item {

    @Id @GeneratedValue(strategy = GenerationType.IDENTITY) // DB에서 값을 증가해주는 전략
    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가 사용하는 객체라는 뜻이다. 
• 이 에노테이션이 있어야 JPA가 인식할 수 있다. 이렇게
• @Entity 가 붙은 객체를 JPA에서는 엔티티라 한다.

@Id

• 테이블의 PK와 해당 필드를 매핑한다.

 

@GeneratedValue(strategy = GenerationType.IDENTITY) 

• PK 생성 값을 데이터베이스에서 생성하는 IDENTITY 방식을 사용한다. 
• 예) MySQL auto increment

@Column

• 객체의 필드를 테이블의 컬럼과 매핑한다.
• name = "item_name" : 객체는 itemName 이지만 테이블의 컬럼은 item_name 이므로 이렇게 매핑했다.
• length = 10 : JPA의 매핑 정보로 DDL( create table )도 생성할 수 있는데, 그때 컬럼의 길이 값으로 활용된다. (varchar10) 
• @Column 을 생략할 경우 필드의 이름을 테이블 컬럼 이름으로 사용한다. 
• 참고로 지금처럼 스프링 부트와 통합해서 사용하면 필드 이름을 테이블 컬럼 명으로 변경할 때 객체 필드의 카멜 케이스를 테이블 컬럼의 언더스코어로 자동으로 변환해준다.
• itemName ➔ item_name , 따라서 위 예제의 @Column(name = "item_name") 를 생략해도 된다.

 

JPA는 public 또는 protected 의 기본 생성자가 필수이다. 기본 생성자를 꼭 넣어주자.

public Item() {}

• 이렇게 하면 기본 매핑은 모두 끝난다.

 

 

JpaItemRepositoryV1

@Slf4j
@Repository
@Transactional
public class JpaItemRepositoryV1 implements ItemRepository {

    private final EntityManager em;

    public JpaItemRepositoryV1(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 = "select i from Item i";
        
        Integer maxPrice = cond.getMaxPrice();
        String itemName = cond.getItemName();
        
        if (StringUtils.hasText(itemName) || maxPrice != null) {
            jpql += " where";
        }
        boolean andFlag = false;
        if (StringUtils.hasText(itemName)) {
            jpql += " i.itemName like concat('%',:itemName,'%')";
            andFlag = true;
        }
        if (maxPrice != null) {
            if (andFlag) {
                jpql += " and";
            }
            jpql += " i.price <= :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();
    }
}

 

 

private final EntityManager em

• 생성자를 보면 스프링을 통해 엔티티 매니저( EntityManager )라는 것을 주입받은 것을 확인할 수 있다. 
• JPA의 모든 동작은 엔티티 매니저를 통해서 이루어진다. 
• 엔티티 매니저는 내부에 데이터소스를 가지고 있고, 데이터베이스에 접근할 수 있다.

@Transactional

• JPA의 모든 데이터 변경(등록, 수정, 삭제)은 트랜잭션 안에서 이루어져야 한다.
• 조회는 트랜잭션이 없어도 가능하다. 
• 변경의 경우 일반적으로 서비스 계층에서 트랜잭션을 시작하기 때문에 문제가 없다. 
• 하지만 이번 예제에서는 복잡한 비즈니스 로직이 없어서 서비스 계층에서 트랜잭션을 걸지 않았다. 
• JPA에서는 데이터 변경시 트랜잭션이 필수다. 따라서 리포지토리에 트랜잭션을 걸어주었다. 
• 다시한번 강조하지만 일반적으로는 비즈니스 로직을 시작하는 서비스 계층에 트랜잭션을 걸어주는 것이 맞다.

 

참고

• JPA를 설정하려면 EntityManagerFactory , JPA 트랜잭션 매니저( JpaTransactionManager ), 데이터소스 등등 다양한 설정을 해야 한다.
• 스프링 부트는 이 과정을 모두 자동화 해준다.
• 그리고 스프링 부트의 자동 설정은 JpaBaseConfiguration 를 참고하자.

 

 

JpaConfig

@Configuration
@RequiredArgsConstructor
public class JpaConfig {

    private final EntityManager em;

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

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

 

 

ItemServiceApplication - 변경

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

• JpaConfig 를 사용하도록 변경

 

테스트를 실행

@SpringBootTest
@Transactional
class ItemRepositoryTest {

    private static final Logger log = LoggerFactory.getLogger(ItemRepositoryTest.class);

    @Autowired
    ItemRepository itemRepository;

    /*@Autowired
    PlatformTransactionManager transactionManager;
    TransactionStatus status;

    @BeforeEach
    void beforeEach() {
        // 트랜잭션 시작
        status = transactionManager.getTransaction(new DefaultTransactionDefinition());
    }*/

    @AfterEach
    void afterEach() {
        //MemoryItemRepository 의 경우 제한적으로 사용
        if (itemRepository instanceof MemoryItemRepository) {
            ((MemoryItemRepository) itemRepository).clearStore();
        }
        // 트랜잭션 롤백
        // transactionManager.rollback(status);
    }

    @Test
    void save() {
        //given
        Item item = new Item("itemA", 10000, 10);

        //when
        Item savedItem = itemRepository.save(item);

        //then
        Item findItem = itemRepository.findById(item.getId()).get();
        log.info("itemId: {}", item.getId());
        assertThat(findItem).isEqualTo(savedItem);
    }

    @Test
    void updateItem() {
        //given
        Item item = new Item("item1", 10000, 10);
        Item savedItem = itemRepository.save(item);
        Long itemId = savedItem.getId();

        //when
        ItemUpdateDto updateParam = new ItemUpdateDto("item2", 20000, 30);
        itemRepository.update(itemId, updateParam);

        //then
        Item findItem = itemRepository.findById(itemId).get();
        assertThat(findItem.getItemName()).isEqualTo(updateParam.getItemName());
        assertThat(findItem.getPrice()).isEqualTo(updateParam.getPrice());
        assertThat(findItem.getQuantity()).isEqualTo(updateParam.getQuantity());
    }

    @Test
    void findItems() {
        //given
        Item item1 = new Item("itemA-1", 10000, 10);
        Item item2 = new Item("itemA-2", 20000, 20);
        Item item3 = new Item("itemB-1", 30000, 30);

        itemRepository.save(item1);
        itemRepository.save(item2);
        itemRepository.save(item3);

        //둘 다 없음 검증
        test(null, null, item1, item2, item3);
        test("", null, item1, item2, item3);

        //itemName 검증
        test("itemA", null, item1, item2);
        test("temA", null, item1, item2);
        test("itemB", null, item3);

        //maxPrice 검증
        test(null, 10000, item1);

        //둘 다 있음 검증
        test("itemA", 10000, item1);
    }

    void test(String itemName, Integer maxPrice, Item... items) {
        List<Item> result = itemRepository.findAll(new ItemSearchCond(itemName, maxPrice));
        assertThat(result).containsExactly(items);
    }
}

---

JPA 적용2 - 리포지토리 분석

JpaItemRepositoryV1 코드 분석

 

save() - 저장

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

• em.persist(item) : JPA에서 객체를 테이블에 저장할 때는 엔티티 매니저가 제공하는 persist() 메서드를 사용하면 된다.

 

JPA가 만들어서 실행한 SQL

insert into item (id, item_name, price, quantity) values (null, ?, ?, ?)
또는
insert into item (id, item_name, price, quantity) values (default, ?, ?, ?)
또는
insert into item (item_name, price, quantity) values (?, ?, ?)

• JPA가 만들어서 실행한 SQL을 보면 id 에 값이 빠져있는 것을 확인할 수 있다. 
• PK 키 생성 전략을 IDENTITY로 사용했기 때문에 JPA가 이런 쿼리를 만들어서 실행한 것이다. 
• 물론 쿼리 실행 이후에 Item 객체의 id 필드에 데이터베이스가 생성한 PK값이 들어가게 된다. 
• JPA가 INSERT SQL 실행 이후에 생성된 ID 결과를 받아서 넣어준다.

 

PK 매핑 참고

@Entity
public class Item {

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

 

 

update() - 수정

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());
}

 

 

JPA가 만들어서 실행한 SQL

update item set item_name=?, price=?, quantity=? where id=?

• em.update() 같은 메서드를 전혀 호출하지 않았다. 그런데 어떻게 UPDATE SQL이 실행되는 것일까?
• JPA는 트랜잭션이 커밋되는 시점에, 변경된 엔티티 객체가 있는지 확인한다.
• 특정 엔티티 객체가 변경된 경우에는 UPDATE SQL을 실행한다.
• 트랜잭션 커밋 시점에 JPA가 변경된 엔티티 객체를 찾아서 UPDATE SQL을 수행한다고 이해하면 된다.
• 테스트의 경우 마지막에 트랜잭션이 롤백되기 때문에 JPA는 UPDATE SQL을 실행하지 않는다. 
• 테스트에서 UPDATE SQL을 확인하려면 @Commit 을 붙이면 확인할 수 있다.

 

 

findById() - 단건 조회

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

• JPA에서 엔티티 객체를 PK를 기준으로 조회할 때는 find() 를 사용하고 조회 타입과, PK 값을 주면 된다. 
• 그러면 JPA가 다음과 같은 조회 SQL을 만들어서 실행하고, 결과를 객체로 바로 변환해준다.

 

JPA가 만들어서 실행한 SQL

select
 item0_.id as id1_0_0_,
 item0_.item_name as item_nam2_0_0_,
 item0_.price as price3_0_0_,
 item0_.quantity as quantity4_0_0_
from item item0_
where item0_.id=?

• JPA(하이버네이트)가 만들어서 실행한 SQL은 별칭이 조금 복잡하다. 
• 조인이 발생하거나 복잡한 조건에서도 문제 없도록 기계적으로 만들다 보니 이런 결과가 나온 듯 하다.

 

 

findAll - 목록 조회

public List<Item> findAll(ItemSearchCond cond) {
    String jpql = "select i from Item i";
    //동적 쿼리 생략
    TypedQuery<Item> query = em.createQuery(jpql, Item.class);
    return query.getResultList();
}

 

 

JPQL

• JPA는 JPQL(Java Persistence Query Language)이라는 객체지향 쿼리 언어를 제공한다.
• 주로 여러 데이터를 복잡한 조건으로 조회할 때 사용한다.
• SQL이 테이블을 대상으로 한다면, JPQL은 엔티티 객체를 대상으로 SQL을 실행한다 생각하면 된다.
• 엔티티 객체를 대상으로 하기 때문에 from 다음에 Item 엔티티 객체 이름이 들어간다. 
• 엔티티 객체와 속성의 대소문자는 구분해야 한다.
• JPQL은 SQL과 문법이 거의 비슷하기 때문에 개발자들이 쉽게 적응할 수 있다.
• 결과적으로 JPQL을 실행하면 그 안에 포함된 엔티티 객체의 매핑 정보를 활용해서 SQL을 만들게 된다.

 

실행된 JPQL

select i from Item i
where i.itemName like concat('%',:itemName,'%')
 and i.price <= :maxPrice

 

 

JPQL을 통해 실행된 SQL

select
 item0_.id as id1_0_,
 item0_.item_name as item_nam2_0_,
 item0_.price as price3_0_,
 item0_.quantity as quantity4_0_
from item item0_
where (item0_.item_name like ('%'||?||'%'))
 and item0_.price<=?

 

 

파라미터

• JPQL에서 파라미터는 다음과 같이 입력한다.
  
  • where price <= :maxPrice
• 파라미터 바인딩은 다음과 같이 사용한다.
  
  • query.setParameter("maxPrice", maxPrice)

 

 

동적 쿼리 문제

• JPA를 사용해도 동적 쿼리 문제가 남아있다. 
• 동적 쿼리는 뒤에서 설명하는 Querydsl이라는 기술을 활용하면 매우 깔끔하게 사용할 수 있다. 
• 실무에서는 동적 쿼리 문제 때문에, JPA 사용할 때 Querydsl도 함께 선택하게 된다.

---

JPA 적용3 - 예외 변환

JPA의 경우 예외가 발생하면 JPA 예외가 발생하게 된다.

@Repository
@Transactional
public class JpaItemRepositoryV1 implements ItemRepository {
    private final EntityManager em; 
    
    @Override
    public Item save(Item item) {
        em.persist(item);
        return item;
    }
}

• EntityManager 는 순수한 JPA 기술이고, 스프링과는 관계가 없다. 
• 따라서 엔티티 매니저는 예외가 발생하면 JPA 관련 예외를 발생시킨다.
• JPA는 PersistenceException 과 그 하위 예외를 발생시킨다.
• 추가로 JPA는 IllegalStateException , IllegalArgumentException 을 발생시킬 수 있다.
• 그렇다면 JPA 예외를 스프링 예외 추상화(DataAccessException)로 어떻게 변환할 수 있을까?
• 비밀은 바로 @Repository 에 있다.

 

 

예외 변환 전

 

@Repository의 기능

• 1. @Repository 가 붙은 클래스는 컴포넌트 스캔의 대상이 된다.
• 2. @Repository 가 붙은 클래스는 예외 변환 AOP의 적용 대상이 된다.
• 스프링과 JPA를 함께 사용하는 경우 스프링은 JPA 예외 변환기( PersistenceExceptionTranslator )를 등록한다.
• 예외 변환 AOP 프록시는 JPA 관련 예외가 발생하면 JPA 예외 변환기를 통해 발생한 예외를 스프링 데이터 접근 예외로 변환한다.

 

 

예외 변환 후

• 결과적으로 리포지토리에 @Repository 애노테이션만 있으면 스프링이 예외 변환을 처리하는 AOP를 만들어준다.

 

참고

• 스프링 부트는 PersistenceExceptionTranslationPostProcessor 를 자동으로 등록하는데, 여기에서 @Repository 를 AOP 프록시로 만드는 어드바이저가 등록된다.

 

참고

• 복잡한 과정을 거쳐서 실제 예외를 변환하는데, 실제 JPA 예외를 변환하는 코드는
  EntityManagerFactoryUtils.convertJpaAccessExceptionIfPossible() 이다.

---