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

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

H2 데이터 베이스 설치하기

  • H2 데이터 베이스는 매우 가벼운 DB로 주로 테스트 용으로 사용한다.

H2 설치하기

  • http://h2database.com/html/main.html로 접속후 All Flatforms선택하고 압축 파일을 다운 후, 압축해제한다.
  • 터미널로 접속후 cd 저장한디렉토리/h2/bin 이동 후 chmod 755 h2.sh로 쉘 파일에 권한 부여한다.
  • 이후 ./h2.sh로 실행하고 아래와 같이 웹 브라우저 띄우면 된다.
  • 데이터베이스 파일 생성 확인을 위해 jdbc:h2:~/test 로 접속한 후, test.mb.db 파일 생성 확인합니다.
  • 정상적으로 있으면, 아래와 같이 jdbc:h2:tcp://localhost/~/test로 접속합니다.

테이블 생성하기

  • 아래의 명령어로 DB 테이블을 생성한다.
create table member
(
    id bigint generated by default as identity,
    name varchar (255),
    primary key(id)
);

순수 JDBC를 이용한 연결

  • build.gralde 설정
 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 레포지토리 구현

  • 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;

    //Spring으로부터 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);
    }

}
  • 봐도 알겠지만 상당히 많은 양의 코드들은 이용해서 DB와 연결해야한다.
  • 요즘은 사용하지 않는 고대의 개발 방식이니 편하게 보고 넘어가도 된다.

스프링 설정 변경

  • 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);
      	}
	}


  • DataSource는 데이터베이스 커넥션을 획득할 때 사용하는 객체이다. 스프링 부트는 데이터 커넥션 정보를 바탕으로 DataSource를 생성하고 스프링 빈으로 만들어둔다. 그래서 DI를 받을 수 있다.
  • 현재 구조 이미지

스프링 통합 테스트

  • 스프링 컨테이너와 DB까지 결합된 스프링스러운 테스트를 구현합니다.
  • MemberServiceIntegrationTest 클래스를 test의 service 패키지에 생성합니다.
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//test가 끝나고 rollback해줘서 DB의 테스트 내용을 초기화해준다.
class MemberServiceIntergrationTest {

    @Autowired
    MemberService memberService;
    @Autowired
    MemberRepository memberRepository;

    @Test
    void 회원가입() {
        //given
        Member member = new Member();
        member.setName("hello");
        //when
        Long saveId = memberService.join(member);
        //then
        Member findMember = memberService.findOne(saveId).get();
        assertThat(member.getName()).isEqualTo(findMember.getName());
    }

    @Test
    void 중복회원방지(){
        //given
        Member member1 = new Member();
        member1.setName("spring");

        Member member2 = new Member();
        member2.setName("spring");
        //when
        memberService.join(member1);
        IllegalStateException exception = assertThrows(IllegalStateException.class, () -> memberService.join(member2));
        assertThat(exception.getMessage()).isEqualTo("이미 존재하는 회원입니다.");

    }
}
  • 기존의 테스트는 순수 자바 코드를 이용하여 각 메서드들이 잘 작동하는지 위한 테스트였다면, 지금의 경우 스프링 및 db와 결합시켜 만들 테스트 코드입니다.
  • 더 이상 localhost에 접속해서 db에 추가가 잘 되었는지 확인할 필요도 없습니다.
  • @SpringBootTest : 스프링 컨테이너와 테스트를 함께 진행합니다.
  • @Transactional : 테스트 케이스에 해당 어노테이션이 존재하면, 테스트 시작전에 트랙잭션을 시작하고 테스트 완료 후에 항상 롤백을 진행합니다. 즉, 테스트를 진행하고 나서도 DB에 데이터를 남기지 않게하는 절차입니다. 그렇기에 이전 테스트 케이스에서 작성했던 @AfterEach 등을 작성하지 않아도 됩니다.

JDBC Template를 이용한 연결

스프링 JdbcTemplate 회원 레포지토리 구현

  • JdbcTemplateMemberRepository 클래스를 레포지토리 패키지 내에 생성한다.
package hello.hellospring.repository;

import hello.hellospring.domain.Member;
import org.apache.catalina.mapper.Mapper;
import org.springframework.beans.factory.annotation.Autowired;
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;

    @Autowired
    public JdbcTemplateMemberRepository(DataSource dataSource) {
        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 = ?",memberRowMapper(),id);
        return result.stream().findAny();
    }

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

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

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

  • 순수 Jdbc와 동일한 환경설정으로 진행하면 됩니다.
  • 스프링 JdbcTemplate과 MyBatis 같은 라이브러리는 JDBC API에서 본 반복 코드를 대부분 제거해주지만 SQL은 직접 작성해야 하는 단점 아닌 단점이 있습니다.

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

  • 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);
      } 

}