[JPA] JPA(Java Persistent API)

지금까지 jdbc부터 jdbctemplate까지 사용자가 직접 SQL을 작성해 매핑해오는 SQL Mapper 방식으로 SQL 중심적인 개발을 해왔습니다.

 

SQL 중심적인 개발은 개발자가 고생을 많이해야합니다.. CRUD에서 시작해서 자바 객체를 SQL로 바꾸고, SQL을 자바 객체로 바꾸고..  이렇게 객체를 SQL 로 매핑하는 작업들을 개발자가 해야하죠. 굉장히 번거롭습니다.  

 

간단한 케이스에는 개발자가 비교적 쉽게 매핑할 수 있다고 해도, 객체 레벨이 상속에 의해서 커지게 되면 SQL로 매핑은 배로 복잡해집니다.

 

예시를 하나들어보겠습니다.

 

Item을 상속한 객체 Album, Movie, Book이 있다고 해봅시다.

그리고 Album, Movie, Book 은 Item의 PK인 id를 외래키로 가진다고 해봅시다.

 

 

이 때 Album에 데이터를 추가하고 싶다고 할 때 개발자는

1) 객체를 분해하고

2) insert into item ...

3) insert into album values ...

 

복잡한 작업들을 거쳐야 합니다.

 

추가 뿐만 아니라 조회, 삭제, 수정에서도 개발자가 손봐야 하는 부분들이 상당히 많아집니다.

 

객체와 객체간, 테이블과 테이블간 관계는 개발자가 쉽게 탐색할 수 있어야 합니다. JPA는 이것을 가능하게 해줍니다.

 

JPA란?

JPA는 자바 진영의 ORM(Object-relational mapping 객체 관계 매핑) 기술 표준으로 

JPA를 사용하면 개발자는 객체는 객체대로 설계하고 , 관계형 데이터베이스는 관계형 데이터베이스대로 설계만 하면 ORM 프레임워크인 JPA가 중간에서 알아서 매핑을 해주기 때문에, 개발자 입장에선 객체를 테이블에 매핑해주지 않아도 되므로 상당히 편해집니다.

 

JPA는 애플리케이션과 JDBC 사이에서 동작합니다. 

 

이제부터는 JPA를 사용해 SQL 중심 개발에서 벗어나 객체 중심 개발로 전환해 보도록 하겠습니다.

JPA를 사용하면 생산성 증가, 유지보수 용이, 패러다임의 불일치 해결, 성능 등 여러 방면에서 이점을 얻을 수 있습니다.

 

JPA는 스프링만큼 방대하고 공부할 게 많기 때문에, 자세한 내용은 추후 JPA를 공부하면서 알아보도록 하고, 지금은 대략적으로 JPA를 쓰면 이렇게 할 수 있구나 정도로만 알아둡시다.

 

JPA 설정

 

- build.gradle

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

 

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

위 라이브러리가 추가됩니다.

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

spring-boot-starter-data-jpa는 jpa, spring data jpa 뿐만 아니라 jdbc도 포함하고 있기 때문의 의존관계를 제거해도 됩니다.

 

 

- application.properties ( main, test )

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

• 하이버네이트가 생성하고 실행하는 SQL을 확인하고, SQL에 바인딩되는 파라미터를 확인하도록 설정

JPA 적용

이제 모든 준비가 끝났습니다. 이 전에 jdbctemplate에서 사용한 예시에 적용해보겠습니다.

 

1. Item - ORM 매핑

@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가 사용하는 객체라는 뜻으로 이 어노테이션이 있어야 JPA가 인식할 수 있습니다. 
• @Id : 테이블의 PK와 해당 필드를 매핑합니다.
• @GeneratedValue(strategy = GenerationType.IDENTITY) : PK 생성 값을 데이터베이스에서 생성하는 IDENTITY 방식을 사용
• @Column : 객체의 필드를 테이블의 컬럼과 매핑합니다. 생략해도 되지만, 테이블의 컬럼명과 다를 경우 직접 매핑해줍니다.

+ JPA는 public이나 protected 기본생성자가 필수적으로 있어야 합니다.

 

2. Repository에 적용 

@Slf4j
@Repository
@Transactional
@RequiredArgsConstructor
public class JpaItemRepositoryV1 implements ItemRepository {
    
    private final EntityManager em;

• JPA의 모든 동작은 EntityManager를 통해 이루어집니다. EntityManager는 내부에 데이터소스를 가지고 있어 DB에 접근할 수 있습니다.
• JPA의 모든 데이터 변경(삽입,수정,삭제 // 조회는 X)는 트랜잭션 안에서 이루어져야 하기 때문에, @Transactional을 붙여주어야 합니다. (JPA에서는 데이터 변경시 트랜잭션이 필수)

 

이 전 포스팅에서도 말했지만, 트랜잭션은 서비스 계층에 걸어주는 것이 맞지만 이 예제에서는 서비스 계층에 복잡한 비즈니스 로직이 없어 리포지토리 계층에 걸어주었습니다.

 

2-1. save()

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

엔티티 매니저의 persist 메소드로 객체를 테이블에 저장할 수 있습니다. ( 매핑은 JPA가 내부적으로 해줍니다. )

이 때 Item 객체에 PK id는 생성전략을 IDENTITY로 설정했기 때문에, 저장 이후에 Item 객체의 id필드에 데이터베이스가 생성한 PK값이 들어가게 됩니다. 즉, JPA가 INSERT SQL(persist 메소드) 실행 이후에 생성된 ID결과를 받아서 테이블에 넣어줍니다.

 

2-2. update()

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

JPA는 트랜잭션이 커밋되는 시점에, 변경된 엔티티 객체가 있는지 확인하고, 특정 엔티티 객체가 변경된 경우에 UPDATE SQL을 실행해줍니다. 

변경된 엔티티 객체는 영속성 컨텍스트라는 JPA 원리를 통해 탐색이 이루어집니다. 

 

2-3. findById() 

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

엔티티 매니저의 find 메소드로 테이블에서 객체를 조회할 수 있습니다.

find에는 조회 타입과, PK 값이 필요합니다.

 

단순히 PK가 아닌 여러 데이터를 복잡한 조건으로 데이터를 조회하려면 어떻게 하면 될까요?

 

2-4. findAll()

JPA는 JPQL이라는 객체 지향 쿼리 언어를 제공합니다. 주로 여러 데이터를 복잡한 조건으로 조회할 때 사용됩니다.

SQL이 테이블을 대상으로 한다면, JPQL은 엔티티 객체를 대상으로 SQL을 실행합니다.

 

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

실행된 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는 JPA를 자세히 공부하면서 알아보도록 합시다.

• (SQL) query에 파라미터 바인딩은 setParameter() 사용
• JPA를 사용해도 동적 쿼리는 처리하기 여전히 어렵습니다. 동적 쿼리는 나중에 Querydsl이라는 기술을 활용하면 깔끔하게 사용할 수 있습니다.

 

+ Config 설정

@Configuration
public class JpaConfig {

    //    private final ItemMapper itemMapper; // Mybatis

    private final EntityManager em;

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

JPA를 설정하려면 EntityManagerFactory, JPA 트랜잭션 매니저, 데이터 소스 등등 다양할 설정이 필요하지만 스프링 부트가 이 과정을 모두 자동화 해줍니다.

 

+ 예외 변환

JPA의 경우 예외가 발생하면 JPA 예외가 발생하게 됩니다. EntityManager는 순수한 JPA 기술이기 때문에 스프링과 관련이 없습니다.

따라서 JPA에서 예외가 발생하면 JPA 예외가 발생하는데 JPA 예외를 스프링 예외 추상화로 변환하려면 어떻게 해야할까요?

 

바로 @Repository 어노테이션을 사용하면 됩니다.

 

@Repository는 컴포넌트 스캔대상으로 지정해줄 뿐만 아니라, 예외 변환 AOP의 적용 대상이 되기 때문에 스프링과 JPA를 같이 사용하는 경우 스프링은 JPA 예외 변환기를 등록합니다. 

예외 변환 AOP 프록시는 JPA 관련 예외가 발생하면 JPA 예외 변환기를 통해 발생한 예외를 스프링 데이터 접근 예외로 변환한다.

 

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

 

 

<정리>

• ORM 기술인 JPA를 대략적으로 알아보았습니다.
• JPA를 이용해 SQL을 직접 작성하지 않고 메소드를 통해 처리할 수 있었습니다.
• JPA는 내용이 방대하기 때문에 이 후 공부하고 정리할 수 있도록 하겠습니다.

 

<참고자료>

스프링 DB 2편 - 데이터 접근 활용 기술 - 인프런 | 강의