這是公眾號《Throwable文摘》釋出的第23篇原創文章,收錄於專輯《SpringBoot2.x入門》。
前提
這篇文章是《SpringBoot2.x入門》專輯的第7篇文章,使用的SpringBoot
版本為2.3.1.RELEASE
,JDK
版本為1.8
。
這篇文章會簡單介紹jdbc
模組也就是spring-boot-starter-jdbc
元件的引入、資料來源的配置以及JdbcTemplate
的簡單使用。為了讓文中的例子相對通用,下文選用MySQL8.x
、h2database
(記憶體資料庫)作為示例資料庫,選用主流的Druid
和HikariCP
作為示例資料來源。
引入jdbc模組
引入spring-boot-starter-jdbc
元件,如果在父POM
全域性管理spring-boot
依賴版本的前提下,只需要在專案pom
檔案的dependencies
元素直接引入:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>
通過IDEA
展開該依賴的關係圖如下:
其實spring-boot-starter-jdbc
模組本身已經引入了spring-jdbc
(間接引入spring-core
、spring-beans
、spring-tx
)、spring-boot-starter
和HikariCP
三個依賴,如果希望啟動Servlet
容器,可以額外引入spring-boot-starter-jdbc
。
spring-boot-starter-jdbc
提供了資料來源配置、事務管理、資料訪問等等功能,而對於不同型別的資料庫,需要提供不同的驅動實現,才能更加簡單地通過驅動實現根據連線URL
、使用者口令等屬性直接連線資料庫(或者說獲取資料庫的連線),因此對於不同型別的資料庫,需要引入不同的驅動包依賴。對於MySQL
而言,需要引入mysql-connector-java
,而對於h2database
而言,需要引入h2
(驅動包和資料庫程式碼位於同一個依賴中),兩者中都具備資料庫抽象驅動介面java.sql.Driver
的實現類:
- 對於
mysql-connector-java
而言,常用的實現是com.mysql.cj.jdbc.Driver
(MySQL8.x
版本)。 - 對於
h2
而言,常用的實現是org.h2.Driver
。
如果需要連線的資料庫是h2database
,引入h2
對應的資料庫和驅動依賴如下:
<dependency>
<groupId>com.h2database</groupId>
<artifactId>h2</artifactId>
<version>1.4.200</version>
</dependency>
如果需要連線的資料庫是MySQL
,引入MySQL
對應的驅動依賴如下:
<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),不定期推送架構設計、併發、原始碼探究相關的原創文章: