스프링 DB 접근 기술

KyungHoon Kim·2022년 9월 24일
DatasourceH2JPAentitytransactional구현 클래스 변경순수 Jdbc스프링 데이터 JPA통합테스트
0

스프링

목록 보기
6/6

1. H2 데이터베이스 설치

  • 다운로드 및 설치
    • 나의 경우, 강의 상 오류 방지를 위해 1.4.200버전을 window installer로 설치했다.
  • h2 데이터베이스 버전은 스프링 부트 버전에 맞춘다.
  • 권한 주기: chmod 755 h2.sh (윈도우 사용자는 x)
  • 실행: ./h2.sh (윈도우 사용자는 h2.bat)
    • 윈도우 사용자의 경우, C:\Program Files (x86)\H2\bin의 h2.bat을 누르면 H2 DB가 실행된다. 실행 시 아래처럼 웹 브라우저를 통해서 새로운 창이 뜬다.
  • 데이터베이스 파일 생성 방법

    • 최초로 등록할 때 한번은, 아래의 캡처 상태처럼 jdbc:h2:~/test에서 연결을 누르면 된다. 이후에는 등록이 된 상태이므로, JDBC URL을 jdbc:h2:tcp://localhost/~/test로 연결을 해야한다. (연결이 중복되어 충돌하는 것을 방지하기 위해 소켓을 사용하는 것이다.)


      연결을 하면 아래의 창으로 이동한다. 참고로, 아래 빨간색 박스를 누르면 다시 나갈 수 있다.

테이블 생성하기

  • H2 데이터베이스에 접근해서 member 테이블 생성
drop table if exists member CASCADE;
create table member
(
 	id bigint generated by default as identity,
 	name varchar(255),
 	primary key (id)
);

참고: 프로젝트 루트(hello-spring 프로젝트 중 소스와 아예 다른 디렉토리)에 sql(디렉토리)/ddl.sql 파일을 생성하면 테이블을 보다 편리하게 확인 및 관리할 수 있다.

2. 순수 JDBC

환경설정

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

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

스프링 부트 데이터베이스 연결 설정 추가

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

Jdbc 리포지토리 구현

main/java/repository/JdbcMemberRepository

// 코드생략

참고: 이런 식으로 JDBC API로 직접 코딩하는 것은 예전 방식이기 때문에 실제로 이런 식으로 코딩을 할 일은 거의 없을 것이다. 따라서 참고만 하는 수준으로 넘어가자

스프링 설정 변경

src/main/java/hello.hellospring/SpringConfig

package hello.hellospring;
import hello.hellospring.repository.JdbcMemberRepository;
import hello.hellospring.repository.JdbcTemplateMemberRepository;
import hello.hellospring.repository.MemberRepository;
import hello.hellospring.repository.MemoryMemberRepository;
import hello.hellospring.service.MemberService;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import javax.sql.DataSource;

@Configuration
public class SpringConfig {
 private final DataSource dataSource;
 // DataSource는 데이터베이스 커넥션을 획득할 때 사용하는 객체다. 
 // 스프링 부트는 DB커넥션 정보를 바탕으로 DataSource를 생성하고 스프링 빈으로 만들어둔다. 
 // 그래서 DI를 받을 수 있다.
 
 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);
 }

구현 클래스 추가 및 스프링 설정 이미지

  • 개방-폐쇄 원칙(OCP, Open-Closed Principle): 확장에는 열려있고, 수정과 변경에는 닫혀있다.
  • 스프링의 DI (Dependencies Injection)을 사용하면 기존 코드를 전혀 손대지 않고, 설정만 수정해서 구현 클래스를 변경할 수 있다. cf) OOP, Assembly
  • 데이터를 DB에 저장하기 때문에 스프링 서버를 다시 실행하더라도 데이터가 잘 저장된다.

3. 스프링 통합 테스트

  • 스프링 컨테이너와 DB까지 연결한 테스트를 통합 테스트라고 한다.
  • 이전에 회원 서비스를 DB 연결없이 테스트한 것을 단위 테스트라고 한다. 

test/java/hello.hellospring/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.assertEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;

@SpringBootTest
@Transactional
class MemberServiceIntegrationTest {
    @Autowired MemberService memberService;
    @Autowired MemberRepository memberRepository;   
    // 테스트케이스를 할 때는 단순히 확인하고 끝이기 때문에 필드 기반으로 주입해서 확인하면 편하다.

    @Test
    public void 회원가입() throws Exception {
        //Given
        Member member = new Member();
        member.setName("hello");
        //When
        Long saveId = memberService.join(member);
        //Then
        Member findMember = memberRepository.findById(saveId).get();
        assertEquals(member.getName(), findMember.getName());
    }
    @Test
    public void 중복_회원_예외() throws Exception {
        //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 : 테스트는 반복해서 사용이 가능해야한다. 이 애너테이션을 달면, 테스트가 시작할 때 데이터베이스는 트랜잭션(insert 등 쿼리 실행)을 다 한 뒤 커밋하지 않은 상태에서 각 테스트가 완료되면 롤백을 해준다.
    따라서 @AfterEach를 사용하지 않아도 DB에 트랜잭션이 반영되지 않아서 다음 테스트에 영향을 주지 않는다.
  • 실무에서 보면, 통합테스트도 필요하지만, 단위테스트가 잘 진행되도록 설계하는 것이 더 바람직하고, 이러한 경우에 좋은 테스트인 경우가 대체로 많다.

4. 스프링 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.sql.ResultSet;
import java.sql.SQLException;
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) {
        jdbcTemplate = new JdbcTemplate(dataSource);
    }
    @Override
    public Member save(Member member) {
        SimpleJdbcInsert jdbcInsert = new SimpleJdbcInsert(jdbcTemplate);
        jdbcInsert.withTableName("member").usingGeneratedKeyColumns("id");
        // 테이블명인 member와 pk인 id를 넣어주면 쿼리를 짤 필요없이 save기능 구현이 가능하다. (document참고)
        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 = ?", memberRowMapper(), id);
        return result.stream().findAny();
    }
    @Override
    public List<Member> findAll() {
        return jdbcTemplate.query("select * from member", memberRowMapper());
    }
    @Override
    public Optional<Member> findByName(String name) {
        List<Member> result = jdbcTemplate.query("select * from member where name = ?", memberRowMapper(), name);
        return result.stream().findAny();
    }
    private RowMapper<Member> memberRowMapper() {
        return (rs, rowNum) -> {
            Member member = new Member();
            member.setId(rs.getLong("id"));
            member.setName(rs.getString("name"));
            return member;
        };
    }
}

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

src/main/java/hello.hellospring/SpringConfig

package hello.hellospring;
import hello.hellospring.repository.JdbcMemberRepository;
import hello.hellospring.repository.JdbcTemplateMemberRepository;
import hello.hellospring.repository.MemberRepository;
import hello.hellospring.repository.MemoryMemberRepository;
import hello.hellospring.service.MemberService;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import javax.sql.DataSource;
@Configuration
public class SpringConfig {
 private final DataSource dataSource;
 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);
 return new JdbcTemplateMemberRepository(dataSource);
 }
}

5. JPA

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

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

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 는 내부에 jdbc 관련 라이브러리도 포함하기 때문에 jdbc는 각주처리 해도 된다.


스프링 부트에 JPA 설정 추가

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

JPA 엔티티 매핑

package hello.hellospring.domain;

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;

@Entity
public class Member {

    @Id @GeneratedValue(strategy = GenerationType.IDENTITY) // id는 DB가 알아서 1씩 올려주는 것인데 이런 것을 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;
    }
}

JPA 회원 리포지토리

package hello.hellospring.repository;
import hello.hellospring.domain.Member;
import javax.persistence.EntityManager;
import java.util.List;
import java.util.Optional;

public class JpaMemberRepository implements MemberRepository {
    private final EntityManager em;
   // JPA는 다 EntityManager로 작동한다. JPA를 쓰려면 EntityManager를 주입받아야 한다.
    
    public JpaMemberRepository(EntityManager em) {
        this.em = em;
    }
    public Member save(Member member) {
        em.persist(member);
        return member;  
        // 이렇게만 하면, 쿼리를 넣지 않아도 JPA가 다 알아서 회원등록을 해준다.
    }
    public Optional<Member> findById(Long id) {
        Member member = em.find(Member.class, id);
        return Optional.ofNullable(member);
    }
    public List<Member> findAll() {
        return em.createQuery("select m from Member m", Member.class)
                // 이 쿼리는 테이블을 대상으로 한 쿼리가 아니라 Entity를 대상으로 쿼리를 날리는 것이다.
                // select m에서 m은 멤버엔티티 객체 자체를 select하는 것이다.
                .getResultList();
    }
    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();
    }
}

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

import org.springframework.transaction.annotation.Transactional
@Transactional // JPA를 쓸 때, 주의할 점 중 서비스 계층에 트랜잭션이 있어야 한다.
public class MemberService {}
  • org.springframework.transaction.annotation.Transactional 를 사용한다.
  • Spring은 해당 클래스의 메서드를 실행할 때 트랜잭션을 시작하고, 메서드가 정상 종료되면 트랜잭션을 커밋한다. 만약 런타임 예외가 발생하게 되면 롤백한다.
  • JPA를 통한 모든 데이터 변경은 트랜잭션 안에서 실행해야 한다.

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

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 DataSource dataSource;
 private final EntityManager em;
 
 public SpringConfig(DataSource dataSource, EntityManager em) {
 this.dataSource = dataSource;
 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);
 }
}

6. 스프링 데이터 JPA

profile
KyungHoon Kim
주니어개발자 시켜줘요
이전 포스트

회원 관리 예제(웹 MVC 개발)

0개의 댓글