[Spring] 스프링 DB 접근 기술 - 2

인프런의 스프링 입문 - 코드로 배우는 스프링 부트, 웹 MVC, DB 접근 기술를 정리한 글이다.

 

h2 실행을 해둬야 제대로 동작한다.

🏃🏻‍♀️ 스프링 JdbcTemplate

* 순수 Jdbc와 동일한 환경설정을 하면 된다.

* 스프링 JdbcTemplate과 MyBatis 같은 라이브러리는 JDBC API에서 본 반복 코드를 대부분 제거해준다. 하지만 SQL은 직접 작성해야 한다.

 

1. 스프링 JdbcTemplate 회원 레포지토리 작성

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 {

    /**
     * JdbcTemplate 사용
     */
    private final JdbcTemplate jdbcTemplate;

//    @Autowired // 생성자가 하나일 때는 @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) {
        // 결과가 나오는 걸 RowMapper를 사용해서 매핑을 해줘야 한다.
        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;
        };
    }
}

 

2. JdbcTemplate을 사용하도록 스프링 설정 변경

SpringConfig를 다음과 같이 변경한다. (MemberRepository 부분)

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 {

    /**
     * 스프링부트가 자체적으로 dataSource를 생성하고, 주입해준다.
     */
    private final DataSource dataSource;

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

    /**
     * memberService와 memberRepository를 스프링 빈에 등록하고,
     * memberService와 memberRepository 의존관계 설정
     */
    @Bean
    public MemberService memberService() {
        return new MemberService(memberRepository()); // Autowired와 비슷
    }

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

 

3. 테스트 실행

MemberServiceIntegrationTest를 실행하면 다음과 같이 정상적으로 작동한다.

 

🏃🏻‍♀️ JPA

* JPA는 기존의 반복 코드는 물론이고, 기본적인 SQL도 JPA가 직접 만들어서 실행해준다.

* JPA를 사용하면, SQL과 데이터 중심의 설계에서 객체 중심의 설계로 패러다임을 전환할 수 있다.

* JPA를 사용하면 개발 생산성을 크게 높일 수 있다.

 

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

build.gradle 파일에 jdbc 관련 주석 처리 후,

implementation 'org.springframework.boot:spring-boot-starter-data-jpa'를 추가해준다.

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

 

2. 스프링 부트에 JPA 설정 추가

resources/application.properties에 다음 코드를 추가한다.

주의!

스프링부트 2.4부터는 spring.datasource.username=sa를 꼭 추가해줘야 한다.
그렇지 않으면 오류가 발생한다.

* show-sql : JPA가 생성하는 SQL을 출력

* ddl-auto : JPA는 테이블을 자동으로 생성하는 기능을 제공하는데, none을 사용하면 해당 기능을 끈다.

    * create을 사용하면 엔티티 정보를 바탕으로 테이블도 직접 생성해준다.

 

3. JPA 엔티티 매핑

기존의 domain/Member 코드에 @Entity 어노테이션을 추가해주고, id 필드에 @Id와 @GeneratedValue~를 추가한다.

package hello.hellospring.domain;


import javax.persistence.*;

// ORM (Object - Relational DB table - Mapping)
@Entity // JPA가 관리하는 entity
public class Member {

    @Id @GeneratedValue(strategy = GenerationType.IDENTITY) // DB가 알아서 생성해주는 걸 IDENTITY라고 한다.
    private Long id;

//    @Column(name = "username") // DB의 username 컬럼과 매핑된다.
    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;
    }
}

 

4. JPA 회원 레포지토리

repository 패키지 아래에 JpaMemberRepository를 생성한다.

package hello.hellospring.repository;

import hello.hellospring.domain.Member;

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

public class JpaMemberRepository implements MemberRepository {

    /**
     * 스프링부트가 자동으로 EntityManager를 생성해준다.
     */
    private final EntityManager em; // JPA는 EntityManager가 모든걸 동작한다.

    // JPA를 사용하려면 EntityManager를 주입해줘야 한다.
    public JpaMemberRepository(EntityManager em) {
        this.em = em;
    }

    @Override
    public Member save(Member member) {
        em.persist(member); // JPA가 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) {
        /**
         * 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() {
        /**
         * JPQL이라는 쿼리 언어를 사용해야 한다. 엔티티를 대상으로 쿼리를 날린다.
         * 객체 자체를 select한다.
         */
        return em.createQuery("select m from Member m", Member.class)
                .getResultList();
    }
}

 

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

JPA를 사용할 때는 서비스 계층에 트랜잭션을 추가해줘야 한다. (@Transactional 어노테이션 추가)

* org.springframework.transaction.annotation.Transactional 사용

* 스프링은 해당 클래스의 메서드를 실행할 때 트랜잭션을 시작하고, 메서드가 정상 종료되면 트랜잭션을 커밋한다. 만약 런타임 예외가 발생하면 롤백한다.

* JPA를 통한 모든 데이터 변경은 트랜잭션 안에서 실행해야 한다.

 

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

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

@Configuration
public class SpringConfig {

    /**
     * 스프링부트가 자체적으로 dataSource를 생성하고, 주입해준다.
     */
    private final DataSource dataSource;
    /**
     * JPA 사용
     */
    private EntityManager em;

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

    /**
     * memberService와 memberRepository를 스프링 빈에 등록하고,
     * memberService와 memberRepository 의존관계 설정
     */
    @Bean
    public MemberService memberService() {
        return new MemberService(memberRepository()); // Autowired와 비슷
    }

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

 

7. 테스트 실행

MemberServiceIntegrationTest를 실행하면 다음과 같이 정상적으로 작동한다.

 

🏃🏻‍♀️ 스프링 데이터 JPA

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

여기에 스프링 데이터 JPA를 사용하면, 레포지토리에 구현 클래스 없이 인터페이스 만으로 개발을 완료할 수 있다.

그리고 반복 개발해온 기본 CRUD 기능도 스프링 데이터 JPA가 모두 제공한다.

 

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

따라서 개발자는 핵심 비즈니스 로직을 개발하는 데 집중할 수 있다. (실무에서 관계형 DB를 사용한다면, 스프링 데이터 JPA는 필수다.)

 

주의!

스프링 데이터 JPA는 JPA를 편리하게 사용하도록 도와주는 기술이기 때문에, JPA를 먼저 학습한 후 스프링 데이터 JPA를 학습해야 한다.

 

* 앞의 JPA 설정을 그대로 사용한다.

 

1. 스프링 데이터 JPA 회원 레포지토리 (인터페이스)

repository 패키지 아래에 SpringDataJpaMemerRepository 인터페이스를 생성한다.

package hello.hellospring.repository;

import hello.hellospring.domain.Member;
import org.springframework.data.jpa.repository.JpaRepository;

import java.util.Optional;

// JpaRepository와 내가 생성한 MemberRepository 인터페이스를 상속받는다.
public interface SpringDataJpaMemberRepository extends JpaRepository<Member, Long>, MemberRepository {

    // JPQL select m from Member m where m.name = ?
    // 단순한 CURD는 이 인터페이스로 쉽게 구현할 수 있다.
    // 아래처럼 단순하게 메서드 이름만으로 조회 기능을 제공한다.
    @Override
    Optional<Member> findByName(String name);
}

 

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

SpringConfig 파일을 변경한다.

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

@Configuration
public class SpringConfig {

    private final MemberRepository memberRepository;

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

    /**
     * memberService와 memberRepository를 스프링 빈에 등록하고,
     * memberService와 memberRepository 의존관계 설정
     */
    @Bean
    public MemberService memberService() {
        return new MemberService(memberRepository); // Autowired와 비슷
    }

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

* 스프링 데이터 JPA가 SpringDataJpaMemberRepository를 스프링 빈으로 자동 등록해준다.

 -> SpringDataJpaMemberRepository 인터페이스를 자동으로 스프링 빈으로 등록해줌!

 

3. 테스트 실행

MemberServiceIntegrationTest를 실행하면 다음과 같이 정상적으로 작동한다.

 

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

위와 같은 상속 관계를 갖고 있다. JpaRepository가 findAll, save, flush, delete 등을 기본으로 제공한다!

 

스프링 데이터 JPA 제공 기능

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

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

* 페이징 기능 자동 제공