스프링 입문 강의 정리 #6

인프런 김영한 강사님의 '스프링 입문 - 코드로 배우는 스프링 부트, 웹 MVC, DB 접근 기술' 듣고 정리한 내용입니다.

 

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

 

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

1. H2 데이터베이스 설치

H2: 개발이나 테스트 용도로 가볍고 편한 DB (웹 화면 제공)

 

Member 테이블 생성 - ddl.sql

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

bigint: 수 십억 개의 데이터가 있을 때 효율성 측면에서 더 좋음! (물론 여기서는 데이터가 많지 않지만...)

 

2. 순수 JDBC

자바가 DB랑  붙으려면? JDBC Driver 필요!

 

build.gradle ➡️ dependencies에 라이브러리 추가

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

 

application.properties ➡️ 스프링부트 데이터베이스 연결 설정

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

 

JDBC란? (Java Database  Connectivity)

자바에서 DB와 연결되어 데이터를 주고받을 수 있게 해주는 프로그래밍 인터페이스

(데이터베이스 종류는 상관없음!)

 

흐름 정도만 알고 넘어가기 ~.~

 

JDBCMemberRepository.java

package com.example.hellospring.repository;

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

    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();
            pstmt = conn.prepareStatement(sql, Statement.RETURN_GENERATED_KEYS);
            pstmt.setString(1, member.getName());
            pstmt.executeUpdate();
            rs = pstmt.getGeneratedKeys();

            if (rs.next()) {
                member.setId(rs.getLong(1));
            } else {
                throw new SQLException("id 조회 실패");
            }

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

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

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

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

    private void close(Connection conn) throws SQLException {
        DataSourceUtils.releaseConnection(conn, dataSource);
    }
}

 

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 javax.sql.DataSource;

@Configuration
public class SpringConfig {

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

DataSource란?

데이터베이스 커넥션을 획득할 때 사용하는 객체로 스프링부트는 DataSource를 생성하고 스프링 빈으로 만들어 준다.

 

<개방-폐쇄 원칙 (OCP)>

- 확장에는 열려 있고, 수정과 변경에는 닫혀 있다.

 

<의존성 주입 (DI)>

- 기존 코드를 전혀 손대지 않고, 설정만으로 구현 클래스 변경

구현 클래스 추가

 

3. 스프링 통합 테스트

회원 서비스 스프링 통합 테스트 - MemberServiceIntegrationTest.java

package com.example.hellospring.service;

import com.example.hellospring.domain.Member;
import com.example.hellospring.repository.MemberRepository;
import org.assertj.core.api.Assertions;
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.junit.jupiter.api.Assertions.assertThrows;

@SpringBootTest
@Transactional
public class MemberServiceIntegrationTest {

    @Autowired
    MemberRepository memberRepository;
    @Autowired
    MemberService memberService;
    // 구현체는 SpringConfig에서 설정한대로 올라옴!

    @Test
    void 회원가입() {
        // given: 어떠한 상황이 주어졌을 때
        Member member = new Member();
        member.setName("spring2");

        // when: 이것을 실행했을 때
        Long saveId = memberService.join(member);

        // then: 결과가 이것이 나온다!
        Member result = memberService.findOne(saveId).get();
        Assertions.assertThat(member.getName()).isEqualTo(result.getName());
    }

    @Test
    public void 중복_회원_예외() {
        Member member1 = new Member();
        member1.setName("spring1");

        Member member2 = new Member();
        member2.setName("spring1");

        memberService.join(member1);
        IllegalStateException e = assertThrows(IllegalStateException.class, () -> memberService.join(member2));
        Assertions.assertThat(e.getMessage()).isEqualTo("이미 존재하는 회원입니다.");
    }
}

 

@SpringBootTest이란?

스프링 컨테이너와 테스트를 함께 실행한다.

 

@Transactional이란?

테스트에 이 어노테이션이 있으면, 테스트를 실행할 때 트랜잭션을 먼저 실행하고 테스트가 끝나면 롤백을 해준다.

= DB에 넣었던 데이터들이 반영이 안되고 깔끔하게 지워짐 ➡️ DB에 실제 데이터가 반영 안됨 ➡️ 다음 테스트 실행 가능

 

테스트는 반복할 수 있어야하고 순수한 단위 테스트가 훨씬 더 좋은 테스트이다! (스프링 컨테이너 없이 테스트 연습해보기)

 

4. 스프링 JDBC Template

JDBCTemplateMemberRepository.java

package com.example.hellospring.repository;

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

 

5. JPA

JPA란?

자바 애플리케이션에서 관계형 데이터베이스를 사용한 방식을 정의한 인터페이스

➡️ 반복 코드 뿐만 아니라 기본적인 SQL문도 직접 만들어서 실행

➡️ SQL과 데이터 중심 설계에서 객체 중심의 설계로 패러다임 전환

➡️ 개발 생산성을 높일 수 있다.

 

build.gradle ➡️ JPA 관련 라이브러리 추가

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

JPA 라이브러리 내부에 JDBC 관련 라이브러리를 포함하기 때문에 제거해도 된다.

 

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 // JPA가 생성하는 SQL문 출력
spring.jpa.hibernate.ddl-auto=none // 객체를 보고 자동으로 테이블을 생성하는 기능을 off (이미 만들었기 때문)

 

spring.jpa.hibernate.ddl-auto=create

▶️ CREATE TABLE까지 자동으로 생성

 

JPA Entity 매핑 - Member.java

package com.example.hellospring.domain;

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

@Entity
public class Member {

    @Id @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id; // 데이터를 구분하기 위한 시스템이 정하는 고객의 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;
    }
}

 

@Id

기본 키(PK) 지정

 

@GeneratedValue

strategy 속성을 통해 자동 생성 전략 지정

@GeneratedValue(strategy = GenerationType.IDENTITY)

▶️ 기본 키 생성을 데이터베이스에 위임 (=DB가 자동으로 알아서 id를 생성)

 

 

JPA 회원 Repository - JPAMemberRepository.java

package com.example.hellospring.repository;

import com.example.hellospring.domain.Member;
import jakarta.persistence.EntityManager;

import java.util.List;
import java.util.Optional;

public class JPAMemberRepository implements MemberRepository{

    private final EntityManager em; // DB와 통신하는 것을 내부적으로 다 처리

    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) {
        // JPQL 객체 지향 쿼리 언어를 써야 함!
        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();
    }
}

 

MemberService.java

import org.springframework.transaction.annotation.Transactional;

@Transactional
public class MemberService {
...
}

 

@Transactional

메서드 실행 시 트랜잭션을 시작하고 메서드가 종료되면 트랜잭션을 커밋하는 것으로, 런타임 예외가 발생할 경우 롤백한다. JPA를 통한 모든 데이터 변경은 트랜잭션 안에서 실행해야 한다.

 

 

JPA 사용하도록 스프링 설정 변경 - SpringConfig.java

package com.example.hellospring;

import com.example.hellospring.repository.*;
import jakarta.persistence.EntityManager;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import javax.sql.DataSource;

// 스프링 빈에 직접 등록
@Configuration
public class SpringConfig {

    private final DataSource 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);
    }

    // 아래 memberRepository를 쓰려면 위 메소드 return 할 때 memberRepository()로 해야 함!
    @Bean
    public MemberRepository memberRepository() {
        // return new MemoryMemberRepository();
        // return new JDBCMemberRepository(dataSource);
        // return new JDBCTemplateMemberRepository(dataSource);
        return new JPAMemberRepository(em);
    }
}

 

6. 스프링 JPA

 

스프링 데이터 JPA 회원 Repository - SpringDataJpaMemberRepository.java

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 {

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

스프링 JPA가 구현체를 자동으로 생성해주므로 그대로 가져다 사용하기만 하면 됨!

 

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

// 스프링 빈에 직접 등록
@Configuration
public class SpringConfig {

    private final MemberRepository memberRepository;

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

    @Bean
    public MemberService memberService() {
        return new MemberService(memberRepository);
    }
}

스프링 JPA가 SpringDataJpaMemberRepository를 스프링 빈으로 자동 등록

 

<스프링 데이터 JPA 제공 기능>

- 인터페이스를 통한 CRUD

- 메서드 이름 만으로 조회

- 페이징 기능 자동