[Spring] 스프링 DB 접근 기술 - 1

인프런의 스프링 입문 - 코드로 배우는 스프링 부트, 웹 MVC, DB 접근 기술를 정리한 글이다

🏃🏻‍♀️ H2 데이터베이스 설치

1. 다운로드

H2 데이터베이스 : 개발이나 테스트 용도로 가볍고 편리한 DB, 웹 화면 제공 (admin 화면)

다운로드 URL로 들어가서 설치를 한다. (h2 데이터베이스 버전은 스프링 부트 버전에 맞춘다.)

2. 권한 주기 (Mac 기준)

맥 사용자는 권한을 줘야 하므로, 다운받은 폴더(h2) 아래 bin 폴더로 들어가서 h2.sh 파일 권한을 준다.

chmod 755 h2.sh // 파일 권한 주기

3. 실행

h2.sh 파일을 실행하면 다음과 같은 화면이 뜬다.

[참고]

URL에 localhost:8082~ 이 아니라 

이런 식으로 ip 주소가 뜨면, 화면이 뜨지 않는다.
이걸 localhost:8082~으로 바꿔줘야 제대로 뜬다.

 

JDBC URL에 위와 같이 뜨는데, 연결 버튼을 클릭하면 home 디렉터리에 test.mv.db 파일이 생성된다.

이후부터는 접속할 때, JDBC URL에 jdbc:h2:tcp://localhost/~/test를 입력하고 접속해야 한다!

 

4. 테이블 생성하기

drop table if exsits member CASCADE;

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

명령어를 입력해 실행해주면, 테이블이 생성된다.

 

insert 명령어를 사용해 데이터를 넣어준다.

5. DDL 관리

src와 같은 위치에 sql 폴더를 생성하고, ddl.sql에 위의 ddl 코드를 입력해 버전 관리를 할 수 있다.

 

🏃🏻‍♀️ 순수 JDBC

1. 환경 설정

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

 

2. JDBC 레포지토리 구현

JDBC API로 직접 코딩하는 건 20년 전 이야기이므로, 참고용으로 보는 게 좋음

repository 패키지 아래에 JdbcMemberRepository 생성

package hello.hellospring.repository;

import hello.hellospring.domain.Member;
import org.springframework.jdbc.datasource.DataSourceUtils;

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

public class JdbcMemberRepository implements MemberRepository {

    private final DataSource dataSource;

    public JdbcMemberRepository(DataSource dataSource) {
        this.dataSource = dataSource;
    }

    @Override
    public Member save(Member member) {
        String sql = "insert into member(name) values(?)";

        Connection conn = null;
        PreparedStatement pstmt = null;
        ResultSet rs = null;

        try {
            conn = getConnection();
            pstmt = conn.prepareStatement(sql,
                    Statement.RETURN_GENERATED_KEYS);
            pstmt.setString(1, member.getName());
            pstmt.executeUpdate();
            rs = pstmt.getGeneratedKeys();
            if (rs.next()) {
                member.setId(rs.getLong(1));
            } else {
                throw new SQLException("id 조회 실패");
            }
            return member;
        } catch (Exception e) {
            throw new IllegalStateException(e);
        } finally {
            close(conn, pstmt, rs);
        }
    }

    @Override
    public Optional<Member> findById(Long id) {
        String sql = "select * from member where id = ?";
        Connection conn = null;
        PreparedStatement pstmt = null;
        ResultSet rs = null;
        try {
            conn = getConnection();
            pstmt = conn.prepareStatement(sql);
            pstmt.setLong(1, id);
            rs = pstmt.executeQuery();
            if(rs.next()) {
                Member member = new Member();
                member.setId(rs.getLong("id"));
                member.setName(rs.getString("name"));
                return Optional.of(member);
            } else {
                return Optional.empty();
            }
        } catch (Exception e) {
            throw new IllegalStateException(e);
        } finally {
            close(conn, pstmt, rs);
        }
    }

    @Override
    public Optional<Member> findByName(String name) {
        String sql = "select * from member where name = ?";
        Connection conn = null;
        PreparedStatement pstmt = null;
        ResultSet rs = null;

        try {
            conn = getConnection();
            pstmt = conn.prepareStatement(sql);
            pstmt.setString(1, name);
            rs = pstmt.executeQuery();
            if(rs.next()) {
                Member member = new Member();
                member.setId(rs.getLong("id"));
                member.setName(rs.getString("name"));
                return Optional.of(member);
            }
            return Optional.empty();
        } catch (Exception e) {
            throw new IllegalStateException(e);
        } finally {
            close(conn, pstmt, rs);
        }
    }

    @Override
    public List<Member> findAll() {
        String sql = "select * from member";

        Connection conn = null;
        PreparedStatement pstmt = null;
        ResultSet rs = null;

        try {
            conn = getConnection();
            pstmt = conn.prepareStatement(sql);
            rs = pstmt.executeQuery();
            List<Member> members = new ArrayList<>();
            while(rs.next()) {
                Member member = new Member();
                member.setId(rs.getLong("id"));
                member.setName(rs.getString("name"));
                members.add(member);
            }
            return members;
        } catch (Exception e) {
            throw new IllegalStateException(e);
        } finally {
            close(conn, pstmt, rs);
        }
    }

    private Connection getConnection() {
        return DataSourceUtils.getConnection(dataSource);
    }

    private void close(Connection conn, PreparedStatement pstmt, ResultSet rs) {
        try {
            if (rs != null) {
                rs.close();
            }
        } catch (SQLException e) {
            e.printStackTrace();
        }

        try {
            if (pstmt != null) {
                pstmt.close();
            }
        } catch (SQLException e) {
            e.printStackTrace();
        }

        try {
            if (conn != null) {
                close(conn);
            }
        } catch (SQLException e) {
            e.printStackTrace();
        }
    }

    private void close(Connection conn) throws SQLException {
        DataSourceUtils.releaseConnection(conn, dataSource);
    }
}

 

3. 스프링 설정 변경

SpringConfig 파일 변경

-> DataSource를 연결해주고, MemberRepository의 return 값을 JdbcMemberRepository로 바꾼다.

package hello.hellospring;

import hello.hellospring.repository.JdbcMemberRepository;
import hello.hellospring.repository.MemberRepository;
import hello.hellospring.repository.MemoryMemberRepository;
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 {

    /**
     * 스프링부트가 자체적으로 dataSource를 생성하고, 주입해준다.
     */
    private DataSource dataSource;

    @Autowired
    public SpringConfig(DataSource dataSource) {
        this.dataSource = dataSource;
    }

    /**
     * memberService와 memberRepository를 스프링 빈에 등록하고,
     * memberService와 memberRepository 의존관계 설정
     */
    @Bean
    public MemberService memberService() {
        return new MemberService(memberRepository()); // Autowired와 비슷
    }

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

 

4. 연결 확인

localhost:8080으로 들어가서, 회원 목록을 클릭하면 다음과 같이 JDBC 데이터베이스에 들어있는 회원 정보가 나타난다.

구현 클래스 추가 이미지

 

스프링 설정 이미지

* 개방-폐쇄 원칙 (OCP, Open-Closed Principle)

        : 확장에는 열려있고, 수정, 변경에는 닫혀있다.

* 스프링의 DI(Dependencies Injection)을 사용하면 기존 코드를 전혀 손대지 않고, 설정만으로 구현 클래스를 변경할 수 있다.

* 회원을 등록하고 DB에 결과가 잘 입력되는지 확인하자.

* 데이터를 DB에 저장하므로 스프링 서버를 다시 실행해도 데이터가 안전하게 저장된다.

 

🏃🏻‍♀️ 스프링 통합 테스트

스프링 컨테이너와 DB까지 연결한 통합 테스트를 진행해보자.

test/.../service 패키지 아래에 MemberSerivceTest를 복사한 MemberServiceIntegrationTest를 생성한다.

package hello.hellospring.service;

import hello.hellospring.domain.Member;
import hello.hellospring.repository.MemberRepository;
import hello.hellospring.repository.MemoryMemberRepository;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
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 // 테스트 시작 전에 트랜잭션을 시작하고, 테스트 완료 후에 항상 롤백한다! -> DB에 데이터가 남지 않으므로, 다음 테스트에 영향을 주지 않는다.
class MemberServiceIntegrationTest {

    // 테스트할 때는 손쉽게 필드 @Autowired 해도 상관 없다.
    @Autowired MemberService memberService;
    @Autowired MemberRepository memberRepository;

    @Test
    void 회원가입() { // 테스트 코드는 한글로 적어도 됨 (직관적) -> 빌드될 때 테스트 코드는 실제 코드에 포함되지 않음
        // given 무언가가 주어지고
        Member member = new Member();
        member.setName("spring");

        // when 실행됐을 때
        Long saveId = memberService.join(member);

        // then 이런 결과가 나와야 함
        Member findMember = memberService.findOne(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);
        /**
         * 방법 1
         * try - catch 사용
         */
        /*
        try {
            memberService.join(member2);
            fail("예외가 발생해야 합니다.");
        } catch (IllegalStateException e) {
            assertThat(e.getMessage()).isEqualTo("이미 존재하는 회원입니다.");
        }
        */
        /**
         * 방법 2
         * assertThrows 사용
         */
        IllegalStateException e = assertThrows(IllegalStateException.class, () -> memberService.join(member2));// member2를 join하면 IllegalStateException이 발생해야 한다는 뜻!

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

        // then

    }
}

@SpringBootTest와 @Transactional 어노테이션을 붙여준다.

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

@Transactional : 테스트 케이스에 이 어노테이션이 있으면, 테스트 시작 전에 트랜잭션을 시작하고, 테스트 완료 후에 항상 롤백한다. 이렇게 하면 DB에 데이터가 남지 않으므로 다음 테스트에 영향을 주지 않는다.