Spring JDBC - Classe SqlQuery

o org.springframework.jdbc.object.SqlQuery A classe fornece um objeto de operação reutilizável que representa uma consulta SQL.

Declaração de Classe

A seguir está a declaração para org.springframework.jdbc.object.SqlQuery classe -

public abstract class SqlQuery<T>
   extends SqlOperation

Uso

  • Step 1 - Crie um objeto JdbcTemplate usando uma fonte de dados configurada.

  • Step 2 - Crie um objeto StudentMapper implementando a interface RowMapper.

  • Step 3 - Use métodos de objeto JdbcTemplate para fazer operações de banco de dados enquanto usa o objeto SqlQuery.

O exemplo a seguir demonstrará como ler uma consulta usando o objeto SqlQuery. Mapearemos os registros de leitura da Tabela de Aluno para o objeto Aluno usando o objeto StudentMapper.

Sintaxe

String sql = "select * from Student";
SqlQuery<Student> sqlQuery = new SqlQuery<Student>() {
   @Override
   protected RowMapper<Student> newRowMapper(Object[] parameters,
      Map<?, ?> context) {
      return new StudentMapper();
   }
};
sqlQuery.setDataSource(dataSource);
sqlQuery.setSql(sql);
List <Student> students = sqlQuery.execute();

Onde,

  • SQL - Leia a consulta para ler todos os registros do aluno.

  • jdbcTemplateObject - Objeto StudentJDBCTemplate para ler registros de alunos do banco de dados.

  • StudentMapper - Objeto StudentMapper para mapear os registros do aluno para objetos do aluno.

  • SqlQuery - Objeto SqlQuery para consultar registros de alunos e mapeá-los para objetos de alunos.

Para entender os conceitos mencionados acima relacionados ao Spring JDBC, vamos escrever um exemplo que irá ler uma consulta e mapear o resultado usando o objeto StudentMapper. Para escrever nosso exemplo, vamos ter um Eclipse IDE funcionando e usar as seguintes etapas para criar um aplicativo Spring.

Degrau Descrição
1 Atualize o projeto que o Aluno criou no capítulo Spring JDBC - Primeiro Aplicativo .
2 Atualize a configuração do bean e execute o aplicativo conforme explicado abaixo.

A seguir está o conteúdo do arquivo de interface do Data Access Object 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
      * all the records from the Student table.
   */
   public List<Student> listStudents();   
}

A seguir está o conteúdo do Student.java Arquivo.

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

A seguir está o conteúdo do StudentMapper.java Arquivo.

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

A seguir está o arquivo de classe de implementação StudentJDBCTemplate.java para a interface DAO definida StudentDAO.

package com.tutorialspoint;

import java.util.List;
import java.util.Map;

import javax.sql.DataSource;

import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.jdbc.core.RowMapper;
import org.springframework.jdbc.object.SqlQuery;

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 List<Student> listStudents() {
      String sql = "select * from Student";
      SqlQuery<Student> sqlQuery = new SqlQuery<Student>() {
         @Override
         protected RowMapper<Student> newRowMapper(Object[] parameters, Map<?, ?> context){
            
            return new StudentMapper();
         }
      };
      sqlQuery.setDataSource(dataSource);
      sqlQuery.setSql(sql);
      List <Student> students = sqlQuery.execute();
      return students;
   }
}

A seguir está o conteúdo do MainApp.java Arquivo.

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

A seguir está o arquivo de configuração 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>

Quando terminar de criar os arquivos de configuração de origem e bean, vamos executar o aplicativo. Se tudo estiver bem com o seu aplicativo, ele imprimirá a seguinte mensagem.

------Listing Multiple Records--------
ID : 1, Name : Zara, Age : 17
ID : 3, Name : Ayan, Age : 18
ID : 4, Name : Nuha, Age : 12