[Spring Boot] [2] 6. 스프링 DB 접근 기술 (2)

윤경·2021년 8월 10일
SpringbootTIL
0

Spring Boot

목록 보기
16/79
post-thumbnail

🔔 스프링 DB 접근 기술 (1) (이전 포스트)

3️⃣ 스프링 통합 테스트

(DB까지 연결된)

🙃 이번 시간도 편안하게 보고 넘기자!

이전까지 했던 test는 사실 순수한 java 코드로만 이루어졌기 때문에 spring과는 아무 관련이 없었음.

✔️ test/java/com.example.hellospring/service에 MemberServiceTest.java를 복사 붙여넣기하고 이름만 다음과 같이 수정하여 파일 생성

package com.example.hellospring.service;

import com.example.hellospring.domain.Member;
import com.example.hellospring.repository.MemberRepository;
import com.example.hellospring.repository.MemoryMemberRepository;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.jupiter.api.Assertions.assertThrows;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.transaction.annotation.Transactional;

import static org.junit.jupiter.api.Assertions.assertEquals;

@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: 스프링 컨테이너와 테스트를 함께 실행 (진짜 spring을 띄워 테스트 한다는 것)
  • @Transactional: 테스트 케이스에 이 애노테이션이 있으면, 테스트 시작 전 트랜젝션을 시작하고 테스트 완료 후 항상 롤백함(테스트 하나하나마다). 이렇게 하면 DB에 데이터가 남지 않으므로 다음 테스트에 영향을 주지 않음. (‼️ 최종적으로 반영하지 않는다는 것) (단, 테스트 케이스에 붙었을 때만 이렇게 동작. 실제 서비스에서는 이렇게 동작 안 함.)

📎 (참고): 순수한 단위 테스트가 훨씬 좋은 테스트일 가능성이 높음. (단위로 쪼개서 테스트 할 수 있도록.) 스프링 컨테이너 없이 테스트 할 수 있게 훈련하여야 함. 스프링 컨테이너가 꼭 필요한 테스트 케이스는 잘못 되었을 가능성이 높음.

4️⃣ 스프링 JdbcTemplate

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

📌 JdbcTemplate는 실무에서도 많이 씀

✔️ src/main/com.example.hellospring/repository 디렉토리에 JdbcTemplateMemberRepository.java 생성 후 아래의 코드 작성

public class JdbcTemplateMemberRepository implements MemberRepository {

⬆️ 이렇게 implements MemberRepository를 해주고 (mac 기준) option+enter로 implement methods 해주기

    private final JdbcTemplate jdbcTemplate;

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

⬆️ 위의 코드 추가. 이 코드는 private- 이 줄을 입력하면 option+enter로 아래 코드를 생성시킬 수 있음. 그리고 내용을 위와 같이 수정해주면 됨. (생성자가 딱 하나만 있으면 스프링 빈으로 등록되어 @Autowired를 생략할 수 있음.)

JdbcTemplateMemberRepository.java 전체 코드

package com.example.hellospring.repository;

import com.example.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 JdbcTemplateMemberRepository implements MemberRepository {

    // JdbcTemplate가 필요
    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;
        };
    }
}

✔️ 이 다음 SpringConfig.java 파일에서 memberRepository() 부분 아래의 코드⬇️로 수정해주기.

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

✔️ test 중에서 MemberServiceIntegrationTest.java를 실행시켜 잘 되는지 확인! ➡️ 나는 중복회원예외에서 에러가 나서 DB 내용을 삭제해버렸더니 됨.(DELETE FROM MEMBER)

왜 안되나 싶어서 코드를 샅샅이 뒤졌는데,,

5️⃣ JPA

🤔 지금까지의 문제점. 뭘까?
☝️ 아, SQL은 개발자가 작성해야 함!

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

✔️ 먼저 라이브러리를 추가하자. 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'
}

위 코드 추가한 다음 코끼리🐘 눌러주기

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

✔️ resources/application.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를 사용하면 엔티티 정보를 바탕으로 테이블도 직접 생성해줌.

‼️ (주의): 스프링부트 2.4부터는 spring.datasource.username=sa를 꼭‼️ 추가해주어야 함. 그렇지 않으면 오류 발생

(JPA는 인터페이스이며 객체랑 ORM이라는 기술임)

✔️ domain/Member.java

package com.example.hellospring.domain;

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;

// @Entity: JPA가 관리하는 entity구나 알 수 있게 됨.
@Entity
public class Member {

    // IDENTITY는 DB가 알아서 직접 생성해주는 방식
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;    // (데이터를 구분하기 위해)고객이 정하는 아이디가 아닌 시스템이 생성하는 아이디
    private String name;

    // 만약 DB에 우리는 똑같이 name이라 되어있지만 username이다? 그러면
    // @Column(name="username") 이렇게 해주면 mapping 됨.
    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;
    }
}

이제 레퍼지토리를 생성해보자!
✔️ repository/JpaMemberRepository.java

package com.example.hellospring.repository;

import com.example.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) {
        em.persist(member);

        return member;
    }

    @Override
    public Optional<Member> findById(Long id) {
        Member member = em.find(Member.class, id);

        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)
                .setParameter("name", name)
                .getResultList();

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

    @Override
    public List<Member> findAll() {

        // option+command+N (inline)
        // (JPQL) 보통은 테이블을 대상으로 쿼리를 날리는데 이건 객체(엔티티)를 대상으로 함.
        return em.createQuery("select m from Member m", Member.class)
                .getResultList();
    }
}

📌 JPA는 EntityManager이라는 것으로 모든 것을 동작시킴.
gradle 파일에서 jpa 라이브러리를 받았으므로(implementation) 스프링부트가 자동으로 EntityManager를 생성해줌(현재 데이터베이스와 연결까지 해서). 그래서 우리는 만들어진 것을 인젝션 받으면 됨.

즉, JPA를 쓰려면 EntityManager를 주입받야아 함!

⬇️ (👩🏻‍💻 mac 기준) control+T 누르면 이렇게 검색할 수 있음 (option+command+N)

‼️ 그리고 JPA를 쓰려면 주의해야 할 것이 항상 @Transactional이 있어야 함. (데이터를 변경, 저장할 때 필요)
다음과 같이 서비스 계층에 트랜젝션을 추가해주자!

✔️ service/MemberService.java - (org.springframework.transaction.annotation.Transactional을 사용)

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

이제 JPA를 사용하도록 스프링 설정을 변경해주자.
✔️ SpringConfig.java

package com.example.hellospring;

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

//import hello.hellospring.repository.JdbcTemplateMemberRepository;

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

TEST

➡️ 지금까지 한 내용으로 살짝 회원가입만 test를 돌려보면 잘 작동하는 것을 확인할 수 있음!

아, 테스트에서 회원가입에 @Commit을 추가하면 데이터베이스에 잘 저장되는 것을 확인할 수 있음 😶

6️⃣ 스프링 데이터 JPA

스프링부트와 JPA만 사용해도 개발 생산성이 정말 많이 증가하고 개발해야 할 코드도 확연히 줄어든다. 여기에 스프링 데이터 JPA를 사용하면, 기존의 한계를 넘어 마치 마법처럼, 레퍼지토리에 구현 클래스 없이 인터페이스만으로 개발을 완료할 수 있다. 그리고 반복 개발해온 기본 CRUD 기능도 스프링 데이터 JPA가 모두 제공한다.
스프링부트와 JPA라는 기반 위에 스프링 데이터 JPA라는 환상적인 프레임워크를 더하면 개발이 정말 즐거워진다. 지금까지 조금이라도 단순하고 반복이라 생각했단 개발 코드들이 확연히 줄어든다.
따라서 개발자는 핵심 비즈니스 로직을 개발하는데 집중할 수 있다. 실무에서 관계형 데이터베이스를 사용한다면 스프링 데이터 JPA는 이제 선택이 아닌 필수❗️

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

✔️ repository/SpringDataJpaMemberRepository.java 라고 ‼️interface‼️ 생성

package com.example.hellospring.repository;

import com.example.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);
}

(인터페이스가 인터페이스를 받을 때는 implements가 아니라 extends라고 함. 인터페이스는 다중 상속이 가능)

✔️ SpringConfig.java

package com.example.hellospring;

import com.example.hellospring.repository.*;
import com.example.hellospring.service.MemberService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

//import hello.hellospring.repository.JdbcTemplateMemberRepository;

import javax.persistence.EntityManager;

@Configuration
public class SpringConfig {

    private final MemberRepository memberRepository;
//    private final EntityManager em;

    @Autowired  // 생성자가 하나인 경우이므로 사실 생략해도 되긴 함.
    public SpringConfig(MemberRepository memberRepository, EntityManager em) {
        this.memberRepository = memberRepository;
//        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가 SpringDataJpaMemberRepository를 스프링 빈으로 자동 등록해줌.

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


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

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

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

🔢 정리

  • JdbcTemplate: 반복되는 코드는 굉장히 줄어들지만 SQL은 직접 작성!!
  • JPA: 기본적인 CRUD를 작성하는데 쿼리를 작성할 필요가 없어졌음!! (select 할 때는 JPQL 필요)
  • 스프링 데이터 JPA: 아예 구현 클래스를 작성할 필요가 없어졌음!! 인터페이스만으로 개발 끝!! 그리고 findByName, findById 등 기본적으로 제공.

🔥 오늘의 TIL 총평

profile
윤경
개발 바보 이사 중
이전 포스트

[Spring Boot] [2] 6. 스프링 DB 접근 기술 (1)

다음 포스트

[Spring Boot] [2] 7. AOP

0개의 댓글