[스프링 DB 2편] #2. 데이터 접근 기술 - 스프링 JdbcTemplate

[newh08]

JdbcTemplate 소개와 설정

SQL 을 직접 사용하는 경우에 스프링이 제공하는 JdbcTemplate은 아주 좋은 선택지다. JdbcTemplate은 JDBC를 매우 편리하게 사용할 수 있게 도와준다.

장점

• 스프링 라이브러리(spring-jdbc)에 포함되어져 있기 때문에 복잡한 설정 없이 바로 사용 가능.
• 반복 문제를 해결해줌.
  • JdbcTemplate은 템플릿 콜백 패턴을 사용해서, JDBC를 직접 사용할 때 발생하는 대부분의 반복 작업을 대신 처리해준다.
  • 개발자는 SQL 작성, 전달 파라미터 정의, 응답값 매핑만 하면 됨.
  • 자동화 해주는 것
    • 커넥션 획득
    • statement 를 준비하고 실행
    • 결과를 반복하도록 루프를 실행
    • 커넥션 종료, statement , resultset 종료
    • 트랜잭션 다루기 위한 커넥션 동기화
    • 예외 발생시 스프링 예외 변환기 실행

단점

• 동적SQL 처리가 어려움.

설정하기
build.gradle 에 아래 코드 추가.

//JdbcTemplate 추가
 implementation 'org.springframework.boot:spring-boot-starter-jdbc'
//H2 데이터베이스 추가
runtimeOnly 'com.h2database:h2'

• org.springframework.boot:spring-boot-starter-jdbc 를 추가하면 JdbcTemplate이 들어있는 spring-jdbc 가 라이브러리에 포함된다.
• 여기서는 H2 데이터베이스에 접속해야 하기 때문에 H2 데이터베이스의 클라이언트 라이브러리(Jdbc Driver) 도 추가하자.
  • runtimeOnly 'com.h2database:h2'
    이거만 하면 끝. 추가 설정 없음.

H2 데이터베이스에 item 테이블 생성 필요

 drop table if exists item CASCADE;
 create table item
 (
     id        bigint generated by default as identity,
     item_name varchar(10),
     price     integer,
     quantity  integer,
     primary key (id)
 );

JdbcTemplate 적용1- 기본

package hello.itemservice.repository.jdbcTemplate;

import hello.itemservice.domain.Item;
import hello.itemservice.repository.ItemRepository;
import hello.itemservice.repository.ItemSearchCond;
import hello.itemservice.repository.ItemUpdateDto;
import hello.itemservice.service.ItemService;
import java.sql.PreparedStatement;
import java.util.ArrayList;
import java.util.List;
import java.util.Optional;
import javax.sql.DataSource;
import org.springframework.dao.EmptyResultDataAccessException;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.jdbc.core.RowMapper;
import org.springframework.jdbc.support.GeneratedKeyHolder;
import org.springframework.jdbc.support.KeyHolder;
import org.springframework.util.StringUtils;

public class JdbcTemplateItemRepositoryV1 implements ItemRepository {

    private final JdbcTemplate template;

    public JdbcTemplateItemRepositoryV1(DataSource dataSource) {
        this.template = new JdbcTemplate(dataSource); // 커넥션 만들기 위해 템플릿에 DataSource 필요함.
    }

    @Override
    public Item save(Item item) {
        String sql = "insert into item(item_name, price, quantity) values (?,?,?)";
        KeyHolder keyHolder = new GeneratedKeyHolder(); // 아이디값 가져오기. JDBC 에선 이렇게 씀.
        template.update(connection -> {
            // 자동 증가 키 / 아이디로 키 자동생성을 해줘야 해서 조금 복잡함
            PreparedStatement ps = connection.prepareStatement(sql, new String[]{"id"});
            ps.setString(1, item.getItemName());
            ps.setInt(2, item.getPrice());
            ps.setInt(3, item.getQuantity());
            return ps;
        }, keyHolder);

        long key = keyHolder.getKey().longValue();
        item.setId(key);
        return item;
    }

    @Override
    public void update(Long itemId, ItemUpdateDto updateParam) {
        String sql = "update item set item_name=?, price=?, quantity=?, where id=?";
        template.update(sql,
                updateParam.getItemName(),
                updateParam.getPrice(),
                updateParam.getQuantity(),
                itemId); // 나머지 복잡한건 템플릿이 해줌
    }

    @Override
    public Optional<Item> findById(Long id) {
        // 결과가 없으면 예외가 터져버림
        String sql = "select id, item_name, price, quantity from item where id = ?";
        try {
            Item item = template.queryForObject(sql, itemRowMapper(), id);
            return Optional.of(item);
        } catch (EmptyResultDataAccessException e) {
            return Optional.empty();
        }
    }

    private RowMapper<Item> itemRowMapper() {
        return ((rs, rowNum) -> {
            Item item = new Item();
            item.setId(rs.getLong("id"));
            item.setItemName(rs.getString("item_name"));
            item.setPrice(rs.getInt("price"));
            item.setQuantity(rs.getInt("quantity"));
            return item;
        });
    }

    @Override
    public List<Item> findAll(ItemSearchCond cond) {
        String itemName = cond.getItemName();
        Integer maxPrice = cond.getMaxPrice();

        String sql = "select id, item_name, price, quantity from item";
        // 동적 쿼리
        if (StringUtils.hasText(itemName) || maxPrice != null) {
            sql += " where";
        }
        boolean andFlag = false;
        List<Object> param = new ArrayList<>();
        if (StringUtils.hasText(itemName)) {
            sql += " item_name like concat('%',?,'%')";
            param.add(itemName);
            andFlag = true;
        }
        if (maxPrice != null) {
            if (andFlag) {
                sql += " and";
            }
            sql += " price <= ?";
            param.add(maxPrice);
        }
        template.query(sql, itemRowMapper(), param.toArray());
        return null;
    }
}

기본

• JdbcTemplateItemRepositoryV1 은 ItemRepository 인터페이스를 구현했다.
• this.template = new JdbcTemplate(dataSource)
  • JdbcTemplate 은 데이터소스( dataSource )가 필요하다.
  • JdbcTemplateItemRepositoryV1() 생성자를 보면 dataSource 를 의존 관계 주입 받고 생성자 내부에서 JdbcTemplate 을 생성한다. 스프링에서는 JdbcTemplate 을 사용할 때 관례상 이 방법을 많 이 사용한다.
  • 물론 JdbcTemplate 을 스프링 빈으로 직접 등록하고 주입받아도 된다.

Save()

• 데이터를 변경할떈 template.update() 를 사용
  • 즉 Insert, Update, Delete 에서 사용.
  • 반환값은 int 인데 영향받은 로우 수
• 데이터 저장시 PK 생성에 idantity (자동 증가) 방식을 사용하기 떄문에, PK인 ID 값을 개발자가 지정하는것이 아니라 비우고 저장해야함. 그럼 데이터베이스가 ID 대신 생성함.
• 이러면 데이터 생성 완료 될 때 까지 ID 값을 모름. 그래서 insert 완료 후 꺼내와야함.
• KeyHolder와connection.prepareStatement(sql, new String[]{"id"})를 사용해서id를 지정해주면INSERT` 쿼리 실행 이후에 데이터베이스에서 생성된 ID 값을 조회할 수 있다.
• 순수 JDBC 로도 가능한데 복잡함.
• 참고로 뒤에서 설명하겠지만 JdbcTemplate이 제공하는 SimpleJdbcInsert 라는 훨씬 편리한 기능이 있으 므로 대략 이렇게 사용한다 정도로만 알아두면 된다.

update()

• template.update() 사용.
• ? 에 바인딩할 파라미터를 순서대로 전달하면 된다. 순서가 바뀌면 큰일남.
• 반환값은해당쿼리의영향을받은로우수이다.여기서는 where id=? 를 지정했기 때문에 영향 받은 로우수는 최대 1개이다.

findById()

• 데이터 하나 조회
• template.queryForObject()
  • 결과 로우가 하나일 때 사용한다.
  • RowMapper 는 데이터베이스의 반환 결과인 ResultSet 을 객체로 변환한다.
  • 결과가 없으면 EmptyResultDataAccessException 예외가 발생한다.
  • 결과가 둘 이상이면 IncorrectResultSizeDataAccessException 예외가 발생한다.
• ItemRepository.findById() 인터페이스는 결과가 없을 때 Optional 을 반환해야 한다. 따라서 결과가 없으면 예외를 잡아서 Optional.empty() 를 대신 반환하면 된다.

findAll()
데이터를 리스트로 조회. 검색 조건으로 적절한 데이터 찾기

• template.query()
  • 결과가 하나 이상일 때 사용 (하나일때도 사용 가능)
  • RowMapper는 데이터베이스의 반환 결과인ResultSet` 을 객체로 변환한다.
  • 결과가 없으면 빈 컬렉션을 반환
  • 동적 쿼리를 사용하는데 바로 다음에 볼 예정

itemRowMapper()
데이터베이스 조회 결과를 객체로 변환할 때 사용.
JDBC 직접 사용할 때 ResultSet 과 동일
차이가 있다면 다음과 같이 JdbcTemplate이 다음과 같은 루프를 돌려주고, 개발자는 RowMapper 를 구현해서 그 내부 코드만 채운다고 이해하면 된다.

while(resultSet 이 끝날 때 까지) { 
    rowMapper(rs, rowNum)
}

JdbcTemplate 적용2- 동적 쿼리 문제

findAll() 에서 어려운 부분이 사용자가 검색하는 값에 따라 실행하는 SQL 이 동적으로 달라져야 한다는 점.

예를 들어서 다음과 같다.

검색 조건이 없음

select id, item_name, price, quantity from item 

상품명( itemName )으로 검색

select id, item_name, price, quantity from item
where item_name like concat('%',?,'%')

최대 가격( maxPrice )으로 검색

select id, item_name, price, quantity from item
where price <= ?

상품명( itemName ), 최대 가격( maxPrice ) 둘다 검색

select id, item_name, price, quantity from item
where item_name like concat('%',?,'%')
and price <= ?

결과적으로 4가지 상황에 따른 SQL을 동적으로 생성해야 한다. 동적 쿼리가 언듯 보면 쉬워 보이지만, 막상 개발해보면 생각보다 다양한 상황을 고민해야 한다.예를 들어서 어떤 경우에는 where 를앞에넣고어떤경우에는 and 를 넣어야 하는지 등을 모두 계산해야 한다.
상황에 맞춰 파라미터도 생성

조건이 하나라도 더 있으면 훨씬 더 복잡해짐
직접 짜보면 버그가 안생길 수 없음...

참고로 이후에 설명할 MyBatis의 가장 큰 장점은 SQL을 직접 사용할 때 동적 쿼리를 쉽게 작성할 수 있다는 점이다.

JdbcTemplate 적용3- 구성과 실행

코드가 동작하도록 구성하고 실행해보자.

@Configuration
@RequiredArgsConstructor
public class JdbcTemplateV1Config {

    private final DataSource dataSource;

    @Bean
    public ItemService itemService() {
        return new ItemServiceV1(itemRepository());
    }

    @Bean
    public ItemRepository itemRepository() {
        return new JdbcTemplateItemRepositoryV1(dataSource);
    }
}

컨피그로 빈 등록, 만든 리포지토리 사용

//@Import(MemoryConfig.class)
@Import(JdbcTemplateV1Config.class)
@SpringBootApplication(scanBasePackages = "hello.itemservice.web")
public class ItemServiceApplication {

수정한 컨피그 파일 사용하도록 수정

spring.datasource.url=jdbc:h2:tcp://localhost/~/yhtest
spring.datasource.username=sa
spring.datasource.password=

데이터베이스 접근을 위한 설정 추가

지금부터 디비가 메모리기 아니기 때문에 서버 재시작 하면 그때 마다 테스트 데이터가 들어감.

로그 추가
JdbcTemplate이 실행하는 SQL 로그를 확인하려면 application.properties 에 다음을 추가하면 된다.
main , test 설정이 분리되어 있기 때문에 둘다 확인하려면 두 곳에 모두 추가해야 한다.

#jdbcTemplate sql log
logging.level.org.springframework.jdbc=debug