스프링 DB 접근 기술

H2 데이터베이스 설치

H2 윈도우에 설치

H2 다운로드 사이트에 들어가서 Last Stable 버전을 다운 후 설치한다.
사이트 주소: http://www.h2database.com/html/download.html

윈도우라 윈도우 버전 설치.

설치된 H2의 bin의 h2.bat을 클릭해 실행시킨다.

자동으로 웹 H2 콘솔이 뜬다. 처음에 비밀번호가 없으므로 그냥 연결 누르면 된다.

h2.bat파일 실행시킬 때 나오는 CMD 창을 꺼버리면 페이지에 연결할 수 없다고 나온다.

Spring에 H2 데이터베이스 연결

• build.gradle의 dependencies에 jdbc와 H2 관련 라이브러리 추가.
• 참고로 runtimeOnly는 실행 시점에만 사용이란 의미. ComplieOnly는 컴파일 시점에만 사용.

• application.properties에 H2 url, driver-class-name, username을 작성
  

스프링 JdbcTemplate

• 스프링 JdbcTemplate과 Mybatis같은 라이브러리는 순수 JDBC에서 사용되는 반복코드를 대부분 제거해준다. 하지만 SQL은 직접 작성해야 한다.
• 현재까지도 실무에서 많이 사용된다.

H2에 Table 생성

스프링 JdbcTemplate 회원 리포지토리

• 이전에 만든 MemoryMemberRepository를 JdbcMemberRepository로 바꿔줄 것이므로, MemberRepository의 인터페이스를 구현해야한다.
  

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

• 생성자가 하나인 경우 @Autowired를 안붙여도 자동으로 의존성 객체가 주입된다.
  

• 전체 소스

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.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;

public class JdbcMemberRepository implements MemberRepository {

    private final JdbcTemplate jdbcTemplate;

    //생성자가 하나인 경우 @Autowired가 없어도 자동으로 의존성 객체를 주입한다.
    public JdbcMemberRepository(DataSource dataSource) {
        this.jdbcTemplate = new JdbcTemplate(dataSource);
    }

    @Override
    public Member save(Member member) {

        //update 구문 만들 필요 없이 jdbcInsert로 넣어주면 된다.
        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;
        };

    }
}

• memberRowMapper() 메서드는 아래와 같이 람다식으로 변경할 수 있다.

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

• memberService의 memberRepository를 MemoryRepository에서 JdbcMemberRepository로 변경

• SpringConfig에서 memberRepository를 변경해준다.
  

• 개방-폐쇄 원칙(OCP, Open-Closed Principle)
  SOLID 원칙 중 하나로 기능 확장에는 열려있고, 소스 수정, 변경에는 닫혀있어야 한다.
  기능을 변경하거나 확장할 수 있으면서 그 기능을 사용하는 코드는 수정하지 않는다.

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

H2 Database 저장 확인

• Hi 저장
  
• Member 목록 조회
  
• H2 Database에서 확인
  

스프링 통합테스트

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

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.assertThrows;

@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
    void 중복_회원_예외() {
        //given
        Member member1 = new Member();
        member1.setName("spring");

        Member member2 = new Member();
        member2.setName("spring");

        //when
        memberService.join(member1);

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

    }
}

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

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

• 순수 Java 테스트가 스프링 컨테이너를 띄울 필요 없기 때문에 훨씬 시간이 적게 걸린다. 또한 순수한 단위 테스트가 훨씬 좋은 테스트일 확률이 높다. 스프링 컨테이너까지 올려야하는 테스트는 테스트 설계가 잘못되었을 확률이 높다.

JPA

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

build.gradle 파일에 JPA 관련 라이브러리 추가

• spring-boot-starter-data-jpa는 내부에 jdbc 관련 라이브러리를 포함한다.
  따라서 jdbc는 제거해도 된다.
  

application.properties에 JPA 설정 추가

• show-sql: JAP가 생성하는 SQL을 출력한다.
• ddl-auto: JPA는 테이블을 자동으로 생성하는 기능을 제공한다.
  none이면 해당 기능을 끄고, create면 엔터티 정보를 바탕으로 테이블도 직접 생성해준다.
  

JPA 엔터티 매핑

• JPA를 ORM (Object-Relational Mapping)이라고 하는 데 이 때 DB 엔터티와 Java 엔터티 간의 매핑을 애노테이션이 한다.

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

• @Id: Primary Key를 의미한다.
• @GeneratedValue: Primary Key의 값 자동 생성 전략. AUTO, IDENTITY, SEQUENCE 등이 있다.

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;

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

    @Override
    public Member save(Member member) {
        //persist 영구 저장. Insert Query를 만들 필요 없다.
        em.persist(member);
        return member;
    }

    @Override
    public Optional<Member> findById(Long id) {
        //select Query를 만들지 않아도 조회해온다. 
        Member member = em.find(Member.class, id);
        return Optional.ofNullable(member);
    }

    @Override
    public List<Member> findAll() {
        //공통 기능으로 제공되지 않는 것은, 직접 Query를 작성할 수 있다. 
        List<Member> result = em.createQuery("select m from Member m", Member.class)
                .getResultList();
        return result;
    }

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

}

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

• JPA를 통한 모든 데이터 변경은 트랜잭션 안에서 실행해야 한다.
• @Transactional이 있으면 스프링은 해당 클래스의 메서드를 실행할 때 트랜잭션을 시작하고, 메서드가 정상 종료되면 트랜잭션을 커밋한다. 만약 런타임 예외가 발생하면 롤백한다.

@Transactional
public class MemberService {

    private final MemberRepository memberRepository;

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

• JPA는 DataSource가 아니라 EntityManager를 사용한다.
  

테스트

• JDBC Temlate에서 사용한 MemberServiceIntegrationTest 그대로 사용하면 된다.
• application.properties에서 show-sql:true로 해놔서 콘솔에 SQL Query가 나오는 것을 알 수 있다.
  

스프링데이터 JPA

• 스프링데이터 JPA를 사용하면, 리포지토리에 구현 클래스 없이 인터페이스 만으로 개발을 완료할 수 있다.
• 반복 개발해온 CRUD 기능도 스프링데이터 JPA가 모두 제공한다.
• 단순하고 반복적인 개발 코드들이 확연하게 줄어들고, 개발자는 핵심 비즈니스 로직을 개발하는데 집중할 수 있다.
• 스프링데이터 JPA는 JPA를 편리하게 사용하도록 도와주는 기술입니다. 따라서 JPA를 먼저 학슴한 후에 스프링데이터 JPA를 학습해야 합니다.

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

• 인터페이스를 통한 기본적인 CRUD

• findByName(), findByEmail(), findByNameAndEmail() 처럼 메서드 이름 만으로 조회 기능 제공

• 페이징 기능 자동 제공
  

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

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

• findByName만 작성하면된다. save, findById, findAll은 상속받은 JpaRepository에 이미 구현되어있으므로, 작성할 필요 없다.
• 리포지토리의 구현체를 생성할 필요 없이, SQL Query도 작성할 필요 없이 기능이 완성된다.
• 스프링데이터 JPA는 메서드 이름만으로 Query가 생성되게끔 만들어졌다.
  findByName: select from Member m whre m.name = ?
  findByNameAndEmail: select from Member m where m.name = ? and m.email = ?
• JpaRepository<Entity 클래스, Primary Key 타입> 이다.

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 {

    Optional<Member> findByName(String name);

}

• 스프링데이터 JPA에서 제공하지 않는 기능은 @Query를 이용해 작성해도 된다.

public interface PostsRepository extends JpaRepository<Posts, Long> {

    //JPA에서 제공하지 않는 것은 이렇게 쿼리로 작성해도 됨
    @Query("Select p From Posts p ORDER BY p.id DESC") 
    List<Posts> findAllDesc();
}

스프링 설정 변경

• 스프링데이터 JPA가 SpringDataJpaMemberRepository 인터페이스의 구현체를 생성해서 스프링 컨테이너의 스프링 빈으로 자동 등록해준다.

테스트

• JDBC Temlate에서 사용한 MemberServiceIntegrationTest 그대로 사용하면 된다.