Spring JDBC-ストアド関数の呼び出し

次の例では、Spring JDBCを使用してストアド関数を呼び出す方法を示します。ストアド関数を呼び出して、Student Tableで利用可能なレコードの1つを読み取ります。 IDを渡し、学生名を受け取ります。

構文

SimpleJdbcCall jdbcCall = new
   SimpleJdbcCall(dataSource).withFunctionName("get_student_name");

SqlParameterSource in = new MapSqlParameterSource().addValue("in_id", id);
String name = jdbcCall.executeFunction(String.class, in);

Student student = new Student();
student.setId(id);
student.setName(name);

どこで、

in -パラメータをストアド関数に渡すSqlParameterSourceオブジェクト。
jdbcCall -ストアド関数を表すSimpleJdbcCallオブジェクト。
jdbcTemplateObject -データベースから呼び出されたストアド関数へのStudentJDBCTemplateオブジェクト。

学生-学生オブジェクト。

*SimpleJdbcCall* クラスを使用して、INパラメーターと戻り値を使用してストアド関数を呼び出すことができます。 Apache Derby、DB2、MySQL、Microsoft SQL Server、Oracle、SybaseなどのRDBMSのいずれかを使用しながら、このアプローチを使用できます。

アプローチを理解するには、次のMySQLストアドプロシージャを検討してください。これは、学生IDを取得し、対応する学生の名前を返します。 MySQLコマンドプロンプトを使用して、TESTデータベースにこのストアド関数を作成しましょう-

DELIMITER $$

DROP FUNCTION IF EXISTS `TEST`.`get_student_name` $$
CREATE FUNCTION `get_student_name` (in_id INTEGER)
RETURNS varchar(200)
BEGIN
DECLARE out_name VARCHAR(200);
   SELECT name
   INTO out_name
   FROM Student where id = in_id;

RETURN out_name;

DELIMITER ;

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).withFunctionName("get_student_name");

      SqlParameterSource in = new MapSqlParameterSource().addValue("in_id", id);
      String name = jdbcCall.executeFunction(String.class, in);
      Student student = new Student();
      student.setId(id);
      student.setName(name);
      return student;
   }
}

呼び出しの実行用に記述するコードには、INパラメーターを含むSqlParameterSourceの作成が含まれます。入力値に指定された名前を、ストアド関数で宣言されたパラメーター名と一致させることが重要です。 executeFunctionメソッドは、INパラメーターを受け取り、保存された関数で指定された文字列を返します。

以下は 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() );
   }
}

以下は、構成ファイル 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

Springjdbc-stored-function

Spring JDBC-ストアド関数の呼び出し

構文