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

[6om1n]

1️⃣ JdbcTemplate - 이름 지정 파라미터1

순서대로 바인딩

JdbcTemplate 을 기본으로 파라미터를 순서대로 바인딩한다.

 String sql = "update item set item_name=?, price=?, quantity=? where id=?";
 template.update(sql,
        itemName,
        price,
        quantity,
        itemId);

여기서는 itemName, price, quantity 가 SQL 에 있는 ? 에 순서대로 바인딩 된다.
순서만 잘 지키면 문제가 될 것이 없다. 그러나 문제는 변경 시점에 발생한다.

누군가 price ,quantity 의 순서를 변경했을 때

String sql = "update item set item_name=?, quantity=?, price=? where id=?";
 template.update(sql,
        itemName,
        price,
        quantity,
        itemId);

이렇게 되면 item_name=itemName, quantity=price, price=quantity

결과적으로 price 와 quantity 가 바뀌는 심각한 문제가 발생한다. 실무에서는 파라미터가 10~20개가 넘어가는 일도 아주 많기에 미래에 필드를 추가하거나 수정하면서 이런 문제가 충분히 발생할 수 있다.
버그 중에서 가장 고치기 힘든 버그는 데이터베이스에 데이터가 잘못 들어가는 버그이다. 코드만 고치는 수준이 아니라 데이터베이스의 데이터를 복구해야 하기 때문에 버그를 해결하는데 들어가는 리소스가 어마어마하다.

**개발을 할 때는 코드를 몇 줄 줄이는 편리함도 중요하지만, 모호함을 제거해서 코드를 명확하게 만드는 것이 유지보수 관점에서 매우 중요하다. **

이름 지정 바인딩

JdbcTemplate은 이러한 문제를 보완하기 위해 NamedParameterJdbcTemplate 라는 이름을 지정해서 파라미터를 바인딩 하는 기능을 제공한다.

• JdbcTemplateItemRepositoryV2

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.BeanPropertyRowMapper;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.jdbc.core.RowMapper;
import org.springframework.jdbc.core.namedparam.BeanPropertySqlParameterSource;
import org.springframework.jdbc.core.namedparam.MapSqlParameterSource;
import org.springframework.jdbc.core.namedparam.NamedParameterJdbcTemplate;
import org.springframework.jdbc.core.namedparam.SqlParameterSource;
import org.springframework.jdbc.support.GeneratedKeyHolder;
import org.springframework.jdbc.support.KeyHolder;
import org.springframework.util.StringUtils;

import javax.sql.DataSource;
import java.sql.PreparedStatement;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Optional;

/**
 * NamedParameterJdbcTemplate
 * SqlParameterSource
 * - BeanPropertySqlParameterSource
 * - MapSqlParameterSource
 * Map
 *
 * BeanPropertyRowMapper
 */
@Slf4j
public class JdbcTemplateItemRepositoryV2 implements ItemRepository {

//    private final JdbcTemplate template;

    private final NamedParameterJdbcTemplate template;

    public JdbcTemplateItemRepositoryV2(DataSource dataSource) {
        this.template = new NamedParameterJdbcTemplate(dataSource);
    }

    @Override
    public Item save(Item item) {
        String sql = "insert into item (item_name, price, quantity) " +
                "values (:itemName, :price, :quantity)";

        SqlParameterSource param = new BeanPropertySqlParameterSource(item);
        KeyHolder keyHolder = new GeneratedKeyHolder();
        template.update(sql, param, 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=:itemName, price=:price, quantity=:quantity " +
                "where id=:id";

        SqlParameterSource param = new MapSqlParameterSource()
                .addValue("itemName", updateParam.getItemName())
                .addValue("price", updateParam.getPrice())
                .addValue("quantity", updateParam.getQuantity())
                .addValue("id", itemId); //이 부분이 별도로 필요하다.
    }

    @Override
    public Optional<Item> findById(Long id) {
        String sql = "select id, item_name, price, quantity from item where id = :id";
        try {
            Map<String, Object> param = Map.of("id", id);
            Item item = template.queryForObject(sql, param, itemRowMapper());
            return Optional.of(item);
        } catch (EmptyResultDataAccessException e) {
            return Optional.empty();
        }
    }

    @Override
    public List<Item> findAll(ItemSearchCond cond) {

        Integer maxPrice = cond.getMaxPrice();
        String itemName = cond.getItemName();

        SqlParameterSource param = new BeanPropertySqlParameterSource(cond);

        String sql = "select id, item_name, price, quantity from item";
        //동적 쿼리
        if (StringUtils.hasText(itemName) || maxPrice != null) {
            sql += " where";
        }

        boolean andFlag = false;
        if (StringUtils.hasText(itemName)) {
            sql += " item_name like concat('%',:itemName,'%')";
            andFlag = true;
        }
        if (maxPrice != null) {
            if (andFlag) {
                sql += " and";
            }
            sql += " price <= :maxPrice";
        }
        log.info("sql={}", sql);
        return template.query(sql,param, itemRowMapper());
    }

    private RowMapper<Item> itemRowMapper() {
        return BeanPropertyRowMapper.newInstance(Item.class); //camel 변환 지원
    }
}

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

save()

SQL 에서 다음과 같이 ? 대신에 :파라미터이름 을 받는 것을 확인할 수 있다.

 insert into item (item_name, price, quantity) " +
             "values (:itemName, :price, :quantity)"

추가로 NamedParameterJdbcTemplate 은 데이터베이스가 생성해주는 키를 매우 쉽게 조회하는 기능도 제공해준다.

---

2️⃣ JdbcTemplate - 이름 지정 파라미터2

이름 지정 파라미터

파라미터를 전달하려면 Map 처럼 key, value 데이터 구조를 만들어서 전달해야 한다.
key 는 :파라미터이름 으로 지정한, 파라미터의 이름이고, value 는 해당 파라미터의 값이 된다.

아래 코드를 보면 이렇게 만든 파라미터(param) 을 전달하는 것을 확인할 수 있다.
template.update(sql, param, keyHolder);

이름 지정 바인딩에서 자주 사용하는 파라미터의 종류는 크게 3가지가 있다.

• Map
• SqlParameterSource
  • MapSqlParameterSource
  • BeanPropertySqlParameterSource

1. Map

• 단순히 Map 을 사용한다.
• findById() 코드에서 확인할 수 있다.

Map<String, Object> param = Map.of("id", id);
 Item item = template.queryForObject(sql, param, itemRowMapper());

2. MapSqlParameterSource

Map 과 유사한데 , SQL 타입을 지정할 수 있는 등 SQL 에 좀 더 특화된 기능을 제공한다.
SqlParameterSource 인터페이스의 구현체이다.
MapSqlParameterSource 는 메서드체인을 통해 편리한 사용법도 제공한다.

update() 코드에서 확인할 수 있다.

 SqlParameterSource param = new MapSqlParameterSource()
        .addValue("itemName", updateParam.getItemName())
        .addValue("price", updateParam.getPrice())
        .addValue("quantity", updateParam.getQuantity())
        .addValue("id", itemId); //이 부분이 별도로 필요하다.
 template.update(sql, param);

3. BeanPropertySqlParameterSource

자바빈 프로퍼티 규약을 통해서 자동으로 파라미터 객체를 생성한다.
예 ) getXxx() -> xxx, getItemName() -> itemName
예를 들어 getItemName() , getPrice() 가 있으면 다음과 같은 데이터를 자동으로 만들어낸다.

• key=itemName, value=상품명 값
• key=price, value=가격 값

SqlParameterSource 인터페이스의 구현체이다.
save(), findAll() 코드에서 확인할 수 있다.

SqlParameterSource param = new BeanPropertySqlParameterSource(item);
 KeyHolder keyHolder = new GeneratedKeyHolder();
 template.update(sql, param, keyHolder);

• BeanPropertySqlParameterSource 를 항상 사용할 수 있는 것은 아니다.
• 예를 들어 update() 에서는 SQL에 :id 를 바인딩 해야 하는데, update() 에서 사용하는 ItemUpdateDto 에는 itemId 가 없다. 따라서 BeanPropertySqlParameterSource 를 사용할 수 없고, 대신에 MapSqlParameterSource 를 사용했다.

BeanPropertyRowMapper

한가지 더 변화된 부분은 BeanPropertyRowMapper 를 사용한 것이다.

• JdbcTemplateItemRepositoryV1 - itemRowMapper()

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

• JdbcTemplateItemRepositoryV2 - itemRowMapper()

private RowMapper<Item> itemRowMapper() {
 return BeanPropertyRowMapper.newInstance(Item.class); //camel 변환 지원
}

BeanPropertyRowMapper 는 ResultSet 의 결과를 받아서 자바빈 규약에 맞추어 데이터를 변환한다.
예를 들어 데이터베이스에서 조회한 결과가 select id, price 라고 하면 다음과 같은 코드를 작성해준다.

Item item = new Item();
 item.setId(rs.getLong("id"));
 item.setPrice(rs.getInt("price"));

데이터베이스에서 조회한 결과 이름을 기반으로 setId(), setPrice() 처럼 자바빈 프로퍼티 규약에 맞춘 메서드를 호출하는 것이다.

별칭

select item_name 의 경우 setItem_name() 이라는 메서드가 없기에 개발자가 조회 SQL을
select item_name as itemName 으로 고치면 된다.

별칭 as 를 사용해서 SQL 조회 결과의 이름을 변경하는 것이다.
이렇게 데이터베이스 컬럼 이름과 객체의 이름이 다를 때 별칭(as) 을 사용해서 문제를 많이 해결한다.
JdbcTemplate 은 물론이고, MyBatis 같은 기술에서도 자주 사용된다.

관례의 불일치

• 정리중..입니다 ....

---

3️⃣ JdbcTemplate - 이름 지정 파라미터3

---

4️⃣ JdbcTemplate - SimpleJdbcInsert

---

5️⃣ JdbcTemplate 기능 정리

---