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項目 - https://www.1ju.org/springjdbc/first-application
更新bean配置並運行應用程序。

完整的項目結構如下所示 -

Spring

文件 : 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>org.1ju</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 org.1ju;

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 org.1ju;

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 org.1ju;

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 org.1ju;

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 org.1ju;


import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import org.1ju.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="org.1ju.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

Spring JDBC教程

基本CRUD示例

高級JDBC示例

Spring JDBC批處理示例

Spring JDBC對象

創建項目