JdBCDaoSupport
# 110.JdBCDaoSupport
当项目中的实体类多了以后,就会有很多dao实现类,而每个dao实现类中都会有重复的代码:定义JdbcTemplate对象及其set方法。本文我们就来简化下这个配置
# 新建父类JdbcDaoSupport
我们新建一个类,将公用的代码抽取出来:并且提供一个get方法,让子类可以获取到JdBCTemplate对象
package com.peterjxl.dao.impl;
import org.springframework.jdbc.core.JdbcTemplate;
/**
* 此类用于抽取dao中的重复代码
*/
public class JdbcDaoSupport {
private JdbcTemplate jdbcTemplate;
public void setJdbcTemplate(JdbcTemplate jdbcTemplate) {
this.jdbcTemplate = jdbcTemplate;
}
public JdbcTemplate getJdbcTemplate(){
return jdbcTemplate;
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
# 让dao继承父类
然后我们就可以让各个 dao实现类,继承这个父类了:
- 我们去掉
JdBCTemplate
的成员变量和其set方法 - 在方法中,我们通过
super.getJdbcTemplate()
返回JdbcTemplate对象
package com.peterjxl.dao.impl;
import com.peterjxl.dao.IAccountDao;
import com.peterjxl.domain.Account;
import org.springframework.jdbc.core.BeanPropertyRowMapper;
import java.util.List;
/**
* 账户的持久层实现类
*/
public class AccountDaoImpl extends JdbcDaoSupport implements IAccountDao {
@Override
public Account findAccountById(Integer accountId) {
List<Account> accounts = super.getJdbcTemplate().query("select * from account where id = ?", new BeanPropertyRowMapper<>(Account.class), accountId);
return accounts.isEmpty() ? null : accounts.get(0); // 如果accounts为空,返回null,否则返回accounts.get(0)
}
@Override
public Account findAccountByName(String accountName) {
List<Account> accounts = super.getJdbcTemplate().query("select * from account where name = ?", new BeanPropertyRowMapper<>(Account.class), accountName);
if (accounts.isEmpty()) {
return null;
}
if (accounts.size() > 1) {
throw new RuntimeException("结果集不唯一");
}
return accounts.get(0);
}
@Override
public void updateAccount(Account account) {
super.getJdbcTemplate().update("update account set name=?, money=? where id=?", account.getName(), account.getMoney(), account.getId());
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# 在父类添加dataSource
我们还可以在父类中添加一个dataSource,并且提供set方法,初始化JdbcTemplate对象:
package com.peterjxl.dao.impl;
import org.springframework.jdbc.core.JdbcTemplate;
import javax.sql.DataSource;
public class JdbcDaoSupport {
private JdbcTemplate jdbcTemplate;
private DataSource dataSource;
public void setJdbcTemplate(JdbcTemplate jdbcTemplate) {
this.jdbcTemplate = jdbcTemplate;
}
public JdbcTemplate getJdbcTemplate(){
return jdbcTemplate;
}
public void setDataSource(DataSource dataSource) {
if (this.dataSource == null) {
this.dataSource = dataSource;
this.jdbcTemplate = createJdbcTemplate(dataSource);
}
}
private JdbcTemplate createJdbcTemplate(DataSource dataSource) {
return new JdbcTemplate(dataSource);
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
配置bean.xml:我们无需在配置JdbcTemplate的bean了,而是在dao实现类中注入dataSource,然后其会调用父类的setDataSource方法,并初始化JdbcTemplate
<?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.xsd">
<!-- 配置账户的持久层实现类 -->
<bean id="accountDao" class="com.peterjxl.dao.impl.AccountDaoImpl">
<!-- 注入JdbcTemplate -->
<property name="dataSource" ref="dataSource"/>
</bean>
<!-- 配置数据源 -->
<bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource">
<!-- 注入数据库驱动 -->
<property name="driverClassName" value="com.mysql.cj.jdbc.Driver"/>
<!-- 注入数据库连接字符串 -->
<property name="url" value="jdbc:mysql://localhost:3306/learnSpring"/>
<!-- 注入数据库用户名 -->
<property name="username" value="learnSpringUser"/>
<!-- 注入数据库密码 -->
<property name="password" value="learnSpringPassword"/>
</bean>
</beans>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
# Spring中的JdbcDaoSupport
Spring默认提供管理JdbcDaoSupport,所以其实我们不用自己写实现类也可以。
我们修改下dao实现类,增加如下一行:就可以使用了
import org.springframework.jdbc.core.support.JdbcDaoSupport;
1
我们观察其部分源码,可以看到其也有一个JdbcTemplate对象,和setDataSource方法
public abstract class JdbcDaoSupport extends DaoSupport {
@Nullable
private JdbcTemplate jdbcTemplate;
/**
* Set the JDBC DataSource to be used by this DAO.
*/
public final void setDataSource(DataSource dataSource) {
if (this.jdbcTemplate == null || dataSource != this.jdbcTemplate.getDataSource()) {
this.jdbcTemplate = createJdbcTemplate(dataSource);
initTemplateConfig();
}
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
当然,使用继承的方式后,我们就不可以在JdbcTemplate对象上加注解了,至于是否使用该种方式需看情况。
# 总结
目前我们的dao实现类有两种实现方式
- 继承JdbcDaoSupport,然后我们就无需写JdbcTemplate成员变量了
- 不继承JdbcDaoSupport,自己写JdbcTemplate和配置注入
使用哪种,按需选择。
# 源码
本项目已将源码上传到GitHub (opens new window)和Gitee (opens new window)上。并且创建了分支demo14,读者可以通过切换分支来查看本文的示例代码
在GitHub上编辑此页 (opens new window)
上次更新: 2023/6/7 11:49:40