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

[Pracrobo]

JdbcTemplate 소개와 설정

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

장점

• 설정의 편리함

  • JdbcTemplate 은 spring-jdbc 라이브러리에 포함되어 있는데 , 이 라이브러리는 스프링으로 JDBC 를 사용할때 기본으로 사용되는 라이브러리이다. 그리고 별도의 복잡한 설정없이 바로 사용할 수 있다.

• 반복 문제 해결

  • JdbcTemplate 은 템플릿 콜백 패턴을 사용해서 JDBC를 직접 사용할때 발생하는 대부분의 반복작업을 대신 처리해준다.
  • 개발자는 SQL을 작성하고 전달할 파라미터를 정의하고 응답값을 매핑하기만 하면된다.
  • 우리가 생각할 수있는 대부분의 반복작업을 대신 처리해준다.
    • 커넥션 획득
    • statement를 준비하고 실행
    • 켤과를 반복하도록 루프를 실행
    • 커넥션 종료, statement, resultset 종료
    • 트랜잭션 다루기 위한 커넥션 동기화
    • 예외 발생시 스프링 예외 변환기 실행

단점

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

dependencies {
	implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
	implementation 'org.springframework.boot:spring-boot-starter-web'

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

	compileOnly 'org.projectlombok:lombok'
	annotationProcessor 'org.projectlombok:lombok'
	testImplementation 'org.springframework.boot:spring-boot-starter-test'

	//테스트에서 lombok 사용
	testCompileOnly 'org.projectlombok:lombok'
	testAnnotationProcessor 'org.projectlombok:lombok'

• refresh해줘야 추가가 된다. External애서 찾아보기

• ‘item테이블 생성하기

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

JdbcTemplate 적용 1 - 기본

repository > jdbctemplate > jdbcTemplateV1

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 java.sql.PreparedStatement;
import java.util.ArrayList;
import java.util.List;
import java.util.Optional;

/**
 * JdbcTemplate
 */
@Slf4j
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(); //jdbcTemplate에서 keyholder로 가져옴
        template.update(connection -> {
            //자동 증가 키 //sequence
            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(); //key값 꺼내고
        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); // optional로 나옴
        } catch (EmptyResultDataAccessException e) {
            return Optional.empty();
        }
    }

    @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(), param.toArray());
    }

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

memory에서 seqence로 id를 설정해줬다.

  @Override
    public Item save(Item item) {
        item.setId(++sequence);
        store.put(item.getId(), item);
        return item;
    }

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

save()

데이터를 저장한다.

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

update()

데이터를 업데이트한다.

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

findById()

데이터를 하나 조회한다.

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

queryForObject()인터페이스의 정의

<T> T queryForObject(String sql, RowMapper<T> rowMapper, Object .. args) throws DataAccessException;

findAll()

데이터를 리스트로 조회한다.

그리고 검색 조건으로 적절한 데이터를 찾는다.

• template.query()
  • 결과가 하나 이상일 때 사용한다
  • RowMapper 는 데이터베이스의 반환 결과인 ResultSet을 객체로 변환한다.
  • 결과가 없으면 빈 컬렉션을 반환한다.
  • 동적 쿼리에 대한 부분은 다음에 다룬다.

query() 인터페이스 정의

<T> List<T> query(String sql, RowMapper<t> rowMapper, Object ... args) throws DataAccessException;

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, quanitity 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을 동적으로 생성해야 한다. 동적쿼리는 개발하려면 생각보다 다양한 상황을 고민해야한다.

• MyBatis의 가장 큰 장점은 SQL을 직접 사용할때 동적 쿼리를 쉽게 작성할 수 있다는 점이다.

JdbcTemplate 적용3 - 구성과 실행

jdbcTemplateV1Config

package hello.itemservice.config;

import hello.itemservice.repository.ItemRepository;
import hello.itemservice.repository.jdbctemplate.JdbcTemplateItemRepositoryV1;
import hello.itemservice.repository.memory.MemoryItemRepository;
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);
    }

}

Config

package hello.itemservice;

import hello.itemservice.config.*;
import hello.itemservice.repository.ItemRepository;
import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Import;
import org.springframework.context.annotation.Profile;
import org.springframework.jdbc.datasource.DriverManagerDataSource;

import javax.sql.DataSource;

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

	public static void main(String[] args) {
		SpringApplication.run(ItemServiceApplication.class, args);
	}

	@Bean
	@Profile("local")
	public TestDataInit testDataInit(ItemRepository itemRepository) {
		return new TestDataInit(itemRepository);
	}

/*
	@Bean
	@Profile("test")
	public DataSource dataSource() {
		log.info("메모리 데이터베이스 초기화");
		DriverManagerDataSource dataSource = new DriverManagerDataSource();
		dataSource.setDriverClassName("org.h2.Driver");
		dataSource.setUrl("jdbc:h2:mem:db;DB_CLOSE_DELAY=-1");
		dataSource.setUsername("sa");
		dataSource.setPassword("");
		return dataSource;
	}
*/

}

[application.properties](http://application.properties/) dataBase 설정

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

실행

• 실제DB에 연결해야 하므로 H2데이터 베이스 서버를 먼저 실행하자
• 앞서 만든 item 테이블이 잘생성되어 있는지 다시 확인하자
• ItemServiceApplication.main()을 실행해서 애플리케이션 서버를 실행하자
• 웹브라우저로 다음에 접속 : httpL//localhost:8080
• 참고로 서버를 다시 시작할때마다 TestDataInit이 실행되기 때문에 itemA, itemB도 데이터베이스에 계속 추가된다. 메모리와 다르게 서버가 내려가도 데이터베이스는 유지되기 때문이다.

로그 추가

JdbcTemplate이 실행하는 SQL로그를 확인하려면 application.properties에 다음을 추가한다.

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