Spring JDBC-SimpleJdbcCallクラス

*org.springframework.jdbc.core.SimpleJdbcCall* クラスは、ストアドプロシージャまたはストアド関数の呼び出しを表すマルチスレッドの再利用可能なオブジェクトです。 基本的なストアドプロシージャ/関数にアクセスするために必要なコードを簡素化するメタデータ処理を提供します。

指定する必要があるのは、プロシージャ/関数の名前と、呼び出しの実行時にパラメータを含むマップだけです。指定されたパラメータの名前は、ストアドプロシージャの作成時に宣言された入出力パラメータと一致します。

クラス宣言

以下は org.springframework.jdbc.core.SimpleJdbcCall クラスの宣言です-

public class SimpleJdbcCall
   extends AbstractJdbcCall
      implements SimpleJdbcCallOperations

次の例は、Spring SimpleJdbcCallを使用してストアドプロシージャを呼び出す方法を示します。ストアドプロシージャを呼び出して、Student Tableで利用可能なレコードの1つを読み取ります。 IDを渡し、学生の記録を受け取ります。

構文

SimpleJdbcCall jdbcCall = new SimpleJdbcCall(dataSource).withProcedureName("getRecord");
SqlParameterSource in = new MapSqlParameterSource().addValue("in_id", id);
Map<String, Object> out = jdbcCall.execute(in);

Student student = new Student();
student.setId(id);
student.setName((String) out.get("out_name"));
student.setAge((Integer) out.get("out_age"));

どこで、

jdbcCall -ストアドプロシージャを表すSimpleJdbcCallオブジェクト。
in -ストアドプロシージャにパラメーターを渡すSqlParameterSourceオブジェクト。
学生-学生オブジェクト。
out -ストアドプロシージャコールの結果の出力を表すオブジェクトをマップします。

Spring JDBCに関連する上記の概念を理解するために、ストアドプロシージャを呼び出す例を作成しましょう。サンプルを作成するには、動作するEclipse IDEを用意し、次の手順を使用してSpringアプリケーションを作成します。

Step	Description
1	Update the project Student created under chapter Spring JDBC - First Application.
2	Update the bean configuration and run the application as explained below.

以下は、データアクセスオブジェクトインターフェイスファイル StudentDAO.java の内容です。

package com.finddevguides;

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 ファイルの内容です。

package com.finddevguides;

public class Student {
   private Integer age;
   private String name;
   private Integer id;

   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 ファイルの内容です。

package com.finddevguides;

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

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

定義済みのDAOインターフェイスStudentDAOの実装クラスファイル StudentJDBCTemplate.java を次に示します。

package com.finddevguides;

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

import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.jdbc.core.namedparam.MapSqlParameterSource;
import org.springframework.jdbc.core.namedparam.SqlParameterSource;
import org.springframework.jdbc.core.simple.SimpleJdbcCall;

public class StudentJDBCTemplate implements StudentDAO {
   private DataSource dataSource;
   private JdbcTemplate jdbcTemplateObject;

   public void setDataSource(DataSource dataSource) {
      this.dataSource = dataSource;
      this.jdbcTemplateObject = new JdbcTemplate(dataSource);
   }
   public Student getStudent(Integer id) {
      SimpleJdbcCall jdbcCall = new
         SimpleJdbcCall(dataSource).withProcedureName("getRecord");

      SqlParameterSource in = new MapSqlParameterSource().addValue("in_id", id);
      Map<String, Object> out = jdbcCall.execute(in);

      Student student = new Student();
      student.setId(id);
      student.setName((String) out.get("out_name"));
      student.setAge((Integer) out.get("out_age"));
      return student;
   }
}

呼び出しの実行用に記述するコードには、INパラメーターを含むSqlParameterSourceの作成が含まれます。入力値に指定された名前を、ストアドプロシージャで宣言されたパラメーター名と一致させることが重要です。 executeメソッドはINパラメータを受け取り、ストアドプロシージャで指定された名前でキー設定された出力パラメータを含むMapを返します。

以下は MainApp.java ファイルの内容です。

package com.finddevguides;

import java.util.List;

import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import com.finddevguides.StudentJDBCTemplate;

public class MainApp {
   public static void main(String[] args) {
      ApplicationContext context = new ClassPathXmlApplicationContext("Beans.xml");
      StudentJDBCTemplate studentJDBCTemplate =
         (StudentJDBCTemplate)context.getBean("studentJDBCTemplate");

      Student student = studentJDBCTemplate.getStudent(1);
      System.out.print("ID : " + student.getId() );
      System.out.print(", Name : " + student.getName() );
      System.out.println(", Age : " + student.getAge());
   }
}

以下は、構成ファイル 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.jdbc.Driver"/>
      <property name = "url" value = "jdbc:mysql://localhost:3306/TEST"/>
      <property name = "username" value = "root"/>
      <property name = "password" value = "admin"/>
   </bean>

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

</beans>

ソースおよびBean構成ファイルの作成が完了したら、アプリケーションを実行しましょう。アプリケーションで問題がなければ、次のメッセージが出力されます。

ID : 1, Name : Zara, Age : 11

Springjdbc-simplejdbccall

Spring JDBC-SimpleJdbcCallクラス

クラス宣言

構文