본문 바로가기

Java/spring

[Java/스프링 입문] 스프링 DB 접근 기술(3) - JPA, 스프링 데이터 JPA(persist, @Transactional, @Id, @GeneratedValue, JpaRepository)

들어가며

🏗 JPA: 기존의 반복 코드 및 기본적인 SQL도 JPA가 직접 만들어서 실행해 줍니다.

SQL과 데이터 중심의 설계 → 객체 중심의 설계로 패러다임을 전환할 수 있습니다. 개발 생산성을 크게 높일 수 있습니다.
🚀 스프링 데이터 JPA: 위의 JPA 기술을 스프링에 한 번 감싸서 제공하는 기술입니다.
(이는 JPA를 편리하게 사용하도록 도와주는 기술, 반드시 JPA에 대해 먼저 공부할 것)


1. JPA

ℹ️ ORM: Object Relational Mapping
Object 즉 Java의 클래스(객체)와 RDM의 테이블을 연결한다는 의미입니다.
이 두 개념을 서로 연결(Mapping)하여 마치 하나인 것처럼 관리하기 위한 방법론입니다.
=> SQL문 작성없이 Java 코드만으로 DB에 데이터를 저장할 수 있습니다.

💡JPA: Java Persistence API (구현체: Hibernate)
자바 진영에서 ORM 기술의 표준으로 자리잡은 인터페이스 집합니다.
*Persistence: 지속성, 애플리케이션을 여러 번 실행해도 데이터가 유지되는 성질을 말합니다.애플리케이션 내 Model 객체를 DB와 같은 저장 공간에 저장하는 것을 의미합니다.

 

1) 환경설정

  • build.gradle 파일에 JPA, h2 데이터베이스 관련 라이브러리를 추가합니다.
  • spring-boot-starter-data-jpa: 내부에 jdbc 관련 라이브러리를 포함하기에 jdbc는 제거해도 됩니다.
dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
    implementation 'org.springframework.boot:spring-boot-starter-web'
    // implementation 'org.springframework.boot:spring-boot-starter-jdbc'
    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
    runtimeOnly 'com.h2database:h2'
    testImplementation('org.springframework.boot:spring-boot-starter-test') {
    	exclude group: 'org.junit.vintage', module: 'junit-vintage-engine'
	}
}

 

  • 스프링부트에 JPA 설정을 추가합니다.
  • resources/application.properties
    • show-sql: JPA가 생성하는 SQL을 출력합니다.
    • ddl-auto: JPA는 테이블을 자동으로 생성하는 기능을 제공하는데, none을 사용하면 해당 기능을 끕니다.
      (<-> create: 사용하면 엔티티 정보를 바탕으로 테이블도 직접 생성해 줍니다.)
spring.datasource.url=jdbc:h2:tcp://localhost/~/test
spring.datasource.driver-class-name=org.h2.Driver
spring.datasource.username=sa
spring.jpa.show-sql=true
spring.jpa.hibernate.ddl-auto=none

 

2) JPA 적용

  • JpaMemberRepository.java
    • em.persist(member): member 객체를 DB에 영속화하는 것입니다.
    • JPQL: PK 기반이 아닌 나머지 메소드는 JPQL을 작성해야 합니다.
      JPQL은 쉽게 말해 Entity를 대상으로 쿼리문을 날리는 것입니다.
package hello.hello_spring.repository;

import hello.hello_spring.domain.Member;

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

public class JpaMemberRepository implements MemberRepository {

    private final EntityManager em;

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

    @Override
    public Member save(Member member) {
        em.persist(member);
        return member;
    }

    @Override
    public Optional<Member> findById(Long id) {
        Member member = em.find(Member.class, id);
        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() {
        // pk 기반이 아닌 나머지 메소드는 JPQL을 작성해 주어야 합니다.
        // JPQL: 객체를 대상으로 쿼리를 날리는 것입니다. (Entity를 대상으로)
        return em.createQuery("select m form Member m", Member.class)
                .getResultList();
    }
}

 

  • MemberService.java
    • @Transactional: 해당 범위 내 메서드가 트랜잭션이 되도록 보장합니다. (join 메서드에서 트랜잭션 필요)
    • JPA를 통한 모든 데이터 변경은 트랜잭션 안에서 실행해야 합니다.
package hello.hello_spring.service;

import hello.hello_spring.domain.Member;
import hello.hello_spring.repository.MemberRepository;
import org.springframework.stereotype.Service;

import java.beans.Transient;
import java.util.List;
import java.util.Optional;

@Transactional // JPA 필수
public class MemberService {
    private final MemberRepository memberRepository;
    
    // 회원 서비스 코드가 DI 가능하게 변경한다
    public MemberService(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
    }
    /**
     * 회원가입
     */
    public long join(Member member) {
        // 같은 이름이 있는 중복 회원은 불가하다는 조건을 추가한다면?
        validateDuplicateMember(member); // 중복회원 검증
        memberRepository.save(member);
        return member.getId();
    }

    private void validateDuplicateMember(Member member) {
        memberRepository.findByName(member.getName())
                .ifPresent(m -> { // 값이 있다면 throw로 오류를 날리도록 한다
                    throw new IllegalArgumentException("이미 존재하는 회원입니다.");
                });
    }
    /**
     * 전체 회원 조회
     */
    public List<Member> findMembers() {
        return memberRepository.findAll();
    }
    public Optional<Member> findOne(Long memberId) {
        return memberRepository.findById(memberId);
    }
}

 

 

  • Member.java
    • @Entity: 데이터베이스의 테이블과 일대일로 매핑해 주는 어노테이션입니다.
    • @Id: 데이터베이스 테이블의 PK와 객체 필드를 매핑해 주는 어노테이션입니다.
    • @GeneratedValue(strategy = GenerationType.IDENTITY): 기본 키를 자동 생성해 주는 어노테이션입니다.
      • 속성: strategy = GenerationType.IDENTITY
        IDENTITY 전략: 기본 키 생성을 데이터베이스에 위임하는 전략입니다.
package hello.hello_spring.domain;

@Entity // 어노테이션으로 RDB와 매핑시킵니다.
public class Member {

    @Id @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id; // 데이터 구분을 위해 시스템이 정하는 id라고 가정
    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;
    }
}

 

  • SpringConfig.java
package hello.hello_spring;

import hello.hello_spring.repository.JdbcMemberRepository;
import hello.hello_spring.repository.JdbcTemplateMemberRepository;
import hello.hello_spring.repository.JpaMemberRepository;
import hello.hello_spring.repository.MemberRepository;
import hello.hello_spring.repository.MemoryMemberRepository;
import hello.hello_spring.service.MemberService;
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 MemberRepository memberRepository() {
//        return new MemoryMemberRepository();
//        return new JdbcMemberRepository(dataSource);
//        return new JdbcTemplateMemberRepository(dataSource);
        return new JpaMemberRepository(em);
    }
}

 


2. 스프링 데이터 JPA

1) 스프링 데이터 JPA

  • SpringDataJpaMemberRepository.java - 인터페이스 구현 끝
    • why?
      • 스프링 데이터 JPA가 JpaRepository를 받고 있으면 구현체를 자동으로 만들어줍니다.
      • 이후 스프링 데이터 JPA가 SpringDataJpaMemberRepository를 스프링 빈으로 자동으로 등록합니다.
package hello.hello_spring.repository;

import hello.hello_spring.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);
}

 

  • SpringConfig.java
    • MemberSerive에 DI 받은 memberRepository 의존관계를 세팅합니다.
package hello.hello_spring;

import hello.hello_spring.domain.Member;
import hello.hello_spring.repository.*;
import hello.hello_spring.repository.JdbcTemplateMemberRepository;
import hello.hello_spring.service.MemberService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import javax.sql.DataSource;
import java.util.List;
import java.util.Optional;

@Configuration
public class SpringConfig {

    private final MemberRepository memberRepository;

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

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

}

 

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

💡스프링 데이터 JPA 제공 기능
- 인터페이스를 통한 기본적인 CRUD
- findByName(), findByEmail()처럼 메서드 이름만으로 조회 기능 제공
- 페이징 기능 자동 제공
  • JpaRepository
    • 기본적인 CRUD와 단순 조회에 대해 제공하고 있습니다.
    • findAll, save 등
  • CrudRepository
    • save, findOne, exists, count, delete 등
  • 공통으로 제공하고 있지 않은 메서드는 @Override
    • Optional<Member> findByName(String name);
    • 규칙: findBy + Name 혹은 findBy + Name + AndId
      인터페이스 이름만으로도
      개발을 끝낼 수 있습니다.
      • findByName(String name)
        • JPA: select m from Member m where m.name = ?
          로 JPQL → SQL로 번역되어서 실행이 되는 것입니다.
      • findByNameAndId(String name, Long id)
        • JPA: select m from Member m where m.name = ? and m.id = ?

 

 


 

[지금 무료] 스프링 입문 - 코드로 배우는 스프링 부트, 웹 MVC, DB 접근 기술 강의 | 김영한 - 인프

김영한 | 스프링 입문자가 예제를 만들어가면서 스프링 웹 애플리케이션 개발 전반을 빠르게 학습할 수 있습니다., 스프링 학습 첫 길잡이! 개발 공부의 길을 잃지 않도록 도와드립니다. 📣 확

www.inflearn.com

 

반응형