Select example using Spring JdbcTemplate

This tutorial will show you how we can select or fetch data from a database using Spring JdbcTemplate. For this tutorial we will create a standalone maven project in Eclipse.

If you already have an idea on how to create a maven project in Eclipse will be great otherwise I will tell you here how to create a maven project in Eclipse.

Sometimes we need to retrieve one or few records from the database. We can retrieve one or multiple records from database with the help of JdbcTemplate.

Prerequisites

The following configurations are required in order to run the application

Eclipse Kepler
JDK 1.8
Have maven installed and configured
Spring dependencies in pom.xml

Now we will see the below steps how to create a maven based spring project in Eclipse

Step 1. Create a standalone maven project in Eclipse

Go to File -> New -> Other. On popup window under Maven select Maven Project. Then click on Next. Select the workspace location – either default or browse the location. Click on Next. Now in next window select the row as highlighted from the below list of archtypes and click on Next button.

maven-arctype-quickstart

Now enter the required fields (Group Id, Artifact Id) as shown below

Group Id : com.roytuts
Artifact Id : spring-select

Step 2. Modify the pom.xml file as shown below.

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
 
    <groupId>com.roytuts</groupId>
    <artifactId>spring-select</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>
 
    <name>spring-select</name>
    <url>http://maven.apache.org</url>
 
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <jdk.version>1.8</jdk.version>
        <junit.version>4.11</junit.version>
        <mysql.version>5.1.27</mysql.version>
        <org.springframework.version>4.1.5.RELEASE</org.springframework.version>
    </properties>
 
    <dependencies>
        <!-- Spring framework -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-core</artifactId>
            <version>${org.springframework.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>${org.springframework.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-jdbc</artifactId>
            <version>${org.springframework.version}</version>
        </dependency>
 
        <!-- mysql driver -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>${mysql.version}</version>
        </dependency>
 
        <!-- junit -->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>${junit.version}</version>
            <scope>test</scope>
        </dependency>
    </dependencies>
 
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>${jdk.version}</source>
                    <target>${jdk.version}</target>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

Step 3. If you see JRE System Library[J2SE-1.4] then change the version by below process

Do right-click on the project and go to Build -> Configure build path, under Libraries tab click on JRE System Library[J2SE-1.4], click on Edit button and select the appropriate jdk 1.8 from the next window. Click on Finish then Ok.

Step 4. Create src/main/resources folder for putting the resource files.

Do right-click on the project and go New -> Source Folder. Give Folder name: as src/main/resources and click on Finish button.

Step 5. Create an XML file under src/main/resources.

Do right-click on src/main/resources in the project and go New -> file. Give File name: as spring-select-properties.xml and click on Finish button.

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:p="http://www.springframework.org/schema/p"
    xmlns:aop="http://www.springframework.org/schema/aop" xmlns:context="http://www.springframework.org/schema/context"
    xmlns:jee="http://www.springframework.org/schema/jee" xmlns:tx="http://www.springframework.org/schema/tx"
    xmlns:task="http://www.springframework.org/schema/task"
    xsi:schemaLocation="http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-4.1.xsd http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.1.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.1.xsd http://www.springframework.org/schema/jee http://www.springframework.org/schema/jee/spring-jee-4.1.xsd http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-4.1.xsd http://www.springframework.org/schema/task http://www.springframework.org/schema/task/spring-task-4.1.xsd">
 
    <bean id="jdbcProperties"
        class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer"
        name="configProperties">
        <property name="order" value="99999" />
        <property name="systemPropertiesModeName" value="SYSTEM_PROPERTIES_MODE_OVERRIDE" />
        <property name="ignoreUnresolvablePlaceholders" value="true" />
        <property name="properties">
            <value>
                
                JDBC.DRIVER=com.mysql.jdbc.Driver
                JDBC.URL=jdbc:mysql://localhost:3306/roytuts
                JDBC.USERNAME=root
                JDBC.PASSWORD=root
 
            </value>
        </property>
    </bean>
 
</beans>

Step 6. Create spring-select-datasource.xml file under src/main/resources with the below content.

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:p="http://www.springframework.org/schema/p"
    xmlns:aop="http://www.springframework.org/schema/aop" xmlns:context="http://www.springframework.org/schema/context"
    xmlns:jee="http://www.springframework.org/schema/jee" xmlns:tx="http://www.springframework.org/schema/tx"
    xmlns:task="http://www.springframework.org/schema/task"
    xsi:schemaLocation="http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-4.1.xsd http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.1.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.1.xsd http://www.springframework.org/schema/jee http://www.springframework.org/schema/jee/spring-jee-4.1.xsd http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-4.1.xsd http://www.springframework.org/schema/task http://www.springframework.org/schema/task/spring-task-4.1.xsd">
 
    <context:annotation-config></context:annotation-config>
    <import    resource="spring-select-properties.xml" />
 
    <bean id="dataSource"
        class="org.springframework.jdbc.datasource.DriverManagerDataSource">
        <property name="driverClassName" value="${JDBC.DRIVER}" />
        <property name="url" value="${JDBC.URL}" />
        <property name="username" value="${JDBC.USERNAME}" />
        <property name="password" value="${JDBC.PASSWORD}" />
    </bean>
 
    <bean id="jdbcTemplate" class="org.springframework.jdbc.core.JdbcTemplate">
        <property name="dataSource" ref="dataSource" />
    </bean>
    
    <bean id="studentDao" class="com.roytuts.spring.select.dao.impl.StudentDAOImpl" />
 
</beans>

Step 7. Create a MySQL table

CREATE TABLE `student` (
  `student_id` int(10) unsigned NOT NULL AUTO_INCREMENT,
  `student_name` varchar(30) NOT NULL,
  `student_dob` varchar(10) NOT NULL,
  `student_email` varchar(80) NOT NULL,
  `student_address` varchar(250) NOT NULL,
  PRIMARY KEY (`student_id`)
) ENGINE=InnoDB DEFAULT CHARSET=latin1;

Step 8. Create a POJO class for student.

package com.roytuts.spring.select.dto;
 
public class Student {
 
    private Integer studentId;
    private String studentName;
    private String studentDob;
    private String studentEmail;
    private String studentAddress;
 
    public Student() {
 
    }
 
    public Student(Integer studentId, String studentName, String studentDob,
            String studentEmail, String studentAddress) {
        this.studentId = studentId;
        this.studentName = studentName;
        this.studentDob = studentDob;
        this.studentEmail = studentEmail;
        this.studentAddress = studentAddress;
    }
 
    public Integer getStudentId() {
        return studentId;
    }
 
    public void setStudentId(Integer studentId) {
        this.studentId = studentId;
    }
 
    public String getStudentName() {
        return studentName;
    }
 
    public void setStudentName(String studentName) {
        this.studentName = studentName;
    }
 
    public String getStudentDob() {
        return studentDob;
    }
 
    public void setStudentDob(String studentDob) {
        this.studentDob = studentDob;
    }
 
    public String getStudentEmail() {
        return studentEmail;
    }
 
    public void setStudentEmail(String studentEmail) {
        this.studentEmail = studentEmail;
    }
 
    public String getStudentAddress() {
        return studentAddress;
    }
 
    public void setStudentAddress(String studentAddress) {
        this.studentAddress = studentAddress;
    }
 
}

Step 9. Create a DAO in com.roytuts.spring.select.dao package

package com.roytuts.spring.select.dao;
 
import java.util.List;
 
import com.roytuts.spring.select.dto.Student;
 
public interface StudentDAO {
 
    String selectName(Integer studentId);
    Student selectOneStudent(Integer studentId);
    List<Student> selectMultipleStudents();
 
}

Note : if you get error then you can change the Compiler compliance level, Generated .class files compatibility, Source compatibility to 1.7

Step 10. Now create a DAO implementation class in com.roytuts.spring.select.dao.impl package.

package com.roytuts.spring.select.dao.impl;
 
import java.sql.PreparedStatement;
import java.sql.SQLException;
import java.util.List;
 
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.jdbc.core.BatchPreparedStatementSetter;
import org.springframework.jdbc.core.JdbcTemplate;
 
import com.roytuts.spring.select.dao.StudentDAO;
import com.roytuts.spring.select.dto.Student;
 
public class StudentDAOImpl implements StudentDAO {
 
    @Autowired
    private JdbcTemplate jdbcTemplate;

    private final String SQL_STUDENT_SELECT_NAME = "select student_name from student where student_id = ?";
    private final String SQL_STUDENT_SELECT_ONE = "select * from student where student_id = ?";
    private final String SQL_STUDENT_SELECT_MULTIPLE = "select * from student";
    
    @Override
    public String selectName(Integer studentId) {
        String name = jdbcTemplate.queryForObject(SQL_STUDENT_SELECT_NAME, new Object[] { studentId }, String.class);
        return name;
    }
    
    @Override
    private Student selectOneStudent(Integer studentId) {
        Student student = jdbcTemplate.queryForObject(SQL_STUDENT_SELECT_ONE, new Object[] { studentId }, new StudentDaoMapper());
        return student;
    }
 
    @Override
    public List<Student> selectMultipleStudents() {
        List<Map<String, Object>> rows = jdbcTemplate.queryForList(SQL_STUDENT_SELECT_MULTIPLE);
        List<Student> students = new ArrayList<Student>();
        for (Map<String, Object> row : rows) {
            Student student = new Student();
            student.setStudentId(Integer.parseInt(String.valueOf(row.get("student_id"))));
            student.setStudentName(String.valueOf(row.get("student_name")));
            student.setStudentDob(String.valueOf(row.get("student_dob")));
            student.setStudentEmail(String.valueOf(row.get("student_email")));
            student.setStudentAddress(String.valueOf(row.get("student_address")));
            students.add(student);
        }
        //or using BeanPropertyRowMapper in a single call
        //List<Student> students = jdbcTemplate.query(SQL_STUDENT_SELECT_MULTIPLE, new BeanPropertyRowMapper(Student.class));
        return students;
    }
 
}

Step 11. Create a mapper class which maps student table column to Java class object.

package com.roytuts.spring.select.dao.mapper;

import java.sql.ResultSet;
import java.sql.SQLException;

import org.springframework.jdbc.core.RowMapper;

import package com.roytuts.spring.select.dto.Student;

public class StudentDaoMapper implements RowMapper<Student> {

  @Override
  public Student mapRow(ResultSet rs, int arg1) throws SQLException {
    Student student = new Student();
    
    student.setStudentId(rs.getInt("student_id"));
    student.setStudentName(rs.getString("student_name"));
    student.setStudentDob(rs.getString("student_dob"));
    student.setStudentEmail(rs.getString("student_email"));
    student.setStudentAddress(rs.getString("student_address"));

    return student;
  }

}

Step 12. Create JUnit test case under src/test/java folder.

package com.roytuts.spring.select.dao.impl;
 
import java.util.ArrayList;
import java.util.List;
 
import org.junit.Before;
import org.junit.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
 
import com.roytuts.spring.select.dto.Student;
 
public class StudentDAOImplTest {
 
    private StudentDAOImpl studentDAOImpl;
 
    @Before
    public void setUp() {
        ApplicationContext applicationContext = new ClassPathXmlApplicationContext("spring-select.xml");
        studentDAOImpl = (StudentDAOImpl) applicationContext.getBean("studentDao");
    }
 
    @Test
    public void selectNameTest() {
        String name = studentDAOImpl.selectName(1);
    }
 
    @Test
    public void selectOneStudentTest() {
        Student student = studentDAOImpl.selectOneStudent(1);
    }
    
    @Test
    public void selectMultipleStudentsTest() {
        List<Student> students = studentDAOImpl.selectMultipleStudents();
    }
 
}

Step 13. Run the above JUnit test case.

Step 14. Now Look at the database table. You will see that all values are inserted.

Soumitra Roy Sarkar

I am a professional Web developer, Enterprise Application developer, Software Engineer and Blogger. Connect me on Roy Tutorials Twitter Facebook  Google Plus Linkedin Or Email Me

Leave a Reply

Your email address will not be published. Required fields are marked *