Spring 中 SQL 的存儲過程
SimpleJdbcCall 類可以被用於調用一個包含 IN 和 OUT 參數的存儲過程。你可以在處理任何一個 RDBMS 時使用這個方法,就像 Apache Derby, DB2, MySQL, Microsoft SQL Server, Oracle,和 Sybase。
為了了解這個方法,我們使用我們的 Student 表,它可以在 MySQL TEST 數據庫中使用下面的 DDL 進行創建:
CREATE TABLE Student( ID INT NOT NULL AUTO_INCREMENT, NAME VARCHAR(20) NOT NULL, AGEINT NOT NULL, PRIMARY KEY (ID) );
下一步,考慮接下來的 MySQL 存儲過程,該過程使用 學生 Id 並且使用 OUT 參數返回相應的學生的姓名和年齡。所以讓我們在你的 TEST 數據庫中使用 MySQL 命令提示符創建這個存儲過程:
DELIMITER $$ DROP PROCEDURE IF EXISTS `TEST`.`getRecord` $$ CREATE PROCEDURE `TEST`.`getRecord` ( IN in_id INTEGER, OUT out_name VARCHAR(20), OUT out_ageINTEGER) BEGIN SELECT name, age INTO out_name, out_age FROM Student where id = in_id; END $$ DELIMITER ;
現在,讓我們編寫我們的 Spring JDBC 應用程序,它可以實現對我們的 Student 數據庫表的創建和讀取操作。讓我們使 Eclipse IDE 處於工作狀態,然後按照如下步驟創建一個 Spring 應用程序:
步驟 | |
---|---|
1 | 創建一個名為 SpringExample 的項目,並且在所創建項目的 src 文件夾下創建一個名為 com.cnblogs |
2 | 使用 Add External JARs 選項添加所需的 Spring 庫文件. |
3 | 在項目中添加 Spring JDBC 指定的最新的庫文件 mysql-connector-java.jar, org.springframework.jdbc.jar 和 org.springframework.transaction.jar。如果你還沒有這些所需要的庫文件,你可以下載它們。 |
4 | 創建 DAO 接口 StudentDAO 並且列出所有需要的方法。 即使他不是必需的,你可以直接編寫 StudentJDBCTemplate 類,但是作為一個良好的實踐,讓我們編寫它。 |
5 | 在 com.cnblogs 包下創建其他所需要的 Java 類 Student, StudentMapper, StudentJDBCTemplate 和 MainApp。 |
6 | 確保你已經在 TEST 數據庫中創建了 Student 表。同樣確保你的 MySQL 服務器是正常工作的,並且保證你可以使用給定的用戶名和密碼對數據庫有讀取/寫入的權限。 |
7 | 在 src 文件夾下創建 Beans 配置文件 Beans.xml。 |
8 | 最後一步是創建所有 Java 文件和 Bean 配置文件的內容,並且按如下解釋的那樣運行應用程序。 |
下面是數據訪問對象接口文件 StudentDAO.java 的內容:
package com.cnblogs; 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 create * a record in the Student table. */ public void create(String name, Integer age); /** * 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); /** * This is the method to be used to list down * all the records from the Student table. */ public List<Student> listStudents(); }
下面是 Student.java 文件的內容:
package com.cnblogs; 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.cnblogs; 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,定義了 DAO 接口 StudentDAO:
package com.cnblogs; import java.util.List; 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; public class StudentJDBCTemplate implements StudentDAO { private DataSource dataSource; private SimpleJdbcCall jdbcCall; public void setDataSource(DataSource dataSource) { this.dataSource = dataSource; this.jdbcCall = new SimpleJdbcCall(dataSource). withProcedureName("getRecord"); } public void create(String name, Integer age) { JdbcTemplate jdbcTemplateObject = new JdbcTemplate(dataSource); String SQL = "insert into Student (name, age) values (?, ?)"; jdbcTemplateObject.update( SQL, name, age); System.out.println("Created Record Name = " + name + " Age = " + age); return; } public Student getStudent(Integer id) { 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; } public List<Student> listStudents() { JdbcTemplate jdbcTemplateObject = new JdbcTemplate(dataSource); String SQL = "select * from Student"; List<Student> students = jdbcTemplateObject.query(SQL,new StudentMapper()); return students; } }
關於上述項目的幾句話:你編寫的課調用執行的代碼涉及創建一個包含 IN 參數的 SqlParameterSource。名稱的匹配是很重要的,該名稱可以使用在存儲過程匯總聲明的參數名稱來提供輸入值。execute 方法利用 IN 參數返回一個包含在存儲過程中由名稱指定的任何外部參數鍵的映射。現在讓我們移動主應用程序文件 MainApp.java,如下所示:
package com.cnblogs; import java.util.List; import org.springframework.context.ApplicationContext; import org.springframework.context.support.ClassPathXmlApplicationContext; import com.cnblogs.StudentJDBCTemplate; public class MainApp { public static void main(String[] args) { ApplicationContext context = new ClassPathXmlApplicationContext("Beans.xml"); StudentJDBCTemplate studentJDBCTemplate = (StudentJDBCTemplate)context.getBean("studentJDBCTemplate"); System.out.println("------Records Creation--------" ); studentJDBCTemplate.create("Zara", 11); studentJDBCTemplate.create("Nuha", 2); studentJDBCTemplate.create("Ayan", 15); System.out.println("------Listing Multiple Records--------" ); List<Student> students = studentJDBCTemplate.listStudents(); for (Student record : students) { System.out.print("ID : " + record.getId() ); System.out.print(", Name : " + record.getName() ); System.out.println(", Age : " + record.getAge()); } System.out.println("----Listing Record with ID = 2 -----" ); Student student = studentJDBCTemplate.getStudent(2); 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="password"/> </bean> <!-- Definition for studentJDBCTemplate bean --> <bean id="studentJDBCTemplate" class="com.cnblogs.StudentJDBCTemplate"> <property name="dataSource" ref="dataSource" /> </bean> </beans>
一旦你已經完成的創建了源文件和 bean 配置文件,讓我們運行一下應用程序。如果你的應用程序一切都正常的話,這將會輸出以下消息:
------Records Creation-------- Created Record Name = Zara Age = 11 Created Record Name = Nuha Age = 2 Created Record Name = Ayan Age = 15 ------Listing Multiple Records-------- ID : 1, Name : Zara, Age : 11 ID : 2, Name : Nuha, Age : 2 ID : 3, Name : Ayan, Age : 15 ----Listing Record with ID = 2 ----- ID : 2, Name : Nuha, Age : 2
Spring 中 SQL 的存儲過程