Spring JDBC Spring JDBC: For Live Spring & Hibernate Training, See THTT// LT

2008 coreservlets.
com
Spring JDBC Part 1

Originals of Slides and Source Code for Examples: http://courses.coreservlets.com/Course-Materials/spring.html
Customized Java EE Training: http://courses.coreservlets.com/
Servlets, JSP, Struts, JSF/MyFaces/Facelets, Ajax, GWT, Spring, Hibernate/JPA, Java 5 & 6. Developed and taught by well-known author and developer. At public venues or onsite at your location.
2008 coreservlets.com
For live Spring & Hibernate training, see courses at t http://courses.coreservlets.com/. htt // l t /
Taught by the experts that brought you this tutorial. Available at public venues, venues or customized versions can be held on-site at your organization.
Courses C d developed l d and dt taught ht b by M Marty t H Hall ll Courses developed and taught by EE coreservlets.com experts (edited by Marty) Customized Java Training: http://courses.coreservlets.com/
Spring, Hibernate/JPA, EJB3, Ruby/Rails Java 5, Java 6, intermediate/beginning servlets/JSP, advanced servlets/JSP, Struts, JSF, Ajax, GWT, custom mix of topics
Servlets, JSP, Struts, JSF/MyFaces/Facelets, Ajax, GWT, Spring, Hibernate/JPA, Java 5 & 6. Contact hall@coreservlets.com for details Developed and taught by well-known author and developer. At public venues or onsite at your location.
Topics p in This Section

Introduction to Spring JDBC Spring JDBC development Spring IoC integration
Java EE training: http://courses.coreservlets.com
Introduction
Motivation
public void save(Customer customer) { private boolean update(Customer customer, Connection conn) { Connection conn = null; PreparedStatement stmt = null; boolean autoCommit = false; try{ try{ stmt = conn.prepareStatement( conn prepareStatement( conn = this.dataSource.getConnection(); hi d i () "update customer set name = ? where id = ?"); autoCommit = conn.getAutoCommit(); stmt.setString(1, customer.getName()); conn.setAutoCommit(false); stmt.setString(2, customer.getId()); if(!update(customer, conn)){ return stmt.executeUpdate() > 0; insert(customer, conn); } } catch(SQLException e){ conn.commit(); throw new CustomerPersistenceException("Error: } SQL." catch(SQLException e){ + " Failed il d to update d customer.",e); ) if(conn != null){ } try{ finally{ conn.rollback(); if(stmt != null){ } try{ catch(SQLException suppressed){} stmt.close(); } stmt = null; throw new CustomerPersistenceException("Error: } SQL." catch(Exception suppressed){} + " Error saving customer: " + customer,e); } } } catch(RuntimeException e){ } if(conn != null){ try{ conn.rollback(); } catch(SQLException suppressed){} } throw new CustomerPersistenceException( CustomerPersistenceException("Error: Error: SQL." + " Error saving customer: " + customer,e); } finally{ if(conn != null){ try{ conn.setAutoCommit(autoCommit); conn.close(); conn = null; } catch(SQLException suppressed){} } } } private boolean insert(Customer customer, Connection conn) { PreparedStatement stmt = null; try{ stmt = conn.prepareStatement( conn prepareStatement( "insert into customer (id, name) values (?, ?)"); stmt.setString(1, customer.getId()); stmt.setString(2, customer.getName()); return stmt.executeUpdate() > 0; } catch(SQLException e){ throw new CustomerPersistenceException("Error: SQL " SQL." + " Failed to insert customer.",e); } finally{ if(stmt != null){ try{ stmt.close(); stmt = null; } catch(Exception suppressed){} } } }
Spring p g JDBC Solution

public void save(Customer customer) { Map<String, Object> parameterMap = new HashMap<String, Object>(); parameterMap.put("customerId", customer.getId()); parameterMap.put("customerName", customer.getName()); boolean updated = simpleJdbc.update( "update customer set name = :customerName" + " where id = :customerId" :customerId , parameters) > 0; if(updated){ return; } simpleJdbc.update( "i "insert t i into t customer t (id (id, name)" )" + " values (:customerId, :customerName)", parameters); }
Spring p g JDBC
Standalone JDBC software
No N d dependencies d i on a running i Spring S i IoC I C container t i
Templated software
Replaces tedious Java SQL APIs Mitigates ii JDBC C resource mismanagement i risks ik
No configuration management overhead

No XML No annotations
Pure code solution

Explicit settings Verbose No class or domain modeling constraints
Interface-driven domain models Complex constructors Separates class and relational cardinality
Outperforms O/R mapping solutions Java EE training: http://courses.coreservlets.com
Spring p g JDBC Templates p

Fine-grained templates
JdbcTemplate NamedParameterJdbcTemplate
Coarse-grained Coarse grained templates

SimpleJdbcTemplate SimpleJdbcInsert p SimpleJdbcCall
SQL objects
SqlUpdate MappingSqlQuery
Spring S i IoC I C Process P Review

Spring p g IoC Process

Develop POJO library
D Define fi th the interfaces i t f Create the implementations
Register Spring JARs

spring-core.jar i j spring-context.jar spring-beans.jar commons-logging.jar l i j
Create the bean definitions file

Default to the file name applicationContext.xml Place the file in an accessible location
Register beans
Register the spring-beans XML schema into the bean definitions file Assign bean identifiers using the id attribute Specify the bean creation method; e.g, the class attribute for direct constructor invocation
Spring p g IoC Process Continued

Integrate configuration
Register the spring-context s i c t t XML schema into the bean definitions file Declare a property-placeholder element with the configuration file path assigned to the location attribute
Define bean interdependencies

Select a DI method; e.g., constructor, property setter, lookup-method, etc Specify the injection value; e.g., e g collaborators, collaborators values, values resources, resources etc etc
Initialize container
Select an ApplicationContext implementation
The integration method will depend on the target environment
Specify the location of the bean definitions file(s)
Access and use beans from the Spring IoC container

For example, example via the BeanFactory API
BeanFactory#getBean(beanName:String):Object BeanFactory#getBean(beanName:String, requiredType:Class):Object
Develop p POJO Library y

package coreservlets; public class Customer { private String id; private String name; public Customer(String id, String name){ this id = id; this.id this.name = name; } public String getId() { return id; } public String getName() { return t name; } }

public interface CustomerQuery { public Customer getCustomerByName(String name); }

public class CustomerQueryImpl implements CustomerQuery { private List<Customer> customers; public CustomerQueryImpl(List<Customer>customers) { this.customers = customers; } public Customer getCustomerByName(String name) { for(Customer c : customers){ if(c.getName().equals(name)){ return c; } } return null; } }
Register g Spring p g JARs
Register Spring JARs Eclipse .classpath classpath

<?xml version="1.0" encoding="UTF-8"?> <classpath> <classpathentry kind="src" path="src"/> <classpathentry kind="lib" path="lib/spring-core.jar" /> <classpathentry kind="lib" path="lib/spring-beans.jar" /> <classpathentry kind="lib" path="lib/spring-context.jar" /> <classpathentry kind="lib" path="lib/commons-logging.jar"/> <classpathentry kind="con" path="org path= org.eclipse.jdt.launching.JRE_CONTAINER eclipse jdt launching JRE CONTAINER"/> /> <classpathentry kind="output" path=".eclipseclasses"/> </classpath>

Default to applicationContext.xml Place the file in an accessible location
Classpath, filesystem or web module path
Register Beans
<?xml version="1.0" encoding="UTF-8"?> <beans xmlns xmlns="http://www.springframework.org/schema/beans" 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-2.5.xsd"> </beans>
Register Beans
<?xml version="1.0" encoding="UTF-8"?> <beans xmlns xmlns="http://www.springframework.org/schema/beans" 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-2.5.xsd"> <bean id="customerQuery" class="coreservlets.mockup.CustomerQueryImpl" /> </beans>
Define Bean Interdependencies

<?xml version="1.0" encoding="UTF-8"?> <beans xmlns xmlns="http://www.springframework.org/schema/beans" 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-2.5.xsd"> <bean id="customerQuery" class="coreservlets.mockup.CustomerQueryImpl"> <constructor-arg> <list> <bean class="coreservlets.Customer"> <property name="id" value="jjoe" /> <property name="name" value="Java Joe" /> </bean> </list> </constructor-arg> / t t </bean> </beans>
Initialize Container
import org.springframework.context.support.*; public class Main { public static void main(String[]args) { BeanFactory beanFactory = new ClassPathXmlApplicationContext( "/applicationContext.xml"); } }
Access and Use Beans

import org.springframework.context.support.*; public class Main { public static void main(String[]args) { BeanFactory beanFactory = new ClassPathXmlApplicationContext( "/applicationContext.xml"); CustomerQuery query = (CustomerQuery) beanFactory.getBean("customerQuery"); Customer C t customer t = query.getCustomerByName("Java Joe"); System out println(customer); System.out.println(customer); } }
Customer id=jjoe, name=Java Joe
Java EE training: http://courses.coreservlets.com Standard output
Spring S i JDBC Process

Spring p g JDBC Process

Define persistence interfaces Register Spring JDBC JARs
Compilation dependencies
spring spring-jdbc jdbc.jar jar spring-tx.jar
Runtime dependencies
spring-core.jar spring core jar spring-context.jar spring-beans.jar commons-logging jar commons-logging.jar
Spring JDBC Process Continued

Create persistence implementations
Defer connectivity responsibilities
Design class for DataSource dependency injection
Use Spring p g JDBC APIs

Initialize Spring JDBC template(s) with the injected DataSource
Initialize and execute the persistence objects

Instantiate the persistence objects
Inject a DataSource object for connectivity
Develop p Persistence Interfaces


package coreservlets; public class Customer { private String id; private String name; public Customer(String id, id String name){ this.id = id; this.name = name; } public String getId() { return id; } public bli String St i getName() tN () { return name; } }
Register g Spring p g JDBC JARs
Register Spring JDBC JARs Eclipse .classpath classpath

<?xml version="1.0" encoding="UTF-8"?> <classpath> <classpathentry kind="src" path="src"/> <classpathentry kind="lib" path="lib/spring-core.jar" /> <classpathentry kind="lib" path="lib/spring-beans.jar" /> <classpathentry l h ki kind="lib" d lib path="lib/spring-jdbc.jar" h lib/ i jdb j /> / <classpathentry kind="lib" path="lib/spring-tx.jar" /> <classpathentry kind="lib" path="lib/commons-logging.jar"/> <classpathentry kind kind="con" con path="org.eclipse.jdt.launching.JRE_CONTAINER"/> <classpathentry kind="output" path=".eclipseclasses"/> </classpath>
Implement p Persistence Class

import java.sql.ResultSet; import java.sql.SQLException; import javax.sql.DataSource; import org.springframework.dao.*; import org.springframework.jdbc.core.simple.*; public class SpringJdbcCustomerQuery implements CustomerQuery { private SimpleJdbcTemplate jdbc; public SpringJdbcCustomerQuery(DataSource dataSource) { this.jdbc = new SimpleJdbcTemplate(dataSource); } ... }
Implement Persistence Class Continued

public class SpringJdbcCustomerQuery implements CustomerQuery { ... public Customer getCustomerByName(String customerName) { try{ return this.jdbc.queryForObject( "select id, name from customer where name = ?" , customerRowMapper , customerName); } catch(EmptyResultDataAccessException e){ return null; } } ... }
Initialize and Execute Persistence Objects

public class Main { public static void main(String[] args) throws Exception { DataSource dataSource = new EmbeddedDerbyDataSource( "target/ngcdb", "/setup.sql"); CustomerQuery query = new SpringJdbcCustomerQuery(dataSource); Customer customer = query getCustomerByName("Java query.getCustomerByName( Java Joe Joe"); ); System.out.println(customer); } }
Standard output

Spring S i JDBC and d Spring IoC Process

Spring JDBC and Spring IoC Process

Register Spring JARs
spring-core.jar i j spring-context.jar spring-beans.jar spring jdbc jar spring-jdbc.jar spring-tx.jar commons-logging.jar
Develop persistence interfaces Create the persistence implementations

Defer connectivity responsibilities Design class for DataSource dependency injection Use Spring JDBC APIs Initialize Spring JDBC template(s) with the injected DataSource

Default to the file name applicationContext.xml Place the file in an accessible location Java EE training: http://courses.coreservlets.com
Spring JDBC and Spring IoC Process Continued

Register beans
R Register i t the th spring-beans i b XML schema h i into t th the bean b definitions d fi iti file fil Assign bean identifiers using the id attribute
Register a DataSource bean Register persistence implementation beans
Specify the bean creation method; e.g, the class attribute for direct constructor invocation
Register the spring-context XML schema into the bean definitions file Declare a property-placeholder element with the configuration file path th assigned i d to t the th location l ti attribute tt ib t
Map DataSource configuration into DataSource
Define bean interdependencies

S Select l t a DI method; th d e.g., constructor, t t property t setter, tt lookup-method, l k th d etc t Specify the injection value; e.g., collaborators, values, resources, etc
Register the DataSource with persistence implementations

Select S l t an ApplicationContext A li ti C t t i implementation l t ti
The integration method will depend on the target environment
Specify the location of the bean definitions file(s)

For example, via the BeanFactory API
BeanFactory#getBean(beanName:String):Object BeanFactory#getBean(beanName:String, requiredType:Class):Object


package coreservlets; public class Customer { private String id; private String name; public Customer(String id, id String name){ this.id = id; this.name = name; } public String getId() { return id; } public bli String St i getName() tN () { return name; } }
Register g Spring p g JDBC JARs
Register Spring JDBC JARs Eclipse .classpath classpath

<?xml version="1.0" encoding="UTF-8"?> <classpath> <classpathentry kind="src" path="src"/> <classpathentry kind="lib" path="lib/spring-core.jar" /> <classpathentry kind="lib" path="lib/spring-beans.jar" /> <classpathentry kind="lib" path="lib/spring-context.jar" /> <classpathentry kind="lib" path="lib/spring-jdbc.jar" /> <classpathentry kind="lib" path="lib/spring-tx.jar" /> <classpathentry kind= kind="lib" lib path= path="lib/commons-logging lib/commons-logging.jar jar"/> /> <classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER"/> <classpathentry kind="output" path=".eclipseclasses"/> </classpath>
Implement p Persistence Class

import java.sql.ResultSet; import java.sql.SQLException; import javax.sql.DataSource; import org.springframework.dao.*; import org.springframework.jdbc.core.simple.*; public class SpringJdbcCustomerQuery implements CustomerQuery { private SimpleJdbcTemplate jdbc; public SpringJdbcCustomerQuery(DataSource dataSource) { jdbc = new SimpleJdbcTemplate(dataSource); } ... }

public class SpringJdbcCustomerQuery implements CustomerQuery { ... private ParameterizedRowMapper<Customer> customerRowMapper = new ParameterizedRowMapper<Customer>(){ public Customer mapRow(ResultSet rslt, int rowNum) throws SQLException { return new Customer(rslt.getString("id"), rslt getString("name")); rslt.getString( name )); } }; ... }

public class SpringJdbcCustomerQuery implements CustomerQuery { ... public Customer getCustomerByName(String customerName) { try{ return jdbc.queryForObject( "select id, name from customer where name = ?" , customerRowMapper , customerName); } catch(EmptyResultDataAccessException e){ return null; } } ... }

Default to applicationContext.xml Place the file in an accessible location
Classpath, filesystem or web module path
Register Beans
<?xml version="1.0" encoding="UTF-8"?> <beans xmlns xmlns="http://www.springframework.org/schema/beans" 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-2.5.xsd"> </beans>
Register Beans
<?xml version="1.0" encoding="UTF-8"?> <beans xmlns xmlns="http://www.springframework.org/schema/beans" 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-2.5.xsd"> <bean id="customerQuery" class="coreservlets.SpringJdbcCustomerQuery" /> <bean id="dataSource" class="coreservlets.util.EmbeddedDerbyDataSource" /> </beans>
Integrate g Configuration g
Create the properties file
dataSource.properties
Place the file in an accessible location

classpath l th root t
<?xml version="1.0" encoding="UTF-8"?> <beans xmlns xmlns="http://www.springframework.org/schema/beans" http://www.springframework.org/schema/beans xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-2.5.xsd"> <bean id="customerQuery" class="coreservlets.SpringJdbcCustomerQuery" /> <bean id="dataSource" class="coreservlets.util.EmbeddedDerbyDataSource" /> </beans> /b
<?xml version="1.0" encoding="UTF-8"?> <beans xmlns xmlns="http://www.springframework.org/schema/beans" http://www.springframework.org/schema/beans xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-2.5.xsd"> <context:property-placeholder location="classpath:/dataSource.properties" /> <bean id="customerQuery" class="coreservlets.SpringJdbcCustomerQuery" /> <bean b id="dataSource" id "d t S " class="coreservlets.util.EmbeddedDerbyDataSource" /> </beans>
Define Bean Interdependencies

<?xml version="1.0" encoding="UTF-8"?> <beans xmlns xmlns="http://www.springframework.org/schema/beans" 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-2.5.xsd"> <bean id="customerQuery" class="coreservlets.SpringJdbcCustomerQuery"> <constructor-arg ref="dataSource" /> </bean> <bean id="dataSource" class="coreservlets.util.EmbeddedDerbyDataSource"> <constructor-arg value="${derby.db.name}" /> <constructor-arg> <list> <value>${derby.db.setup}</value> </list> /li t </constructor-arg> </bean> Java EE training: http://courses.coreservlets.com </beans>
Initialize Container
import org.springframework.context.support.*; public class Main { public static void main(String[]args) { BeanFactory beanFactory = new ClassPathXmlApplicationContext( "/applicationContext.xml"); } }
Access and Use Beans

import org.springframework.context.support.*; public class Main { public static void main(String[]args) { BeanFactory beanFactory = new ClassPathXmlApplicationContext( "/applicationContext.xml"); CustomerQuery query = (CustomerQuery) beanFactory.getBean("customerQuery"); Customer C t customer t = query.getCustomerByName("Java Joe"); System out println(customer); System.out.println(customer); } }
Java EE training: http://courses.coreservlets.com Standard output
Wrap-up
Spring JDBC and Spring IoC Process

Spring JARs spring-jdbc.jar, i jdb j spring-tx.jar, i t j spring-core.jar, i j springi context.jar, spring-beans.jar, commons-logging.jar Develop persistence implementations
Initialize JDBC template(s) with a DataSource Defer connectivity responsibilities. Use constructor or property setter DI integrating with the DataSource
Create C applicationContext.xml
Save in an accessible location
Register g and wire beans

Register spring-beans XML schema Create persistence and DataSource beans Wire DataSource bean into persistence beans using constructor or property setter DI

C Create t and d save the th properties ti file fil in i an accessible ibl location l ti Register spring-context XML schema Create a property-placeholder declaration with a location attribute
Instantiate a BeanFactory
e.g., e g ClassPathXmlApplicationContext

Pass the bean name to BeanFactory#getBean(beanName:String):Object
Q Questions? ti ?

Spring JDBC Spring JDBC: For Live Spring & Hibernate Training, See THTT// LT

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Spring JDBC Spring JDBC: For Live Spring & Hibernate Training, See THTT// LT

Uploaded by

Copyright:

Available Formats

2008 coreservlets.

Spring JDBC Part 1

Topics p in This Section

Java EE training: http://courses.coreservlets.com

Java EE training: http://courses.coreservlets.com

Spring p g JDBC Solution

No configuration management overhead

Pure code solution

Outperforms O/R mapping solutions Java EE training: http://courses.coreservlets.com

Spring p g JDBC Templates p

Coarse-grained Coarse grained templates

Java EE training: http://courses.coreservlets.com

Spring S i IoC I C Process P Review

Spring p g IoC Process

Register Spring JARs

Create the bean definitions file

Java EE training: http://courses.coreservlets.com

Spring p g IoC Process Continued

Define bean interdependencies

Specify the location of the bean definitions file(s)

Access and use beans from the Spring IoC container

Java EE training: http://courses.coreservlets.com

Develop p POJO Library y

Develop p POJO Library y

Java EE training: http://courses.coreservlets.com

Develop p POJO Library y

Register g Spring p g JARs

Java EE training: http://courses.coreservlets.com

Register Spring JARs Eclipse .classpath classpath

Java EE training: http://courses.coreservlets.com

Create the bean definitions file

Java EE training: http://courses.coreservlets.com

Java EE training: http://courses.coreservlets.com

Java EE training: http://courses.coreservlets.com

Define Bean Interdependencies

Java EE training: http://courses.coreservlets.com

Access and Use Beans

Spring S i JDBC Process

Spring p g JDBC Process

Java EE training: http://courses.coreservlets.com

Spring JDBC Process Continued

Use Spring p g JDBC APIs

Initialize and execute the persistence objects

Java EE training: http://courses.coreservlets.com

Develop p Persistence Interfaces

Java EE training: http://courses.coreservlets.com

Develop p Persistence Interfaces

Register g Spring p g JDBC JARs

Java EE training: http://courses.coreservlets.com

Register Spring JDBC JARs Eclipse .classpath classpath

Java EE training: http://courses.coreservlets.com

Implement p Persistence Class

Implement Persistence Class Continued

Java EE training: http://courses.coreservlets.com

Initialize and Execute Persistence Objects

Customer id=jjoe, name=Java Joe

Spring S i JDBC and d Spring IoC Process

Spring JDBC and Spring IoC Process

Develop persistence interfaces Create the persistence implementations

Create the bean definitions file

Spring JDBC and Spring IoC Process Continued

Define bean interdependencies

Spring JDBC and Spring IoC Process Continued