Spring 입문 / 6. DB 접근 기술

1.  H2 DB 설치

H2 DB는 개발이나 테스트 용도로 가볍고 편리한 DB, 웹 화면을 제공

 

테이블 생성

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

2.  순수 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 리포지토리 구현

package kdo6301.spring0.repository;

import kdo6301.spring0.domain.Member;
import kdo6301.spring0.repository.MemberRepository;
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 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);
        }
    }
    @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);
        }
    }
    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);

    }
}

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

• 개방-폐쇄 원칙(OCP, Open-Closed Principle) 확장에는 열려있고, 수정, 변경에는 닫혀있다.

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

  회원을 등록하고 DB에 결과가 잘 입력되는지 확인해보면 데이터를 DB에 저장하므로 스프링 서버를 다시 실행해도 데이터가 안전하게 저장된다.

   

  
  그 외의 코드가 너무 장황하고 올드한 방식이라 코드에 대한 설명 생략. 이렇게 짰다 참고만 하고 넘어감

3.  스프링 통합 테스트

package kdo6301.spring0.service;

import kdo6301.spring0.domain.Member;
import kdo6301.spring0.repository.MemberRepository;
import kdo6301.spring0.repository.MemoryMemberRepository;
import org.assertj.core.api.Assertions;
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.test.annotation.Rollback;
import org.springframework.transaction.annotation.Transactional;

import static org.junit.jupiter.api.Assertions.*;

@SpringBootTest
@Transactional
class MemberServiceIntegrationTest {
    @Autowired MemberService memberService;
    @Autowired MemberRepository memberRepository;

    @Test
    void join()
    {
        //given
        Member member = new Member();
        member.setName("Kim");
        //when
        Long saveId = memberService.join(member);

        //then
        Member One = memberService.findOne(saveId).get();
        Assertions.assertThat(member.getName()).isEqualTo(One.getName());
    }
    @Test
    void 중복회원예외()
    {
        // given
        Member mem1 = new Member();
        mem1.setName("Spring1");

        Member mem2 = new Member();
        mem2.setName("Spring1");

        // when

        memberService.join(mem1);
        IllegalStateException e = assertThrows(IllegalStateException.class, () -> memberService.join(mem2));
        Assertions.assertThat(e.getMessage()).isEqualTo("이미 존재하는 회원입니다.");

//        try
//        {
//            memberService.join(mem2);
//            fail();
//        }catch(IllegalStateException e){
//            Assertions.assertThat(e.getMessage()).isEqualTo("이미 존재하는 회원입니다.");
//        }

        // then
    }

}

앞서 MemoryMemberRepository를 사용할 때에는, @BeforeEach나 @AfterEach를 사용하여 테스트 케이스를 돌릴 때 마다 리포지토리를 초기화 해주어 각 테스트를 독립적으로 실행했었다.

 

+ 우리는 JDBC DB를 이용하여 리포지토리를 사용했으므로 기존에 있던 MemoryMemberRepository가 아닌 MemberRepository로 변경하였다.

 

@Transactional 어노테이션을 사용하면 테스트 진행 전에 트랜잭션을 시작하고, 테스트 완료 후에는 항상 롤백을 진행한다.

이렇게 하면 DB에 데이터가 남지 않아 다음 테스트에 영향을 주지 않는다.

 

@SpringBootTest는 애플리케이션의 전체 Bean을 모두 가져오고, 테스트를 함께 진행한다. 쉽게 말해 스프링 컨테이너와 테스트를 함께 실행한다. 

 

 

4. 스프링 JdbcTemplate

순수 Jdbc와 동일한 환경설정을 하면 된다.
스프링 JdbcTemplate과 MyBatis 같은 라이브러리는 JDBC API에서 본 반복 코드를 대부분 제거해준다. 하지만 SQL은 직접 작성해야 한다.

 

스프링 JdbcTemplate 회원 리포지토리

package kdo6301.spring0.repository;

import kdo6301.spring0.domain.Member;
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) {
        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 = ?", 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;
        };
    }
}

0. memberRowMapper

- RowMapper를 사용하면 원하는 형태의 결과값을 반환할 수 있다.

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

member를 생성하고 resultset rs로부터 아이디와 이름을 받아와  member객체에 저장한다.

 

1. findByID , name, All

 

query에 대한 결괏값을 memberRowMapper()에 매핑하여 리스트 형태로 리턴

 

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

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

 

5.  JPA

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

 

 

JPA 엔티티 매핑

package kdo6301.spring0.domain;

import jdk.jfr.Name;

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)
    private Long id;

    private String name;

    public Long getId() {
        return id;
    }

    public String getName() {
        return name;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public void setName(String name) {
        this.name = name;
    }

}

 

JPA 회원 리포지토리

package kdo6301.spring0.repository;

import kdo6301.spring0.domain.Member;
import org.springframework.transaction.annotation.Transactional;

import javax.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 as 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 as m",Member.class).getResultList();

    }
}

JPA를 사용하면 개발코드들이 확연하게 줄어드는 것을 볼 수 있다.

 

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

import org.springframework.transaction.annotation.Transactional
  @Transactional
  public class MemberService {}

스프링은 해당 클래스의 메소드를 실행할 때 트랜잭션을 시작하고 메소드가 종료되면 트랜잭션을 커밋한다.

JPA를 통한 모든 데이터 변경은 트랜잭션 안에서 실행해야 한다.

 

빈 계층 변경

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

 

6. 스프링 데이터 JPA

스프링 부트와 JPA만 사용해도 개발생산성이 많이 증가했지만, 여기에 더불어 스프링 데이터 JPA를 사용하면 기존의 한계를 넘어 인터페이스 만으로 개발을 완료할 수 있다.

스프링 데이터 JPA는 JPA를 편리하게 사용하도록 도와주는 기술로 JPA를 먼저 배운후에 스프링 데이터 JPA를 학습하는 것이 좋다.

 

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

package kdo6301.spring0.repository;

import kdo6301.spring0.domain.Member;
import org.springframework.data.jpa.repository.JpaRepository;

import java.util.Optional;

public interface SpringDataJpaMemberRepository extends JpaRepository<Member, Long>, MemberRepository{

    // JPQL - select m from Member as m where m.name = ?
    @Override
    Optional<Member> findByName(String name);
}

 

문법 / interface는 extends를 통해 다중 상속이 가능하다. 

 

JpaRepository에는 findAll(), saveAll() 등과 같은 메소드들이 기본적으로 구현되어 있는데 이 기본 메소드외의 findByName, findById 같은 메소드들은 메소드 이름을 통해 JPA가 JPQL문을 생성하여 자동적으로 기능을 구현하여 제공해준다 !

 

- 스프링 데이터 JPA 제공 기능

• JpaRepository에는 findByName() , findByEmail() 처럼 메서드 이름을 통한 조회 기능을 제공한다.
• 페이징 기능 제공
• 인터페이스를 통한 기본적인 CRUD

 

❗️참고

실무에서는 JPA와 스프링 데이터 JPA를 기본으로 사용하고, 복잡한 동적 쿼리는 Querydsl이라는 라이브러리를 사용하면 된다. Querydsl을 사용하면 쿼리도 자바 코드로 안전하게 작성할 수 있고, 동적 쿼리도 편리하게 작성할 수 있다.

이 조합으로 해결하기 어려운 쿼리는 JPA가 제공하는 네이티브 쿼리를 사용하거나, 앞서 학습한 스프링 JdbcTemplate를 사용하면 된다.

 

스프링 빈에 등록

package kdo6301.spring0;

import kdo6301.spring0.repository.*;
import kdo6301.spring0.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);
    }

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

}

 

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

 

 

<정리>

 

>   H2를 설치하여 데이터베이스를 설치하여 순수한 jdbc 기술로 사용해 봤더니 메소드 하나하나 구현 파트가 가독성이 떨어지고 코드가 장황함.

 

>   통합테스트를 만들어보았음

 

>  Jdbctemplate 를 사용해봤지만 sql 직접 작성해야 한다는 단점이 있었음

 

>  jpa는 기본적인 crud(create, read, update, delete) 하는데 쿼리 작성할 필요 없었음

 

> 스프링 데이터 jpa를 사용해보니 아예 구현 클래스를 작성할 필요가 없이 인터페이스만으로 개발을 할 수 있었음

 

 

<참고 자료>

 

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-%EC%9E%85%EB%AC%B8-%EC%8A%A4%ED%94%84%EB%A7%81%EB%B6%80%ED%8A%B8/dashboard

[무료] 스프링 입문 - 코드로 배우는 스프링 부트, 웹 MVC, DB 접근 기술 - 인프런 | 강의

 

https://atoz-develop.tistory.com/entry/H2-Database-%EC%84%A4%EC%B9%98-%EC%84%9C%EB%B2%84-%EC%8B%A4%ED%96%89-%EC%A0%91%EC%86%8D-%EB%B0%A9%EB%B2%95

H2 Database 설치, 서버 실행, 접속 방법 (Windows, MacOS)

https://mommoo.tistory.com/62

트랜잭션(Transaction)이란?