Spring JDBC 教程 - Spring MVC

简介 
Spring JDBC抽象框架所带来的价值将在以下几个方面得以体现:(注:使用了Spring JDBC抽象框架之后,应用开发人员只需要完成斜体字部分的编码工作。) 
  • 定义数据库连接参数 
  • 打开数据库连接 
  • 声明SQL语句 
  • 预编译并执行SQL语句 
  • 遍历查询结果(如果需要的话) 
  • 处理每一次遍历操作 
  • 处理抛出的任何异常 
  • 处理事务 
  • 关闭数据库连接 
Spring将替我们完成所有使用JDBC API进行开发的单调乏味的、底层细节处理工作。 
选择一种工作模式 

使用Spring进行基本的JDBC访问数据库有多种选择。Spring至少提供了三种不同的工作模式:

  • JdbcTemplate, 一个在Spring2.5中新提供的SimpleJdbc类能够更好的处理数据库元数据; 
  • RDBMS Object的风格的面向对象封装方式, 有点类似于JDO的查询设计。 

我们在这里简要列举你采取某一种工作方式的主要理由. 不过请注意, 即使你选择了其中的一种工作模式, 你依然可以在你的代码中混用其他任何一种模式以获取其带来的好处和优势。 所有的工作模式都必须要求JDBC 2.0以上的数据库驱动的支持, 其中一些高级的功能可能需要JDBC 3.0以上的数据库驱动支持。 

JdbcTemplate- 这是经典的也是最常用的Spring对于JDBC访问的方案。这也是最低级别的封装, 其他的工作模式事实上在底层使用了JdbcTemplate作为其底层的实现基础。JdbcTemplate在JDK 1.4以上的环境上工作得很好。 
NamedParameterJdbcTemplate- 对JdbcTemplate做了封装,提供了更加便捷的基于命名参数的使用方式而不是传统的JDBC所使用的“?”作为参数的占位符。这种方式在你需要为某个SQL指定许多个参数时,显得更加直观而易用。该特性必须工作在JDK 1.4以上。 
SimpleJdbcTemplate- 这个类结合了JdbcTemplate和NamedParameterJdbcTemplate的最常用的功能,同时它也利用了一些Java 5的特性所带来的优势,例如泛型、varargs和autoboxing等,从而提供了更加简便的API访问方式。需要工作在Java 5以上的环境中。 
SimpleJdbcInsert 和 SimpleJdbcCall - 这两个类可以充分利用数据库元数据的特性来简化配置。通过使用这两个类进行编程,你可以仅仅提供数据库表名或者存储过程的名称以及一个Map作为参数。其中Map的key需要与数据库表中的字段保持一致。这两个类通常和SimpleJdbcTemplate配合使用。这两个类需要工作在JDK 5以上,同时数据库需要提供足够的元数据信息。 

RDBMS 对象包括MappingSqlQuery, SqlUpdate and StoredProcedure - 这种方式允许你在初始化你的数据访问层时创建可重用并且线程安全的对象。该对象在你定义了你的查询语句,声明查询参数并编译相应的Query之后被模型化。一旦模型化完成,任何执行函数就可以传入不同的参数对之进行多次调用。这种方式需要工作在JDK 1.4以上。 
Spring JDBC包结构 
Spring Framework的JDBC抽象框架由四个包构成:core、 dataSource、object以及support。 
org.springframework.jdbc.core包由JdbcTemplate类以及相关的回调接口(callback interface)和类组成。 org.springframework.jdbc.core.simple 子包则包含了 SimpleJdbcTemplate 类以及相关的SimpleJdbcInsert 类和SimpleJdbcCall 类。 org.springframework.jdbc.core.namedparam 子包则包含了NamedParameterJdbcTemplate 类以及其相关的支持类。 
org.springframework.jdbc.datasource包提供了一些工具类来简化对DataSource的访问。同时提供了多种简单的DataSource实现。这些实现可以脱离J2EE容器进行独立测试和运行。 这些工具类提供了一些静态方法,允许你通过JNDI来获取数据库连接和关闭连接。同时支持绑定到当前线程的数据库连接。例如使用DataSourceTransactionManager。 
org.springframework.jdbc.object包包含了一些类,用于将RDBMS查询、更新以及存储过程表述为一些可重用的、线程安全的对象。这种方式通过JDO进行模型化,不过这些通过查询返回的对象是与数据库脱离的对象。 这种对于JDBC的高层次的封装是基于org.springframework.jdbc.core包对JDBC的低层次封装之上的。 
org.springframework.jdbc.support包定义了SQLException转化类以及一些其他的工具类。 

在JDBC调用过程中所抛出的异常都会被转化为在org.springframework.dao包中定义的异常。也就是说,凡是使用Spring的JDBC封装层的代码无需实现任何JDBC或者RDBMS相关的异常处理。所有的这些被转化的异常都是unchecked异常,因而也给了你一种额外的选择,你可以抓住这些异常,从而转化成其他类型的异常被允许调用者传播。 
 利用JDBC核心类控制JDBC的基本操作和错误处理 
JdbcTemplate类 
JdbcTemplate是core包的核心类。它替我们完成了资源的创建以及释放工作,从而简化了我们对JDBC的使用。 它还可以帮助我们避免一些常见的错误,比如忘记关闭数据库连接。 JdbcTemplate将完成JDBC核心处理流程,比如SQL语句的创建、执行,而把SQL语句的生成以及查询结果的提取工作留给我们的应用代码。 它可以完成SQL查询、更新以及调用存储过程,可以对ResultSet进行遍历并加以提取。 它还可以捕获JDBC异常并将其转换成org.springframework.dao包中定义的,通用的,信息更丰富的异常。 
使用JdbcTemplate进行编码只需要根据明确定义的一组契约来实现回调接口。 PreparedStatementCreator回调接口通过给定的Connection创建一个PreparedStatement,包含SQL和任何相关的参数。 CallableStatementCreateor实现同样的处理,只不过它创建的是CallableStatement。 RowCallbackHandler接口则从数据集的每一行中提取值。 
我们可以在DAO实现类中通过传递一个DataSource引用来完成JdbcTemplate的实例化,也可以在Spring的IoC容器中配置一个JdbcTemplate的bean并赋予DAO实现类作为一个实例。 需要注意的是DataSource在Spring的IoC容器中总是配制成一个bean,第一种情况下,DataSource bean将传递给service,第二种情况下DataSource bean传递给JdbcTemplate bean。 
最后,JdbcTemplate中使用的所有SQL将会以“DEBUG”级别记入日志(一般情况下日志的category是JdbcTemplate相应的全限定类名,不过如果需要对JdbcTemplate进行定制的话,可能是它的子类名)。 

Example

下面是一些使用JdbcTemplate类的示例。(这些示例并不是完整展示所有的JdbcTemplate所暴露出来的功能。请查看与之相关的Javadoc)。 
  • 查询(SELECT) 
一个简单的例子用于展示如何获取一个表中的所有行数。 
int rowCount = this.jdbcTemplate.queryForInt("select count(0) from t_accrual"); 

一个简单的例子展示如何进行参数绑定。 

int countOfActorsNamedJoe = this.jdbcTemplate.queryForInt( 
        "select count(0) from t_actors where first_name = ?", new Object[]{"Joe"}); 

查询一个String。 

String surname = (String) this.jdbcTemplate.queryForObject( 
        "select surname from t_actor where id = ?", 
        new Object[]{new Long(1212)}, String.class); 

查询并将结果记录为一个简单的数据模型。 

Actor actor = (Actor) this.jdbcTemplate.queryForObject( 
    "select first_name, surname from t_actor where id = ?", 
    new Object[]{new Long(1212)}, 
    new RowMapper() { 
        public Object mapRow(ResultSet rs, int rowNum) throws SQLException { 
            Actor actor = new Actor(); 
            actor.setFirstName(rs.getString("first_name")); 
            actor.setSurname(rs.getString("surname")); 
            return actor; 
        } 
    }); 
查询并组装多个数据模型。 
Collection actors = this.jdbcTemplate.query( 
    "select first_name, surname from t_actor", 
    new RowMapper() { 
        public Object mapRow(ResultSet rs, int rowNum) throws SQLException { 
            Actor actor = new Actor(); 
            actor.setFirstName(rs.getString("first_name")); 
            actor.setSurname(rs.getString("surname")); 
            return actor; 
        } 
    }); 
如果最后2个示例中的代码出现在同一段程序中,我们有必要去掉这些重复的RowMapper匿名类代码,将这些代码抽取到一个单独的类中(通常是一个静态的内部类)。 这样,这个内部类就可以在DAO的方法中被共享。因而,最后2个示例写成如下的形式将更加好: 
public Collection findAllActors() { 
    return this.jdbcTemplate.query( "select first_name, surname from t_actor", new ActorMapper()); 
} 

private static final class ActorMapper implements RowMapper { 

    public Object mapRow(ResultSet rs, int rowNum) throws SQLException { 
        Actor actor = new Actor(); 
        actor.setFirstName(rs.getString("first_name")); 
        actor.setSurname(rs.getString("surname")); 
        return actor; 
    } 
} 

  • 更新(INSERT/UPDATE/DELETE) 
this.jdbcTemplate.update( 
        "insert into t_actor (first_name, surname) values (?, ?)", 
        new Object[] {"Leonor", "Watling"}); 
this.jdbcTemplate.update( 
        "update t_actor set weapon = ? where id = ?", 
        new Object[] {"Banjo", new Long(5276)}); 
this.jdbcTemplate.update( 
        "delete from actor where id = ?", 
        new Object[] {new Long.valueOf(actorId)}); 

  • 其他操作 
execute(..)方法可以被用作执行任何类型的SQL,甚至是DDL语句。 这个方法的实现需要传入一个回调接口、需要绑定的参数数组等作为参数。 
this.jdbcTemplate.execute("create table mytable (id integer, name varchar(100))"); 
调用一个简单的存储过程(更多复杂的存储过程支持请参见存储过程支持)。 
this.jdbcTemplate.update( 
        "call SUPPORT.REFRESH_ACTORS_SUMMARY(?)", 
        new Object[]{Long.valueOf(unionId)}); 
JdbcTemplate 的最佳实践 
JdbcTemplate类的实例是线程安全的实例。这一点非常重要,正因为如此,你可以配置一个简单的JdbcTemplate实例,并将这个“共享的”、“安全的”实例注入到不同的DAO类中去。 另外, JdbcTemplate 是有状态的,因为他所维护的DataSource 实例是有状态的,但是这种状态是无法变化的。 
使用JdbcTemplate的一个常见的最佳实践(同时也是SimpleJdbcTemplate和NamedParameterJdbcTemplate 类的最佳实践)就是在Spring配置文件中配置一个DataSource实例,然后将这个共享的DataSource实例助于到你的DAO中去。 而JdbcTemplate的实例将在DataSource的setter方法中被创建。这样的话,DAO可能看上去像这样:
public class JdbcCorporateEventDao implements CorporateEventDao { 

    private JdbcTemplate jdbcTemplate; 

    public void setDataSource(DataSource dataSource) { 
        this.jdbcTemplate = new JdbcTemplate(dataSource); 
    } 

    // JDBC-backed implementations of the methods on the CorporateEventDao follow... 
} 

相关的配置看上去就像这样。 
<?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-2.5.xsd"> 

    <bean id="corporateEventDao" class="com.example.JdbcCorporateEventDao"> 
        <property name="dataSource" ref="dataSource"/> 
    </bean> 

    <!-- the DataSource (parameterized for configuration via a PropertyPlaceHolderConfigurer) --> 
    <bean id="dataSource" destroy-method="close" class="org.apache.commons.dbcp.BasicDataSource"> 
        <property name="driverClassName" value="${jdbc.driverClassName}"/> 
        <property name="url" value="${jdbc.url}"/> 
        <property name="username" value="${jdbc.username}"/> 
        <property name="password" value="${jdbc.password}"/> 
    </bean> 
</beans> 
如果你使用Spring提供的JdbcDaoSupport类,并且你的那些基于JDBC的DAO都继承自这个类,那么你会自动地从JdbcDaoSupport类中继承了setDataSource(..)方法。 是否将你的DAO类继承自这些类完全取决于你自己的决定,事实上这并不是必须的,如果你看一下JdbcDaoSupport类你会发现,这里只是提供了一个简便的方式而已。 

无论你是否使用上述这种初始化方式,都无需在执行某些SQL操作时多次创建一个JdbcTemplate实例。记住,一旦JdbcTemplate被创建,他是一个线程安全的对象。 一个你需要创建多次JdbcTemplate实例的理由可能在于,你的应用需要访问多个不同的数据库,从而需要不同的DataSources来创建不同的JdbcTemplates实例。 

NamedParameterJdbcTemplate类 
NamedParameterJdbcTemplate类为JDBC操作增加了命名参数的特性支持,而不是传统的使用('?')作为参数的占位符。NamedParameterJdbcTemplate类对JdbcTemplate类进行了封装, 在底层,JdbcTemplate完成了多数的工作。这一个章节将主要描述NamedParameterJdbcTemplate类与JdbcTemplate类的一些区别,也就是使用命名参数进行JDBC操作。 
// some JDBC-backed DAO class... 
private NamedParameterJdbcTemplate namedParameterJdbcTemplate; 

public void setDataSource(DataSource dataSource) { 
    this.namedParameterJdbcTemplate = new NamedParameterJdbcTemplate(dataSource); 
} 

public int countOfActorsByFirstName(String firstName) { 

    String sql = "select count(0) from T_ACTOR where first_name = :first_name"; 

    SqlParameterSource namedParameters = new MapSqlParameterSource("first_name", firstName); 

    return namedParameterJdbcTemplate.queryForInt(sql, namedParameters); 
} 

注意这里在'sql'中使用了命名参数作为变量,而这个名称所对应的值被定义在传入的'namedParameters' 中作为参数(也可以传入到MapSqlParameterSource中作为参数)。 

你也可以传入许多命名参数以及他们所对应的值,以Map的方式,作为键值对传入到NamedParameterJdbcTemplate中。 (其余的被NamedParameterJdbcOperations所暴露的接口以及NamedParameterJdbcTemplate实现类遵循了类似的方式,此处不包含相关内容)。 

// some JDBC-backed DAO class... 
private NamedParameterJdbcTemplate namedParameterJdbcTemplate; 

public void setDataSource(DataSource dataSource) { 
    this.namedParameterJdbcTemplate = new NamedParameterJdbcTemplate(dataSource); 


public int countOfActorsByFirstName(String firstName) { 

    String sql = "select count(0) from T_ACTOR where first_name = :first_name"; 

    Map namedParameters = Collections.singletonMap("first_name", firstName); 

    return this.namedParameterJdbcTemplate.queryForInt(sql, namedParameters); 

NamedParameterJdbcTemplate类所具备的另外一个比较好的特性就是可以接收SqlParameterSource作为传入参数 (这个类位于相同的包定义中)。 你已经在先前的一个例子中看到了这个接口的一个具体实现类。( MapSqlParameterSource类)。而SqlParameterSource 这个接口对于NamedParameterJdbcTemplate类的操作而言是一个传入的参数。MapSqlParameterSource只是一个非常简单的实现,使用了java.util.Map作为转接器, 其中,Map中的Key表示参数名称,而Map中的Value表示参数值。 

另外一个SqlParameterSource 的实现类是BeanPropertySqlParameterSource。这个类对传统的Java进行了封装(也就是那些符合JavaBean标准的类), 并且使用了JavaBean的属性作为参数的名称和值。 

public class Actor { 

    private Long id; 
    private String firstName; 
    private String lastName; 
    
    public String getFirstName() { 
        return this.firstName; 
    } 
    
    public String getLastName() { 
        return this.lastName; 
    } 
    
    public Long getId() { 
        return this.id; 
    } 
    
    // setters omitted... 


// some JDBC-backed DAO class... 
private NamedParameterJdbcTemplate namedParameterJdbcTemplate; 

public void setDataSource(DataSource dataSource) { 
    this.namedParameterJdbcTemplate = new NamedParameterJdbcTemplate(dataSource); 


public int countOfActors(Actor exampleActor) { 

    // notice how the named parameters match the properties of the above 'Actor' class 
    String sql = "select count(0) from T_ACTOR where first_name = :firstName and last_name = :lastName"; 

    SqlParameterSource namedParameters = new BeanPropertySqlParameterSource(exampleActor); 

    return this.namedParameterJdbcTemplate.queryForInt(sql, namedParameters); 

注意,NamedParameterJdbcTemplate类只是封装了JdbcTemplate模板; 因而如果你需要访问相应被封装的JdbcTemplate类,并访问一些只有在JdbcTemplate中拥有的功能,你需要使用getJdbcOperations()方法来进行访问。 

请参照Section 11.2.1.2, “JdbcTemplate 的最佳实践”来获取一些使用NamedParameterJdbcTemplate的最佳实践。 

11.2.3. SimpleJdbcTemplate类 
Note 
SimpleJdbcTemplate所提供的一些特性必须工作在Java 5及以上版本。 


SimpleJdbcTemplate类是对JdbcTemplate类进行的封装,从而可以充分利用Java 5所带来的varargs和autoboxing等特性。 SimpleJdbcTemplate类完全利用了Java 5语法所带来的蜜糖效应。凡是使用过Java 5的程序员们如果要从Java 5迁移回之前的JDK版本,无疑会发现这些特性所带来的蜜糖效应。 

“before and after”示例可以成为SimpleJdbcTemplate类所带来的蜜糖效应的最佳诠释。 下面的代码示例首先展示了使用传统的JdbcTemplate进行JDBC访问的代码,接着是使用SimpleJdbcTemplate类做同样的事情。 

// classic JdbcTemplate-style... 
private JdbcTemplate jdbcTemplate; 

public void setDataSource(DataSource dataSource) { 
    this.jdbcTemplate = new JdbcTemplate(dataSource); 


public Actor findActor(long id) { 
    String sql = "select id, first_name, last_name from T_ACTOR where id = ?"; 
    
    RowMapper mapper = new RowMapper() { 
    
        public Object mapRow(ResultSet rs, int rowNum) throws SQLException { 
            Actor actor = new Actor(); 
            actor.setId(rs.getLong("id")); 
            actor.setFirstName(rs.getString("first_name")); 
            actor.setLastName(rs.getString("last_name")); 
            return actor; 
        } 
    }; 
    
    // notice the cast, the wrapping up of the 'id' argument 
    // in an array, and the boxing of the 'id' argument as a reference type 
    return (Actor) jdbcTemplate.queryForObject(sql, mapper, new Object[] {Long.valueOf(id)}); 

下面是同样的逻辑,使用了SimpleJdbcTemplate;可以看到代码“干净”多了: 

// SimpleJdbcTemplate-style... 
private SimpleJdbcTemplate simpleJdbcTemplate; 

public void setDataSource(DataSource dataSource) { 
    this.simpleJdbcTemplate = new SimpleJdbcTemplate(dataSource); 


public Actor findActor(long id) { 
    String sql = "select id, first_name, last_name from T_ACTOR where id = ?"; 

    ParameterizedRowMapper<Actor> mapper = new ParameterizedRowMapper<Actor>() { 
    
        // notice the return type with respect to Java 5 covariant return types 
        public Actor mapRow(ResultSet rs, int rowNum) throws SQLException { 
            Actor actor = new Actor(); 
            actor.setId(rs.getLong("id")); 
            actor.setFirstName(rs.getString("first_name")); 
            actor.setLastName(rs.getString("last_name")); 
            return actor; 
        } 
    }; 

    return this.simpleJdbcTemplate.queryForObject(sql, mapper, id); 

请同样参照Section 11.2.1.2, “JdbcTemplate 的最佳实践”来获取一些SimpleJdbcTemplate的最佳实践 

Note 
SimpleJdbcTemplate只是提供了JdbcTemplate所提供的功能的子类。 如果你需要使用JdbcTemplate的方法,而这些方法又没有在SimpleJdbcTemplate中定义,你需要调用getJdbcOperations()方法 获取相应的方法调用。JdbcOperations接口中定义的方法需要在这边做强制转化才能使用。 


11.2.4. DataSource接口 
为了从数据库中取得数据,我们首先需要获取一个数据库连接。Spring通过DataSource对象来完成这个工作。 DataSource是JDBC规范的一部分,它被视为一个通用的数据库连接工厂。通过使用DataSource, Container或Framework可以将连接池以及事务管理的细节从应用代码中分离出来。 作为一个开发人员,在开发和测试产品的过程中,你可能需要知道连接数据库的细节。但在产品实施时,你不需要知道这些细节。通常数据库管理员会帮你设置好数据源。 

在使用Spring JDBC时,你既可以通过JNDI获得数据源,也可以自行配置数据源(使用Spring提供的DataSource实现类)。使用后者可以更方便的脱离Web容器来进行单元测试。 这里我们将使用DriverManagerDataSource,不过DataSource有多种实现, 后面我们会讲到。使用DriverManagerDataSource和你以前获取一个JDBC连接 的做法没什么两样。你首先必须指定JDBC驱动程序的全限定名,这样DriverManager 才能加载JDBC驱动类,接着你必须提供一个url(因JDBC驱动而异,为了保证设置正确请参考相关JDBC驱动的文档), 最后你必须提供一个用户连接数据库的用户名和密码。下面我们将通过一个例子来说明如何配置一个DriverManagerDataSource: 

DriverManagerDataSource dataSource = new DriverManagerDataSource(); 
dataSource.setDriverClassName("org.hsqldb.jdbcDriver"); 
dataSource.setUrl("jdbc:hsqldb:hsql://localhost:"); 
dataSource.setUsername("sa"); 
dataSource.setPassword(""); 
11.2.5. SQLExceptionTranslator接口 
SQLExceptionTranslator是一个接口,如果你需要在 SQLException和org.springframework.dao.DataAccessException之间作转换,那么必须实现该接口。 转换器类的实现可以采用一般通用的做法(比如使用JDBC的SQLState code),如果为了使转换更准确,也可以进行定制(比如使用Oracle的error code)。 

SQLErrorCodeSQLExceptionTranslator是SQLExceptionTranslator的默认实现。 该实现使用指定数据库厂商的error code,比采用SQLState更精确。转换过程基于一个JavaBean(类型为SQLErrorCodes)中的error code。 这个JavaBean由SQLErrorCodesFactory工厂类创建,其中的内容来自于 “sql-error-codes.xml”配置文件。该文件中的数据库厂商代码基于 Database MetaData 信息中的DatabaseProductName,从而配合当前数据库的使用。 

SQLErrorCodeSQLExceptionTranslator使用以下的匹配规则: 

首先检查是否存在完成定制转换的子类实现。通常SQLErrorCodeSQLExceptionTranslator 这个类可以作为一个具体类使用,不需要进行定制,那么这个规则将不适用。 

接着将SQLException的error code与错误代码集中的error code进行匹配。 默认情况下错误代码集将从SQLErrorCodesFactory取得。 错误代码集来自classpath下的sql-error-codes.xml文件,它们将与数据库metadata信息中的database name进行映射。 

使用fallback翻译器。SQLStateSQLExceptionTranslator类是缺省的fallback翻译器。 


SQLErrorCodeSQLExceptionTranslator可以采用下面的方式进行扩展: 

public class MySQLErrorCodesTranslator extends SQLErrorCodeSQLExceptionTranslator { 

    protected DataAccessException customTranslate(String task, String sql, SQLException sqlex) { 
        if (sqlex.getErrorCode() == -12345) { 
            return new DeadlockLoserDataAccessException(task, sqlex); 
        } 
        return null; 
    } 

在上面的这个例子中,error code为'-12345'的SQLException将采用该转换器进行转换,而其他的error code将由默认的转换器进行转换。 为了使用该转换器,必须将其作为参数传递给JdbcTemplate类的setExceptionTranslator方法,并在需要使用这个转换器器的数据 存取操作中使用该JdbcTemplate。下面的例子演示了如何使用该定制转换器: 

// create a JdbcTemplate and set data source 
JdbcTemplate jt = new JdbcTemplate(); 
jt.setDataSource(dataSource); 
// create a custom translator and set the DataSource for the default translation lookup 
MySQLErrorCodesTransalator tr = new MySQLErrorCodesTransalator(); 
tr.setDataSource(dataSource); 
jt.setExceptionTranslator(tr); 
// use the JdbcTemplate for this SqlUpdate 
SqlUpdate su = new SqlUpdate(); 
su.setJdbcTemplate(jt); 
su.setSql("update orders set shipping_charge = shipping_charge * 1.05"); 
su.compile(); 
su.update(); 
在上面的定制转换器中,我们给它注入了一个数据源,因为我们仍然需要 使用默认的转换器从sql-error-codes.xml中获取错误代码集。 

11.2.6. 执行SQL语句 
我们仅需要非常少的代码就可以达到执行SQL语句的目的,一旦获得一个 DataSource和一个JdbcTemplate, 我们就可以使用JdbcTemplate提供的丰富功能实现我们的操作。下面的例子使用了极少的代码完成创建一张表的工作。 

import javax.sql.DataSource; 
import org.springframework.jdbc.core.JdbcTemplate; 

public class ExecuteAStatement { 

    private JdbcTemplate jdbcTemplate; 

    public void setDataSource(DataSource dataSource) { 
        this.jdbcTemplate = new JdbcTemplate(dataSource); 
    } 

    public void doExecute() { 
        this.jdbcTemplate.execute("create table mytable (id integer, name varchar(100))"); 
    } 

11.2.7. 执行查询 
除了execute方法之外,JdbcTemplate还提供了大量的查询方法。 在这些查询方法中,有很大一部分是用来查询单值的。比如返回一个汇总(count)结果 或者从返回行结果中取得指定列的值。这时我们可以使用queryForInt(..)、 queryForLong(..)或者queryForObject(..)方法。 queryForObject方法用来将返回的JDBC类型对象转换成指定的Java对象,如果类型转换失败将抛出 InvalidDataAccessApiUsageException异常。 下面的例子演示了两个查询的用法,一个返回int值,另一个返回String。 

import javax.sql.DataSource; 
import org.springframework.jdbc.core.JdbcTemplate; 

public class RunAQuery { 

    private JdbcTemplate jdbcTemplate; 

    public void setDataSource(DataSource dataSource) { 
        this.jdbcTemplate = new JdbcTemplate(dataSource); 
    } 
  
    public int getCount() { 
        return this.jdbcTemplate.queryForInt("select count(*) from mytable"); 
    } 

    public String getName() { 
        return (String) this.jdbcTemplate.queryForObject("select name from mytable", String.class); 
    } 

    public void setDataSource(DataSource dataSource) { 
        this.dataSource = dataSource; 
    } 

除了返回单值的查询方法,JdbcTemplate还提供了一组返回List结果 的方法。List中的每一项对应查询返回结果中的一行。其中最简单的是queryForList方法, 该方法将返回一个List,该List中的每一条 记录是一个Map对象,对应应数据库中某一行;而该Map 中的每一项对应该数据库行中的某一列值。下面的代码片断接着上面的例子演示了如何用该方法返回表中所有记录: 

private JdbcTemplate jdbcTemplate; 

public void setDataSource(DataSource dataSource) { 
    this.jdbcTemplate = new JdbcTemplate(dataSource); 


public List getList() { 
    return this.jdbcTemplate.queryForList("select * from mytable"); 

返回的结果集类似下面这种形式: 

[{name=Bob, id=1}, {name=Mary, id=2}] 
11.2.8. 更新数据库 
JdbcTemplate还提供了一些更新数据库的方法。 在下面的例子中,我们根据给定的主键值对指定的列进行更新。 例子中的SQL语句中使用了“?”占位符来接受参数(这种做法在更新和查询SQL语句中很常见)。 传递的参数值位于一个对象数组中(基本类型需要被包装成其对应的对象类型)。 

import javax.sql.DataSource; 

import org.springframework.jdbc.core.JdbcTemplate; 

public class ExecuteAnUpdate { 

    private JdbcTemplate jdbcTemplate; 

    public void setDataSource(DataSource dataSource) { 
        this.jdbcTemplate = new JdbcTemplate(dataSource); 
    } 

    public void setName(int id, String name) { 
        this.jdbcTemplate.update( 
                "update mytable set name = ? where id = ?", 
                new Object[] {name, new Integer(id)}); 
    } 

11.2.9. 获取自动生成的主键 
JdbcTemplate中有一个update方法,可以方便地从数据库中获取数据库自动创建的主键。(这是JDBC 3.0的标准 - 可以参见13.6节获取详细信息)。 这个方法使用了PreparedStatementCreator接口作为第一个参数, 可以通过这个接口的实现类来定义相应的Insert语句。另外一个参数是KeyHolder, 一旦update方法成功,这个参数将包含生成的主键。这里对于创建合适的PreparedStatement并没有一个统一的标准。(这也解释了函数签名如此定义的原因)。下面是一个在Oracle上运行良好的示例,它可能在其他平台上无法工作: 

final String INSERT_SQL = "insert into my_test (name) values(?)"; 
final String name = "Rob"; 

KeyHolder keyHolder = new GeneratedKeyHolder(); 
jdbcTemplate.update( 
    new PreparedStatementCreator() { 
        public PreparedStatement createPreparedStatement(Connection connection) throws SQLException { 
            PreparedStatement ps = 
                connection.prepareStatement(INSERT_SQL, new String[] {"id"}); 
            ps.setString(1, name); 
            return ps; 
        } 
    }, 
    keyHolder); 

// keyHolder.getKey() now contains the generated key 
11.3. 控制数据库连接 
11.3.1. DataSourceUtils类 
DataSourceUtils作为一个帮助类提供易用且强大的数据库访问能力, 我们可以使用该类提供的静态方法从JNDI获取数据库连接以及在必要的时候关闭之。 它提供支持线程绑定的数据库连接(比如使用DataSourceTransactionManager的时候,将把数据库连接绑定到当前的线程上)。 

11.3.2. SmartDataSource接口 
SmartDataSource是DataSource 接口的一个扩展,用来提供数据库连接。使用该接口的类在指定的操作之后可以检查是否需要关闭连接。该接口在某些情况下非常有用,比如有些情况需要重用数据库连接。 

11.3.3. AbstractDataSource类 
AbstractDataSource是一个实现了DataSource 接口的abstract基类。它实现了DataSource接口的 一些无关痛痒的方法,如果你需要实现自己的DataSource,那么可以继承该类。 

11.3.4. SingleConnectionDataSource类 
SingleConnectionDataSource是SmartDataSource接口 的一个实现,其内部包装了一个单连接。该连接在使用之后将不会关闭,很显然它不能在多线程的环境下使用。 

当客户端代码调用close方法的时候,如果它总是假设数据库连接来自连接池(就像使用持久化工具时一样), 你应该将suppressClose设置为true。这样,通过该类获取的将是代理连接(禁止关闭)而不是原有的物理连接。 需要注意的是,我们不能把使用该类获取的数据库连接造型(cast)为Oracle Connection之类的本地数据库连接。 

SingleConnectionDataSource主要在测试的时候使用。它使得测试代码很容易脱离应用服务器而在一个简单的JNDI环境下运行。 与DriverManagerDataSource不同的是,它始终只会使用同一个数据库连接,从而避免每次建立物理连接的开销。 

11.3.5. DriverManagerDataSource类 
DriverManagerDataSource类实现了 SmartDataSource接口。可以使用bean properties来设置JDBC Driver属性,该类每次返回的都是一个新的连接。 

该类主要在测试以及脱离J2EE容器的独立环境中使用。它既可以用来在application context中作为一个DataSource bean,也可以在简单的JNDI环境下使用。 由于Connection.close()仅仅只是简单的关闭数据库连接,因此任何能够获取DataSource的持久化代码都能很好的工作。不过使用JavaBean风格的连接池 (比如commons-dbcp)也并非难事。即使是在测试环境下,使用连接池也是一种比使用DriverManagerDataSource更好的做法。 

11.3.6. TransactionAwareDataSourceProxy类 
TransactionAwareDataSourceProxy作为目标DataSource的一个代理, 在对目标DataSource包装的同时,还增加了Spring的事务管理能力, 在这一点上,这个类的功能非常像J2EE服务器所提供的事务化的JNDI DataSource。 

Note 
该类几乎很少被用到,除非现有代码在被调用的时候需要一个标准的 JDBC DataSource接口实现作为参数。 这种情况下,这个类可以使现有代码参与Spring的事务管理。通常最好的做法是使用更高层的抽象 来对数据源进行管理,比如JdbcTemplate和DataSourceUtils等等。 

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值