[스프링 입문] #6. 스프링 DB 접근 기술

[6om1n]

H2 데이터베이스 설치

• https://www.h2database.com 링크에서 H2 설치
• cmd 창에서 h2.bat 을 입력하여 실행

• 파일을 직접 접근하는 것이 아닌 소캣을 통해서 접근
• 여러 에서 접근 가능하게 하기 위함

• 데이터베이스에 member 테이블 생성

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

• 생성된 테이블 확인 가능

• insert into member(name) values('spring')

• insert into member(name) values('spring2')

  • spring과 spring2 라는 이름을 가진 튜플 두 개 생성

• select * from member 를 통해 member 테이블에 있는 튜플을 볼 수 있다.

---

순수 JDBC

• 스프링 설정 변경

package hello.hellospring;
import hello.hellospring.repository.JdbcMemberRepository;
import hello.hellospring.repository.MemberRepository;
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 {
    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 JdbcMemberRepository(dataSource);
    }
}

• 위에서 return이 기존MemoryMemberRepository 에서 JdbcMemberRepository 로 변경함
• DataSource는 데이터베이스 커넥션을 획득할 때 사용하는 객체이다.
• 스프링 부트는 데이터베이스 커넥션 정보를 바탕으로 DataSource를 생성하고 스프링 빈으로 만들어둔다. 따라서 DI를 받을 수 있다.

• 구현 클래스 추가 이미지

• MemberService는 MemberRepository 를 의존하고 있음.
• MemoryRepository 는 MemoryMemberRepository 와 JdbcMemberRepository 가 있음

• 스프링 설정 이미지

• 기존에 사용하던 memberRepository 대신해서 memberRepository 를 사용한다.

• 실행 화면

• 새롭게 jpa 이름으로 회원 가입 시 기존에 있던 회원 목록과 추가한 회원 목록이 DB에 잘 나오는 것을 확인할 수 있다.

• 개방-폐쇄 원칙 (OCP, Open-Closed Principle)
  • 확장에는 열려있고, 수정, 변경에는 닫혀있다.
• 스프링의 DI (Dependencies Injection) 을 사용하면 기존 코드를 전혀 손대지 않고, 설정만으로 구현 클래스를 변경 할 수 있다.
• 데이터를 DB에 저장하므로 스프링 서버를 다시 실행해도 데이터가 안전하게 저장된다.

---

스프링 통합 테스트

• 스프링 컨테이너와 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.assertEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;

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

    @Test
    public void 회원가입() throws Exception {
        //Given
        Member member = new Member();
        member.setName("hello");
        //When
        Long saveId = memberService.join(member);
        //Then
        Member findMember = memberRepository.findById(saveId).get();
        assertEquals(member.getName(), findMember.getName());
    }

    @Test
    public void 중복_회원_예외() throws Exception {
        //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("이미 존재하는 회원입니다.");
    }
}

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

• 단순히 test를 할 때는 @Autowired 기반으로 받는 것이 편리하다.
• 통합테스트도 필요하지만 단위 테스트를 잘 만드는 테스트가 좋은 테스트이다.

---

스프링 JdbcTemplate

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

package hello.hellospring;

import hello.hellospring.repository.JdbcTemplateMemberRepository;
import hello.hellospring.repository.MemberRepository;
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 {
    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를 사용하면 개발 생산성을 크게 높일 수 있다.

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

• spring-boot-starter-data-jpa 는 내부에 jdbc 관련 라이브러리를 포함하기에, jdbc 는 제거한다.

• 스프링 부트에 JPA 설정 추가

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

• JPA 엔티티 매핑

package hello.hellospring.domain;

import jakarta.persistence.*;

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

• JPA를 사용하려면 엔티티를 매핑해야한다.
• @Entity 라고 작성하면 이것은 JPA가 관리하는 엔티티라고 표현을 한다.
• 조회, 저장, 업데이트 이런건 sql을 짤 필요가 없다. --> 자동으로 되기 때문이다.

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

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

---

스프링 데이터 JPA

스프링 부트와 JPA를 사용하면 개발 생산성이 많이 증가하고, 개발 할 코드도 확연히 줄어든다.
여기에 스프링 데이터 JPA를 사용하면 인터페이스 만으로 개발을 할 수 있다.
CRUD 기능도 스프링 데이터 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 회원 리포지토리를 사용하도록 스프링 설정 변경

package hello.hellospring;

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

• 인터페이스가 인터페이스를 받을 때는 extends 를 사용한다.
• 인터페이스는 다중 상속이 가능하다.

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

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

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

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