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

[6om1n]

1️⃣ JdbcTemplate 소개와 설정

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

장점

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

단점

• 동적 SQL 을 해결하기 어렵다.

JdbcTemplate 설정

• build.gradle (추가된부분)

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

---

2️⃣ JdbcTemplate 적용1 - 기본

• JdbcTemplateItemRepositoryV1 (JdbcTemplate 을 사용해서 메모리에 저장하던 데이터를 데이터베이스에 저장)

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 lombok.extern.slf4j.Slf4j;
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;

import javax.sql.DataSource;
import javax.swing.text.html.Option;
import java.sql.PreparedStatement;
import java.util.ArrayList;
import java.util.List;
import java.util.Optional;
import java.util.jar.JarEntry;

/**
 * JdbcTemplate
 */
@Slf4j
public class JdbcTemplateItemRepositoryV1 implements ItemRepository {

    private final JdbcTemplate template;

    public JdbcTemplateItemRepositoryV1(DataSource dataSource) {
        this.template = new JdbcTemplate(dataSource);
    }

    @Override
    public Item save(Item item) {
        String sql = "insert into item(item_name, price, quantity) values (?,?,?)";
        KeyHolder keyHolder = new GeneratedKeyHolder();
        template.update(cconnection -> {
            //자동 증가 키
            PreparedStatement ps = cconnection.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);
        }
        log.info("sql={}", sql);
        return template.query(sql, itemRowMapper());
    }
}

기본

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

save() - 데이터를 저장한다.

• template.update() : 데이터를 변경할 때는 update() 를 사용하면 된다.
  • INSERT, UPDATE, DELETE SQL 에 사용한다.
  • template.update() 의 반환 값은 int 인데, 영향 받은 로우 수를 반환한다.
• 데이터를 저장할 때 PK 생성에 identity 방식을 사용하기 때문에 직접 개발자가 지정하는 것이 아니라 비워두고 저장해야 한다. 그러면 데이터베이스가 PK 인 ID 를 대신 생성해준다.
• 데이터베이스가 대신 생성해주는 PK ID 값은 데이터베이스가 생성하기 때문에, 데이터베이스에 insert 가 완료 되어야 생성된 PK ID 값을 확인할 수 있다.
• KeyHolder 와 connection.prepareStatement(sql, new String[]{"id"}) 를 사용해서 id 를 지정해주면 INSERT 쿼리 실행 이후에 데이터베이스에서 생성된 ID 값을 조회할 수 있다.
• 뒤에서 설명하는 JdbcTemplate 이 제공하는 SimpleJdbcInsert 라는 훨씬 편리한 기능이 있다.

update() - 데이터를 업데이트 한다.

• template.update() : 데이터를 변경할 때는 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 를 구현해서 그 내부 코드만 채운다고 이해하면 된다.

---

3️⃣ 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을 직접 사용할 때 동적 쿼리를 쉽게 작성할 수 있다는 점이다.

---

4️⃣ JdbcTemplate 적용3 - 구성과 실행

• JdbcTemplateV1Config

package hello.itemservice.config;

import hello.itemservice.repository.ItemRepository;
import hello.itemservice.repository.jdbctemplate.JdbcTemplateItemRepositoryV1;
import hello.itemservice.service.ItemService;
import hello.itemservice.service.ItemServiceV1;
import lombok.RequiredArgsConstructor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import javax.sql.DataSource;

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


}

• ItemRepository 구현체로 JdbcTemplateItemRepositoryV1 이 사용되도록 했다. 메모리 저장소가 아닌 실제 DB 에 연결하는 JdbcTemplate 이 사용된다.

ItemServiceApplication - 변경

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

데이터베이스 접근 설정

• src/main/resources/application.properties

spring.profiles.active=local
spring.datasource.url=jdbc:h2:tcp://localhost/~/test
spring.datasource.username=sa

• 이렇게 설정하면 스프링 부트가 해당 설정을 사용해서 커넥션 풀과 DataSource , 트랜잭션 매니저를 스프링 빈으로 자동 등록한다.

실행

• 웹브라우저에서 localhost:8080 에 들어가서 확인
• 서버를 다시 시작할 때 마다 TestDataInit 이 실행되기 때문에 itemA, itemB 도 데이터베이스에 계속 추가된다. 메모리와 다르게 서버가 내려가도 데이터베이스를 유지되기 때문이다.

---

🔗 출처

김영한 - 스프링 DB 2편 - 데이터 접근 활용 기술

---