[Spring Boot] Spring Data JPA

안녕하세요? 주니하랑 입니다.

오늘은 Spring Data JPA에  대해 공부 해 보도록 할 것이에요.

바로 시작 해 보겠습니다!

 

코드에 관련한 내용은 주니하랑의 Github에서 확인 하실 수 있습니다!

 

 

 

 

---

 

 

📋 목차

---

01.[Spring Boot] thymeleaf와 Spring Boot
02.[Spring Boot] Spring Web 개발 기초
03.[Spring Boot] 회원 관리 예제 - Backend
04.[Spring Boot] Service 개발 및 Test Case 작성
05.[Spring Boot] Spring Bean과 의존관계
06.[Spring Boot] Java Code로 직접 Spring Bean 등록
07.[Spring Boot] 등록, 목록 보기 구현하기
08.[Spring Boot] 기존 코드 손 안대고, 설정으로 구현 Class 변경
09.[Spring Boot] 통합 Test
10.[Spring Boot] JPA
11.[Spring Boot] Spring Data JPA
12.[Spring Boot] AOP

 

 

---

 

 

📌 Spring Data JPA

---

Spring Boot와 JPA만 사용해도 개발 생산성이 많이 증가하고, 개발해야 할 Code의 Line도 많이 줄어 드는 것이에요.

여기에 오늘의 주인공인 Spring Data JPA를 사용한다면 기존의 한계를 넘어 마치 마법처럼, Repository에 구현 Class 없이 Interface만으로 개발을 완료 할 수 있답니다!

그리고 반복적으로 개발하는 CRUD 기능도 Spring Data JPA가 모두 제공하는 것이에요.

 

Spring Boot와 JPA라는 기반 위에 Spring Data JPA라는 Frame Work를 더하면 환상의 콤비가 되는 것이에요.

왜냐하면? 지금까지 조금이라도 단순 반복 작업이라고 생각되었던 부분들이 사라지기 때문이랍니다.

 

개발자는 그렇게 되면 핵심 비즈니스 로직 개발에 더욱 집중할 수 있게 되겠지요?

 

관계형 DB를 사용한다면 Spring Data JPA는 필수로 사용하여야 한답니다!

 

 

         👉 Spring Boot JPA Config Insert

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
    // JPQL 번역 : select m from Member m where m.name = ?
    Optional<Member> findByName(String name);
} // Interface 끝

 

자! 여기서 우리가 이번 시리즈에서 계속 변경이 이뤄졌었던 Jdbc와 JPA 코드들을 모두 비교 해 볼까요?

 

         👉 JDBC

JdbcMemberRepository.java

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;

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

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

 

우와! 엄청 긴 것이에요!

 

 

         👉 JDBC Template

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.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;
    } // save() 끝

    @Override
    public Optional<Member> findById(Long id) {
        List<Member> result = jdbcTemplate.query("select * from member where id = ?", memberRowMapper(), id);
        return result.stream().findAny();
    } // findById() 끝

    @Override
    public Optional<Member> findByName(String name) {
        List<Member> result = jdbcTemplate.query("select * from member where name = ?", memberRowMapper(), name);
        return result.stream().findAny();
    } // findByName() 끝

    @Override
    public List<Member> findAll() {
        return jdbcTemplate.query("select * from member", memberRowMapper());
    } // findAll() 끝

    private RowMapper<Member> memberRowMapper() {
//        return new RowMapper<Member>() {
//            @Override
//            public Member mapRow(ResultSet rs, int rowNum) throws SQLException {
//
//                Member member = new Member();
//                member.setId(rs.getLong("id"));
//                member.setName(rs.getString("name"));
//
//                return member;
//            }
//        }

        // 위의 코드 람다 형식으로 변환

        return (rs, rowNum) -> {

            Member member = new Member();
            member.setId(rs.getLong("id"));
            member.setName(rs.getString("name"));

            return member;
        }; // mapRow() 끝
    } // memberRowMapper() 끝
} // Class 끝

 

조금 줄어들긴 했지만, 아직도 정신이 없는 것이에요. 그리고, 직접 SQL Query를 작성해 주고 있답니다!

 

         👉 JPA

JpaMemberRepository.java

package hello.hellospring.repository;

import hello.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;
    } // JpaMemberRepository() 끝

    @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> reulst = em.createQuery("select m from Member m where m.name = :name", Member.class).setParameter("name", name).getResultList();
        return reulst.stream().findAny();
    }

    @Override
    public List<Member> findAll() {
//        List<Member> result = em.createQuery("select m from Member m", Member.class).getResultList();
//        return result;

        // 위의 코드를 단순화 한 것
        return em.createQuery("select m from Member m", Member.class).getResultList();
    }
}

 

이제는 어느정도 가독성도 좋아진 것 같지 않으세요?

 

 

    📍 Spring Data JPA 회원 Repository를 사용하도록 Spring Config Modifie

 

SpringConfig.java

package hello.hellospring;

import hello.hellospring.repository.JdbcMemberRepository;
import hello.hellospring.repository.JdbcTemplateMemberRepository;
import hello.hellospring.repository.JpaMemberRepository;
import hello.hellospring.repository.MemberRepository;
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 {

    private final MemberRepository memberRepository;

    @Autowired      // 생성자가 하나라면 생략 가능
    public SpringConfig(MemberRepository memberRepository) {
    
        this.memberRepository = memberRepository;
    } // 생성자 끝

    // @Bean : Bean을 내가 직접 만들겠다는 의미; 스프링은 이것을 보고, Bean을 등록하라는 명령으로 인식
    @Bean
    // 아래 Method를 호출하여 Bean에 등록
    public MemberService memberService() {
        // MeberService를 생성하면서 memberRepository를 Spring Bean에 등록 된 주입하여 준다.
        return new MemberService(memberRepository);
    } // memberService() 끝

 

이렇게 해 두면 Spring Data JPA가 SpringDataJpaMemberRepository를 Spring Bean으로 자동 등록 하여 준답니다!

 

 

출처 : 인프런: 스프링 입문 - 코드로 배우는 스프링 부트

 

위에 그림을 보면 각 Interface들은 우리가 공통적으로 사용할 기능들을 모두 이미 만들어 놓은 것이에요. 저기 PagingAndSortingRepository를 보세요! Paging 처리 기능까지 만들어져 있어요!

 

    📍 Spring Data JPA 기능

• Interface를 통한 기본 CRUD 기능
• findByName(), findByEmail()과 같이 Method 이름 만으로 조회 기능 제공
• Paging 기능 자동 제공

 

💡 참고
기본적으로 Spring에서는 JPA와 Spring Data JPA를 사용하고, 복잡한 동적 Query의 경우 Querydsl이라는 Library를 사용하면 좋다. Querydsl를 사용한다면 Query도 Java Code로 안전하게 작성할 수 있고,
동적 Query도 편리하게 작성할 수 있다.
이 조합으로 해결하기 어려운 Query의 경우 JPA가 제공하는 Native Query(SQL Query)를 사용하거나, Jdbc Template 사용

 

 

 

---

 

주니하랑의 글이 마음에 드셨나요? 구독과 공감! 그리고, 댓글은 주니하랑에게 많은 힘이 됩니다