Spring JDBC - Appel d'une procédure stockée

L'exemple suivant montre comment appeler une procédure stockée à l'aide de Spring JDBC. Nous lirons l'un des enregistrements disponibles dans Student Table en appelant une procédure stockée. Nous passerons un identifiant et recevrons un dossier d'étudiant.

Syntaxe

SimpleJdbcCall jdbcCall = new SimpleJdbcCall(dataSource).withProcedureName("getRecord");
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"));

Où,

jdbcCall - Objet SimpleJdbcCall pour représenter une procédure stockée.
in - Objet SqlParameterSource pour passer un paramètre à une procédure stockée.
student - Objet étudiant.
out - Objet mappé pour représenter la sortie du résultat de l'appel de procédure stockée.

le SimpleJdbcCallLa classe peut être utilisée pour appeler une procédure stockée avec des paramètres IN et OUT. Vous pouvez utiliser cette approche tout en travaillant avec l'un des SGBDR tels qu'Apache Derby, DB2, MySQL, Microsoft SQL Server, Oracle et Sybase.

Pour comprendre l'approche, considérez la procédure stockée MySQL suivante, qui prend l'identifiant de l'élève et renvoie le nom et l'âge de l'élève correspondant à l'aide des paramètres OUT. Créons cette procédure stockée dans la base de données TEST à l'aide de l'invite de commande 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 ;

Pour comprendre les concepts mentionnés ci-dessus liés à Spring JDBC, écrivons un exemple qui appellera une procédure stockée. Pour écrire notre exemple, mettons en place un IDE Eclipse fonctionnel et utilisons les étapes suivantes pour créer une application Spring.

Étape	La description
1	Mettez à jour le projet Student créé dans le chapitre Spring JDBC - First Application .
2	Mettez à jour la configuration du bean et exécutez l'application comme expliqué ci-dessous.

Voici le contenu du fichier d'interface de l'objet d'accès aux données 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);  
}

Voici le contenu de la Student.java fichier.

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

Voici le contenu de la StudentMapper.java fichier.

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

Voici le fichier de classe d'implémentation StudentJDBCTemplate.java pour l'interface DAO StudentDAO définie.

package com.tutorialspoint;

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).withProcedureName("getRecord");

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

Le code que vous écrivez pour l'exécution de l'appel implique la création d'un SqlParameterSource contenant le paramètre IN. Il est important de faire correspondre le nom fourni pour la valeur d'entrée avec celui du nom du paramètre déclaré dans la procédure stockée. La méthode execute prend les paramètres IN et retourne un Map contenant tous les paramètres out saisis par le nom spécifié dans la procédure stockée.

Voici le contenu de la MainApp.java fichier.

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

Voici le fichier de configuration 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>

Une fois que vous avez terminé de créer les fichiers de configuration source et bean, laissez-nous exécuter l'application. Si tout va bien avec votre application, elle imprimera le message suivant.

ID : 1, Name : Zara, Age : 11