Calling Stored Function

下面的示例将演示如何使用Spring JDBC调用存储的函数。 我们将通过调用存储函数来读取学生表中的一个可用记录。 我们将通过身份证并获得学生姓名。

语法 (Syntax)

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

Where,

• in - SqlParameterSource对象将参数传递给存储的函数。

• jdbcCall - 表示存储函数的SimpleJdbcCall对象。

• jdbcTemplateObject - 从数据库调用存储函数的StudentJDBCTemplate对象。

• student - 学生对象。

SimpleJdbcCall类可用于使用IN参数和返回值调用存储的函数。 您可以在使用任何RDBMS（如Apache Derby，DB2，MySQL，Microsoft SQL Server，Oracle和Sybase）时使用此方法。

要了解该方法，请考虑以下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应用程序。

以下是数据访问对象接口文件StudentDAO.java 。

package cn.xnip;
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 cn.xnip;
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 cn.xnip;
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接口StudentJDBCTemplate.java的实现类文件StudentJDBCTemplate.java 。

package cn.xnip;
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参数并返回存储函数中指定的String。

以下是MainApp.java文件的内容

package cn.xnip;
import java.util.List;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import cn.xnip.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 = "cn.xnip.StudentJDBCTemplate">
      <property name = "dataSource" ref = "dataSource" />    
   </bean>
</beans>

完成源和bean配置文件的创建后，让我们运行应用程序。 如果您的应用程序一切正常，它将打印以下消息。

ID : 1, Name : Zara