[인프런] 스프링 입문 강의 Section6. 스프링 DB 접근 기술

 

---

 

H2 데이터베이스 설치

테이블 생성하기

테이블 관리를 위해 프로젝트 루트에 sql/ddl.sql 파일을 생성

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

H2 데이터베이스에 접근해서 member 테이블 생성

 

---

순수 Jdbc

환경 설정

build.gradle

implementation 'org.springframework.boot:spring-boot-starter-jdbc'
runtimeOnly 'com.h2database:h2'

 

resource/application.yml

spring.datasource.url=jdbc:h2:tcp://localhost/~/test
spring.datasource.driver-class-name=org.h2.Driver
spring.datasource.username=sa

 

순수 JDBC 코드도 강의에서 나오지만 편하게 들으라고 하셔서 편하게 들었습니다ㅎㅎ

 

스프링 설정 이미지

스프링의 DI를 사용하면 기존 코드를 전혀 손대지 않고, 설정만으로 구현 클래스를 변경할 수 있기 때문에 SOLID 원칙 중 OCP(개방-폐쇄)원칙을 잘 지킬 수 있게 됩니다.

 

---

스프링 통합 테스트

회원 서비스 스프링 통합 테스트

이제 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("이미 존재하는 회원입니다.");
    }
}

• @SpringBootText : 스프링 컨테이너와 테스트를 함께 실행
• @Transactional : 테스트 케이스에 쓰면, 테스트 시작 전에 트랙잭션을 시작하고, 테스트 완료 후에 항상 롤백하여서 DB에 데이터가 남지 않아 다음 테스트에 영향을 주지 않을 수 있음. 그래서 @BeforEach, @AfterEach를 안 써도 됨!

 

테스트 DB는 별도로 두어서 테스트를 진행합니다.
가급적이면 순수한 단위 테스트가 더 좋은 테스트라고 합니다.

 

---

스프링 JdbcTemplate

• 순수 JDBC에 비해 간결하긴 하지만 SQL은 직접 작성해야 한다.

 

스프링 JdbcTemplate 회원 리포지토리

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.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;
    
    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 List<Member> findAll() {
        return jdbcTemplate.query("select * from member", memberRowMapper());
    }
    
    @Override
    public Optional<Member> findByName(String name) {
        List<Member> result = jdbcTemplate.query("select * from member where name = ?", memberRowMapper(), name);
        return result.stream().findAny();
    }
    
    private RowMapper<Member> memberRowMapper() {
        return (rs, rowNum) -> {
            Member member = new Member();
            member.setId(rs.getLong("id"));
            member.setName(rs.getString("name"));
            return member;
        };
    }
}

 

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

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

JdbcTemplate는 아직 실무에서도 사용되고 있다 합니다.

 

---

JPA

• 반복 코드 제거는 물론이고, 기존적인 SQL도 JPA가 직접 만들어 실행
• SQL과 데이터 중심의 설계에서 객체 중심의 설계로 패러다임 전환 가능
• 개발 생산성 대폭 상승

 

build.gradle

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
    implementation 'org.springframework.boot:spring-boot-starter-web'
    //implementation 'org.springframework.boot:spring-boot-starter-jdbc'
    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
    
    runtimeOnly 'com.h2database:h2'
    
    testImplementation('org.springframework.boot:spring-boot-starter-test') {
        exclude group: 'org.junit.vintage', module: 'junit-vintage-engine'
    }
}

 

스프링 부트에 JPA 설정 추가(resource/application.yml)

spring.datasource.url=jdbc:h2:tcp://localhost/~/test
spring.datasource.driver-class-name=org.h2.Driver
spring.datasource.username=sa

spring.jpa.show-sql=true
spring.jpa.hibernate.ddl-auto=none

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

 

JPA 엔티티 매핑

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

 

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;
    }
 
    public Member save(Member member) {
        em.persist(member);
        return member;
    }
 
    public Optional<Member> findById(Long id) {
        Member member = em.find(Member.class, id);
        return Optional.ofNullable(member);
    }
 
    public List<Member> findAll() {
        return em.createQuery("select m from Member m", Member.class)
            .getResultList();
    }
 
    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();
    }
}

 

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

import org.springframework.transaction.annotation.Transactional

@Transactional
public class MemberService {}

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

 

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

package hello.hellospring;

import hello.hellospring.repository.*;
import hello.hellospring.service.MemberService;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import javax.persistence.EntityManager;
import javax.sql.DataSource;

@Configuration
public class SpringConfig { 
    private final DataSource dataSource;
    private final EntityManager em;
    
    public SpringConfig(DataSource dataSource, EntityManager em) {
        this.dataSource = dataSource;
        this.em = em;
    }
 
    @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

• 리포지토리에 구현 클래스 없이 인터페이스만으로 개발이 가능
• 기본 CRUD 기능은 스프링 데이터 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 {
    Optional<Member> findByName(String name);
}

 

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

package hello.hellospring;

import hello.hellospring.repository.*;
import hello.hellospring.service.MemberService;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class SpringConfig {
    private final MemberRepository memberRepository; public SpringConfig(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
    }
    
    @Bean
    public MemberService memberService() {
        return new MemberService(memberRepository);
    }
}

• 스프링 데이터 JPA가 SpringDataJpaMemberRepository를 스프링 빈으로 자동 등록

 

스프링 데이터 JPA 

 

제공 기능

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

 

실무에서는 JPA와 스프링 데이터 JPA를 기본적으로 사용

복잡한 동적 쿼리는 Querydsl이라는 라이브러리 사용
쿼리도 자바 코드로 안전하게 작성 가능하고, 동적 쿼리도 편리하게 작성 가능

이 조합으로 해결하기 어려운 쿼리는
JPA가 제공하는 네이티브 쿼리를 사용하거나, JdbcTemplate를 사용