[Spring 복습] Spring 입문 - Spring DB 접근 기술

❤️ H2 데이터베이스

• 자바 기반의 오픈소스 관계형 데이터베이스 관리 시스템(RDBMS)
• In-Memory Mode, Embedded Mode, Server Mode 세 가지의 모드를 지원

다운로드 및 설치

• H2 설치 사이트에 들어가서 다운로드
• Spring Boot 3.0 이상일 경우, 2.1.214 버전 이상 사용
• h2/bin 디렉토리에 있는 h2.bat파일 실행 (윈도우 사용자)
• 다음과 같이 콘솔창이 뜨면 연결을 클릭
  • 처음 접속할 때는 JDBC URL을 jdbc:h2:~/test로 설정하고 연결 (최초 한 번)
  • 이후부터는 jdbc:h2:tcp://localhost/~/test 로 설정해 접속
    
• 연결을 클릭하면 다음과 같은 창이 나온다
  • 표시해둔 곳을 클릭하면 나갈 수 있다
    
• 만약 이미 설치하고 실행까지 했다면 다시 설치한 이후에 ~/test.mv.db 파일을 삭제
  • h2 DB 종료 : ctrl + c

테이블 생성하기

• 회원 테이블을 생성하기 위한 쿼리문
  • 테이블 관리를 위해 프로젝트 루트에 sql/ddl.sql 파일을 생성

create table member
(
  id bigint generated by default as identity,
  name varchar(255),
  primary key (id)
);

• H2 DB에 MEMBER 테이블 생성
  
• 회원 데이터를 넣어보자
  
• 조회해보면 등록한 회원 데이터를 볼 수 있다
  

❤️ 순수 JDBC

환경 설정

• build.gradle 파일에 jdbc, h2 데이터베이스 관련 라이브러리 추가

  implementation 'org.springframework.boot:spring-boot-starter-jdbc'
  runtimeOnly 'com.h2database:h2'

• 스프링 부트 데이터베이스 연결 설정 추가 : resources/application.properties

  spring.datasource.url=jdbc:h2:tcp://localhost/~/test
  spring.datasource.driver-class-name=org.h2.Driver
  spring.datasource.username=sa

JDBC 리포지토리 구현

• JDBC API로 직접 코딩하는 것은 20년 전 방식이므로 참고만 할 것

  참고
  JDBC 연결 및 해제
  JDBC crud

• JdbcMemberRepository.java 파일 생성 후 작성 (코드 생략)

스프링 설정 변경

• 기존의 MemoryMemberRepository 와 연결된 부분만 JdbcMemberRepository(dataSource)로 바꿔주면 된다 → 스프링의 장점

  • DataSource는 데이터베이스 커넥션을 획득할 때 사용하는 객체
  • 스프링 부트는 데이터베이스 커넥션 정보를 바탕으로 DataSource를 생성하고 스프링 빈으로 만들어두기 때문이 DI를 받을 수 있다

  package hello.hellospring;
  
  import hello.hellospring.repository.JdbcMemberRepository;
  import hello.hellospring.repository.MemberRepository;
  import hello.hellospring.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 DataSource dataSource;
  
      @Autowired
      public SpringConfig(DataSource dataSource) {
          this.dataSource = dataSource;
      }
  
      @Bean
      public MemberService memberService() {
          return new MemberService(memberRepository());
      }
  
      @Bean
      public MemberRepository memberRepository() {
  //        return new MemoryMemberRepository();
          return new JdbcMemberRepository(dataSource);  
      }
  }

• localhost:8080을 요청한 뒤 회원 목록에 들어가보면 다음과 같이 데이터베이스에 저장된 회원 목록이 화면에 출력된다
  

스프링 설정 이미지

• SOLID 중 하나인 개방-폐쇄 원칙(OCP)에 해당
• 스프링의 DI를 사용하면 기존 코드를 전혀 손대지 않고, 설정만으로 구현 클래스를 변경할 수 있다

❤️ 스프링 통합 테스트

• 스프링 컨테이너와 DB까지 연결한 통합 테스트
  • 자바 코드만을 테스트 → 단위 테스트
  • 데이터베이스와 연결된 것까지 테스트 → 통합 테스트

회원 서비스 스프링 통합 테스트

/test/java/hello.hello-spring/service에 MemberServiceIntegrationTest을 생성하고 다음과 같이 코드 작성

package hello.hellospring.service;

import hello.hellospring.domain.Member;
import hello.hellospring.repository.MemberRepository;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.transaction.annotation.Transactional;

import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.jupiter.api.Assertions.assertThrows;

@SpringBootTest
@Transactional
class MemberServiceIntegrationTest {

    @Autowired MemberService memberService;
    @Autowired MemberRepository memberRepository;

    @Test
    void 회원가입() {
        // given : 회원 정보가 주어짐
        Member member = new Member();
        member.setName("judyan");

        // when : 회원가입 실행
        Long saveId = memberService.join(member);

        // then : 가입여부 검증
        Member findMember = memberRepository.findById(saveId).get();
        assertThat(member.getName()).isEqualTo(findMember.getName());
    }

    @Test
    public void 중복_회원_예외() {
        // given
        Member member1 = new Member();
        member1.setName("spring");

        Member member2 = new Member();
        member2.setName("spring");

        // when
        memberService.join(member1);
        IllegalStateException e = assertThrows(IllegalStateException.class, () -> memberService.join(member2));  // 예외가 발생해야 함

        assertThat(e.getMessage()).isEqualTo("이미 존재하는 회원입니다.");
    }
}

• @SpringBootTest와 @Transactional 애노테이션을 붙여준다
• 테스트 코드 작성 시, 편한 방식으로 한다
• 보통 테스트 전용 DB를 만들어 테스트 진행

@SpringBootTest
: 스프링 컨테이너와 테스트를 함께 실행한다

@Transactional
: 테스트 케이스에 이 애노테이션이 있으면, 테스트 시작 전에 트랜잭션을 시작하고, 테스트 완료 후에 항상 롤백한다 → 다음 테스트에 영향 X

❤️ 스프링 JdbcTemplate

• 순수 JDBC와 동일한 환경설정
• 스프링 JdbcTemplate과 Mybatis같은 라이브러리는 JDBC API에서 본 반복 코드를 대부분 제거해줌
• SQL은 직접 작성해야 함

스프링 JdbcTemplate 회원 리포지토리

package hello.hellospring.repository;

import hello.hellospring.domain.Member;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.jdbc.core.RowMapper;
import org.springframework.jdbc.core.namedparam.MapSqlParameterSource;
import org.springframework.jdbc.core.simple.SimpleJdbcInsert;

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

public class JdbcTemplateMemberRepository implements MemberRepository {

    private final JdbcTemplate jdbcTemplate;

    public JdbcTemplateMemberRepository(DataSource dataSource) {
        this.jdbcTemplate = new JdbcTemplate(dataSource);
    }

    @Override
    public Member save(Member member) {
        SimpleJdbcInsert jdbcInsert = new SimpleJdbcInsert(jdbcTemplate);
        jdbcInsert.withTableName("member").usingGeneratedKeyColumns("id");
        Map<String, Object> parameters = new HashMap<>();
        parameters.put("name", member.getName());

        Number key = jdbcInsert.executeAndReturnKey(new MapSqlParameterSource(parameters));
        member.setId(key.longValue());
        return member;
    }

    @Override
    public Optional<Member> findById(Long id) {
        List<Member> result = jdbcTemplate.query("select * from member where id = ?", memberRomMapper(), id);
        return result.stream().findAny();
    }

    @Override
    public Optional<Member> findByName(String name) {
        List<Member> result = jdbcTemplate.query("select * from member where name = ?", memberRomMapper(), name);
        return result.stream().findAny();
    }

    @Override
    public List<Member> findAll() {
        return jdbcTemplate.query("select * from member", memberRomMapper());
    }

    private RowMapper<Member> memberRomMapper() {
        return (RowMapper<Member>) (rs, rowNum) -> {
            Member member = new Member();
            member.setId(rs.getLong("id"));
            member.setName(rs.getString("name"));
            return member;
        };
    }
}

• 생성자가 하나일 경우, @Autowired 생략 가능

JdbcTemplate을 사용하도록 스프링 설정 변경

• SpringConfig.java 파일에서 다음과 같이 변경하기만 하면 된다
• MemberServiceIntegrationTest를 실행하여 테스트

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

❤️ JPA(Java Persistence API)

: 자바 객체와 DB 데이터 간의 매핑을 처리하기 위한 ORM 표준

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

ORM(Object-Relational Mapping)

• '객체를 연결 해준다'는 의미
• 객체와 관계형 데이터베이스의 데이터를 자동으로 연결(매핑)해주는 도구

환경설정

• build.gradle 파일에 JPA, h2 데이터베이스 관련 라이브러리 추가

  • spring-boot-starter-data-jpa는 내부에 jdbc관련 라이브러리를 포함하므로 jdbc는 제거해도 된다

    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
    runtimeOnly 'com.h2database:h2'

• 스프링 부트에 JPA설정 추가 : resources/application.properties

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

  spring.datasource.driver-class-name=org.h2.Driver
  spring.datasource.username=sa
  
  spring.jpa.show-sql=true
  spring.jpa.hibernate.ddl-auto=none

JPA 엔티티 매핑

/domain/Member파일을 다음과 같이 수정

package hello.hellospring.domain;

import jakarta.persistence.*;

@Entity
public class Member {

    @Id @GeneratedValue(strategy = GenerationType.IDENTITY)  
    private Long 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;
    }
}

• @Entity : 엔티티와 테이블을 매핑
• @Id : 기본키 지정
• @GeneratedValue : 생성 전략을 정의
  • strategy = GenerationType.IDENTITY)
    : 자동 생성 방식 (IDEBTITY : 기본 키 생성을 DB에 위임)

JPA 회원 리포지토리

/repository 하위에 JdbcMemberRepository 파일 생성 후 다음과 같이 작성

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;

    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() {
        return em.createQuery("select m from Member m", Member.class)
                .getResultList();
    }
}

• EntityManager
  • 엔티티를 관리하는 역할
  • 내부에 영속성 컨텍스트가 있으며 이를 통해 관리

영속성 컨텍스트

• 엔티티를 영구히 저장하는 공간
• 관리하고 있는 엔티티의 변화를 추적하고, 한 트랜잭션 내에서 변화가 일어날 경우 엔티티에 마킹 → dirty checking
• 끝나는 시점에 DB에 반영

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

MemberService에 @Transaction 애노테이션을 붙여준다

@Transactional
public class MemberService {
    private final MemberRepository memberRepository;

    public MemberService(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
    }
    ...
}    

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

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

SpringConfig에서 설정 변경

@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와 스프링 데이터 JPA를 기본으로 사용하고, 복잡한 동적 쿼리는 Querydsl이라는 라이브러리를 사용

스프링 데이터 JPA

• JPA를 편리하게 사용하도록 도와주는 기술
• CRUD 처리를 위한 공통 인터페이스 제공
• 리포지토리 개발 시 인터페이스만 작성하면 실행 시점에 스프링 JPA가 구현 객체를 동적으로 생성해서 주입
• 데이터 접근 계층 개발 시, 구현 클래스 없이 인터페이스만 작성해도 개발이 가능하도록 함

참고 포스팅

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

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

스프링 데이터 JPA 회원 리포지토리

/repository 하위에 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 {

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

• 인터페이스가 인터페이스를 상속받을 때는 extends를 사용
• 스프링 데이터 JPA는 인터페이스만으로 리포지토리 개발이 가능하기 때문에 인터페이스만 만들어준다

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

SpringConfig를 다음과 같이 변경

package hello.hellospring;

import hello.hellospring.repository.MemberRepository;
import hello.hellospring.service.MemberService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class SpringConfig {

    private final MemberRepository memberRepository;

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

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

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

출처 - 인프런 '스프링 입문' 강의