섹션7. 스프링 DB 접근 기술

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

섹션7. 스프링 DB 접근 기술

dlng23 2024. 11. 23. 17:56

H2 데이터베이스 설치

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

https://www.h2database.com 에서 다운로드

h2.bat 입력하여 실행

실행 후 화면

jdbc:h2:~/test (최초 한번)

연결 버튼 클릭

~/test.mv.db 파일 생성 확인

jdbc:h2:tcp://localhost/~/test 입력하여 연결

테이블 생성하기

ctrl + Enter 로 실행

모두 지운 상태로 MEMBER 클릭하면 자동으로 SELECT * FROM MEMBER 입력됨

insert into member(name) values('spring1')

insert into member(name) values('spring2') 입력 후 결과

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

순수 JDBC

환경 설정

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

스프링 부트 데이터베이스 연결 설정 추가

resources/application.properties 에 추가

스프링부트 2.4 부터는 spring.datasource.username=sa 추가해주어야 함

Jdbc 리포지토리 구현

지금은 JDBC API로 직접 코딩X (과거에 개발자들이 했었음)

Jdbc 회원 리포지토리

repository에 JbdcMemberRepository 생성

package hello.hellospring.repository;

import hello.hellospring.domain.Member;
import org.springframework.jdbc.datasource.DataSourceUtils;

import javax.sql.DataSource;
import java.sql.*;
import java.util.ArrayList;
import java.util.List;
import java.util.Optional;

public class JdbcMemberRepository implements MemberRepository {

    private final DataSource dataSource; //db에 붙으려면 dataSource 필요

    public JdbcMemberRepository(DataSource dataSource) {
        this.dataSource = dataSource;
    }

    @Override
    public Member save(Member member) {
        String sql = "insert into member(name) values(?)";

        Connection conn = null;
        PreparedStatement pstmt = null;
        ResultSet rs = null; //결과를 받음

        try {
            conn = getConnection(); //connection을 가지고 옴
            pstmt = conn.prepareStatement(sql, Statement.RETURN_GENERATED_KEYS); //두번째 인자는 insert를 해봐야 id 값 얻을 수 있었는데, 그때 사용
            pstmt.setString(1, member.getName()); //첫번째 인자 parameterIndex:1에서 1은 위 sql문의 물음표와 매칭됨, member.getName으로 값을 넣음

            pstmt.executeUpdate(); //DB의 실제 query가 날라감
            rs = pstmt.getGeneratedKeys();//prepareStatement 두번째 인자와 매칭되어, 방금 생성된 키(id) 반환해줌

            if (rs.next()) { //값이 있으면 꺼냄
                member.setId(rs.getLong(1)); //값을 꺼내어 세팅
            } else { //실패 시
                throw new SQLException("id 조회 실패");
            }
            return member;
        } catch (Exception e) { //exception 매우 많기에 try catch 잘 해주어야 함
            throw new IllegalStateException(e);
        } finally {
            close(conn, pstmt, rs);
        }//자원들 release 해야 함, db connection은 외부 네트워크가 연결된 것이기 때문에 끝나면 바로 끊어줘야 함
    }
    
    //조회
    @Override
    public Optional<Member> findById(Long id) {
        String sql = "select * from member where id = ?";
		
        Connection conn = null;
        PreparedStatement pstmt = null;
        ResultSet rs = null;
		
        try {
            conn = getConnection();
            pstmt = conn.prepareStatement(sql);
            pstmt.setLong(1, id);
			
            rs = pstmt.executeQuery(); //조회는 executeQuery() (executeUpdate()가 아니라)

            if(rs.next()) {
                Member member = new Member();
                member.setId(rs.getLong("id"));
                member.setName(rs.getString("name"));
                return Optional.of(member); //반환
            } else {
                return Optional.empty();
            }

        } catch (Exception e) {
            throw new IllegalStateException(e);
        }finally {
            close(conn, pstmt, rs);
        }

    }
    @Override
    public List<Member> findAll() {
        String sql = "select * from member";

        Connection conn = null;
        PreparedStatement pstmt = null;
        ResultSet rs = null;

        try {
            conn = getConnection();
            pstmt = conn.prepareStatement(sql);

            rs = pstmt.executeQuery();

            List<Member> members = new ArrayList<>(); //리스트에 담음
            while(rs.next()) {
                Member member = new Member();
                member.setId(rs.getLong("id"));
                member.setName(rs.getString("name"));
                members.add(member);
            }

            return members; //멤버 리스트 반환
        } catch (Exception e) {
            throw new IllegalStateException(e);
        } finally {
            close(conn, pstmt, rs);
        }
    }

    @Override
    public Optional<Member> findByName(String name) {
        String sql = "select * from member where name = ?";

        Connection conn = null;
        PreparedStatement pstmt = null;
        ResultSet rs = null;

        try {
            conn = getConnection();
            pstmt = conn.prepareStatement(sql);
            pstmt.setString(1, name);

            rs = pstmt.executeQuery();

            if(rs.next()) {
                Member member = new Member();
                member.setId(rs.getLong("id"));
                member.setName(rs.getString("name"));
                return Optional.of(member);
            }

            return Optional.empty(); //없을 시 empty
        } catch (Exception e) {
            throw new IllegalStateException(e);
        } finally {
            close(conn, pstmt, rs);
        }
    }
    
    //DataSourceUtils를 통해서 커넥션을 획득 → 데이터베이스 커넥션 똑같은 걸 유지시켜줌
    private Connection getConnection() {
        return DataSourceUtils.getConnection(dataSource);
    }

    private void close(Connection conn, PreparedStatement pstmt, ResultSet rs) {
        try {
            if (rs != null) {
                rs.close();
            }
        } catch (SQLException e) {
            e.printStackTrace();
        }
        try {
            if (pstmt != null) {
                pstmt.close();
            }
        } catch (SQLException e) {
            e.printStackTrace();
        }
        try {
            if (conn != null) {
                close(conn);
            }
        } catch (SQLException e) {
            e.printStackTrace();
        }
    }

	//닫을 때도 DataSoruceUtils를 이용하여 release
    private void close(Connection conn) throws SQLException {
        DataSourceUtils.releaseConnection(conn, dataSource);
    }
}

스프링 설정 변경

SpringConfig 변경

package hello.hellospring;

import hello.hellospring.repository.JdbcMemberRepository;
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;
import javax.xml.crypto.Data;

@Configuration
public class SpringConfig {

    private DataSource dataSource; //앞(application properties)에 설정해둔 파일보고 datSource 제공해줌, 자체적으로 빈 생성

    @Autowired
    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); //JdbcMemberRepository로 바꿈
    }
}

다른 어떤 코드 변경 없이 jdbc member repository 클래스 생성 후 인터페이스 확장

configuration만 변경하였음

http://localhost:8080/ 에서 회원목록 들어가면 spring, spring2 있음

회원 가입으로 jpa 등록하면 회원목록 들어갔을 때 아래와 같이 나옴

db 콘솔에서 쿼리 날려보면 3 jpa 들어가있는 모습 확인 가능

구현 클래스 추가 이미지

MemberService는 MemberRepository 의존하고 있음

MemberRepository는 구현체로 MemoryMemberRepository 와 JdbcMemberRepository가 있음

기존에는 메모리 버전의 멤버 리포지토리를 스프링 빈으로 등록

→ <memory> memberRepository를 빼고 jdbc 버전의 멤버 리포지토리 등록

조립하는 코드는 수정해야 하지만 애플리케이션 동작하는 데 필요한 코드들은 변경하지 않아도 됨

개방-폐쇄 원칙(OCP, Open-Closed Principle)
- 확장에는 열려있고, 수정, 변경에는 닫혀있다.
스프링 DI (Dependencies Injection)을 사용하면 기존 코드를 전혀 손대지 않고, 설정만으로 구현 클래스를 변경할 수 있음

스프링 통합 테스트

스프링 컨테이너와 DB까지 연결한 통합 테스트 진행

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

기존 memberServiceTest 복사 붙여넣기 하여 MemberServiceIntegrationTest 생성 후, 일부 수정

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 //annotation 추가 
@Transactional //annotation 추가
class MemberServiceIntegrationTest {

    @Autowired MemberService memberService;
    @Autowired MemberRepository memberRepository; //MemmoryMemberRepository를 MemberRepository로 수정
	//@Autowired annotation 추가

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

       /* try {
            memberService.join(member2);
            fail();
        } catch (IllegalStateException e){
            assertThat(e.getMessage()).isEqualTo("이미 존재하는 회원입니다. 123123");
        }*/

        //then
    }

}

직접 객체 생성해서 넣었었는데 테스트 케이스할 때는 필드 기반으로 @Autowired 받는게 편함

MemoryMemberRepository → MemberRepository : 구현체는 SpringConfig 한 곳에서 올라옴

@BeforeEach, @AfterEach 삭제

회원가입만 실행

error 발생 ('이미 존재하는 회웝입니다.')

db에 이미 이름 spring인 데이터가 남아있기 때문

DB 데이터 삭제

실제로는 운영중인 DB 데이터 삭제하는 것이 아니라 테스트 전용 DB를 따로 구축

모두 지운 상태에서 test 진행

제대로 동작

Transactional 주석 처리

테스트 실행 후 DB 확인해보면 올라가 있음

다시 한번 실행

오류 발생 ('이미 존재하는 회원입니다.')

테스트는 반복할 수 있어야 함

DB 데이터 삭제 만들기 번잡 → @Transactionl

@Transactionl을 달면 테스트 실행할 때 트랜잭션을 먼저 실행하고 DB에 데이터를 인서트 쿼리를 하고 다 넣은 다음 테스트가 끝나면 롤백 해줌 → DB에 넣었던 데이터가 다 지워짐

@Transactionl 주석 처리 제거 후 실행

테스트 종료 후 롤백되기 때문에 DB에 데이터 남지 않음

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

스프링 Jdbc Template

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

스프링 JdbcTemplate 회원 리포지토리

hello.hellospring.repository 패키지 안에 JdbcTemplateMemberRepository 클래스 생성

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) {
        this.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;
        };
    }
}

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

import javax.sql.DataSource;
import javax.xml.crypto.Data;

@Configuration
public class SpringConfig {

    private DataSource dataSource;

    @Autowired
    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

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

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

plugins {
	id 'java'
	id 'org.springframework.boot' version '3.3.5'
	id 'io.spring.dependency-management' version '1.1.6'
}

group = 'hello'
version = '0.0.1-SNAPSHOT'

java {
	toolchain {
		languageVersion = JavaLanguageVersion.of(21)
	}
}

repositories {
	mavenCentral()
}

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'
	testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
}

tasks.named('test') {
	useJUnitPlatform()
}

spring-boot-starter-dat-jpa 는 내부에 jdbc 관련 라이브러리를 포함 → jdbc 제거해도 됨

스프링 부트에 JPA 설정 추가

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

JPA 엔티티 매핑

package hello.hellospring.domain;

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

@Entity //JPA가 관리하는 엔티티라는 것을 설정하는 애노테이션, 테이블과 매핑됨
public class Member {

    @Id @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

	//@Column(name = "user_name") 컬럼명과 필드 이름이 같으면 안해도 됨
    private String name;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }
}

JPA 회원 리포지토리

package hello.hellospring.repository;

import hello.hellospring.domain.Member;

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

public class JpaMemberRepository implements MemberRepository{

    //JPA는 EntityManager로 동작
    private final EntityManager em; 
    //JPA 라이브러리를 받으면 스프링이 자동으로 스프링 빈으로 등록해줌
    public JpaMemberRepository(EntityManager em) {
        this.em = em;
    }

	//PK 기반의 쿼리들은 EntityManager에서 제공해주는 메소드 사용
    @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);
    }

	//pk 기반이 아닌 쿼리들은 jpql 언어 작성, 테이블을 대상으로 쿼리를 보내지 않고 객체를 대상으로 쿼리를 보냄
    @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)
                .getResultList();
    }
}

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

 import org.springframework.transaction.annotation.Transactional
 
 @Transactional
 public class MemberService {}

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

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

package hello.hellospring;

import hello.hellospring.repository.*;
import hello.hellospring.service.MemberService;
import jakarta.persistence.EntityManager;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import javax.sql.DataSource;
import javax.xml.crypto.Data;

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

스프링 데이터 JPA

스프링 부트와 JPA만 사용해도 개발 생산성이 많이 증가, 개발해야 할 코드 확연히 줄어듦

리포지토리에 구현 클래스 없이 인터페이스만으로 개발을 완료할 수 있음

반복 개발해온 기본 CRUD 기능을 스프링 데이터 JPA가 모두 제공함

스프링 데이터 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 {

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

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

package hello.hellospring;

import hello.hellospring.domain.Member;
import hello.hellospring.repository.*;
import hello.hellospring.service.MemberService;
import jakarta.persistence.EntityManager;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import javax.sql.DataSource;
import javax.xml.crypto.Data;

@Configuration
public class SpringConfig {

    private final MemberRepository memberRepository;

    @Autowired
    public SpringConfig(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'를 스프링 빈으로 자동 등록해줌

Spring Data JPA 기본적인 CRUD, 단순조회들이 제공이 됨'

스프링 데이터 JPA 제공 기능

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

'백엔드 > 스프링 입문 - 코드로 배우는 스프링 부트, 웹 MVC, DB 접근 기술' 카테고리의 다른 글

섹션8. AOP (0)	2024.11.23
섹션6. 회원 관리 예제 - 웹 MVC 개발 (0)	2024.11.16
섹션5. 스프링 빈과 의존관계 (0)	2024.11.16
섹션4. 회원 관리 예제 - 백엔드 개발 (0)	2024.11.16
섹션3. 스프링 웹 개발 기초 (0)	2024.11.09

현재글섹션7. 스프링 DB 접근 기술

dlng23

Today :
Yesterday :

dlng23