Spring 中的 SQL 存储过程

更新于 2024/9/6 5:30:00

SimpleJdbcCall 类可用于调用带有 IN 和 OUT 参数的存储过程。您可以在使用任何一种 RDBMS（如 Apache Derby、DB2、MySQL、Microsoft SQL Server、Oracle 和 Sybase）时使用此方法。

为了理解这种方法，让我们使用可以在 MySQL TEST 数据库中使用以下 DDL 创建的 Student 表 −

CREATE TABLE Student(
   ID   INT NOT NULL AUTO_INCREMENT,
   NAME VARCHAR(20) NOT NULL,
   AGE  INT NOT NULL,
   PRIMARY KEY (ID)
);

接下来，考虑以下 MySQL 存储过程，它接受学生 ID 并使用 OUT 参数返回相应学生的姓名和年龄。因此，让我们使用 MySQL 命令提示符在您的 TEST 数据库中创建此存储过程 −

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 表上实现简单的 Create 和 Read 操作。让我们有一个可以工作的 Eclipse IDE，并按照以下步骤创建一个 Spring 应用程序 −

步骤	描述
1	创建一个名为 SpringExample 的项目，并在创建的项目中的 src 文件夹下创建一个包 com.tutorialspoint。
2	使用 Add External JARs 选项添加所需的 Spring 库，如 Spring Hello World 示例一章中所述。
3	添加 Spring JDBC 特定的最新库 mysql-connector-java.jar、org.springframework.jdbc.jar 和 org.springframework.transaction.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;
   }
}

下面是定义的 DAO 接口 StudentDAO 的实现类文件 StudentJDBCTemplate.java −

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 参数并返回一个 Map，其中包含由存储过程中指定的名称作为键的任何输出参数。现在让我们查看主应用程序文件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

❮ Spring JDBC 框架概述

❮ Spring JDBC 框架概述 Spring JDBC 框架概述 ❯

Spring 核心基础

Spring 其他资源

Spring 中的 SQL 存储过程

颜色选择器

读后有收获微信请站长喝咖啡

错误报告

您的建议:

感谢您的帮助！