[Spring] Spring JdbcTemplate 가이드 (공식문서, Baeldung)

Spring JdbcTemplate에 대한 공식문서 가이드

(K가 알려주셨다🙇‍♀️ 감사합니다!)

3.1 Choosing an Approach for JDBC Database Access에서 간단한 설명을 읽고

3.3.1. UsingJdbcTemplate 부분부터 보면 될 듯!

https://docs.spring.io/spring-framework/docs/current/reference/html/data-access.html#jdbc

3.1 Choosing an Approach for JDBC Database Access (JDBC 데이터베이스에 대한 접근방식 선택)

JdbcTemplate, SimpleJdbcInsert, SimpleJdbcCall, 등등의 방식들이 JDBC 데이터베이스 접근을 쉽게 한다.

셋 중 하나를 골라 쓰더라도, 나머지 방식을 섞어 사용할 수도 있다.

• JdbcTemplate : 기본적이며 가장 인기 있는 스프링 JDBC 접근법. 가장 낮은 수준의 접근.
  • 나머지 방식들은 모두 이 방식의 확장이다.
• NamedParameterJdbcTemplate : JDBC의 ?방식 대신 명명된 매개변수 사용할 수 있도록 함. SQL문에 여러 파라미터를 가지고 있을 때 유용함.
• SimpleJdbcInsert, SimpleJdbcCall : 필요한 구성의 규모를 제한하기 위해 데이터베이스 메타데이터를 최적화한다.

3.3.1 Using JdbcTemplate

JdbcTemplate는 JDBC 코어 패키지의 중심 클래스이다.

• 자원의 생성 및 릴리스를 다룬다.
• JDBC의 중심 워크플로우의 기본 작업을 다룬다.

JdbcTemplate클래스는..

• SQL쿼리들을 실행함
• 구문과 저장된 프로시저 호출을 수정함
• ResultSet 인스턴스에 대한 반복을 실행함
• 반환된 매개변수 값을 추출함
• JDBC 예외를 잡아 더 일반적이고 유익하게 변환함

※ DataSource는 항상 스프링 컨테이너에서 빈으로 구성해야 함.

SELECT 쿼리

• String을 찾는 쿼리

  • id가 1212인 배우의 성을 가져옴

  • String lastName = this.jdbcTemplate.queryForObject(
            "select last_name from t_actor where id = ?",
            String.class, 1212L);

• 바인드 변수를 사용하는 쿼리

  • 이름이 Joe인 배우의 수를 셈

  • int countOfActorsNamedJoe = this.jdbcTemplate.queryForObject(
            "select count(*) from t_actor where first_name = ?", Integer.class, "Joe");

• 관계있는 행(row)의 수를 세는 쿼리

  • 배우의 수를 셈?

  • int rowCount = this.jdbcTemplate.queryForObject("select count(*) from t_actor", Integer.class);

• 하나의 도메인 객체를 찾아서 값을 채우는 쿼리

  • 아이디가 1212인 배우의 성과 이름을 찾음

  • Actor actor = jdbcTemplate.queryForObject(
            "select first_name, last_name from t_actor where id = ?",
            (resultSet, rowNum) -> {
                Actor newActor = new Actor();
                newActor.setFirstName(resultSet.getString("first_name"));
                newActor.setLastName(resultSet.getString("last_name"));
                return newActor;
            },
            1212L);

• 여러 도메인 객체(리스트)를 찾아서 값을 채우는 쿼리

  • 배우들의 성과 이름을 찾음

  • List<Actor> actors = this.jdbcTemplate.query(
            "select first_name, last_name from t_actor",
            (resultSet, rowNum) -> {
                Actor actor = new Actor();
                actor.setFirstName(resultSet.getString("first_name"));
                actor.setLastName(resultSet.getString("last_name"));
                return actor;
            });

• 하나의 도메인 객체 & 여러 도메인 객체 를 찾을 때 RowMapper 코드가 중복되는 경우 다음과 같이 중복을 제거할 수 있다

  • private final RowMapper<Actor> actorRowMapper = (resultSet, rowNum) -> {
        Actor actor = new Actor();
        actor.setFirstName(resultSet.getString("first_name"));
        actor.setLastName(resultSet.getString("last_name"));
        return actor;
    };
    
    public List<Actor> findAllActors() {
        return this.jdbcTemplate.query( "select first_name, last_name from t_actor", actorRowMapper);
    }

INSERT, UPDATE, DELETE 쿼리 그리고 JdbcTemplate

update(...) 메서드를 통해 INSERT, UPDATE, DELETE를 모두 수행할 수 있다. 매개변수 값은 보통 변수 / 객체 배열로 제공된다.

• 새 엔트리를 삽입하는 쿼리

  • 성이 Watling, 이름이 Leonor인 배우를 추가한다

  • this.jdbcTemplate.update(
            "insert into t_actor (first_name, last_name) values (?, ?)",
            "Leonor", "Watling");

• 기존 엔트리를 수정하는 쿼리

  • id가 5276인 배우의 이름을 Banjo로 수정한다

  • this.jdbcTemplate.update(
            "update t_actor set last_name = ? where id = ?",
            "Banjo", 5276L);

• 기존 엔트리를 삭제하는 쿼리

  • id가 actorId인 배우를 삭제한다

  • this.jdbcTemplate.update(
            "delete from t_actor where id = ?",
            Long.valueOf(actorId));

JdbcTemplate 모범 사례

아래와 같이 DataSource는 설정 파일에서 생성하고(Spring Configuration), 그 빈을 DAO클래스에 의존성 주입하는 방식이 권장된다.

• DAO 클래스
• public class JdbcCorporateEventDao implements CorporateEventDao { private JdbcTemplate jdbcTemplate; public void setDataSource(DataSource dataSource) { this.jdbcTemplate = new JdbcTemplate(dataSource); } // JDBC-backed implementations of the methods on the CorporateEventDao follow... }
• 설정 파일 (XML)
• <?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context" xsi:schemaLocation=" http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd"> <bean id="corporateEventDao" class="com.example.JdbcCorporateEventDao"> <property name="dataSource" ref="dataSource"/> </bean> <bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource" destroy-method="close"> <property name="driverClassName" value="${jdbc.driverClassName}"/> <property name="url" value="${jdbc.url}"/> <property name="username" value="${jdbc.username}"/> <property name="password" value="${jdbc.password}"/> </bean> <context:property-placeholder location="jdbc.properties"/> </beans>

다른 방법으로 의존성 주입을 하기 위해서는 컴포넌트스캔과 어노테이션을 사용할 수 있다.

• DAO 클래스
• @Repository public class JdbcCorporateEventDao implements CorporateEventDao { private JdbcTemplate jdbcTemplate; @Autowired public void setDataSource(DataSource dataSource) { this.jdbcTemplate = new JdbcTemplate(dataSource); } // JDBC-backed implementations of the methods on the CorporateEventDao follow... }
• 설정 파일 (XML)
• <?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context" xsi:schemaLocation=" http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd"> <!-- Scans within the base package of the application for @Component classes to configure as beans --> <context:component-scan base-package="org.springframework.docs.test" /> <bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource" destroy-method="close"> <property name="driverClassName" value="${jdbc.driverClassName}"/> <property name="url" value="${jdbc.url}"/> <property name="username" value="${jdbc.username}"/> <property name="password" value="${jdbc.password}"/> </bean> <context:property-placeholder location="jdbc.properties"/> </beans>

3.3.2 Using NamedParameterJdbcTemplate

NamedParameterJdbcTemplate 클래스는 JDBC 구문에 명명된 매개변수를 사용할 수 있도록 지원해 준다.

기존 JDBC구문과 다른 점은 ?만을 사용하는 것이 아니라 정의한 매개변수명을 그대로 사용할 수 있다는 것이다.

이 클래스는 JdbcTemplate를 포함한다.

명명된 매개변수를 사용해 JDBC구문을 프로그래밍할 때 이 클래스를 사용할 수 있다.

// some JDBC-backed DAO class...
private NamedParameterJdbcTemplate namedParameterJdbcTemplate;

public void setDataSource(DataSource dataSource) {
    this.namedParameterJdbcTemplate = new NamedParameterJdbcTemplate(dataSource);
}

public int countOfActorsByFirstName(String firstName) {

    String sql = "select count(*) from T_ACTOR where first_name = :first_name";

    SqlParameterSource namedParameters = new MapSqlParameterSource("first_name", firstName);

    return this.namedParameterJdbcTemplate.queryForObject(sql, namedParameters, Integer.class);
}

또는 아래와 같이, Map 기반으로 명명된 매개변수와 그에 상응하는 값을 전달할 수 있다.

// some JDBC-backed DAO class...
private NamedParameterJdbcTemplate namedParameterJdbcTemplate;

public void setDataSource(DataSource dataSource) {
    this.namedParameterJdbcTemplate = new NamedParameterJdbcTemplate(dataSource);
}

public int countOfActorsByFirstName(String firstName) {

    String sql = "select count(*) from T_ACTOR where first_name = :first_name";

    Map<String, String> namedParameters = Collections.singletonMap("first_name", firstName);

    return this.namedParameterJdbcTemplate.queryForObject(sql, namedParameters,  Integer.class);
}

NamedParameterJdbcTemplate에는 SqlParameterSource인터페이스가 존재한다.

• SqlParameterSource : NamedParameterJdbcTemplate의 명명된 매개변수의 source이다.

• MapSqlParameterSource클래스 : java.util.Map의 어댑터(키가 매개변수 이름이고, 값이 매개변수 값)인 간단한 구현체이다.

• BeanPropertySqlParameterSource클래스 : 임의의 자바빈을 랩핑하고, 랩핑된 자바빈의 속성을 명명된 매개변수의 값의 source로 사용함

• 예시는 아래와 같다.

  • public class Actor {
    
        private Long id;
        private String firstName;
        private String lastName;
    
        public String getFirstName() {
            return this.firstName;
        }
    
        public String getLastName() {
            return this.lastName;
        }
    
        public Long getId() {
            return this.id;
        }
    
        // setters omitted...
    
    }

  • // some JDBC-backed DAO class...
    private NamedParameterJdbcTemplate namedParameterJdbcTemplate;
    
    public void setDataSource(DataSource dataSource) {
        this.namedParameterJdbcTemplate = new NamedParameterJdbcTemplate(dataSource);
    }
    
    public int countOfActors(Actor exampleActor) {
    
        // notice how the named parameters match the properties of the above 'Actor' class
        String sql = "select count(*) from T_ACTOR where first_name = :firstName and last_name = :lastName";
    
        SqlParameterSource namedParameters = new BeanPropertySqlParameterSource(exampleActor);
    
        return this.namedParameterJdbcTemplate.queryForObject(sql, namedParameters, Integer.class);
    }

3.3.4 Running Statements

import javax.sql.DataSource;
import org.springframework.jdbc.core.JdbcTemplate;

public class ExecuteAStatement {

    private JdbcTemplate jdbcTemplate;

    public void setDataSource(DataSource dataSource) {
        this.jdbcTemplate = new JdbcTemplate(dataSource);
    }

    public void doExecute() {
        this.jdbcTemplate.execute("create table mytable (id integer, name varchar(100))");
    }
}

3.3.5 Running Queries

• queryForObject() : 하나의 값을 리턴할 때 (갯수를 세거나, 한 행의 값을 검색 )

  • 매개변수로 int나 String을 넣을 수 있다

  • import javax.sql.DataSource;
    import org.springframework.jdbc.core.JdbcTemplate;
    
    public class RunAQuery {
    
        private JdbcTemplate jdbcTemplate;
    
        public void setDataSource(DataSource dataSource) {
            this.jdbcTemplate = new JdbcTemplate(dataSource);
        }
    
        public int getCount() {
            return this.jdbcTemplate.queryForObject("select count(*) from mytable", Integer.class);
        }
    
        public String getName() {
            return this.jdbcTemplate.queryForObject("select name from mytable", String.class);
        }
    }

• queryForList() : 여러 항목을 리스트로 리턴할 때

  • private JdbcTemplate jdbcTemplate;
    
    public void setDataSource(DataSource dataSource) {
        this.jdbcTemplate = new JdbcTemplate(dataSource);
    }
    
    public List<Map<String, Object>> getList() {
        return this.jdbcTemplate.queryForList("select * from mytable");
    }

  • 리턴되는 리스트의 형태는 [{name=Bob, id=1}, {name=Mary, id=2}] 와 같다.

3.3.5. Updating the Database

• 특정 PK의 컬럼을 수정하는 경우의 예시.

  • import javax.sql.DataSource;
    import org.springframework.jdbc.core.JdbcTemplate;
    
    public class ExecuteAnUpdate {
    
        private JdbcTemplate jdbcTemplate;
    
        public void setDataSource(DataSource dataSource) {
            this.jdbcTemplate = new JdbcTemplate(dataSource);
        }
    
        public void setName(int id, String name) {
            this.jdbcTemplate.update("update mytable set name = ? where id = ?", name, id);
        }
    }

---

Spring JDBC Template 튜토리얼 (Baeldung) (작성 중)

출처 : https://www.baeldung.com/spring-jdbc-jdbctemplate

• datasource 패키지 : 데이터 소스에 액세스하기 위한 유틸리티 클래스.

2. 구성

데이터 소스의 간단한 구성. (MySQL 사용)

데이터소스를 생성하고 스프링 빈으로 만들기.

@Configuration
@ComponentScan("com.baeldung.jdbc")
public class SpringJdbcConfig {
    @Bean
    public DataSource mysqlDataSource() {
        DriverManagerDataSource dataSource = new DriverManagerDataSource();
        dataSource.setDriverClassName("com.mysql.jdbc.Driver");
        dataSource.setUrl("jdbc:mysql://localhost:3306/springjdbc");
        dataSource.setUsername("guest_user");
        dataSource.setPassword("guest_password");

        return dataSource;
    }
}

3. JdbcTemplate 및 쿼리 실행

3.1. 기본 쿼리

JdbcTemplate API로 아래와 같은 대부분의 기능에 액세스할 수 있다.

• Connection 생성 및 종료
• 구문 실행 및 저장된 절차 호출
• ResultSet을 순회하고 결과를 반환

간단한 SELECT문

• int result = jdbcTemplate.queryForObject(
      "SELECT COUNT(*) FROM EMPLOYEE", Integer.class);

간단한 INSERT문

• public int addEmplyee(int id) {
      return jdbcTemplate.update(
        "INSERT INTO EMPLOYEE VALUES (?, ?, ?, ?)", id, "Bill", "Gates", "USA");
  }

• ?를 통해 매개변수를 제공한다.

3.2. 명명된 매개변수가 있는 쿼리

이름이 있는 파라미터를 사용하기 위해 NamedParameterJdbcTemplate라는 프레임워크를 사용할 수 있다.

• (?) 내부적으로 ?를 이름 있는 파라미터로 대체하며, 쿼리 실행을 위해 감싼 JdbcTemplate로 위임한다

명명된 파라미터를 위한 값을 제공하기 위해 MapSqlParameterSource를 사용한다.

• SqlParameterSource namedParameters = new MapSqlParameterSource().addValue("id", 1);
  return namedParameterJdbcTemplate.queryForObject(
    "SELECT FIRST_NAME FROM EMPLOYEE WHERE ID = :id", namedParameters, String.class);

명명된 파라미터를 결정짓기 위해 스프링 빈으로부터 프로퍼티를 사용할 수도 있다.

• Employee employee = new Employee();
  employee.setFirstName("James");
  
  String SELECT_BY_ID = "SELECT COUNT(*) FROM EMPLOYEE WHERE FIRST_NAME = :firstName";
  
  SqlParameterSource namedParameters = new BeanPropertySqlParameterSource(employee);
  return namedParameterJdbcTemplate.queryForObject(
    SELECT_BY_ID, namedParameters, Integer.class);

• BeanPropertySqlParameterSource를 사용한 구현 (전처럼 명명된 파라미터를 특정하는 대신)

3.3. Java 객체에 쿼리 결과 맵핑하기

RowMapper인터페이스를 구현함으로써 쿼리 결과를 자바 객체에 맵핑할 수 있다.

예를 들어 쿼리에 의해 반환되는 각 행에 대해, 스프링이 row mapper를 사용해 자바 빈을 채운다.

• public class EmployeeRowMapper implements RowMapper<Employee> {
      @Override
      public Employee mapRow(ResultSet rs, int rowNum) throws SQLException {
          Employee employee = new Employee();
  
          employee.setId(rs.getInt("ID"));
          employee.setFirstName(rs.getString("FIRST_NAME"));
          employee.setLastName(rs.getString("LAST_NAME"));
          employee.setAddress(rs.getString("ADDRESS"));
  
          return employee;
      }
  }

그 다음, row mapper를 쿼리 API에 전달하고 완전히 채워진 자바 객체를 얻을 수 있다.

• String query = "SELECT * FROM EMPLOYEE WHERE ID = ?";
  Employee employee = jdbcTemplate.queryForObject(
    query, new Object[] { id }, new EmployeeRowMapper());