Spring 中 SQL 的儲存過程
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, AGE INT 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_age INTEGER)
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.tutorialspoint的包。 |
2 | 使用Add External JARs選項新增所需的 Spring 庫檔案,就如在Spring Hello World Example章節中解釋的那樣。 |
3 | 在專案中新增 Spring JDBC 指定的最新的庫檔案mysql-connector-java.jar |
4 | 建立 DAO 介面StudentDAO並且列出所有需要的方法。 即使他不是必需的,你可以直接編寫StudentJDBCTemplate類,但是作為一個良好的實踐,讓我們編寫它。 |
5 | 在com.tutorialspoint包下建立其他所需要的 Java 類Student,StudentMapper,StudentJDBCTemplate和MainApp。 |
6 | 確保你已經在 TEST 資料庫中建立了Student表。同樣確保你的 MySQL 伺服器是正常工作的,並且保證你可以使用給定的使用者名稱和密碼對資料庫有讀取/寫入的許可權。 |
7 | 在src資料夾下建立 Beans 配置檔案Beans.xml。 |
8 | 最後一步是建立所有 Java 檔案和 Bean 配置檔案的內容,並且按如下解釋的那樣執行應用程式。 |
下面是資料訪問物件介面檔案StudentDAO.java的內容:
package com.tutorialspoint;
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.tutorialspoint;
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.tutorialspoint;
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.tutorialspoint;
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() {
String SQL = "select * from Student";
List <Student> students = jdbcTemplateObject.query(SQL,new StudentMapper());
return students;
}
}
關於上述專案的幾句話:你編寫的課呼叫執行的程式碼涉及建立一個包含 IN 引數的SqlParameterSource。名稱的匹配是很重要的,該名稱可以使用在儲存過程彙總宣告的引數名稱來提供輸入值。execute方法利用 IN 引數返回一個包含在儲存過程中由名稱指定的任何外部引數鍵的對映。現在讓我們移動主應用程式檔案MainApp.java,如下所示:
package com.tutorialspoint;
import java.util.List;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import com.tutorialspoint.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.tutorialspoint.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