김영한 강사님의 스프링 입문 나머지

스프링 DB 접근 기술

H2 데이터베이스 설치

https://www.h2database.com/

https://atoz-develop.tistory.com/entry/H2-Database-설치-서버-실행-접속-방법

(위에 링크를 따라 하면 윈도우에서 쉽게 h2 database 를 사용할 수 있다)

• 테이블 관리를 위해 프로젝트 루트에 sql/ddl.sql 파일을 생성( 항상 타 개발자를 위해 sql 문을 프로젝트에 저장하는 습관을 들이자. (용량이 허락되는 한))

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

순수 JDBC

환경 설정

• build.gradle 에 jdbc, h2 데이터베이스 관련 라이브러리를 추가한다.

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

• 스트링부트 데이터베이스 연결을 추가한다.

  resource/application.properties

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

  주의!: 스프링부트 2.4부터는 spring.datasource.username=sa 를 꼭 추가해주어야 한다. 그렇지 않으면 Wrong user name or password 오류가 발생한다. 참고로 다음과 같이 마지막에 공백이 들어가면 같은 오류가 발생한다. spring.datasource.username=sa 공백 주의, 공백은 모두 제거해야 한다.

JDBC 레포지토리 구현

jdbc API 로 직접 코딩하는 것은 20년 전 이야기이다. 참고만 하자.

package com.hello.hellospring.repository;

import com.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); // 스프링 통해 connection : Database Transaction 유지
  }

  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); // 스프링 통해 disconnection : Database Transaction 유지
  }
}

스프링 설정 변경

SpringConfig

package com.hello.hellospring;

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

  private DataSource dataSource;

  @Autowired // 스프링 자체에서 datasource 에 대한 빈을 생성해준다.
  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 를 생성하고, 스프링 빈으로 만들어준다. 그래서 DI 를 받을 수 있다.

• [주의]항상 h2 database 가 켜져있는지 확인

구현 클래스 추가 이미지

 

 

스프링 설정 이미지

• 개방폐쇄의 원칙(OCP, Open Closed Principle)
  • 확장에는 열려있고, 수정, 변경에는 닫혀있다.
• 스프링의 DI(Dependency Injection) 을 사용하면, 기존 코드를 전혀 손대지 않고 설정만으로 구현 클래스를 변경할 수 있다.
• 데이터를 DB 에 저장하므로 스프링 서버를 다시 실행해도 데이터가 안전하게 저장된다.

---

스프링 통합 테스트

• 테스트용 디비가 따로 존재해야한다를 가정하고 시작.

• 데이터 다 지우고 시작

  delete from member;

package com.hello.hellospring.service;

import com.hello.hellospring.domain.Member;
import com.hello.hellospring.repository.MemberRepository;
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
@Transactional
public class MemberServiceIntegrationTest {
  @Autowired MemberService memberService;
  @Autowired MemberRepository memberRepository;

  @Test
  void 회원가입() {
    // given
    Member member = new Member();
    member.setName("재은");
    // when
    Long savedId = memberService.join(member);
    // then
    Member findMember = memberService.findOne(savedId).get();
    assertThat(member.getName()).isEqualTo(findMember.getName());
  }

  @Test
  void 중복_회원_예외() {
    // given
    Member duplicateMember1 = new Member();
    duplicateMember1.setName("재은2");
    Member duplicateMember2 = new Member();
    duplicateMember2.setName("재은2");
    // when
    memberService.join(duplicateMember1);

    IllegalStateException e =
        assertThrows(IllegalStateException.class, () -> memberService.join(duplicateMember2));
    assertThat(e.getMessage()).isEqualTo("이미 존재하는 회원입니다. ");
    /*   try {
      memberService.join(duplicateMember2);
      fail();
    } catch (IllegalStateException e) {
      e.printStackTrace();
      assertThat(e.getMessage()).isEqualTo("이미 존재하는 회원입니다.");
    }*/
    // then

  }
}

• @SpringBootTest: 스프링 컨테이너와 테스트를 함께 실행한다

• @Transactional: 테스트 케이스에 이 어노테이션이 있으면, 테스트 시작전에 트랜잭션을 실행하고, 테스트 완료 후에 항상 롤백 한다. 이렇게 하면, DB 에 데이터가 남지 않으므로 다음 테스트에 영향을 주지 않는다.( 디비에 반영하지 않는다. )

• 디비 반영: @Commit

---

스프링 JDBC Template

순수 JDBC 와 동일한 환경 설정을 해주면 된다.

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

shif+F10: recent task run 단축키

package com.hello.hellospring.repository;

import com.hello.hellospring.domain.Member;
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  -> 생성자가 1개일 경우, @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;
    };
  }
}

package com.hello.hellospring;

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

  private DataSource dataSource;

  @Autowired // 스프링 자체에서 datasource 에 대한 빈을 생성해준다.
  public SpringConfig(DataSource dataSource) {
    this.dataSource = dataSource;
  }

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

  @Bean
  public MemberRepository memberRepository() {

    // return new JdbcMemberRepository(dataSource);
    return new JdbcTemplateMemberRepository(dataSource);
  }
}

---

JPA

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

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

dependencies {
    //implementation 'org.springframework.boot:spring-boot-starter-jdbc'
    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
    runtimeOnly 'com.h2database:h2'
    developmentOnly("org.springframework.boot:spring-boot-devtools")
    implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
    implementation 'org.springframework.boot:spring-boot-starter-web'
    testImplementation('org.springframework.boot:spring-boot-starter-test') {
        exclude group: 'org.junit.vintage', module: 'junit-vintage-engine'
    }
}

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

스프링부트에 JPA 설정 추가

resource/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

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

• show-sql: JPA가 생성하는 SQL을 출력한다.

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

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

• Ctrl+ Alt+ N: 인라인 단축키

JPA 엔티티 매핑

package com.hello.hellospring.domain;

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

@Entity
public class Member {
  @Id
  @GeneratedValue(strategy = GenerationType.IDENTITY)
  private Long id;
  // @Column(name = "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;
  }
}

JPA 회원 리포지토리

package com.hello.hellospring.repository;

import com.hello.hellospring.domain.Member;
import org.springframework.transaction.annotation.Transactional;

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

@Transactional
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.of(member);
  }

  @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 com.hello.hellospring;

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

@Configuration
public class SpringConfig {

  // private DataSource dataSource;
  private EntityManager em;

  @Autowired // 스프링 자체에서 EntityManager 에 대한 빈을 생성해준다.
  public SpringConfig(EntityManager em) {
    this.em = em;
  }
  //  @Autowired // 스프링 자체에서 datasource 에 대한 빈을 생성해준다.
  //  public SpringConfig(DataSource dataSource) {
  //    this.dataSource = dataSource;
  //  }

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

  @Bean
  public MemberRepository memberRepository() {

    // return new JdbcMemberRepository(dataSource);
    //  return new JdbcTemplateMemberRepository(dataSource);
    return new JpaMemberRepository(em);
  }
}

스프링 데이터 JPA

스프링 부트와 JPA만 사용해도 개발 생산성이 정말 많이 증가하고, 개발해야할 코드도 확연히 줄어듭니다. 여기에 스프링 데이터 JPA를 사용하면, 기존의 한계를 넘어 마치 마법처럼, 리포지토리에 구현 클래스 없이 인터페이스 만으로 개발을 완료할 수 있습니다. 그리고 반복 개발해온 기본 CRUD 기능도 스프링 데이터 JPA가 모두 제공합니다. 스프링 부트와 JPA라는 기반 위에, 스프링 데이터 JPA라는 환상적인 프레임워크를 더하면 개발이 정말 즐거워집니다. 지금까지 조금이라도 단순하고 반복이라 생각했던 개발 코드들이 확연하게 줄어듭니다. 따라서 개발자는 핵심 비즈니스 로직을 개발하는데, 집중할 수 있습니다. 실무에서 관계형 데이터베이스를 사용한다면 스프링 데이터 JPA는 이제 선택이 아니라 필수 입니다.

스프링 데이터 JPA 제공 기능

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

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

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

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

package com.hello.hellospring.repository;

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

import java.util.Optional;

public interface SpringDataJpaMemberRepository
    extends JpaRepository<Member, Long>, MemberRepository {
  // JPQL select m from Member m where m.name =?
  @Override
  Optional<Member> findByName(String name);
}

package com.hello.hellospring;

import com.hello.hellospring.repository.MemberRepository;
import com.hello.hellospring.service.MemberService;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class SpringConfig {
  private final MemberRepository memberRepository;

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

  // private DataSource dataSource;
  //  private EntityManager em;
  //
  //  @Autowired // 스프링 자체에서 EntityManager 에 대한 빈을 생성해준다.
  //  public SpringConfig(EntityManager em) {
  //    this.em = em;
  //  }
  //  @Autowired // 스프링 자체에서 datasource 에 대한 빈을 생성해준다.
  //  public SpringConfig(DataSource dataSource) {
  //    this.dataSource = dataSource;
  //  }

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

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

---

AOP

• 공통 관심사항(cross-cutting conversion) vs 핵심 관심사항 (core concern)

AOP

• AOP: Aspect Oriented Programming
• 공통 관심사항과 핵심 관심사항을 분리한다.

문제

• 회원가입, 회원조회의 시간을 측정하는 기능은 핵심 관심사항이 아니다.
• 시간을 측정하는 로직은 공통 관심사항이다.
• 시간을 측정하는 로직과 핵심 비즈니스의 로직이 섞여 유지보수가 어렵다
• 시간을 측정하는 로직은 별도의 공통로직으로 만들기 어렵다
• 시간을 측정하는 로직을 변동할 때 모든 로직을 찾아 변경해야한다.

package com.hello.hellospring.aop;

import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.springframework.stereotype.Component;

@Component
@Aspect
public class TimeTraceAop {
  @Around("execution(* com.hello.hellospring..*(..))")
  public Object execute(ProceedingJoinPoint joinPoint) throws Throwable {

    long start = System.currentTimeMillis();
    System.out.println("Start: " + joinPoint.toString());
    try {
      return joinPoint.proceed();
    } finally {
      long end = System.currentTimeMillis();
      long timeMs = end - start;
      System.out.println("End: " + joinPoint.toString() + " " + timeMs + "ms");
    }
  }
}

• 구현 결과

op 적용 전

 

• aop 적용 후

• aop 적용 전 전체 그림

• aop 적용 후 전체 그림

프록시 직접 확인하기

  //  @Autowired
  public MemberService(MemberRepository memberRepository) {
    this.memberRepository = memberRepository;
    System.out.println("member Proxy Service: " + memberRepository.getClass());
  }

---

참고문헌

김영한 강사님의 스프링 입문