4 min read

<Spring> 스프링 DB 관리 기술 2

해당 글은 김영한님의 <스프링 입문> 강좌를 기반으로 작성되었습니다.

JPA로 DB 연결하기

JPA(Java Persistence API) 란?

  • 현재 자바 진영의 ORM 기술 표준으로서, 인터페이스의 모음이다.
  • 과거의 자바 진영의 표준은 Entity Bean을 사용했다.(과거의 ORM)
  • 이러한 단점을 보완한 Hibernate라는 ORM 프레임워크가 등장했고, 급증하는 수요오 함께 이를 기반으로 JPA라는 새로운 ORM 기술 표준을 만들었다.
  • JPA는 여러 vendor가 존재하며, 대표적으로 Hibernate, EclipseLink 등이 존재한다.
  • JPA는 기존의 반복 코드는 물론이고, 기본적인 SQL도 JPA가 직접 만들어서 실행해준다.
  • JPA를 사용하면, SQL과 데이터 중심의 설계에서 객체 중심의 설계로 패러다임을 전환을 할 수 있다.
  • 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-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'}
}
  • spring-boot-starter-data-jpa는 내부에 JPA 관련 라이브러리를 포함한다. 따라서 org.springframework.boot:spring-boot-starter-jdbc는 삭제해도 상관없다.

resources/application.properties 설정

	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
  • spring.datasource.username=sa는 spring-boot 2.4 ver 이상부터는 추가해줘야하는 설정이다.
  • spring.jpa.show-sql=true는 JPA가 생성하는 SQL은 출력해주는 설정이다.
  • spring.jpa.hibernate.ddl-auto=none는 JPA가 DB 테이블을 자동으로 생성해주는 기능은 끄는 설정이다. 만약 create를 사용하면 테이블이 자동으로 생성된다.

JPA Entity 매핑

  • domain 패키지의 Member 클래스를 다음과 같이 변경해줍니다.
package hello.hellospring.domain;

import javax.persistence.*;

@Entity//jpa가 관리하도록 entity 설정
public class Member {

    @Id @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;//system이 정해주는 순번

    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 회원 레포지토리 생성

package hello.hellospring.repository;

import hello.hellospring.domain.Member;

import javax.persistence.EntityManager;
import java.awt.*;
import java.util.List;
import java.util.Optional;

public class JpaMemberRepository implements MemberRepository {

    private final EntityManager entityManager;

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

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

    @Override
    public Optional<Member> findById(Long id) {
        Member member = entityManager.find(Member.class, id);
        return Optional.ofNullable(member);
    }

    @Override
    public Optional<Member> findByName(String name) {
        List<Member> result = entityManager.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 entityManager.createQuery("select m from Member m", Member.class).getResultList();
    }
}

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

  • MemberService 클래스에 아래와 같이 어노테이션을 붙이면 됩니다.
import org.springframework.transaction.annotation.Transactional
  @Transactional
  public class MemberService {}
  • 스프링은 해당 클래스의 메서드를 실행할 때 트랜잭션을 시작하고, 메서드가 정상 종료되면 트랜잭션을 커밋합니다. 만약 런타임 예외가 발생하면 롤백을 진행합니다.
  • JPA를 통한 모든 데이터 변경은 트랜잭션 안에서 실행해야 합니다.

스프링 Config 설정하기

package hello.hellospring;
  import hello.hellospring.repository.*;
  import hello.hellospring.service.MemberService;
  import org.springframework.context.annotation.Bean;
  import org.springframework.context.annotation.Configuration;
  import javax.persistence.EntityManager;
  import javax.sql.DataSource;
  @Configuration
  public class SpringConfig {
      private final EntityManager em;
      public SpringConfig(DataSource dataSource, 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);
      }
}
  • EntityManager를 DI로 받아줍니다.

스프링 Data JPA로 DB 연결하기

SpringDataJpaMemberRepository 인터페이스 만들기

 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 {
        Optional<Member> findByName(String name);
    }
 
  • JpaRepository 인터페이스로 들어가보면 findByName을 제외한 메서드들은 조회 가능하게 되어있습니다.

스프링 Config 설정 변경하기

package hello.hellospring;
  import hello.hellospring.repository.*;
  import hello.hellospring.service.MemberService;
  import org.springframework.context.annotation.Bean;
  import org.springframework.context.annotation.Configuration;
  @Configuration
  public class SpringConfig {
      private final MemberRepository memberRepository;
      public SpringConfig(MemberRepository memberRepository) {
          this.memberRepository = memberRepository;
}
      @Bean
      public MemberService memberService() {
          return new MemberService(memberRepository);
      }
}

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