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

🍀 Spring Boot

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

dmaolon 2021. 11. 23. 01:08

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

[무료] 스프링 입문 - 코드로 배우는 스프링 부트, 웹 MVC, DB 접근 기술 - 인프런 | 강의

스프링 입문자가 예제를 만들어가면서 스프링 웹 애플리케이션 개발 전반을 빠르게 학습할 수 있습니다., 스프링 학습 첫 길잡이! 개발 공부의 길을 잃지 않도록 도와드립니다. 📣 확인해주세

www.inflearn.com

인프런 김영한님 강좌인 스프링 입문 - 코드로 배우는 스프링 부트, 웹 MVC, DB 접근 기술 내용을 학습하며 다룬 글입니다.
문제(저작권, 오류 및 잘못된 부분 등)가 있다면 알려주세요!!

PREV)

스프링 입문 - 5. 회원 관리 예제 - 웹 MVC 개발

[Spring] 스프링 입문 - 5. 회원 관리 예제 - 웹 MVC 개발

스프링 입문 - 코드로 배우는 스프링 부트, 웹 MVC, DB 접근 기술 [무료] 스프링 입문 - 코드로 배우는 스프링 부트, 웹 MVC, DB 접근 기술 - 인프런 | 강의 스프링 입문자가 예제를 만들어가면서 스프

dmaolon00.tistory.com

[1. H2 데이터베이스 설치]
[2. 순수 JDBC]
[3. 스프링 통합 테스트]
[4. 스프링 JdbcTemplate]
[5. JPA]
[6. 스프링 데이터 JPA]

[1. H2 데이터베이스 설치]

https://www.h2database.com 에서 다운로드
H2>bin>h2.bat 실행

jdbc:h2:~/test 로 JDBC URL 설정 후 연결

test.mv.db 파일 생성 확인
이후부터는 jdbc:h2:tcp://localhost/~/test 로 접속
문제가 생긴다면, test.mv.db를 지웠다가 다시 위의 방법을 해준다.

member 테이블 생성

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

bigint : Long 타입
generated by default as identity : null 값이 들어왔을 때 자동으로 id 값을 채워줌

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

SELECT * FROM MEMBER

[실행 결과]

[2. 순수 JDBC]

해당 내용은 요즘에는 잘 사용되지 않기도 하고 구현 내용이 길다보니 따로 정리는 해주지 않겠습니당,,,

build.gradle 에 다음 내용 추가

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

resources/application.properties 에 다음 내용 추가

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

까지 해준 후 DB와 연결을 위해 JDBC 리포지토리를 구현해주는데, 생략

스프링의 DI(Dependencies Injection)을 사용하면 기존 코드에 손대지 않고도, 설정만으로 구현 클래스를 변경할 수 있다.

[3. 스프링 통합 테스트]

DELETE FROM MEMBER

테스트를 진행하면서 겹치는 이름이 존재할 수 있으므로, 기존 데이터베이스를 비워주었다.

회원 서비스 스프링 통합 테스트
java/hello/hellospring/service/MemberServiceIntegrationTest.java

package hello.hellospring.service;

import hello.hellospring.domain.Member;
import hello.hellospring.repository.MemberRepository;
import hello.hellospring.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  
class MemberServiceIntegrationTest {


    @Autowired MemberService memberService;
    @Autowired MemberRepository memberRepository;

    @Test
    public 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));   //asserThrows : 예외 처리 메서드, ()->가 실행되고 예외가 발생해야 한다.
        assertThat(e.getMessage()).isEqualTo("이미 존재하는 회원입니다.");

    }

}

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

실제 스프링을 가지고 하는 테스트는 단순히 자바 코드로만 진행되는 순수 테스트(단위 테스트)보다 시간이 오래 걸린다. 따라서 단위 테스트로 진행되도록 구현하는 것이 좋은 코드라고 한다.

[4. 스프링 JdbcTemplate]

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

스프링 JdbcTemplate 회원 리포지토리
java/hello/hellospring/repository/JdbcTemplateMemberRepository.java

package hello.hellospring.repository;

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

}

순수 JDBC와 비교해보면 훨씬 간단하게 작성할 수 있음

JdbcTemplate을 사용하도록 스프링 설정 변경
java/hello/hellospring/SpringConfig.java

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.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import javax.sql.DataSource;

@Configuration
public class SpringConfig {

//    Autowired
//    DataSource dataSource;
    private DataSource dataSource; //스프링 부트에서 제공해준다.

    @Autowired
    public SpringConfig(DataSource dataSource) {
        this.dataSource = dataSource;
    }

    // memberService를 스프링 빈으로 등록
    @Bean
    public MemberService memberService() {
        return new MemberService(memberRepository()); // 스프링 빈에 등록되어 있는 MemberRepository를 MemberService에 넣어줌
    }

    // memberRepository를 스프링 빈으로 등록
    @Bean
    public MemberRepository memberRepository() {
        //return new MemoryMemberRepository();
        //return new JdbcMemberRepository(dataSource);
        return new JdbcTemplateMemberRepository(dataSource);  //@@!!@@ 여기를 바꿔준다
    } 
}

[참고]
https://suhwan.dev/2019/02/24/jpa-vs-hibernate-vs-spring-data-jpa/

JPA, Hibernate, 그리고 Spring Data JPA의 차이점

개요 Spring 프레임워크는 어플리케이션을 개발할 때 필요한 수많은 강력하고 편리한 기능을 제공해준다. 하지만 많은 기술이 존재하는 만큼 Spring 프레임워크를 처음 사용하는 사람이 Spring 프레

suhwan.dev

[5. JPA]

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

JPA(Java Persistence API)는 ORM(Object Relational database Mapping) 기술이다. (데이터 단위로 객체를 구현하고, 데이터간의 관계를 형성)

build.gradle에 다음 내용 추가

//implementation 'org.springframework.boot:spring-boot-starter-jdbc'
	implementation 'org.springframework.boot:spring-boot-starter-data-jpa'

spring-boot-starter-jpa 는 내부에 jdbc 관련 라이브러리를 포함하므로 jdbc 제거해도 된다.

application.properties 에 다음 내용 추가

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

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

JPA 엔티티 설정
java/hello/hellospring/domain/Member.java

package hello.hellospring.domain;

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

@Entity  //JPA가 관리하는 엔티티가 된다.
public class Member {

    @Id      //primary key
    @GeneratedValue(strategy = GenerationType.IDENTITY) // DB에 값을 입력해주면, 자동으로 id값이 설정된다.(identity 전략)
    private Long id;  //임의의 값. 고객이 정하는 id가 아니라 데이터 구분을 위한 시스템 id

    // @Column(name = "username") 유저이름일 경우 이렇게 설정, DB에 있는 name과 매핑된다.
    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 어노테이션으로 매핑해주어 JPA가 관리할 수 있도록 한다.
@Id : primary key를 의미한다
@GeneratedValue(strategy = GenerationType.IDENTITY) : insert into member(name) values ('spring') 처럼 데이터베이스에 값을 입력해주면 자동으로 id 값이 설정된다, 이것을 identity 전략이라고 한다.

JPA 회원 리포지토리 생성
java/hello/hellospring/repository/JpaMemberReporitory.java

package hello.hellospring.repository;

import hello.hellospring.domain.Member;

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

public class JpaMemberReporitory implements MemberRepository {

    private final EntityManager em; //JPA는 EntityManger라는 것으로 모든 것이 동작된다.(data-jpa를 라이브러리로 설정하면 스프링 부트가 자동으로 EntityManger를 생성해준다.

    public JpaMemberReporitory(EntityManager em) {
        this.em = em;
    }

    @Override
    public Member save(Member member) {
        em.persist(member); //persist : 영구 저장하다라는 뜻, insert, id 모든 것을 알아서 해준다.
        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() {
        return em.createQuery("select m from Member m", Member.class) //Member(= Entity) (as) m이라는 객체에서 m이라는 객체 자체를 불러온다.
                .getResultList();
    }
}

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

@Transactional
public class MemberService {...}

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

JPA를 사용하도록 스프링 설정 변경
java/hello/hellospring/SpringConfig.java

package hello.hellospring;

import hello.hellospring.repository.*;
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.persistence.EntityManager;
import javax.sql.DataSource;

@Configuration
public class SpringConfig {

    //    Autowired
//    DataSource dataSource;
//    private DataSource dataSource; //스프링 부트에서 제공해준다.
//
//    @Autowired
//    public SpringConfig(DataSource dataSource) {
//        this.dataSource = dataSource;
//    }


    private EntityManager em;

    @Autowired
    public SpringConfig(EntityManager em) {
        this.em = em;
    }

    // memberService를 스프링 빈으로 등록
    @Bean
    public MemberService memberService() {
        return new MemberService(memberRepository()); // 스프링 빈에 등록되어 있는 MemberRepository를 MemberService에 넣어줌
    }

    // memberRepository를 스프링 빈으로 등록
    @Bean
    public MemberRepository memberRepository() {
        //return new MemoryMemberRepository();
        //return new JdbcMemberRepository(dataSource);
        //return new JdbcTemplateMemberRepository(dataSource);
        return new JpaMemberReporitory(em);
    }
}

스프링 통합 테스트에서 @Commit 어노테이션을 이용하면 실제 데이터베이스에 테스트값이 추기됨을 확인해볼 수 있다.

[6. 스프링 데이터 JPA]

스프링 데이터 JPA를 사용하면, 리포지토리에 구현 클래스 없이 인터페이스만으로 개발을 완료할 수 있다. 그리고 반복 개발을 해온 기본 CRUD 기능도 스프링 데이터 JPA에서 모두 제공된다.
따라서, 핵심 비지니스 로직을 구현하는 것에 집중할 수 있다.

스프링 데이터 JPA 회원 리포지토리
java/hello/hellospring/repository/SpringDataJpaMemberRepository.java

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

SpringDataJpaMemberRepository 인터페이스가 JpaRepository를 갖고 있으면, 구현체를 자동으로 만들어준다. → 스프링 빈으로 자동으로 등록해준다.
스프링 데이터 JPA가 SpringDataJpaMemberRepository를 스프링 빈으로 자동 등록해준다.

스프링 데이터 JPA 회원 리포지토리를 사용하도록 스프링 설정 변경
java/hello/hellospring/SpringConfig.java

package hello.hellospring;

import hello.hellospring.repository.*;
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.persistence.EntityManager;
import javax.sql.DataSource;

@Configuration
public class SpringConfig {

    //    Autowired
//    DataSource dataSource;
//    private DataSource dataSource; //스프링 부트에서 제공해준다.
//
//    @Autowired
//    public SpringConfig(DataSource dataSource) {
//        this.dataSource = dataSource;
//    }


//    private EntityManager em;
//
//    @Autowired
//    public SpringConfig(EntityManager em) {
//        this.em = em;
//    }

    private final MemberRepository memberRepository;

    @Autowired
    public SpringConfig(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
    }

    // memberService를 스프링 빈으로 등록
    @Bean
    public MemberService memberService() {
        return new MemberService(memberRepository); // 스프링 빈에 등록되어 있는 MemberRepository를 MemberService에 넣어줌
    }

    // memberRepository를 스프링 빈으로 등록
//    @Bean
//    public MemberRepository memberRepository() {
        //return new MemoryMemberRepository();
        //return new JdbcMemberRepository(dataSource);
        //return new JdbcTemplateMemberRepository(dataSource);
//        return new JpaMemberReporitory(em);
//    }
}

스프링 데이터 JPA 제공 기능
- 인터페이스를 통한 기본적인 CRUD
(JpaRepository에서 제공하는 메소드들을 통해 쿼리문 작성 없이 기본적인 CRUD가 가능하다.)
- findByName() , findByEmail() 처럼 메서드 이름 만으로 조회 기능 제공
- 페이징 기능 자동 제공

NEXT)
스프링 입문 - 7. AOP

[Spring] 스프링 입문 - 7. AOP

dmaolon00.tistory.com