[Spring] 스프링 DB 접근 기술

H2 데이터베이스

---

웹 콘솔로 접근

https://www.h2database.com/html/download-archive.html

h2 데이터베이스 설치

 

bin 폴더에서 h2.bat파일 실행 (window)

 

처음에 데이터베이스 파일을 만들어야 한다.

연결 화면 -> test.mv.db 파일이 생성된다.

 

JDBC URL을 jdbc:h2:~/test처럼 접근하면 애플리케이션과 웹 콘솔이 동시에 접근하면 오류가 발생할 수 있다.

 

JDBC URL을 jdbc:h2:tcp://localhost/~/test와 같이 바꿔서 연결한다.

파일에 직접 접근하는 것이 아니라 소켓을 통해서 접근하면 여러 군데서 접근할 수 있다. 

 

테이블 생성

generated by default as identity

-> 값을 정하지 않고 insert 하면 DB가 자동으로 id값을 채워준다.

 

sql 폴더를 생성하여 dbl.sql 파일에 sql을 관리.

 

 

순수 JDBC

---

애플리케이션에서 DB에 연동하여 저장하여 insert쿼리, select쿼리를 이용해 데이터를 넣고 빼보기

 

설정

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

자바는 기본적으로 DB와 연동하려면 JDBC 드라이버가 반드시 있어야 한다.

DB가 제공하는 클라이언트가 필요한데 그것을 h2데이터베이스로 설정.

 

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

 

JDBC API 활용

기존에 MemoryMemberRepository를 만들었는데 인터페이스를 만들었기 때문에 구현체 생성

repository 패키지에 JdbcMemberRepository 클래스 생성

 

전체 코드

// import 생략

public class JdbcMemberRepository implements MemberRepository {
    private 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);
    }
}

 

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

DB에 붙이려면 DataSource가 필요하다.

Spring한테 의존성을 주입받아야 하기 때문에 생성자를 만든다.

dataSource.getConnection()해서 DB를 연결할 수 있다.

 

DB에 insert 하면 

// import 생략

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

코드 변경 없이 JdbcMemberRepository 클래스를 만들고 인터페이스를 구현체를 만들어 확장했다.

SpringConfig를 조금 수정하고 데이터를 조회하면 기존에 생성했던 데이터가 남아있다.

MemberService는 MemberRepository를 의존하고 있다.

MemberRepository는 구현체로 MemoryMemberRepository, JdbcMemberRepository가 있다.

jdbcmemberRepository로 구현체 변경.

개방 폐쇄 원칙(OCP, Open-Closed Principle)
확장에는 열려있고, 수정, 변경에는 닫혀있다.
객체 지향의 다향성을 잘 활용하면 기능을 변경해도 애플리케이션에 동작하는 코드를 수정하지 않아도 된다.

스프링의 DI을 사용하면 기존 코드를 전혀 손대지 않고, 설정만으로 구현 클래스를 변경할 수 있다.
데이터를 DB에 저장하므로 스프링 서버를 다시 실행해도 데이터가 안전하게 저장된다.

객체지향의 핵심 중 하나.
기존 코드를 변경하지 않고 인터페이스에서 구현체를 바꾸는 것.

 

 

개방 폐쇄 원칙(OCP, Open-Closed Principle)
확장에는 열려있고, 수정, 변경에는 닫혀있다.
객체 지향의 다향성을 잘 활용하면 기능을 변경해도 애플리케이션에 동작하는 코드를 수정하지 않아도 된다.

스프링의 DI를 사용하면 기존 코드를 전혀 손대지 않고, 설정만으로 구현 클래스를 변경할 수 있다.
데이터를 DB에 저장하므로 스프링 서버를 다시 실행해도 데이터가 안전하게 저장된다.

객체 지향의 핵심 중 하나
기존 코드를 변경하지 않고 인터페이스를 활용하여 구현체를 바꾸는 것

 

 

통합 테스트

---

test/service에 기존의 MemberServiceTest와 같은 MemberServiceIntegrationTest 클래스 생성

 

기존 MemberServiceTest

// import 생략

@SpringBootTest
@Transactional
class MemberServiceIntegrationTest {

    MemberService memberService;
    MemoryMemberRepository memberRepository;

    @BeforeEach
    public void beforeEach() {
        memberRepository = new MemoryMemberRepository();
        memberService = new MemberService(memberRepository);
    }
    @AfterEach
    public void afterEach() {
        memberRepository.clearStore();
    }

    @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
    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("이미 존재하는 회원입니다."); // 메세지 같은지 확인.
        // 메세지 검증
        /*try {
            memberService.join(member2);
            fail();
        } catch (IllegalStateException e) {
            assertThat(e.getMessage()).isEqualTo("이미 존재하는 회원입니다.");
        }*/


        //then
    }
    @Test
    void findMembers() {
    }

    @Test
    void findOne() {
    }
}

 

수정 후 MemberServiceIntegrationTest

// import 생략
@SpringBootTest
@Transactional
class MemberServiceIntegrationTest {

    @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
    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("이미 존재하는 회원입니다."); // 메세지 같은지 확인.
    }

}

@BeforEach와 @AfterEach가 붙은 메서드들을 지운다.

스프링 컨테이너한테 MemberService, MemberRepository를 받아야 한다.

생성자로 DI 할 수 있지만 테스트는 가장 끝단에 있기 때문에 가장 편한 @Autowired를 사용한다.

 

테스트를 두 번 실행하면 DB에 spring이 남아있기 때문에 에러가 발생한다.

 

@Transactional은 테스트를 DB에 데이터를 쿼리에 맞게 실행하고 

테스트가 끝나면 RollBack을 해준다. DB에 넣은 데이터가 반영이 안 되고 다 지워진다.

 

@SpringBootTest : 스프링 컨테이너와 테스트를 함께 실행한다.
@Transactional : 테스트 케이스에 이 annotation이 있으면, 테스트 시작 전에 트랜잭션을 시작하고, 테스트 완료 후에 항상 롤백한다. 이렇게 하면 DB에 데이터가 남지 않으므로 다음 테스트에 영향을 주지 않는다.

 

 

JdbcTemplate

---

• 순수 Jdbc와 동일한 환경설정을 한다.
• 스프링 JdbcTemplate와 Mybatis 같은 라이브러리는 JDBC API에서 본 반복 코드를 대부분 제거해준다.
• SQL은 직접 작성해야 한다.
• 실무에서 많이 쓴다.

public class JdbcTemplateMemberRepository implements MemberRepository{

    private final JdbcTemplate jdbcTemplate;

    @Autowired
    public JdbcTemplateMemberRepository(DataSource dataSource) {
        jdbcTemplate = new JdbcTemplate(dataSource);
    }

생성자가 하나면 @Autowired를 생략해도 Bean에 등록된다.

Spring이 dataSource를 jdbTemplate에 주입해준다.

 

// import 생략

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());
        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로 구현했을 때보다 코드가 훨씬 줄어든 것을 볼 수 있다.

 

// import 생략

@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);
        return new JdbcTemplateMemberRepository(dataSource);
    }
}

구현체 변경

 

 

JPA 

---

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

JPA는 객체와 RDB의 테이블을 매핑하는 것.

 

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

 

resources/application.properties 에 JPA설정 추가

 

 

JPA 엔티티 매핑

package hello.hellospring.domain;

import javax.persistence.*;

@Entity
public class Member {

    @Id @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    
    private String name;

	...
}

@Entity - JPA가 관리하는 Entity

@Id - PK를 매핑

@GenerateValue(strategy = GenerationType.IDENTITY)

쿼리에 ID를 넣는 게 아니라 DB에 값을 넣으면 ID를 자동으로 생성하는 것 - IDENTITY

 

JPA 회원 리포지토리

public class JpaMemberRepository implements MemberRepository{

    private final EntityManager em;

    public JpaMemberRepository(EntityManager em) {
        this.em = em;
    }
    ...
}

JPA는 EntityManager로 모든 동작을 한다.

JPA관련 라이브러리를 추가하면 스프링 부트가 자동으로 EntityManager를 생성한다.

만들어진 EntityManager로 Injection 하면 된다.

설정들과 데이터 커넥션 정보를 합쳐서 스프링 부트가 EntityManager를 만들어 준다.

EntityManager는 내부적으로 DataSource를 갖고 DB와 통신하는 것을 내부적으로 처리한다.

JPA를 쓰려면 EntityManager를 주입받아야 한다.

 

// import 생략

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

 

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

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

스프링은 해당 클래스의 메서드를 실행할 때 트랜잭션을 시작하고

메서드가 종료되면 트랜잭션을 커밋한다. 만약 런타임 예외가 발생하면 롤백한다.

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

 

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

// import 생략

@Configuration
public class SpringConfig {

    private EntityManager em;

    @Autowired
    public SpringConfig(EntityManager em) {
        this.em = em;
    }

    //    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);
//        return new JdbcTemplateMemberRepository(dataSource);
        return new JpaMemberRepository(em);
    }
}

 

 

스프링 데이터 JPA

---

스프링 부트와 JPA만 사용해도 개발 생산성이 많이 증가하고, 개발해야 할 코드도 확연히 줄어든다.
여기에 스프링 데이터 JPA를 사용하면, 기존의 한계를 넘어 마치 마법처럼, 리포지토리에 구현 클래스 없이 인터페이스 만으로 개발을 할 수 있다. 그리고 반복 개발해온 기본 CRUD 기능도 스프링 데이터 JPA가 모두 제공한다.
스프링 부트와 JPA라는 기반 위에, 스프링 데이터 JPA라는 프레임워크를 더하면 개발이 즐거워진다.
조금이라도 단순하고 반복이라 생각했던 코드들이 줄어든다.
개발자는 핵심 비즈니스 로직을 개발하는데 집중할 수 있다.
실무에서 관계형 데이터베이스를 사용한다면 스프링 데이터 JPA는 선택이 아니라 필수다.

스프링 데이터 JPA는 JPA를 편리하게 사용하도록 도와주는 기술이다.
따라서 JPA를 먼저 학습한 후에 스프링 데이터 JPA를 학습해야 한다

 

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

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

스프링 데이터 JPA가 구현체를 자동으로 컨테이너에 등록해준다.

 

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

package hello.hellospring;

import hello.hellospring.repository.*;
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);
    }

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

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

 

 

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

 

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

참고 : 실무에서는 JPA와 스프링 데이터 JPA를 기본으로 사용하고, 복잡한 동적 쿼리는 Querydsl이라는 라이브러리를 사용하면 된다. Querydsl을 사용하면 쿼리도 자바 코드로 안전하게 작성할 수 있고, 동적 쿼리도 편리하게 작성할 수 있다. 이 조합으로 해결하기 어려운 쿼리는 JPA가 제공하는 네이티브 쿼리를 사용하거나, 앞서 학습한 스프링 JdbcTemplate를 사용하면 된다.