🌱 Spring DB 접근 기술

H2 데이터베이스 설치

개발이나 테스트 용도로 가볍고 편리한 DB, 웹 화면 제공

• 권한 주기
  chmod 755 h2.sh
• 실행
  ./h2.sh
• 데이터베이스 파일 생성 방법
  jdbc:h2:~/test (최초 한번)
  ~/test.mv.db 파일 생성 확인
  이후부터는 jdbc:h2:tcp://localhost/~/test 이렇게 접속

 

순수 JDBC

환경 설정

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

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

Java는 DB를 연결하려면 jdbc-driver가 꼭 필요

스프링 부트 데이터베이스 연결 설정 추가

resources/application.properties

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

접속 정보 경로 넣기

JDBC 회원 리파지토리 구현

이렇게 JDBC API로 직접 코딩하는 것은 20년 전 이야기이다. 따라서 고대 개발자들이 이렇게 고생하고 살았구나 생각하고, 정신건강을 위해 참고만 하고 넘어가자.

Jdbc 회원 리포지토리

기존에 MemoryMemberRepository로 만들어놓은 구현체를 db와 연동하기 위해 JDBC로 대체

DB를 붙이려면 dataSource가 필요, Spring에게 주입받아야 함
→ application.properties에서 setting해놓은 대로 Spring이 dataSource 접속정보를 만들어놓고 주입해줌.

private final DataSource dataSource;

public JdbcMemberRepository(DataSource dataSource) {
		this.dataSource = dataSource;
}

스프링 설정 변경

@Configuration
public class SpringConfig {

    private final DataSource dataSource;

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

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

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

• DataSource는 데이터베이스 커넥션을 획득할 때 사용하는 객체다.
  스프링 부트는 데이터베이스 커넥션 정보를 바탕으로 DataSource를 생성하고 스프링 빈으로 만들어둔다. 그래서 DI를 받을 수 있다.

• JdbcMemberRepository만 생성하고, Config만 바꿔주면 다른 코드를 수정할 필요 없이 MemberRepository 구현체를 변경 가능
  → interface는 그대로 두고 구현체를 바꿀 수 있다. (다형성 활용)

  <img width="836" alt="스크린샷 2021-01-22 오후 2 09 47" src="https://user-images.githubusercontent.com/45806836/105449312-7d8d8b00-5cbb-11eb-9813-788a95366a80.png">

• 개방-폐쇄 원칙(OCP, Open-Closed Principle)
  → 확장에는 열려있고, 수정, 변경에는 닫혀있다.

• 스프링의 DI (Dependencies Injection)을 사용하면 기존 코드를 전혀 손대지 않고, 설정만으로 구현 클래스를 변경할 수 있다.

• 데이터를 DB에 저장하므로 스프링 서버를 다시 실행해도 데이터가 안전하게 저장된다.

 

스프링 통합 테스트

스프링 컨테이너와 DB까지 연결한 통합 테스트를 진행해보자.

@SpringBootTest
@Transactional
class MemberServiceIntegrationTest {

    @Autowired MemberService memberService;
    @Autowired MemberRepository memberRepository;

		...

}

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

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

단위 테스트는 주로 서비스 로직에 적용한다. 그런데 DB를 연동하면 단위 테스트가 어려워진다.
그래서 테스트 전용 가짜 repository를 만들어서 테스트 시점에 넣어주어야 한다. 이것을 mock 객체라고 한다.
단순히 테스트를 위해서 진짜 db가 아니라 가짜 객체를 하나 만들어서 넣어주는 것이다.
그런데 일일이 이런 객체를 만들면 개발자가 너무 귀찮으니까 실무에서는 mockito 같은 가짜 객체를 만들어주는 라이브러리를 주로 사용한다.

 

스프링 JdbcTemplate

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

private final JdbcTemplate jdbcTemplate;

@Autowired
public JdbcTemplateMemberRepository(DataSource dataSource) {
		this.jdbcTemplate = new JdbcTemplate(dataSource);
}

참고) 생성자가 단 하나 존재한다면 @Autowired 생략 가능!

Spring으로부터 DataSource를 injection 받아 JdbcTemplate을 등록

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

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

 

JPA

환경 설정

객체를 메모리에 넣듯이 JPA에 집어넣으면, JPA가 중간에서 DB에 sql문들을 실행하고, DB를 통해 data를 가져오기까지 해준다.

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

build.gradle 파일에 JPA 라이브러리 추가

implementation 'org.springframework.boot:spring-boot-starter-data-jpa'

spring-boot-starter-data-jpa는 내부에 jdbc 관련 라이브러리를 포함한다. 따라서 jdbc는 제거해도 된다. 또한 스프링이 자동으로 엔티티 매니저를 생성해 준다.

스프링 부트에 JPA 설정 추가

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

spring.jpa.show-sql=true: JPA가 생성하는 SQL을 출력한다.

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

엔티티 매핑

JPA는 자바 진영의 표준 인터페이스, 구현체 중 하나가 hibernate

JPA는 자바 ORM (Object-Relational database-Mapping) by 애노테이션

• *@Entity 객체와 테이블 매핑*

: JPA를 사용해 테이블과 매핑할 클래스는 @Entity 어노테이션을 붙여야 한다.
@Entity가 붙은 클래스는 JPA가 관리하는 것으로, 엔티티라 부른다.

• *@Id 기본 키(Primary Key) 매핑*
• @GeneratedValue(strategy = GenerationType.IDENTITY)

: 기본 키 생성을 데이터베이스에 위임하는 전략.
DB에 값을 넣으면 DB가 Id를 자동으로 생성해주는 것을 IDENTITY전략이라고 한다.

• *@Column(name = "username") 필드와 컬럼 매핑*

@Entity
public class Member {

    @Id @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    
    @Column(name = "username")
    private String name;

		...
} 

엔티티 매니저

JPA는 엔티티 매니저로 모든 것이 동작한다.
엔티티 매니저를 사용해 엔티티를 데이터베이스에 등록/수정/삭제/조회할 수 있다.
엔티티 매니저는 내부에 데이터베이스 커넥션(데이터 소스)를 유지하면서 데이터베이스와 통신한다.

결론은 JPA를 사용하려면 EntityManager를 주입 받아야 한다.

public class JpaMemberRepository implements MemberRepository {

    private final EntityManager entityManager;

    public JpaMemberRepository(EntityManager entityManager) {
        this.entityManager = entityManager;
    }

		...
}

JPQL

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

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

import org.springframework.transaction.annotation.Transactional

@Transactional
public class MemberService {}

트랜잭션: 데이터베이스의 상태를 변화시키기 위해 수행하는 작업의 단위

Commit: 하나의 트랜잭션이 성공적으로 끝났고, 데이터베이스가 일관성 있는 상태에 있을 때 하나의 트랜잭션이 끝났다는 것을 알려주는 연산. 수행했던 트랜잭션이 로그에 저장되며, 후에 트랜잭션 단위로 Rollback하는 것을 도와준다.

RollBack: 하나의 트랜잭션 처리가 비정상적으로 종료되어 원자성이 깨진 경우, 트랜잭션을 처음부터 다시 시작하거나, 부분적으로만 연산된 결과를 다시 취소 시킨다.

@Transactional 데이터를 저장하거나 변경할 때 항상 트랜잭션이 있어야 한다. (회원 가입에 필요)

org.springframework.transaction.annotation.Transactional
스프링은 해당 클래스의 메서드를 실행할 때 트랜잭션을 시작하고, 메서드가 정상 종료되면 트랜잭션을 커밋한다. 만약 런타임 예외가 발생하면 롤백한다.
JPA를 통한 모든 데이터 변경은 트랜잭션 안에서 실행해야 한다.

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

@Configuration
public class SpringConfig {

    private EntityManager entityManager;

    public SpringConfig(EntityManager entityManager) {
        this.entityManager = entityManager;
    }

    ...

    @Bean
    public MemberRepository memberRepository() {
        return new JpaMemberRepository(entityManager);
    }
}

 

스프링 데이터 JPA

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

스프링 부트와 JPA라는 기반 위에, 스프링 데이터 JPA라는 환상적인 프레임워크를 더하면 개발이 정말
즐거워진다. 지금까지 조금이라도 단순하고 반복이라 생각했던 개발 코드들이 확연하게 줄어든다.
따라서 개발자는 핵심 비즈니스 로직을 개발하는데, 집중할 수 있다.
실무에서 관계형 데이터베이스를 사용한다면 스프링 데이터 JPA는 이제 선택이 아니라 필수다.

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

스프링 데이터 JPA 회원 리포지토리

public interface SpringDataJpaMemberRepository extends JpaRepository<Member, Long>, MemberRepository {
    
    @Override
    Optional<Member> findByName(String name);
}

Interface로 생성. Interface가 Interface를 확장할 땐 extends.
Spring Data Jpa가 JpaRepository를 확장하면, 구현체를 자동으로 만들어 Bean에 등록 → 가져다 쓴다.

,로 구분하여 MemberRepository도 다중 상속.

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

@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 제공 클래스

스프링 데이터 JPA 제공 기능

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

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

• 페이징 기능 자동 제공

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