스프링 DB 접근 기술(3) - JPA

JPA(Java Persistence API)

• JPA는 기존의 반복 코드는 물론이고, 기본적인 SQL도 JPA가 직접 만들어서 실행해 준다.
• JPA를 사용하면, SQL과 데이터 중심의 설계에서 객체 중심의 설계로 패러다임을 전환을 할 수 있다.
• JPA를 사용하면 개발 생산성을 크게 높일 수 있다.

 

JPA를 사용하기 위해서는 build.gradle 파일에 관련 라이브러리를 추가해야 한다.

dependencies {
   implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
   implementation 'org.springframework.boot:spring-boot-starter-web'
   implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
// implementation 'org.springframework.boot:spring-boot-starter-jdbc'
   implementation("org.mariadb.jdbc:mariadb-java-client:2.1.2")
   testImplementation 'org.springframework.boot:spring-boot-starter-test'
}

spring-boot-starter-data-jpa는 내부에 jdbc 관련 라이브러리를 포함한다. 따라서 jdbc는 제거해도 된다.

 

 

application.properties

spring.jpa.hibernate.ddl-auto=none
spring.jpa.show-sql=true

• show-sql : JPA가 생성하는 SQL을 출력한다.
• ddl-auto : JPA는 테이블을 자동으로 생성하는 기능을 제공하는데 none를 사용하면 해당 기능을 끈다
  • create를 사용하면 엔티티 정보를 바탕으로 테이블도 직접 생성해 준다. 해보자.

 

JPA 엔티티 매핑

package hello.hellospring.domain;

import jakarta.persistence.*;

@Entity // JPA가 관리하는 엔티티로 등록
public class Member {
    @Id @GeneratedValue(strategy = GenerationType.IDENTITY) // @Id는 PK, @GeneratedValue(strategy = GenerationType.IDENTITY) identity 전략/auto_increment
    private Long id;
    @Column(name = "username")  // DB의 name컬럼이 username과 매핑
    private String name;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}

JPA는 ORM을 애노테이션으로 한다.

 

@Entity을 사용하면 JPA가 관리하는 엔티티가 된다.

PK 매핑을 위해 @Id를 사용한다.

PK는 DB에서 값을 자동으로 생성해주고 있다. 테이블을 생성할 당시 id에 auto_increment 설정을 했었다. 이렇게 DB가 값을 자동으로 생성해 주는 것을 identity 전략이라고 한다. @GeneratedValue(strategy = GenerationType.IDENTITY)

 

ORM(Object Relational Mapping)

객체와 관계 데이터베이스의 테이블을 연결

 

 

생성

 

package hello.hellospring.repository;

import hello.hellospring.domain.Member;
import jakarta.persistence.EntityManager;

import java.util.List;
import java.util.Optional;

public class JpaMemberRepository implements MemberRepository {

    private final EntityManager em; // JPA는 EntityManager라는 것으로 모든게 동작함

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

    @Override
    public Member save(Member member) {
        em.persist(member); // 이렇게 하면 JPA가 insert 쿼리를 다 만들어서 DB에 입력하고 id까지 member에 set한다.
        return member;
    }

    @Override
    public Optional<Member> findById(Long id) {
        Member member = em.find(Member.class, id);// 조회. 조회할 타입과 식별자(pk)를 넣어준다.
        return Optional.ofNullable(member);
    }

    @Override
    public Optional<Member> findByName(String name) {
        List<Member> result = em.createQuery("select m from Member m where m.name = :name", Member.class)
                .setParameter("name", name)
                .getResultList();

        return result.stream().findAny();
    }

    @Override
    public List<Member> findAll() {
        return em.createQuery("select m from Member as m", Member.class)
                .getResultList();   // 보통 테이블 대상으로 sql을 작성하는데 객체(엔티티)를 대상으로 쿼리를 작성하는 것이다. 그러면 sql로 번역이 된다. (as 생략가능)
    }
}

JPA 라이브러리를 받으면 스프링부트가 자동으로 EntityManager를 DB와 연결해서 생성해 준다. 우리는 이것을 주입받으면 된다.

 

@Override
public List<Member> findAll() {
    return em.createQuery("select m from Member m", Member.class)
            .getResultList();
}

보통 테이블을 대상으로  sql을 작성하는데 위 코드는 객체(엔티티)를 대상으로 쿼리를 작성하는 것이다. 그러면 자동으로 sql로 번역이 된다. (from Member m은 as(별칭)이 생략된 것이다.)

 

select의 대상은 m인데, 보통 *이나 m.id, m.name와 같은 식으로 적는데 m은 Member 엔티티 자체를 select 하는 것이다.

 

단 건을 찾는 PK 기반은 간단하게 할 수 있지만, findByName, findAll 같은 것은 jpql이라는 것을 작성해줘야 한다.

 

 

서비스 계층에 트랜잭션 추가

import org.springframework.transaction.annotation.Transactional;

@Transactional
public class MemberService {

• org.springframework.transaction.annotation.Transactional를 사용하자
• 스프링은 해당 클래스의 메서드를 실행할 때 트랜잭션을 시작하고, 메서드가 정상 종료되면 트랜잭션을 커밋한다. 만약 런타임 예외가 발생하면 롤백한다.
• JPA를 통한 모든 데이터 변경은 트랜잭션 안에서 실행해야 한다.

 

 

JPA를 사용하도록 스프링 설정 변경

package hello.hellospring;

import hello.hellospring.repository.*;
import hello.hellospring.service.MemberService;
import jakarta.persistence.EntityManager;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import javax.sql.DataSource;

@Configuration
public class SpringConfig {

    private EntityManager em;

    @Autowired
    public SpringConfig(EntityManager em) {
        this.em = em;
    }

    @Bean
    public MemberService memberService() {
        return new MemberService(memberRepository());
    }

    @Bean
    public MemberRepository memberRepository() {
//        return new MemoryMemberRepository();
//        return new JdbcMemberRepository(dataSource);
//        return new JdbcTemplateMemberRepository(dataSource);
        return new JpaMemberRepository(em);
    }
}

 

통합테스트에서 회원가입만 돌려보면

 

 

 

스프링 데이터 JPA

• 스프링 부트와 JPA만 사용해도 개발 생산성이 정말 많이 증가하고, 개발해야 할 코드도 확연히 줄어든다.
• 여기에 스프링 데이터 JPA를 사용하면, 기존의 한계를 넘어 마치 마법처럼, 리포지토리에 구현 클래스 없이 인터페이스 만으로 개발을 완료할 수 있다.
• 그리고 반복 개발해 온 기본 CRUD 기능도 스프링 데이터 JPA가 모두 제공한다.
• 지금까지 조금이라도 단순하고 반복이라 생각했던 개발 코드들이 확연하게 줄어든다.
• 따라서 개발자는 핵심 비즈니스 로직을 개발하는데, 집중할 수 있다. 

 

주의
스프링 데이터 JPA는 JPA를 편리하게 사용하도록 도와주는 기술입니다. 따라서 JPA를 먼저 학습한 후에 스프링 데이터 JPA를 학습해야 한다.

 

생성

package hello.hellospring.repository;

import hello.hellospring.domain.Member;
import org.springframework.data.jpa.repository.JpaRepository;

import java.util.Optional;

public interface SpringDataJpaMemberRepository extends JpaRepository<Member, Long>, MemberRepository {

    @Override
    Optional<Member> findByName(String name);
}

스프링 데이터 JPA가 SpringDataJpaMemberRepository를 스프링 빈으로 자동 등록해 준다.

 

 

스프링 데이터 JPA 회원 리포지토리를 사용하도록 스프링 설정 변경

package hello.hellospring;

import hello.hellospring.repository.*;
import hello.hellospring.service.MemberService;
import jakarta.persistence.EntityManager;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import javax.sql.DataSource;

@Configuration
public class SpringConfig {

    private final MemberRepository memberRepository;

    @Autowired
    public SpringConfig(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
    }

    @Bean
    public MemberService memberService() {
        return new MemberService(memberRepository);
    }

//    @Bean
//    public MemberRepository memberRepository() {
//        return new MemoryMemberRepository();
//        return new JdbcMemberRepository(dataSource);
//        return new JdbcTemplateMemberRepository(dataSource);
//        return new JpaMemberRepository(em);
//    }
}

 

통합테스트에서 회원가입을 돌려보면

 

전체를 돌려보면 역시 통과된다.

 

 

스프링 데이터 JPA 제공 클래스

 

스프링 데이터 JPA 제공 기능

• 인터페이스를 통한 기본적인 CRUD
• findByName() , findByEmail()처럼 메서드 이름 만으로 조회 기능 제공
• 페이징 기능 자동 제공

public interface SpringDataJpaMemberRepository extends JpaRepository<Member, Long>, MemberRepository {

    //JPQL select m from Member m where m.name = ?
    @Override
    Optional<Member> findByName(String name);
}

메서드 이름에 대한 규칙이 있다. (예시 : findByNameAndId(String name, Long id))

여기에 맞추면 JPQL을 알아서 짜주고 이게 SQL로 번역이 된다.

 

참고
실무에서는 JPA와 스프링 데이터 JPA를 기본으로 사용하고, 복잡한 동적 쿼리는 Querydsl이라는 라이브러리를 사용하면 된다. Querydsl을 사용하면 쿼리도 자바 코드로 안전하게 작성할 수 있고, 동적 쿼리도 편리하게 작성할 수 있다. 이 조합으로 해결하기 어려운 쿼리는 JPA가 제공하는 네이티브 쿼리를 사용하거나, 앞서 학습한 스프링 JdbcTemplate를 사용하면 된다.