SpringBoot2.x入門教程：引入jdbc模塊與JdbcTemplate簡單使用
這是公衆號《Throwable文摘》發佈的第23篇原創文章，收錄於專輯《SpringBoot2.x入門》。css
前提
這篇文章是《SpringBoot2.x入門》專輯的第7篇文章，使用的SpringBoot版本爲2.3.1.RELEASE，JDK版本爲1.8。html
這篇文章會簡單介紹jdbc模塊也就是spring-boot-starter-jdbc組件的引入、數據源的配置以及JdbcTemplate的簡單使用。爲了讓文中的例子相對通用，下文選用MySQL8.x、h2database（內存數據庫）做爲示例數據庫，選用主流的Druid和HikariCP做爲示例數據源。java
引入jdbc模塊
引入spring-boot-starter-jdbc組件，若是在父POM全局管理spring-boot依賴版本的前提下，只須要在項目pom文件的dependencies元素直接引入：mysql
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>
經過IDEA展開該依賴的關係圖以下：git
其實spring-boot-starter-jdbc模塊自己已經引入了spring-jdbc（間接引入spring-core、spring-beans、spring-tx）、spring-boot-starter和HikariCP三個依賴，若是但願啓動Servlet容器，能夠額外引入spring-boot-starter-jdbc。github
spring-boot-starter-jdbc提供了數據源配置、事務管理、數據訪問等等功能，而對於不一樣類型的數據庫，須要提供不一樣的驅動實現，才能更加簡單地經過驅動實現根據鏈接URL、用戶口令等屬性直接鏈接數據庫（或者說獲取數據庫的鏈接），所以對於不一樣類型的數據庫，須要引入不一樣的驅動包依賴。對於MySQL而言，須要引入mysql-connector-java，而對於h2database而言，須要引入h2（驅動包和數據庫代碼位於同一個依賴中），二者中都具有數據庫抽象驅動接口java.sql.Driver的實現類：web
- 對於
mysql-connector-java而言，經常使用的實現是com.mysql.cj.jdbc.Driver（MySQL8.x版本）。 - 對於
h2而言，經常使用的實現是org.h2.Driver。
若是須要鏈接的數據庫是h2database，引入h2對應的數據庫和驅動依賴以下：spring
<dependency>
<groupId>com.h2database</groupId>
<artifactId>h2</artifactId>
<version>1.4.200</version>
</dependency>
若是須要鏈接的數據庫是MySQL，引入MySQL對應的驅動依賴以下：sql
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.20</version>
</dependency>
上面的類庫版本選取了編寫本文時候的最新版本，實際上要根據軟件對應的版本選擇合適的驅動版本。數據庫
數據源配置
spring-boot-starter-jdbc模塊默認使用HikariCP做爲數據庫的鏈接池。
HikariCP，也就是Hikari Connection Pool，Hikari鏈接池。HikariCP的做者是日本人，而Hikari是日語，意義和light相近，也就是"光"。Simplicity is prerequisite for reliability（簡單是可靠的先決條件）是HikariCP的設計理念，他是一款代碼精悍的高性能鏈接池框架，被Spring項目選中做爲內建默認鏈接池，值得信賴。
若是決定使用HikariCP鏈接h2數據庫，則配置文件中添加以下的配置項以配置數據源HikariDataSource：
spring.datasource.driver-class-name=org.h2.Driver spring.datasource.url=jdbc:h2:mem:test spring.datasource.username=root spring.datasource.password=123456 # 可選配置,是否啓用h2數據庫的WebUI控制檯 spring.h2.console.enabled=true # 可選配置,訪問h2數據庫的WebUI控制檯的路徑 spring.h2.console.path=/h2-console # 可選配置,是否容許非本機訪問h2數據庫的WebUI控制檯 spring.h2.console.settings.web-allow-others=true
若是決定使用HikariCP鏈接MySQL數據庫，則配置文件中添加以下的配置項以配置數據源HikariDataSource：
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver # 注意MySQL8.x須要指定服務時區屬性 spring.datasource.url=jdbc:mysql://localhost:3306/local?serverTimezone=Asia/Shanghai&useUnicode=true&characterEncoding=UTF-8&zeroDateTimeBehavior=convertToNull&useSSL=false spring.datasource.username=root spring.datasource.password=root
有時候可能更偏好於使用其餘鏈接池，例如Alibaba出品的Durid，這樣就要禁用默認的數據源加載，改爲Durid提供的數據源。引入Druid數據源須要額外添加依賴：
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid</artifactId>
<version>1.1.23</version>
</dependency>
若是決定使用Druid鏈接MySQL數據庫，則配置文件中添加以下的配置項以配置數據源DruidDataSource：
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver # 注意MySQL8.x須要指定服務時區屬性 spring.datasource.url=jdbc:mysql://localhost:3306/local?serverTimezone=Asia/Shanghai&useUnicode=true&characterEncoding=UTF-8&zeroDateTimeBehavior=convertToNull&useSSL=false spring.datasource.username=root spring.datasource.password=root # 指定數據源類型爲Druid提供的數據源 spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
上面這樣配置DruidDataSource，全部數據源的屬性值都會選用默認值，若是想深度定製數據源的屬性，則須要覆蓋由DataSourceConfiguration.Generic建立的數據源，先預設全部須要的配置，爲了和內建的spring.datasource屬性前綴避嫌，這裏自定義一個屬性前綴druid，配置文件中添加自定義配置項以下：
druid.url=jdbc:mysql://localhost:3306/local?serverTimezone=Asia/Shanghai&useUnicode=true&characterEncoding=UTF-8&zeroDateTimeBehavior=convertToNull&useSSL=false druid.driver-class-name=com.mysql.cj.jdbc.Driver druid.username=root druid.password=root # 初始化大小 druid.initialSize=1 # 最大 druid.maxActive=20 # 空閒 druid.minIdle=5 # 配置獲取鏈接等待超時的時間 druid.maxWait=60000 # 配置間隔多久才進行一次檢測，檢測須要關閉的空閒鏈接，單位是毫秒 druid.timeBetweenEvictionRunsMillis=60000 # 配置一個鏈接在池中最小生存的時間，單位是毫秒 druid.minEvictableIdleTimeMillis=60000 druid.validationQuery=SELECT 1 FROM DUAL druid.testWhileIdle=true druid.testOnBorrow=false druid.testOnReturn=false # 打開PSCache，而且指定每一個鏈接上PSCache的大小 druid.poolPreparedStatements=true druid.maxPoolPreparedStatementPerConnectionSize=20 # 配置監控統計攔截的filters，後臺統計相關 druid.filters=stat,wall # 打開mergeSql功能；慢SQL記錄 druid.connectionProperties=druid.stat.mergeSql=true;druid.stat.slowSqlMillis=5000
這裏要確保本地安裝了一個8.x版本的MySQL服務，而且創建了一個命名爲local的數據庫。
須要在項目中添加一個數據源自動配置類，這裏命名爲DruidAutoConfiguration，經過註解@ConfigurationProperties把druid前綴的屬性注入到數據源實例中：
@Configuration
public class DruidAutoConfiguration {
@Bean
@ConfigurationProperties(prefix = "druid")
public DataSource dataSource() {
return new DruidDataSource();
}
@Bean
public ServletRegistrationBean<StatViewServlet> statViewServlet() {
ServletRegistrationBean<StatViewServlet> servletRegistrationBean
= new ServletRegistrationBean<>(new StatViewServlet(), "/druid/*");
// 添加IP白名單
servletRegistrationBean.addInitParameter("allow", "127.0.0.1");
// 添加控制檯管理用戶
servletRegistrationBean.addInitParameter("loginUsername", "admin");
servletRegistrationBean.addInitParameter("loginPassword", "123456");
// 是否可以重置數據
servletRegistrationBean.addInitParameter("resetEnable", "true");
return servletRegistrationBean;
}
@Bean
public FilterRegistrationBean<WebStatFilter> webStatFilter() {
WebStatFilter webStatFilter = new WebStatFilter();
FilterRegistrationBean<WebStatFilter> filterRegistrationBean = new FilterRegistrationBean<>();
filterRegistrationBean.setFilter(webStatFilter);
// 添加過濾規則
filterRegistrationBean.addUrlPatterns("/*");
// 忽略過濾格式
filterRegistrationBean.addInitParameter("exclusions", "*.js,*.gif,*.jpg,*.png,*.css,*.ico,/druid/*,");
return filterRegistrationBean;
}
}
能夠經過訪問${requestContext}/druid/login.html跳轉到Druid的監控控制檯，登陸帳號密碼就是在statViewServlet中配置的用戶和密碼：
Druid是一款爭議比較多的數據源框架，項目的Issue中也有人提出過框架中加入太多和鏈接池無關的功能，例如SQL監控、屬性展現等等，這些功能本該讓專業的監控軟件完成。但毫無疑問，這是一款活躍度比較高的優秀國產開源框架。
配置schema和data腳本
spring-boot-starter-jdbc能夠經過一些配置而後委託DataSourceInitializerInvoker進行schema（通常理解爲DDL）和data（通常理解爲DML）腳本的加載和執行，具體的配置項是：
# 定義schema的加載路徑，能夠經過英文逗號指定多個路徑 spring.datasource.schema=classpath:/ddl/schema.sql # 定義data的加載路徑，能夠經過英文逗號指定多個路徑 spring.datasource.data=classpath:/dml/data.sql # 可選 # spring.datasource.schema-username= # spring.datasource.schema-password= # 項目數據源初始化以後的執行模式,可選值EMBEDDED、ALWAYS和NEVER spring.datasource.initialization-mode=always
類路徑的resources文件夾下添加ddl/schema.sql：
DROP TABLE IF EXISTS customer;
CREATE TABLE customer
(
id BIGINT UNSIGNED AUTO_INCREMENT PRIMARY KEY COMMENT '主鍵',
customer_name VARCHAR(32) NOT NULL COMMENT '客戶名稱',
create_time DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '建立時間',
edit_time DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '修改時間'
) COMMENT '客戶表';
因爲spring.datasource.initialization-mode指定爲ALWAYS，每次數據源初始化都會執行spring.datasource.schema中配置的腳本，會刪表重建。接着類路徑的resources文件夾下添加dml/data.sql：
INSERT INTO customer(customer_name) VALUES ('throwable');
添加一個CommandLineRunner實現驗證一下：
@Slf4j
@SpringBootApplication
public class Ch7Application implements CommandLineRunner {
@Autowired
private DataSource dataSource;
public static void main(String[] args) {
SpringApplication.run(Ch7Application.class, args);
}
@Override
public void run(String... args) throws Exception {
Connection connection = dataSource.getConnection();
ResultSet resultSet = connection.createStatement().executeQuery("SELECT * FROM customer WHERE id = 1");
while (resultSet.next()) {
log.info("id:{},name:{}", resultSet.getLong("id"), resultSet.getString("customer_name"));
}
resultSet.close();
connection.close();
}
}
啓動後執行結果以下：
這裏務必注意一點，spring.datasource.schema指定的腳本執行成功以後纔會執行spring.datasource.data指定的腳本，若是想僅僅執行spring.datasource.data指定的腳本，那麼須要至少把spring.datasource.schema指向一個空的文件，確保spring.datasource.schema指定路徑的文件初始化成功。
使用JdbcTemplate
spring-boot-starter-jdbc中自帶的JdbcTemplate是對JDBC的輕度封裝。這裏只簡單介紹一下它的使用方式，構建一個面向前面提到的customer表的具有CURD功能的DAO。這裏先在前文提到的DruidAutoConfiguration中添加一個JdbcTemplate實例到IOC容器中：
@Bean
public JdbcTemplate jdbcTemplate(DataSource dataSource){
return new JdbcTemplate(dataSource);
}
添加一個Customer實體類：
// 實體類
@Data
public class Customer {
private Long id;
private String customerName;
private LocalDateTime createTime;
private LocalDateTime editTime;
}
接着添加一個CustoemrDao類，實現增刪改查：
// CustoemrDao
@RequiredArgsConstructor
@Repository
public class CustomerDao {
private final JdbcTemplate jdbcTemplate;
/**
* 增
*/
public int insertSelective(Customer customer) {
StringJoiner p = new StringJoiner(",", "(", ")");
StringJoiner v = new StringJoiner(",", "(", ")");
Optional.ofNullable(customer.getCustomerName()).ifPresent(x -> {
p.add("customer_name");
v.add("?");
});
Optional.ofNullable(customer.getCreateTime()).ifPresent(x -> {
p.add("create_time");
v.add("?");
});
Optional.ofNullable(customer.getEditTime()).ifPresent(x -> {
p.add("edit_time");
v.add("?");
});
String sql = "INSERT INTO customer" + p.toString() + " VALUES " + v.toString();
KeyHolder keyHolder = new GeneratedKeyHolder();
int updateCount = jdbcTemplate.update(con -> {
PreparedStatement ps = con.prepareStatement(sql, Statement.RETURN_GENERATED_KEYS);
int index = 1;
if (null != customer.getCustomerName()) {
ps.setString(index++, customer.getCustomerName());
}
if (null != customer.getCreateTime()) {
ps.setTimestamp(index++, Timestamp.valueOf(customer.getCreateTime()));
}
if (null != customer.getEditTime()) {
ps.setTimestamp(index, Timestamp.valueOf(customer.getEditTime()));
}
return ps;
}, keyHolder);
customer.setId(Objects.requireNonNull(keyHolder.getKey()).longValue());
return updateCount;
}
/**
* 刪
*/
public int delete(long id) {
return jdbcTemplate.update("DELETE FROM customer WHERE id = ?", id);
}
/**
* 查
*/
public Customer queryByCustomerName(String customerName) {
return jdbcTemplate.query("SELECT * FROM customer WHERE customer_name = ?",
ps -> ps.setString(1, customerName), SINGLE);
}
public List<Customer> queryAll() {
return jdbcTemplate.query("SELECT * FROM customer", MULTI);
}
public int updateByPrimaryKeySelective(Customer customer) {
final long id = Objects.requireNonNull(Objects.requireNonNull(customer).getId());
StringBuilder sql = new StringBuilder("UPDATE customer SET ");
Optional.ofNullable(customer.getCustomerName()).ifPresent(x -> sql.append("customer_name = ?,"));
Optional.ofNullable(customer.getCreateTime()).ifPresent(x -> sql.append("create_time = ?,"));
Optional.ofNullable(customer.getEditTime()).ifPresent(x -> sql.append("edit_time = ?,"));
StringBuilder q = new StringBuilder(sql.substring(0, sql.lastIndexOf(","))).append(" WHERE id = ?");
return jdbcTemplate.update(q.toString(), ps -> {
int index = 1;
if (null != customer.getCustomerName()) {
ps.setString(index++, customer.getCustomerName());
}
if (null != customer.getCreateTime()) {
ps.setTimestamp(index++, Timestamp.valueOf(customer.getCreateTime()));
}
if (null != customer.getEditTime()) {
ps.setTimestamp(index++, Timestamp.valueOf(customer.getEditTime()));
}
ps.setLong(index, id);
});
}
private static Customer convert(ResultSet rs) throws SQLException {
Customer customer = new Customer();
customer.setId(rs.getLong("id"));
customer.setCustomerName(rs.getString("customer_name"));
customer.setCreateTime(rs.getTimestamp("create_time").toLocalDateTime());
customer.setEditTime(rs.getTimestamp("edit_time").toLocalDateTime());
return customer;
}
private static ResultSetExtractor<List<Customer>> MULTI = rs -> {
List<Customer> result = new ArrayList<>();
while (rs.next()) {
result.add(convert(rs));
}
return result;
};
private static ResultSetExtractor<Customer> SINGLE = rs -> rs.next() ? convert(rs) : null;
}
測試結果以下：
JdbcTemplate的優點是能夠應用函數式接口簡化一些值設置和值提取的操做，而且得到接近於原生JDBC的執行效率，可是它的明顯劣勢就是會產生大量模板化的代碼，在必定程度上影響開發效率。
小結
本文簡單分析spring-boot-starter-jdbc引入，以及不一樣數據庫和不一樣數據源的使用方式，最後簡單介紹了JdbcTemplate的基本使用。
demo項目倉庫：
Github：https://github.com/zjcscut/spring-boot-guide/tree/master/ch6-jdbc-module-h2Github：https://github.com/zjcscut/spring-boot-guide/tree/master/ch7-jdbc-module-mysql
（本文完 c-2-d e-a-20200716 1:15 AM）
公衆號《Throwable文摘》（id：throwable-doge），不按期推送架構設計、併發、源碼探究相關的原創文章：
- 1. Spring簡單入門======jdbctemplate
- 2. SpringBoot2.x簡單使用JWT
- 3. sumo簡簡簡單單入門教程
- 4. Git簡單入門教程
- 5. lodop簡單入門教程
- 6. anime.js 簡單入門教程
- 7. GRUB簡單入門教程
- 8. vim 簡單入門教程
- 9. Github簡單入門教程
- 10. SpringBoot簡單入門教程
- 更多相關文章...
- • Memcached入門教程 - NoSQL教程
- • Neo4j數據庫入門教程 - NoSQL教程
- • YAML 入門教程
- • Java Agent入門實戰（一）-Instrumentation介紹與使用
-
每一个你不满意的现在，都有一个你没有努力的曾经。
- 1. Spring簡單入門======jdbctemplate
- 2. SpringBoot2.x簡單使用JWT
- 3. sumo簡簡簡單單入門教程
- 4. Git簡單入門教程
- 5. lodop簡單入門教程
- 6. anime.js 簡單入門教程
- 7. GRUB簡單入門教程
- 8. vim 簡單入門教程
- 9. Github簡單入門教程
- 10. SpringBoot簡單入門教程