스프링 DB 접근 기술

최도혁·2023년 3월 5일
Spring입문
0

Spring

목록 보기
6/8

스프링 데이터 액세스

  • H2 데이터베이스 사용
  • 스프링 통합 테스트
  • 스프링 JdbcTemplate
  • JPA
  • 스프링 데이터 JPA

H2 데이터베이스

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

테이블 생성하기
테이블 관리를 위해 프로젝트 루트에 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 테이블 생성

스프링 통합 테스트

스프링 컨테이너와 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에 데이터가 남지 않으므로 다음 테스트에 영향을 주지 않는다.

스프링 JdbcTemplate

스프링 JdbcTemplate과 MyBatis 같은 라이브러리는 JDBC API에서 본 반복 코드를 대부분 제거해준다. 하지만 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);
    }
}

JPA

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

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

dependencies {
	`
    `
    implementation 'org.springframework.boot:spring-boot-starter-data-jpa' 
    runtimeOnly 'com.h2database:h2' 
    `
    `
}

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

스프링 부트에 JPA 설정 추가
경로 : resources/application.properties

`
`
spring.jpa.show-sql=true
spring.jpa.hibernate.ddl-auto=none
  • show-sql
    JPA가 생성하는 SQL을 출력한다.

  • ddl-auto
    JPA는 테이블을 자동으로 생성하는 기능을 제공하는데 none 를 사용하면 해당 기능을 끈다.

  • create 를 사용하면 엔티티 정보를 바탕으로 테이블도 직접 생성해준다.

!주의!

스프링부트 2.4부터는 spring.datasource.username=sa 를 꼭 추가해주어야 한다. 그렇지 않으면 오류가 발생한다.

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를 사용하도록 스프링 설정 변경

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

스프링 부트와 JPA만 사용해도 개발 생산성이 정말 많이 증가하고, 개발해야할 코드도 확연히 줄어듭니다. 여기에 스프링 데이터 JPA를 사용하면,
리포지토리에 구현 클래스 없이 인터페이스 만으로 개발을 완료할 수 있습니다.
그리고 반복 개발해온 기본 CRUD 기능도 스프링 데이터 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이라는 라이브러리를 사용하면 된다. Querydsl을 사용하면 쿼리도
자바 코드로 안전하게 작성할 수 있고, 동적 쿼리도 편리하게 작성할 수 있다.
이 조합으로 해결하기 어려운 쿼리는 JPA가 제공하는 네이티브 쿼리를 사용하거나, 앞서 학습한 스프링 JdbcTemplate를 사용하면 된다.

profile
최도혁
백엔드 개발자 지망생
이전 포스트

웹 MVC 개발

다음 포스트

JPA 연관관계 매핑

0개의 댓글