Spring JDBC - PreparedStatementSetter 介面

---

---

概述

org.springframework.jdbc.core.PreparedStatementSetter 介面充當 JdbcTemplate 類使用的一般回撥介面。此介面在 JdbcTemplate 類提供的 PreparedStatement 上設定值，用於使用相同 SQL 的批處理中的多個更新中的每一個。

實現負責設定任何必要的引數。帶有佔位符的 SQL 已經提供。使用此介面比 PreparedStatementCreator 更容易。JdbcTemplate 將建立 PreparedStatement，回撥僅負責設定引數值。

介面宣告

以下是 org.springframework.jdbc.core.PreparedStatementSetter 介面的宣告：

public interface PreparedStatementSetter

用法

• 步驟 1 - 使用已配置的資料來源建立一個 JdbcTemplate 物件。

• 步驟 2 - 使用 JdbcTemplate 物件方法進行資料庫操作，同時傳遞 PreparedStatementSetter 物件以替換查詢中的佔位符。

示例

以下示例將演示如何使用 JdbcTemplate 類和 PreparedStatementSetter 介面讀取查詢。我們將讀取學生表中學生的可用記錄。

語法

final String SQL = "select * from Student where id = ? ";
List <Student> students = jdbcTemplateObject.query(
   SQL, new PreparedStatementSetter() {
   
   public void setValues(PreparedStatement preparedStatement) throws SQLException {
      preparedStatement.setInt(1, id);
   }
},
new StudentMapper());

其中，

• SQL - 讀取學生的查詢語句。

• jdbcTemplateObject - 用於從資料庫讀取學生物件的 StudentJDBCTemplate 物件。

• PreparedStatementSetter - 用於在查詢中設定引數的 PreparedStatementSetter 物件。

• StudentMapper - StudentMapper 是一個 RowMapper 物件，用於將每個提取的記錄對映到學生物件。

為了理解上面提到的與 Spring JDBC 相關的概念，讓我們編寫一個將選擇查詢的示例。要編寫我們的示例，讓我們準備好一個可用的 Eclipse IDE，並使用以下步驟建立一個 Spring 應用程式。

StudentDAO.java

以下是資料訪問物件介面檔案 StudentDAO.java 的內容。

package com.tutorialspoint;

import java.util.List;
import javax.sql.DataSource;

public interface StudentDAO {
   /** 
    * This is the method to be used to initialize
    * database resources ie. connection.
   */
   public void setDataSource(DataSource ds);
   
   /** 
    * This is the method to be used to list down
    * a record from the Student table corresponding
    * to a passed student id.
   */
   public Student getStudent(Integer id);
}

Student.java

以下是 Student.java 檔案的內容。

package com.tutorialspoint;

// Student POJO for Student Table
public class Student {
   private Integer age;
   private String name;
   private Integer id;

   // setter/getter methods
   public void setAge(Integer age) {
      this.age = age;
   }
   public Integer getAge() {
      return age;
   }
   public void setName(String name) {
      this.name = name;
   }
   public String getName() {
      return name;
   }
   public void setId(Integer id) {
      this.id = id;
   }
   public Integer getId() {
      return id;
   }
}

StudentMapper.java

以下是 StudentMapper.java 檔案的內容。

package com.tutorialspoint;

import java.sql.ResultSet;
import java.sql.SQLException;
import org.springframework.jdbc.core.RowMapper;

// Row Mapper Object to map Student table entry with Student Object
public class StudentMapper implements RowMapper<Student> {
   public Student mapRow(ResultSet rs, int rowNum) throws SQLException {
      Student student = new Student();
      student.setId(rs.getInt("id"));
      student.setName(rs.getString("name"));
      student.setAge(rs.getInt("age"));
      return student;
   }
}

StudentJDBCTemplate.java

以下是為已定義的 DAO 介面 StudentDAO 實現的類檔案 StudentJDBCTemplate.java。

package com.tutorialspoint;

import java.util.List;
import javax.sql.DataSource;
import org.springframework.jdbc.core.JdbcTemplate;

// DAO instance to persist Student values
public class StudentJDBCTemplate implements StudentDAO {
   private DataSource dataSource;
   private JdbcTemplate jdbcTemplateObject;

   // set the datasource and jdbctemplate   
   public void setDataSource(DataSource dataSource) {
      this.dataSource = dataSource;
      this.jdbcTemplateObject = new JdbcTemplate(dataSource);
   }
   // get all the students from the database
   public Student getStudent(final Integer id) {
      final String SQL = "select * from Student where id = ? ";
      List <Student> students = jdbcTemplateObject.query(
         SQL, new PreparedStatementSetter() {
            public void setValues(PreparedStatement preparedStatement) throws SQLException {
               preparedStatement.setInt(1, id);
            }
         },
         new StudentMapper()
      );
      return students.get(0);
   }
}

MainApp.java

以下是 MainApp.java 檔案的內容。

package com.tutorialspoint;

import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

public class MainApp {
   public static void main(String[] args) {
      // Create the application context by reading Beans.xml   
      ApplicationContext context = new ClassPathXmlApplicationContext("Beans.xml");
      // Create the JDBCTemplate instance from spring context
      StudentJDBCTemplate studentJDBCTemplate = (StudentJDBCTemplate)context.getBean("studentJDBCTemplate");
      // get the student
      Student student = studentJDBCTemplate.getStudent(1);
      // print the student details
      System.out.print("ID : " + student.getId() );
      System.out.println(", Age : " + student.getAge()); 
   }
}

Beans.xml

以下是配置檔案 Beans.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" 
   xsi:schemaLocation = "http://www.springframework.org/schema/beans
   http://www.springframework.org/schema/beans/spring-beans-3.0.xsd ">

   <!-- Initialization for data source -->
   <bean id = "dataSource" 
      class = "org.springframework.jdbc.datasource.DriverManagerDataSource">
      <property name = "driverClassName" value = "com.mysql.cj.jdbc.Driver"/>
      <property name = "url" value = "jdbc:mysql://:3306/TEST"/>
      <property name = "username" value = "root"/>
      <property name = "password" value = "admin"/>
   </bean>

   <!-- Definition for studentJDBCTemplate bean -->
   <bean id = "studentJDBCTemplate" 
      class = "com.tutorialspoint.StudentJDBCTemplate">
      <property name = "dataSource" ref = "dataSource" />    
   </bean>      
</beans>

輸出

建立原始檔和 bean 配置檔案後，讓我們執行應用程式。如果應用程式一切正常，它將列印以下訊息。

ID : 1, Age : 17