Spring JDBC呼叫儲存函式

以下範例將演示spring jdbc如何呼叫儲存函式。在這個範例中將通過呼叫儲存函式來讀取Student表中的一個可用記錄資訊。傳遞一個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);

在上面語法中 -

jdbcCall - 這是一個SimpleJdbcCall物件，它用來表示儲存函式。
in - 這是一個SqlParameterSource物件用於將引數傳遞給儲存函式。
student - Student物件。
jdbcTemplateObject - StudentJDBCTemplate物件從資料庫中呼叫儲存函式。

SimpleJdbcCall類可用於使用IN和OUT引數呼叫儲存函式。可以在使用任何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;
END $$

DELIMITER ;

建立專案

要了解上面提到的Spring JDBC相關的概念，這裡建立一個專案用來演示如何呼叫資料中的儲存過程。開啟Eclipse IDE，並按照以下步驟建立一個名稱為：CallingStoredProcedure 的Spring應用程式專案。

步驟說明

參考第一個Spring JDBC專案來建立一個Maven專案 - /20/235/8754.html
更新bean組態並執行應用程式。

完整的專案結構如下所示 -

檔案 : pom.xml 的內容 -

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.yiibai</groupId>
    <artifactId>CallingStoredFunction</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>
    <name>CallingStoredFunction</name>
    <url>http://maven.apache.org</url>
    <dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>3.8.1</version>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.40</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-jdbc</artifactId>
            <version>4.1.0.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>4.1.4.RELEASE</version>
        </dependency>
    </dependencies>
</project>

以下是資料存取物件介面檔案：StudentDAO.java的程式碼內容：

package com.yiibai;

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.yiibai;

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.yiibai;

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

以下是實現類檔案:StudentJDBCTemplate.java，它實現了介面StudentDAO.java：
以下是檔案：StudentJDBCTemplate.java的程式碼內容：

package com.yiibai;

import java.util.Map;

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;
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 com.yiibai;


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

public class MainApp {
   public static void main(String[] args) {
      ApplicationContext context = 
             new ClassPathXmlApplicationContext("application-beans.xml");

      StudentJDBCTemplate studentJDBCTemplate = 
      (StudentJDBCTemplate)context.getBean("studentJDBCTemplate");

      System.out.println("Get Student's Name By ID 1:");
      Student student = studentJDBCTemplate.getStudent(1);

      System.out.print("ID : " + student.getId() );
      System.out.print(", Name : " + student.getName() );

      System.out.println("\n Get Student's Name By ID 3:");
      Student student2 = studentJDBCTemplate.getStudent(3);
      System.out.print("ID : " + student2.getId() );
      System.out.print(", Name : " + student2.getName() );
   }
}

以下是Bean和資料庫組態檔案：application-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?characterEncoding=utf8&useSSL=true" />
        <property name="username" value="root" />
        <property name="password" value="123456" />
    </bean>

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

</beans>

注意： application-beans.xml 檔案的位置是：{workspace}/fistapp/src/main/java 目錄，如果放置錯了，程式可能會因為找不到此組態檔案而出錯。

完成建立原始碼和bean和資料庫連線資訊的檔案組態後，執行應用程式。這裡先簡單說明一下執行的步驟，在專案名稱(CallingStoredFunction)上點選右鍵，在彈出的選單中選擇：【Run As】-> 【Maven test】

在執行測試成功後，應該會輸出類似以下內容(含有 BUILD SUCCESS 的資訊) 。
接下來，點選類檔案：MainApp.java 選擇【Run As】->【Java Application】，如果應用程式一切正常，這將列印以下訊息：

Get Student's Name By ID 1:
ID : 1, Name : Maxsu
 Get Student's Name By ID 3:
ID : 3, Name : Allen