[Spring Boot] 회원 예제 만들기 (3) - 스프링 DB 접근 기술

H2DB를 이용할 건데 이미 설치되어 있어서 등록부터 진행하겠다.

test2라는 이름으로 데이터 베이스를 등록하고 이후 사용을 할 땐 충돌의 위험이 있으니 아래와 같이 url을 변경한 뒤 사용한다. (파일에 직접 접근하는 게 아닌 톰캣을 통해서 접근하게 됨)

jdbc:h2:tcp://localhost/~/test2

 

 

member 테이블 생성

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

 

 

 

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

 

sql문을 IDE 안에서 함께 관리해 주면 편리하다.

 

---

 

 

스프링 데이터 접근 기술은 4가지가 있다.

1. 순수 JDBC
2. 스프링 JdbcTemplate
3. JPA
4. Spring Data JPA

4가지 방법 모두 차례대로 적용해보겠다.

 

 

 

1. 순수 JDBC

DB와 스프링 연결

build.gradle

// 순수 JDBC
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 API 활용해서 개발

JdbcMemberRepository.java

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

 

 

SpringConfig 수정

@Configuration
public class SpringConfig {

    DataSource dataSource;

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

    @Bean
    public MemberService service() {
        return new MemberService(repository());
    }

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

DataSource를 생성자로 Autowired 걸고 JdbcMemberRepository를 생성할 때 주입해 준다.

 

브라우저 화면에서 회원 조회, 등록이 정상적으로 동작되는 것을 확인한다.

 

스프링 통합 테스트

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

@SpringBootTest
@Transactional
class MemberServiceIntegrationTest {

    @Autowired
    MemberService service;
    @Autowired
    MemberRepository repository;

    @Test
    void 회원가입() {
        // given
        Member member = new Member();
        member.setName("spring");

        // when
        Long saveId = service.join(member);

        // then
        Member findMember = repository.findById(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
        service.join(member1);
        IllegalStateException e = assertThrows(IllegalStateException.class, () -> service.join(member2));
        // assertThrows: 예외가 발생하는지 확인하는 메소드

        assertThat(e.getMessage()).isEqualTo("이미 존재하는 이름입니다.");
    }

 

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

 

---

 

2. Spring JdbcTemplate

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

빌드 그레이들 설정은 순수 JDBC와 똑같이 해주면 된다.

 

JdbcTemplateMemberRepository

public class JdbcTemplateMemberRepository implements MemberRepository {

    private final JdbcTemplate template;

    // DataSource 생성자 주입
//    @Autowired    // 생성자가 하나일 땐 Autowired 생략 가능
    public JdbcTemplateMemberRepository(DataSource dataSource) {
        template = new JdbcTemplate(dataSource);
    }

    @Override
    public Member save(Member member) {
        // sql문을 직접 작성하지 않아도 insert문을 만들어줌
        SimpleJdbcInsert jdbcInsert = new SimpleJdbcInsert(template);
        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 = template.query("select * from member where id = ?", memberRowMapper(), id);
        return result.stream().findAny();
    }

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

    @Override
    public List<Member> findAll() {
        return template.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;
        };
    }
}

ctrl+alt+V: 짜놓은 코드에 맞게 리턴 타입과 변수명 자동 생성해 주는 단축키

 

SpringConfig.java 수정

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

 

MemberServiceIntegrationTest 실행

shift+F10: 마지막 실행한 테스트 재실행

 

정리

1. JdbcTemplateMemberRepository 작성 (MemberRepository를 implements)
   이때 JdbcTemplate의 생성자로 DataSource를 주입한다.
2. MemberRepository가 JdbcTemplate을 사용하도록 SpringConfig를 수정해 준다.

 

---

 

3. JPA

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

JPQL: 테이블 대상이 아닌 객체 대상으로 쿼리를 날림 (sql문으로 자동 변환)

 

라이브러리 추가

	// JPA
	implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
	runtimeOnly 'com.h2database:h2'

 

application.properties 수정

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

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

Entity 생성

기존의 Member.java 클래스를 Entity로 수정

@Entity
public class Member {

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

//    @Column(name = "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;
    }
}

 

JpaMemberRepository.java

public class JpaMemberRepository implements MemberRepository {

    private final EntityManager em;

    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);     // 값이 없을 수 있기 때문에 Optional
    }

    @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();
        // JPQL -> 테이블 대상이 아닌 객체 대상으로 쿼리를 날림 (sql문으로 자동 변환)

        return result.stream().findAny();
    }

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

JPA를 사용하려면 EntityManager를 주입받아야 함

persist: 영구 저장하다.

ctrl+alt+N: In line Refactoring

JPA를 사용할 땐 반드시 서비스 계층에 @Transactional 어노테이션이 있어야 한다.

 

SpringConfig 수정

@Configuration
public class SpringConfig {

    private EntityManager em;

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

    @Bean
    public MemberService service() {
        return new MemberService(repository());
    }

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

 

통합 테스트 실행

 

---

 

 

4. 스프링 데이터 JPA

스프링 부트와 JPA만 사용해도 개발 생산성이 정말 많이 증가하고, 개발해야할 코드도 확연히 줄어든다. 여기에 스프
링 데이터 JPA를 사용하면, 기존의 한계를 넘어 리포지토리에 구현 클래스 없이 인터페이스만으로 개발을 완료할 수 있다. 그리고 반복 개발해 온 기본 CRUD 기능도 스프링 데이터 JPA가 모두 제공한다.

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

빌드 그레이들은 JPA에서 사용한 설정을 그대로 사용한다.

 

SpringDataJpaMemberRepository.java

public interface SpringDataJpaMemberRepository extends JpaRepository<Member, Long>, MemberRepository {

    // (JPQL) select m from Member m where m.name = ?
    @Override
    Optional<Member> findByName(String name);
}

메소드 이름과 파라미터를 reflection 기술로 읽어내서 자동으로 JPQL을 생성해 준다.

 

SpringConfig.java 수정

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

@Configuration
public class SpringConfig {

    private MemberRepository repository;

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

    @Bean
    public MemberService service() {
        return new MemberService(repository);
    }

 

통합 테스트 실행

 

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

실무에서는 JPA와 스프링 데이터 JPA를 기본으로 사용하고, 복잡한 동적 쿼리는 Querydsl이라는 라이브러리를 사용하면 된다. Querydsl을 사용하면 쿼리도 자바 코드로 안전하게 작성할 수 있고, 동적 쿼리도 편리하게 작성할 수 있다. 이 조합으로 해결하기 어려운 쿼리는 JPA가 제공하는 네이티브 쿼리를 사용하거나, 앞서 학습 한 스프링 JdbcTemplate를 사용하면 된다.