笔者带你剖析Spring3.x JDBC

《笔者带你剖析Spring3.x JDBC》

 

前言

笔者在之前的系列博文中，曾经讲解过Apache旗下的DbUtils工具(http://gao-xianglong.iteye.com/blog/2166444)。简单来说，这一款工具对JDBC实施了非常轻量级的封装，只要你会使用JDBC，估计半个小时，或许你就能够熟练掌握DbUtils的基本用法，当然笔者并不是让你立即换掉你生产环境中的持久层选项，而是告诉你，在互联网场景下，越简单，越纯粹，越贴近原生是最好的，因为这样会拥有更好的灵活性、伸缩性，以及高性能(毕竟封装层次越高，开销越大，同样组件的“可见性”会更加模糊，对于开发人员而言，则为黑盒)。

 

无论从哪一个角度来看，DbUtils都是一款不错的持久层工具，天生具备优秀的灵活性、伸缩性，但是与此同时也伴随着一定的缺陷。试想一下，在一些项目周期较紧的情况下，你的Project Manager是不太可能给你足够充裕的时间去编写相应的Template(除非项目组编写有公共组件)，并且在集成有Spring环境的项目中，也确实没有太多必要将DbUtils再次集成。看到这里，笔者本篇博文的主角诞生了，那就是Spring JDBC。同Apache的DbUtils相比，尽管Spring JDBC在封装上会显得更加“丰满”一些，但随之提升的简易性会大大缩短项目的开发周期，提高生产效率，因此所带来的一些额外开销也就不值一提。这便是笔者在当前项目中选择它的最主要的原因，有现成的Templet，以及同样不失灵活性、伸缩性的前提下，选择Spring JDBC作为持久层的开发工具将会比DbUtils更加诱人，那么说道这里，你，动心了吗？

 

目录

一、下载Spring JDBC的相关构件；

二、配置参数；

三、基于Spring JDBC的CRUD示例；

四、RowMapper；

五、JdbcTemplate；

六、基于@注解的声明式事物管理；

 

一、下载Spring JDBC的相关构件

 笔者使用Maven对项目进行管理，自然而言，就不会再单独进行Spring JDBC构件的下载，而是由Maven来对相关构件进行管理。在本篇博文中，笔者所使用的Spring版本为3.2.13，如下所示：

<dependency>
	<groupId>org.springframework</groupId>
	<artifactId>spring-context</artifactId>
	<version>${org.springframework-version}</version>
	<exclusions>
		<!-- Exclude Commons Logging in favor of SLF4j -->
		<exclusion>
			<groupId>commons-logging</groupId>
			<artifactId>commons-logging</artifactId>
		</exclusion>
	</exclusions>
</dependency>
<dependency>
	<groupId>org.springframework</groupId>
	<artifactId>spring-webmvc</artifactId>
	<version>${org.springframework-version}</version>
</dependency>
<dependency>
	<groupId>org.springframework</groupId>
	<artifactId>spring-core</artifactId>
	<version>${org.springframework-version}</version>
</dependency>
<dependency>
	<groupId>org.springframework</groupId>
	<artifactId>spring-beans</artifactId>
	<version>${org.springframework-version}</version>
</dependency>
<dependency>
	<groupId>org.springframework</groupId>
	<artifactId>spring-jdbc</artifactId>
	<version>${org.springframework-version}</version>
</dependency>
<dependency>
	<groupId>org.springframework</groupId>
	<artifactId>spring-web</artifactId>
	<version>${org.springframework-version}</version>
</dependency>
<dependency>
	<groupId>org.springframework</groupId>
	<artifactId>spring-aop</artifactId>
	<version>${org.springframework-version}</version>
</dependency>
<dependency>
	<groupId>org.springframework</groupId>
	<artifactId>spring-tx</artifactId>
	<version>${org.springframework-version}</version>
</dependency>
<dependency>
	<groupId>org.springframework</groupId>
	<artifactId>spring-orm</artifactId>
	<version>${org.springframework-version}</version>
</dependency>
<dependency>
	<groupId>org.springframework</groupId>
	<artifactId>spring-context-support</artifactId>
	<version>${org.springframework-version}</version>
</dependency>
<dependency>
	<groupId>org.springframework</groupId>
	<artifactId>spring-test</artifactId>
	<version>${org.springframework-version}</version>
</dependency>
<dependency>
	<groupId>org.springframework</groupId>
	<artifactId>spring-jms</artifactId>
	<version>${org.springframework-version}</version>
</dependency>

 

二、配置参数

当Maven成功下载好Spring JDBC所需的构件后，接下来的任务就是在Spring持久层配置文件中配置相关的数据源信息。首先需要配置的是数据源信息，考虑到后期的维护性，数据源信息笔者单独存放在一个properties文件中，在Spring持久层配置文件中通过标签“<context:property-placeholder/>”进行加载。这里笔者插一句题外话，在一些大型的分布式+集群环境的项目中，最好采用集中式的资源配置方式，而非继续采用这种静态配置文件的方式，因为如果一旦配置信息发生改变时，可以动态响应，并通知程序实时更新，以此更大程度上降低维护成本，这里笔者推荐淘宝开源的Diamond中间件(实在不行，存放在DB也行，自己写个组件执行参数变化后的动态响应即可)。

 

回到正题，数据源信息无非就是定义了一堆与DB链接相关的参数以及连接池相关的信息，笔者在本篇博文中所使用的DB连接池为c3p0，当然你也可以选用其它的DB连接池，笔者在此不过多进行讲解。关于Spring JDBC的相关数据源配置参数，如下所示：

<!-- 加载本地数据源配置信息 -->
<context:property-placeholder location="classpath:*.properties" />
<!-- 定义数据源信息 -->
<bean id="dataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource">
	<property name="user" value="${name}" />
	<property name="password" value="${password}" />
	<property name="jdbcUrl" value="${jdbcUrl}" />
	<property name="driverClass" value="${driverClass}" />
	<property name="initialPoolSize" value="${initialPoolSize}" />
	<property name="minPoolSize" value="${minPoolSize}" />
	<property name="maxPoolSize" value="${maxPoolSize}" />
	<property name="maxStatements" value="${maxStatements}" />
	<property name="maxIdleTime" value="${maxIdleTime}" />
</bean>
<!-- 配置JdbcTemplate -->
<bean id="jdbcTemplate" class="org.springframework.jdbc.core.JdbcTemplate">
	<property name="dataSource" ref="dataSource" />
</bean>

 

关于JdbcTemplet，笔者会在后续章节为大家进行详细的讲解，目前你只需要明白和了解，单纯配置数据源(不包括事物)是多么的简单即可。

 

三、基于Spring JDBC的CRUD示例

当大家成功配置好所需的配置信息后，接下来要做的事情就是编写一些简单的CRUD用例来进行测试，如下所示：

@Repository("userDao")
public class UserDaoImpl implements UserDao {
	@Resource
	private JdbcTemplate jdbcTemplate;

	@Resource
	private UserMapper userMapper;

	public List<User> queryUser() throws Exception {
		final String SQL = "SELECT u.* from user u";
		return jdbcTemplate.query(SQL, userMapper);
	}

	public User queryUserById() throws Exception {
		final String SQL = "SELECT u.* from user u where u.id = 1";
		return jdbcTemplate.queryForObject(SQL, userMapper);
	}

	public void insertUser(User user) throws Exception {
		final String SQL = "INSERT INTO user(id,name) VALUES(?,?)";
		jdbcTemplate.update(SQL, new Object[] { user.getId(), user.getName() });

	}

	public void updateUser(User user) throws Exception {
		final String SQL = "UPDATE user u set u.name = ? where u.id = ?";
		jdbcTemplate.update(SQL, new Object[] { user.getName(), user.getId() });
	}

	public void deleteUserbyId(int id) throws Exception {
		final String SQL = "DELETE FROM user where id = ?";
		jdbcTemplate.update(SQL, new Object[] { id });
	}
}

 

四、RowMapper

在上述程序示例中，大家可以看见笔者声明了一个成员变量UserMapper。简单来说，UserMapper实际上是一个与Entity对应的Mapper，对MyBatis有所了解的开发人员应该不会感到陌生。在Spring JDBC中，当我们进行数据检索时，如果希望Spring能够自动将结果集映射到Entity中所对应的字段上时，就需要首先编写一个与Entity对应的Mapper，这样Spring才知道，在检索结果集的时候执行值映射。

 

实现一个Mapper非常简单，首先需要实现一个全限定名为org.springframework.jdbc.core.RowMapper的接口，并重写其mapRow(ResultSet rs, int rowNum)方法。在此大家需要注意，在重写mapRow()方法时，参数rs实际上就是java.sql.ResultSet结果集，如果想实现结果集的映射，那么我们则需要手动在mapRow()方法中，将Entity中的参数一一进行set，而参数rs的用法，学过JDBC的开发人员都应该了解，笔者则不再过多进行讲解。关于Mapper的编写，如下所示：

@Component
public class UserMapper implements RowMapper<User> {
	public User mapRow(ResultSet rs, int rowNum) throws SQLException {
		User user = new User();
		user.setId(rs.getInt("id"));
		user.setName(rs.getString("name"));
		return user;
	}
}

 

五、JdbcTemplate

Template实际上就是一个封装后的CRUD模板。在Spring JDBC中，JdbcTemplate可以帮助开发人员实现大部分的CRUD操作，而不再需要像使用Dbutils那样，手动编写其对应的Template。简单来说，JdbcTemplate所提供的CURD方法可以分为2大类，一类是用于执行检索的query...()方法，而另外一类则是用于执行insert、update和delete的update()操作方法。

 

在JdbcTemplate中，执行数据检索有N多的方法都可以支持，如下所示：

 

其实更多时候，笔者最长使用的查询方法为query()和queryForObject()，而其它的比如检索单个字段的queryForInt()方法之流几乎不用，首先是这种类型的方法 已经过时，其次使用query()方法完全已经可以满足绝大多数的场景。以query(String sql, RowMapper<T> rowMapper)方法为例，其参数为SQL语句和Mapper。如果希望SQL语句带有条件参数，那么则可以调用query(String sql, ResultSetExtractor<T> rse, Object... args)方法，参数由一个Object[]数组接收。

 

在此大家需要注意，对于初学者而言，使用queryForObject()进行数据检索时，如果 查询出来的数据与预期不符，将会抛出org.springframework.dao.EmptyResultDataAccessException异常，比如我们期望查询出来的结果为1，而数据库并无数据，则会提示Incorrect result size: expected 1, actual 0。

 

六、基于@注解的声明式事物管理

事物管理其实是一个老生常谈的话题了，由Spring来执行事物管理是一件非常容易的事情。当然需要Spring管理我们的事物，首先要做的事情就是更改之前的配置文件，打开声明式事物即可，如下所示：

<!-- 定义事物注解驱动 -->
<tx:annotation-driven transaction-manager="transactionManager" />
<!-- 配置transactionManager -->
<bean id="transactionManager"
	class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
	<property name="dataSource">
		<ref local="dataSource" />
	</property>
</bean>

 

当在配置文件中定义好事物需要进行声明式管理后，我们还需要在Service层，添加@Transactional注解，该注解的作用域可以作用于类和方法。如果@Transactional添加在类上方，则意味着一个 全局事务诞生，而添加在方法上时，则只会对当前方法产生事物。如果方法和类都有@Transactional注解时，则 优先执行方法上的事物，如果方法没有标记事物，则执行全局事物。

 

一般来说，标记在类上方的都是 只读事物，如下所示：

@Transactional(propagation = Propagation.NOT_SUPPORTED, readOnly = true)

 

而标记在类上方的才是真正需要开启事物，如下所示：

@Transactional(propagation = Propagation.REQUIRED, isolation = Isolation.DEFAULT, rollbackFor = Exception.class, timeout = 20)

 

简单来说，propagation参数用于定义 事物传播特性，Propagation.REQUIRED为如果当前方法没有事物，则新建一个事物，如果当前有事物，则 归并为一个事物。isolation参数为 事物隔离级别，一般来说，这个参数不要瞎弄，用default即可，毕竟要数据库支持才是可以。rollbackFor参数用于指定 异常回滚，一旦程序中抛出运行时异常或者非运行时异常时，都将执行事物回滚，这里大家需要注意， 千万不要手痒自己捕获异常，否则事物将不会进行回滚。timeout参数代表 事物的执行时间，以秒为单位，如果事物在规定的时间内没有执行完毕，那么将执行事物回滚操作。