Spring JDBC - klasa StoredProcedure

Plik org.springframework.jdbc.core.StoredProcedureclass jest nadklasą dla abstrakcji obiektów procedur składowanych RDBMS. Ta klasa jest abstrakcyjna i zakłada się, że podklasy będą zapewniać określoną metodę wywołania, która deleguje do podanej metody execute (java.lang.Object ...). Dziedziczona właściwość SQL to nazwa procedury składowanej w RDBMS.

Deklaracja klasy

Poniżej znajduje się deklaracja dla org.springframework.jdbc.core.StoredProcedure klasa -

public abstract class StoredProcedure
   extends SqlCall

Poniższy przykład pokaże, jak wywołać procedurę składowaną przy użyciu Spring StoredProcedure. Odczytujemy jeden z dostępnych rekordów w tabeli uczniów, wywołując procedurę składowaną. Przekażemy legitymację i otrzymamy kartę studenta.

Składnia

class StudentProcedure extends StoredProcedure{
   public StudentProcedure(DataSource dataSource, String procedureName){
      super(dataSource,procedureName);
      declareParameter(new SqlParameter("in_id", Types.INTEGER));
      declareParameter(new SqlOutParameter("out_name", Types.VARCHAR));
      declareParameter(new SqlOutParameter("out_age", Types.INTEGER));
      compile();
   }
   public Student execute(Integer id){
      Map<String, Object> out = super.execute(id);
      Student student = new Student();
      student.setId(id);
      student.setName((String) out.get("out_name"));
      student.setAge((Integer) out.get("out_age"));
      return student;  	
   }
}

Gdzie,

StoredProcedure - Obiekt StoredProcedure do reprezentowania procedury składowanej.
StudentProcedure - Obiekt StudentProcedure rozszerza StoredProcedure, aby zadeklarować dane wejściowe, zmienną wyjściową i wynik odwzorowania na obiekt Student.
student - Obiekt studencki.

Aby zrozumieć wspomniane wyżej pojęcia związane z Spring JDBC, napiszmy przykład, który wywoła procedurę składowaną. Aby napisać nasz przykład, uruchommy działające środowisko Eclipse IDE i wykonaj następujące kroki, aby utworzyć aplikację Spring.

Krok	Opis
1	Zaktualizuj projekt Studenta utworzony w rozdziale Wiosna JDBC - Pierwsza aplikacja .
2	Zaktualizuj konfigurację fasoli i uruchom aplikację, jak wyjaśniono poniżej.

Poniżej znajduje się zawartość pliku interfejsu obiektu dostępu do danych 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 list down
      * a record from the Student table corresponding
      * to a passed student id.
   */
   public Student getStudent(Integer id);  
}

Poniżej znajduje się zawartość Student.java plik.

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

Poniżej znajduje się zawartość StudentMapper.java plik.

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

Poniżej znajduje się plik klasy implementacji StudentJDBCTemplate.java dla zdefiniowanego interfejsu DAO StudentDAO.

package com.tutorialspoint;

import java.sql.Types;
import java.util.List;
import java.util.Map;

import javax.sql.DataSource;

import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.jdbc.core.SqlOutParameter;
import org.springframework.jdbc.core.SqlParameter;
import org.springframework.jdbc.core.namedparam.MapSqlParameterSource;
import org.springframework.jdbc.core.namedparam.SqlParameterSource;
import org.springframework.jdbc.object.StoredProcedure;

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) {    
      StudentProcedure studentProcedure = new StudentProcedure(dataSource, "getRecord");
      return studentProcedure.execute(id);      
   }    
}
class StudentProcedure extends StoredProcedure{
   public StudentProcedure(DataSource dataSource, String procedureName) {
      super(dataSource,procedureName);
      declareParameter(new SqlParameter("in_id", Types.INTEGER));
      declareParameter(new SqlOutParameter("out_name", Types.VARCHAR));
      declareParameter(new SqlOutParameter("out_age", Types.INTEGER));
      compile();
   }
   public Student execute(Integer id){
      Map<String, Object> out = super.execute(id);
      Student student = new Student();
      student.setId(id);
      student.setName((String) out.get("out_name"));
      student.setAge((Integer) out.get("out_age"));
      return student;  	
   }
}

Kod, który piszesz w celu wykonania wywołania, obejmuje utworzenie SqlParameterSource zawierającego parametr IN. Ważne jest, aby dopasować nazwę podaną dla wartości wejściowej z nazwą parametru zadeklarowaną w procedurze składowanej. Metoda execute przyjmuje parametry IN i zwraca Map zawierającą wszystkie parametry wyjściowe z kluczem o nazwie określonej w procedurze składowanej.

Poniżej znajduje się zawartość MainApp.java plik.

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");
      
      Student student = studentJDBCTemplate.getStudent(1);
      System.out.print("ID : " + student.getId() );
      System.out.print(", Name : " + student.getName() );
      System.out.println(", Age : " + student.getAge()); 
   }
}

Poniżej znajduje się plik konfiguracyjny 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 = "admin"/>
   </bean>

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

Po utworzeniu plików źródłowych i konfiguracyjnych komponentów bean uruchom aplikację. Jeśli wszystko jest w porządku z Twoją aplikacją, wydrukuje następujący komunikat.

ID : 1, Name : Zara, Age : 10