Spring MVC - JDBC 기반 데이터 액세스 계층

데이터 액세스 계층은 서비스 계층에서 비즈니스 로직을 통해 처리된 데이터를 데이터베이스에 저장하고, 비즈니스 로직을 처리하기 위해 데이터베이스에서 데이터를 조회하는 등의 역할을 수행한다.

 

💡JDBC(Java Database Connectivity)란?

Java 기반 애플리케이션의 코드 레벨에서 사용하는 데이터를 데이터베이스에 저장 및 업데이트 하거나 반대로 데이터베이스에 저장된 데이터를 Java 코드 레벨에서 사용할 수 있도록 해주는 Java에서 제공하는 표준 사양.

Java 프로그램이 데이터베이스와 상호 작용할 수 있도록 하는 표준 Java API.

 

Spring에서는 JDBC API를 직접적으로 사용하기 보다는 Spring Data JDBC나 Spring Data JPA같은 기술을 제공함으로써 개발자들이 조금 더 편리하게 데이터 액세스 로직을 구현할 수 있게 해준다. (Spring Data JDBC나 Spring Data JPA 같은 기술 역시 데이터베이스와 연동하기 위해 내부적으로 JDBC를 이용함.)

 

💡JDBC 동작 흐름

JDBC는 Java 애플리케이션 내에서 JDBC API를 사용하여 데이터베이스에 액세스하는 단순한 구조이기 때문에 JDBC의 동작 흐름은 다음과 같이 매우 심플하다.

Java 애플리케이션에서 JDBC API를 이용해 적절한 데이터베이스 드라이버를 로딩한 후, 데이터베이스와 인터랙션한다.

이처럼, JDBC API를 사용해 데이터베이스와 구체적인 인터렉션을 하기 위해서는 JDBC 드라이버를 먼저 로딩한 후에 데이터베이스에 연결해야 한다.

 

 

💡JDBC 드라이버

 

데이터베이스와 통신을 담당하는 인터페이스. Oracle, MySQL, My SQL 같은 다양한 벤더에서는 해당 벤더에 맞는 JDBC 드라이버를 구현해서 제공하게 되고, 이 JDBC 드라이버의 구현체를 이용해서 특정 벤더의 데이터베이스에 액세스할 수 있음.

 

 

JDBC API 사용 흐름

 

1) JDBC 드라이버 로딩 : JDBC 드라이버는 DriveManager라는 클래스를 통해 로딩됨.

2) Connection 객체 생성 : DriverManager를 통해 데이터베이스와 연결된느 세션(Session)인 Connection 객체를 생성함.

3) Statement 객체 생성 : Statement 객체는 작성된 SQL 쿼리문을 실행하기 위한 객체 생성 후에 정적인 SQL 쿼리 문자열을 입력으로 가짐.

4) Query 생성 : 생성된 Statement 객체를 이용해서 입력한 SQL 쿼리를 실행함.

5) ResultSet 객체로부터 데이터 조회 : 실행된 SQL 쿼리문에 대한 결과 데이터 셋.

6) ResultSet 객체 Close : JDBC API를 통해 사용된 객체들은 사용 이후에 사용한 순서의 역순으로 차례로 Close를 해주어야 함.

7) Statement 객체 Close

8) Connection 객체 Close

 

 

Connection Pool이란?

JDBC API를 사용해서 데이터베이스와의 연결을 위한 Connection 객체를 생성하는 작업은 비용이 많은 드는 작업 중 하나.

따라서 애플리케이션 로딩 시점에 Connection 객체를 미리 생성해두고, 애플리케이션에서 데이터베이스에 연결이 필요할 경우, Connection 객체를 새로 생성하는 것이 아니라, 미리 만들어 둔 Connection 객체를 사용함으로써 애플리케이션의 성능을 향상할 수 있다.

 

이처럼 데이터베이스 Connection을 미리 만들어서 보관하고, 애플리케이션이 필요할 때 이 Connection을 제공해주는 역할을 하는 Connection 관리자를 바로 Connection Pool이라고 한다.

 

Spring Boot 2.0 이전에는 Apache 재단의 오픈 소스인 Apache Commons DBCP(Database Connection Pool)를 주로 사용했으나 Spring Boot 2.0부터는 성능면에서 더 나은 이점을 가지고 있는 HikariCP를 기본 DBCP로 채택함.

 

 

데이터 액세스 기술  유형으로, Spring에서 사용할 수 있는 대표적인 데이터 액세스 기술에는 mybatis, Spring JDBC, Spring Data JDBC, JPA, Spring Data JPA 등이 있다.

 

SQL 중심 기술로는 iBatis, mybatis, Spring JDBC가 있다. SQL 중심 기술은 애플리케이션에서 데이터베이스에 접근하기 위해 SQL 쿼리문을 애플리케이션 내부에서 직접적으로 작성하는 것이 중심이 되는 기술이다.

 

다음은 mybatis에서 사용되는 SQL Mapper의 예이다.

<select id="findMember" resultType="Member">
  SELECT * FROM MEMBER WHERE member_id = #{memberId}
</select>

mybatis의 경우, SQL Mapper라는 설정 파일이 존재하는데, 이 SQL Mapper에서 SQL 쿼리문을 직접적으로 작성한다.

작성된 SQL 쿼리문을 기반으로 데이터베이스의 특정 테이블에서 데이터를 조회한 후, Java 객체로 변환해주는 것이 mybatis의 대표적인 기술적 특징이다.

코드에서 보다시피 SQL 문이 직접적으로 포함되어 있다.

 

다음은 Spring JDBC의 JdbcTemplate이라는 템플릿 클래스를 사용한 데이터베이스 접근의 예이다.

Member member = this.jdbcTemplate.queryForObject(
"select * from member where member_id=?", 1, Member.class);

Spring JDBC의 경우, Java 코드에 SQL 쿼리문이 직접적으로 포함되어 있다.

이처럼, SQL 쿼리문이 직접적으로 표함되는 방식은 과거부터 많이 사용하던 방식으로, 현재도 사용이 되고 있으나 Java 진영에서는 SQL 중심의 기술에서 객체(Object) 중심의 기술로 지속적으로 이전을 하고 있는 추세이다.

 

객체(Object) 중심 기술은 Spring Data JDBC, JPA, Spring Data JPA가 있다.

객체 중심 기술은 SQL 쿼리문 위주로 생각하는 것이 아니라 모든 데이터를 객체 관점으로 바라보는 기술이다.

즉, 객체 중심 기술은 데이터베이스에 접근하기 위해서 SQL 쿼리문을 직접적으로 작성하기보다는 데이터베이스의 테이블에 데이터를 저장하거나 조회할 경우, Java 객체(Object)를 이용해 애플리케이션 내부에서 이 Java 객체를 SQL 쿼리문으로 자동 변환한 후에 데이터베이스의 테이블에 접근한다.

 

이러한 객체(Object) 중심의 데이터 액세스 기술을 ORM(Object-Relational Mapping)이라고 한다.

 

Java에서 대표적인 ORM 기술이 JPA(Java Persistence API).

JPA를 사용하면 SQL 쿼리문을 직접적으로 다룰 일은 많지 않다.

물론, 복잡한 조건의 데이터 조회를 위해 SQL 쿼리문을 사용하기도 하지만, 그 사용 빈도수가 이 전보다 급격히 줄었다.

 

 

Spring Data JDBC란?

 

Spring Data JDBC는 JPA처럼 ORM 기술을 사용하지만, JPA의 기술적 복잡도를 낮춘 기술이기 때문에 상대적으로 쉽다.

 

Spring Data JDBC 와 Spring Data JPA

우선, Spring Data JDBC 기술은 2018년에 1.0버전이 처음 릴리즈되었기 때문에 기술의 역사가 아직 짧은 편.

따라서 현재도 기능 업그레이드가 꾸준히 이루어지고 있지만, 아직까지는 JPA보다 상대적으로 적게 사용된다.

 

하지만, 애플리케이션의 규모가 상대적으로 크지 않고, 복잡하지 않을 경우에는 Spring Data JDBC가 뛰어난 생산성을 보여준다.

그리고 Spring Data JDBC를 통해 기본적은 ORM 개념과 Spring에서 Data에 접근하는 일관된 접근 방식을 먼저 접하게 되므로, JPA와 Spring Data JPA를 이해하는데 꽤 많은 도움이 된다.

 

JPA는 실무에서 가장 많이 사용하는 기술이기 때문에, 당연히 알아야 한다.

Spring Data JPA는 Spring에서 JPA기술을 편리하게 사용하기 위한 기술이기 때문에 JPA에 대한 선행 지식이 있어야 제대로 사용 가능하다.

 

Spring Data JDBC를 이해하기 위해서는 Spring Boot Starter를 추가해야 한다.

dependencies {
	...
	...
	implementation 'org.springframework.boot:spring-boot-starter-data-jdbc'
	runtimeOnly 'com.h2database:h2'
}

 

Hello World 샘플 코드 구현

 

클라이언트 쪽에서 "Hello, World" 문자열 데이터를 Request Body로 전송한 후에 Spring Data JDBC를 이용해서 "Hello, World" 문자열을 H2 데이터베이스에 저장해 보도록 하자.

 

서비스 계층의 MessageService 클래스와 데이터 액세스 계층의 MessageRepository 인터페이스를 어떻게 연동하여 데이터베이스에 저장하는지 이해하는 것이 핵심이다.

 

클라이언트가 Request Body를 전달하는 'Hello, World' 문자열을 바인딩하는 DTO 클래스

@Getter
public class MessagePostDto {
    @NotBlank
    private String message;
}

 

Response에 사용할 DTO 클래스

package com.codestates.hello_world;

import lombok.Getter;
import lombok.Setter;

@Getter
@Setter
public class MessageResponseDto {
    private long messageId;
    private String message;
}

 

Controller 클래스

package com.codestates.hello_world;

import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.validation.Valid;

@RequestMapping("/v1/messages")
@RestController
public class MessageController {
    private final MessageService messageService;
    private final MessageMapper mapper;

    public MessageController(MessageService messageService, MessageMapper mapper) {
        this.messageService = messageService;
        this.mapper = mapper;
    }

    @PostMapping
    public ResponseEntity postMessage(@Valid @RequestBody MessagePostDto messagePostDto){
        Message message = messageService.createMessage(mapper.messageDtoToMessage(messagePostDto));
        return ResponseEntity.ok(mapper.messageToMessageResponseDto(message));
    }
}

 

DTO클래스와 엔티티 클래스를 매핑해주는 Mapper 인터페이스

package com.codestates.hello_world;

import org.mapstruct.Mapper;

@Mapper(componentModel = "spring")
public interface MessageMapper {
    Message messageDtoToMessage(MessagePostDto messagePostDto);
    MessageResponseDto messageToMessageResponseDto(Message message);
}

 

데이터 액세스 계층에서 데이터베이스와의 연동을 담당하는 Repository인 MessageRepository 인터페이스

package com.codestates.hello_world; 

import org.springframework.data.repository.CrudRepository;

public interface MessageRepository extends CrudRepository<Message,Long> {

}

 

MessageService

package com.codestates.hello_world;

import org.springframework.stereotype.Service;

@Service
public class MessageService {
		//(1)
    private final MessageRepository messageRepository;

    public MessageService(MessageRepository messageRepository) {
        this.messageRepository = messageRepository;
    }
		
		//(2)
    public Message createMessage(Message message){
        return messageRepository.save(message);
    }
}

 

Message 엔티티 클래스

package com.codestates.hello_world;

import lombok.Getter;
import lombok.Setter;
import org.springframework.data.annotation.Id;


@Getter
@Setter
public class Message { //(1)
    @Id //(2)
    private long messageId;
    private String message;
}

 

H2 데이터베이스에 MESSAGE 테이블 생성

spring:
  h2:
    console:
      enabled: true
      path: /h2     
  datasource:
    url: jdbc:h2:mem:test
  sql:
    init:
      schema-locations: classpath*:db/h2/schema.sql   // (1) 테이블 생성 파일 경로

 

src/main/resources/db/h2/schema.sql 

CREATE TABLE IF NOT EXISTS MESSAGE (
    message_id bigint NOT NULL AUTO_INCREMENT,
    message varchar(100) NOT NULL,
    PRIMARY KEY (message_id)
);

 

 

 

Spring Data JDBC 적용 순서

 

1. build.gradle에 사용할 데이터베이스를 위한 의존 라이브러리를 추가한다.

2. application.yml 파일에 사용할 데이터베이스에 대한 설정을 한다.

3. schema.sql 파일에 필요한 테이블 스크립트를 설정한다.

4. application.yml 파일에서 schema.sql 파일을 읽어들여 테이블을 생성할 수 있도록 초기화 설정을 추가한다.

5. 데이터베이스의 테이블과 매핑할 엔티티 클래스를 작성한다.

6. 작성한 엔티티 클래스를 기반으로 데이터베이스의 작업을 처리할 Repository 인터페이스를 작성한다.

7. 작성된 Repository 인터페이스를 서비스 클래스에서 사용할 수 있도록  DI 한다.

8. DI된 Repository 의 메서드를 사용해서 서비스 클래스에서 데이터베이스에 CRUD 작업을 수행한다.