目錄
SpringBootTutorial :: Data :: Jdbc
簡介
Spring Data 包含對 JDBC 的存儲庫支持,並將自動為 CrudRepository 上的方法生成 SQL。對於更高級的查詢,提供了 @Query 注解。
當 classpath 上存在必要的依賴項時,Spring Boot 將自動配置 Spring Data 的 JDBC 存儲庫。它們可以通過 spring-boot-starter-data-jdbc 的單一依賴項添加到項目中。如有必要,可以通過將 @EnableJdbcRepositories 批注或 JdbcConfiguration 子類添加到應用程序來控制 Spring Data JDBC 的配置。
更多 Spring Data JDBC 細節,可以參考 Spring Data JDBC 官方文檔。
API
spring-boot-starter-data-jdbc 引入了 spring-jdbc ,其 JDBC 特性就是基於 spring-jdbc。
而 spring-jdbc 最核心的 API 無疑就是 JdbcTemplate,可以說所有的 JDBC 數據訪問,幾乎都是圍繞着這個類去工作的。
Spring 對數據庫的操作在 Jdbc 層面做了深層次的封裝,利用依賴注入,把數據源配置裝配到 JdbcTemplate 中,再由 JdbcTemplate 負責具體的數據訪問。
JdbcTemplate 主要提供以下幾類方法:
execute方法:可以用於執行任何 SQL 語句,一般用於執行 DDL 語句;update方法及batchUpdate方法:update方法用於執行新增、修改、刪除等語句;batchUpdate方法用於執行批處理相關語句;query方法及queryForXXX方法:用於執行查詢相關語句;call方法:用於執行存儲過程、函數相關語句。
為了方便演示,以下增刪改查操作都圍繞一個名為 user 的表(該表的主鍵 id 是自增序列)進行,該表的數據實體如下:
public class User { private Integer id; private String name; private Integer age; // 省略 getter/setter }
數據實體只要是一個純粹的 Java Bean 即可,無需任何注解修飾。
execute
使用 execute 執行 DDL 語句,創建一個名為 test 的數據庫,並在此數據庫下新建一個名為 user 的表。
public void recreateTable() { jdbcTemplate.execute("DROP DATABASE IF EXISTS test"); jdbcTemplate.execute("CREATE DATABASE test"); jdbcTemplate.execute("USE test"); jdbcTemplate.execute("DROP TABLE if EXISTS user"); jdbcTemplate.execute("DROP TABLE if EXISTS user"); // @formatter:off StringBuilder sb = new StringBuilder(); sb.append("CREATE TABLE user (id int (10) unsigned NOT NULL AUTO_INCREMENT,\n") .append("name varchar (64) NOT NULL DEFAULT '',\n") .append("age tinyint (3) NOT NULL DEFAULT 0,\n") .append("PRIMARY KEY (ID));\n"); // @formatter:on jdbcTemplate.execute(sb.toString()); }
update
新增數據
public void insert(String name, Integer age) { jdbcTemplate.update("INSERT INTO user(name, age) VALUES(?, ?)", name, age); }
刪除數據
public void delete(String name) { jdbcTemplate.update("DELETE FROM user WHERE name = ?", name); }
修改數據
public void update(User user) { jdbcTemplate.update("UPDATE USER SET name=?, age=? WHERE id=?", user.getName(), user.getAge(), user.getId()); }
批處理
public void batchInsert(List<User> users) { String sql = "INSERT INTO user(name, age) VALUES(?, ?)"; List<Object[]> params = new ArrayList<>(); users.forEach(item -> { params.add(new Object[] {item.getName(), item.getAge()}); }); jdbcTemplate.batchUpdate(sql, params); }
query
查單個對象
public User queryByName(String name) { try { return jdbcTemplate .queryForObject("SELECT * FROM user WHERE name = ?", new BeanPropertyRowMapper<>(User.class), name); } catch (EmptyResultDataAccessException e) { return null; } }
查多個對象
public List<User> list() { return jdbcTemplate.query("select * from USER", new BeanPropertyRowMapper(User.class)); }
獲取某個記錄某列或者 count、avg、sum 等函數返回唯一值
public Integer count() { try { return jdbcTemplate.queryForObject("SELECT COUNT(*) FROM user", Integer.class); } catch (EmptyResultDataAccessException e) { return null; } }
實戰
配置數據源
在 src/main/resource 目錄下添加 application.properties 配置文件,內容如下:
spring.datasource.url = jdbc:mysql://localhost:3306/test?serverTimezone=UTC&useUnicode=true&characterEncoding=utf8&useSSL=false spring.datasource.username = root spring.datasource.password = root spring.datasource.driver-class-name = com.mysql.cj.jdbc.Driver
需要根據實際情況,替換 url、username、password。
注入 JdbcTemplate
@Service public class UserDAOImpl implements UserDAO { private JdbcTemplate jdbcTemplate; @Autowired public UserDAOImpl(JdbcTemplate jdbcTemplate) { this.jdbcTemplate = jdbcTemplate; } // ... }
完整示例
請參考:源碼
使用方法:
運行應用或單元測試例前,請先執行 codes/data/sbe-data-jdbc/sql/ddl.sql
引申和引用
引申
參考
