[Spring Boot] H2 데이터베이스 설치 2

Updated: April 12, 2022

스프링 통합 테스트

이전에 했던 테스트는 순수한 java 코드를 한 것, 스프링과 아무 관련이 없는 테스트

스프링과 테스트를 엮어서 해보자

test/java/com.example.memberproject/service에 MemberServiceTest.java를 복사 붙여넣기, 이름을 MemberServiceIntegrationTest로 수정해 파일 생성 후 코드 수정

이제는 스프링 컨테이너한테 멤버서비스 멤버리퍼지토리 내놔 해야함
테스트는 반복 할 수 있어야 한다.

package com.example.memberproject.service;

import com.example.memberproject.domain.Member;
import com.example.memberproject.repository.MemberRepository;
import com.example.memberproject.repository.MemoryMemberRepository;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
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 // test를 실행할 때, transaction을 먼저 실행하고 db에 데이터를 넣은 다음 rollback을 해줌, 그래서 db에 넣었던 데이터가 깔끔하게 지워짐
class MemberServiceIntegrationTest {

    @Autowired MemberService memberService;
    @Autowired MemberRepository memberRepository;

    @Test
    void 회원가입() {
        // given
        Member member = new Member();
        member.setName("spring");

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

✔️ @SpringBootTest : 스프링 컨테이너와 테스트를 함께 실행

✔️ @Transactional : 테스트 케이스에 이 에노테이션이 있으면, 테스트 시작 전에 트랜잭션을 시작하고, 테스트 완료 후에 항상 rollback 한다. (테스트 하나하나 마다) 이렇게 하면 DB에 데이터가 남지 않으므로 다음 테스트에 영향을 주지 않는다. 테스트 케이스에 붙었을 때만 이렇게 동작

(참고) : 순수한 단위 테스트(java 코드로 최소한의 단위만 하는 것)가 훨씬 좋은 테스트일 확률이 높음 단위단위로 테스트를 잘 쪼개서 할 수 있도록 하고, 스프링 컨테이너 없이 테스트할 수 있도록 훈련해야 함 컨테이너까지 올려야 하는 상황이면 테스트 설계가 잘못됐을 확률이 높음

스프링 JdbcTemplate

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

➡️ JdbcTemplate는 실무에서도 많이 씀

src/main/com.example.memberproject/repository에 JdbcTemplateMemberRepository.java 생성 후 코드 작성

MemberRepository를 implements 한 후, option + enter로 구현 메소드 재정의

public class JdbcTemplateMemberRepository implements MemberRepository{

    private final JdbcTemplate jdbcTemplate;

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

❗ 생성자가 하나만 있으면 스프링 빈으로 등록되어 @Autowired 생략 가능, 자동으로 dataSource 를 injection

findById 메소드 작성

@Override
public Optional<Member> findById(Long id) {
    List<Member> result = jdbcTemplate.query("select * from where id = ?", memberRowMapper());
    return result.stream().findAny();
}

memberRowMapper 메소드 작성

private RowMapper<Member> memberRowMapper() {
        return new RowMapper<Member>() { // 
            @Override
            public Member mapRow(ResultSet rs, int rowNum) throws SQLException {
                Member member = new Member();
                member.setId(rs.getLong("id"));
                member.setName(rs.getString("name"));

                return member;
            }
        }
    }

option + enter 로 해서 람다로 바꾸기

private RowMapper<Member> memberRowMapper() {
    //
    return (rs, rowNum) -> {
        Member member = new Member();
        member.setId(rs.getLong("id"));
        member.setName(rs.getString("name"));

        return member;
    };
}

JdbcTemplateMemberRepository 전체 코드

package com.example.memberproject.repository;

import com.example.memberproject.domain.Member;
import org.springframework.beans.factory.annotation.Autowired;
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;

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

❕(코드 해석해서 정리하기)

SpringConfig.java의 memberRepository() 수정

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

TEST 를 해보자 MemberServiceIntegrationTest 를 실행시켜 본 결과 모두 잘 통과한다.

Screen Shot 2022-04-12 at 5 13 45 PM

JPA

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

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

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

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

스프링 부트에 JPA 설정 추가

resources/appication.properties에 아래 두줄 추가

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는 인터페이스만 제공, 객체랑 ORM이라는 기술, 구현체로 hibernate로 구현,

✔️ 어노테이션으로 db와 매핑!

엔티티랑 매핑을 해야함 ➡️ 어노테이션으로 @Entitiy
pk 매핑 ➡️ @Id

domain/Member.java

package com.example.memberproject.domain;

import javax.persistence.*;

@Entity
public class Member {
    @Id @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id; // 데이터 구분을 위해 system이 저장하는 id

    // @Column(name = "username") // db에 column명이 username일 경우 이렇게 해주면 mapping
    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;
    }
}

@Entity : Member는 JPA가 관리하는 엔티티다. @GeneratedValue(strategy = GenerationType.IDENTITY) : db에서 자동으로 Id를 생성해 주는 것 (= identity)

repository/JpaMemberRepository.java 생성

❗️ JPA를 사용하려면 EntityManager를 주입 받아야 한다.

gradle 파일에서 jpa 라이브러리를 받았으므로(implementation) 스프링 부트가 자동으로 현재 db와 연결해서 EntityManager를 생성해 준다. 만들어진 것을 injection 받으면 된다.

package com.example.memberproject.repository;

import com.example.memberproject.domain.Member;
import org.springframework.transaction.annotation.Transactional;

import javax.persistence.EntityManager;
import java.util.List;
import java.util.Optional;

public class JpaMemberRepository implements MemberRepository {

    private final EntityManager em; // jpa는 EntityManager로 모든게 동작

    public JpaMemberRepository(EntityManager em) { // 스프링 부트가 자동으로 EntityManager 생성, 만들어 진 것을 그냥 injection 받으면 된다
        this.em = em;
    }

    @Override
    public Member save(Member member) {
        em.persist(member); // persist 영속하다, 영구저장하다
        return member; // jpa가 insert 쿼리 다 만들어서 db에 집어넣고, setId까지 해줌
    }

    @Override
    public Optional<Member> findById(Long id) {
        Member member = em.find(Member.class, id); // 조회할 타입, pk
        return Optional.ofNullable(member);
    }

    @Override
    public Optional<Member> findByName(String name) {
        List<Member> result = em.createQuery("select m from Member m where m.name = :name", Member.class) // jpql : 객체지향 쿼리 언어
                .setParameter("name", name)
                .getResultList();

        return result.stream().findAny();
    }

    @Override
    public List<Member> findAll() {
        return em.createQuery("select m from Member m", Member.class) // 객체 자체를 select
                .getResultList(); // jpql : 객체(entity)를 대상으로 쿼리를 날림, 그럼 sql로 번역
    }
}

단축키 : command + option + N : 인라인으로 바꿔줌 단축키 : control + T : 검색

❗️ 주의 : jpa를 쓰려면 항상 transaction이 있어야 함 ➡️ @Transatcional (데이터 변경, 저장할 때 필요)

MemberService.java에 @Transactional 추가

import org.springframework.transaction.annotation.Transactional;

@Transactional
public class MemberService {
    ...
}

스프링은 해당 클래스의 메소드를 실행할 때 transaction 시작, 메소드가 정상 종료되면 transaction을 commit. 만약 런타임 예외가 발생하면 rollback
JPA를 통한 모든 데이터 변경은 transaction 안에서 실행해야 한다.

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

SpringConfig.java 수정

package com.example.memberproject;

import com.example.memberproject.repository.*;
import com.example.memberproject.service.MemberService;
import org.springframework.beans.factory.annotation.Autowired;
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 EntityManager em;

    @Autowired
    public SpringConfig(EntityManager em) {
        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);
    }
}

TEST

회원가입 테스트 해보기

Screen Shot 2022-04-12 at 6 56 43 PM

@Commit을 추가하면 db에 저장된다.

Screen Shot 2022-04-12 at 7 00 20 PM

(하고 데이터 다 지우기 : delete from member;)

모든 테스트 케이스를 실행해보자

Screen Shot 2022-04-12 at 7 01 51 PM

스프링 데이터 JPA

스프링부트와 JPA만 사용해도 개발 생산성이 정말 많이 증가하고 개발해야 할 코드도 확연히 줄어든다. 여기서 스프링 데이터 JPA를 사용하면, 기존의 한계를 넘어 마치 마법처럼, 레퍼지토리에 구현 클래스 없이 인터페이스만으로 개발을 완료할 수 있다. 그리고 반복 개발해온 기본 CRUD 기능도 스프링 데이터 JPA가 모두 제공한다.

스프링부트와 JPA라는 기반 위에 스프링 데이터 JPA라는 환상적인 프레임워크를 더하면 개발이 즐거워진다. 지금까지 조금이라도 단순하고 반복이라 생각했다는 개발 코드들이 확연히 줄어든다.

따라서 개발자는 핵심 비즈니스 로직을 개발하는데 집중할 수 있다. 실무에서 관계형 데이터베이스를 사용한다면 스프링 데이터 JPA는 이제 선택이 아닌 필수❕

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

앞의 JPA 설정을 그대로 사용

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

repository/SpringDataJpaMemberRepository.java 인터페이스 생성

package com.example.memberproject.repository;

import com.example.memberproject.domain.Member;
import org.springframework.data.jpa.repository.JpaRepository;

import java.util.Optional;

public interface SpringDataJpaMemberRepository extends JpaRepository<Member, Long>, MemberRepository { // interface가 interface를 받을 땐 implements가 아니라 extends

    @Override
    Optional<Member> findByName(String name);
}

✔️ interface가 interface를 받을 땐 implements가 아니라 extends

✔️ interface는 다중상속 가능

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

SpringConfig.java

package com.example.memberproject;

import com.example.memberproject.repository.*;
import com.example.memberproject.service.MemberService;
import org.springframework.beans.factory.annotation.Autowired;
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 MemberRepository memberRepository;

    @Autowired // 생략 가능
    public SpringConfig(MemberRepository 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를 스프링 빈으로 자동 등록해줌

테스트를 해보자

Screen Shot 2022-04-12 at 7 41 34 PM

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

➡️ 스프링 데이터 JPA가 SpringDataJpaMemberRepository 인터페이스를 보고 스프링 빈을 자동으로 만들어서 객체를 생성해서 스프링 빈을 올린다.

➡️ 그걸 인젝션 해서 쓴것

➡️ JpaRepository에 기본 공통 메소드들이 다 있다. (save, findById, count, crud….)

➡️ 못만드는 거 : findByName 이런거, 근데 인터페이스 이름만으로도 개발이 끝 (findByName And Id)

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

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

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

✔️ 페이징 기능 자동 제공

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

정리

✔️ 스프링 JdbcTemplate : 반복되는 코드는 굉장히 줄어들지만 SQL은 직접 작성

✔️ JPA : 기본적인 CRUD를 작성하는데 쿼리를 작성할 필요가 없었음 (elect 할 때는 JPQL을 짜야함)

✔️ 스프링 데이터 JPA : 구현 클래스를 작성할 필요가 없이 인터페이스만으로 개발이 끝남, findByName, findByEmail 등 기본적인 메서드를 제공

참고

스프링 입문 - 코드로 배우는 스프링 부트, 웹 MVC, DB 접근 기술

YoonkyungH.log

Share on

Twitter Facebook LinkedIn

Hyeon Jiwon

[Spring Boot] H2 데이터베이스 설치 2

스프링 통합 테스트

스프링 JdbcTemplate

JPA

스프링 데이터 JPA

정리

참고

Share on

Leave a comment

You may also enjoy

[LeetCode] Binary Search

[Spring Boot] AOP

[Spring Boot] H2 데이터베이스 설치 1

[Spring Boot] 회원 관리 예제 : 웹 MVC 개발