Spring boot 使用JdbcTemplate訪問數據庫

2024-07-14 08:40:42

字體：大中小

來源：轉載

供稿：網友

SpringBoot 是為了簡化 Spring 應用的創建、運行、調試、部署等一系列問題而誕生的產物，自動裝配的特性讓我們可以更好的關注業務本身而不是外部的XML配置，我們只需遵循規范，引入相關的依賴就可以輕易的搭建出一個 WEB 工程

Spring Framework 對數據庫的操作在 JDBC 上面做了深層次的封裝，通過依賴注入功能，可以將 DataSource 注冊到 JdbcTemplate 之中，使我們可以輕易的完成對象關系映射，并有助于規避常見的錯誤，在 SpringBoot 中我們可以很輕松的使用它。

特點

速度快，對比其它的ORM框架而言，JDBC的方式無異于是最快的
配置簡單， Spring 自家出品，幾乎沒有額外配置
學習成本低，畢竟 JDBC 是基礎知識， JdbcTemplate 更像是一個 DBUtils

導入依賴

在 pom.xml 中添加對 JdbcTemplate 的依賴

<!-- Spring JDBC 的依賴包，使用 spring-boot-starter-jdbc 或 spring-boot-starter-data-jpa 將會自動獲得HikariCP依賴 --><dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-jdbc</artifactId></dependency><!-- MYSQL包 --><dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId></dependency><!-- 默認就內嵌了Tomcat 容器，如需要更換容器也極其簡單--><dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId></dependency>

連接數據庫

在 application.properties 中添加如下配置。值得注意的是，SpringBoot默認會自動配置 DataSource ，它將優先采用 HikariCP 連接池，如果沒有該依賴的情況則選取 tomcat-jdbc ，如果前兩者都不可用最后選取 Commons DBCP2 。通過 spring.datasource.type 屬性可以指定其它種類的連接池

spring.datasource.url=jdbc:mysql://localhost:3306/chapter4?useUnicode=true&characterEncoding=UTF-8&zeroDateTimeBehavior=convertToNull&allowMultiQueries=true&useSSL=falsespring.datasource.password=rootspring.datasource.username=root#spring.datasource.type#更多細微的配置可以通過下列前綴進行調整#spring.datasource.hikari#spring.datasource.tomcat#spring.datasource.dbcp2

啟動項目，通過日志，可以看到默認情況下注入的是 HikariDataSource

2018-05-07 10:33:54.021 INFO 9640 --- [   main] o.s.j.e.a.AnnotationMBeanExporter  : Bean with name 'dataSource' has been autodetected for JMX exposure2018-05-07 10:33:54.026 INFO 9640 --- [   main] o.s.j.e.a.AnnotationMBeanExporter  : Located MBean 'dataSource': registering with JMX server as MBean [com.zaxxer.hikari:name=dataSource,type=HikariDataSource]2018-05-07 10:33:54.071 INFO 9640 --- [   main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat started on port(s): 8080 (http) with context path ''2018-05-07 10:33:54.075 INFO 9640 --- [   main] com.battcn.Chapter4Application   : Started Chapter4Application in 3.402 seconds (JVM running for 3.93)

具體編碼

完成基本配置后，接下來進行具體的編碼操作。為了減少代碼量，就不寫 UserDao 、 UserService 之類的接口了，將直接在 Controller 中使用 JdbcTemplate 進行訪問數據庫操作，這點是不規范的，各位別學我…

表結構

創建一張 t_user 的表

CREATE TABLE `t_user` ( `id` int(8) NOT NULL AUTO_INCREMENT COMMENT '主鍵自增', `username` varchar(50) NOT NULL COMMENT '用戶名', `password` varchar(50) NOT NULL COMMENT '密碼', PRIMARY KEY (`id`)) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='用戶表';

實體類

package com.battcn.entity;/** * @author Levin * @since 2018/5/7 0007 */public class User { private Long id; private String username; private String password; // TODO 省略get set}

restful 風格接口

package com.battcn.controller;import com.battcn.entity.User;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.jdbc.core.BeanPropertyRowMapper;import org.springframework.jdbc.core.JdbcTemplate;import org.springframework.web.bind.annotation.*;import java.util.List;/** * @author Levin * @since 2018/4/23 0023 */@RestController@RequestMapping("/users")public class SpringJdbcController { private final JdbcTemplate jdbcTemplate; @Autowired public SpringJdbcController(JdbcTemplate jdbcTemplate) {  this.jdbcTemplate = jdbcTemplate; } @GetMapping public List<User> queryUsers() {  // 查詢所有用戶  String sql = "select * from t_user";  return jdbcTemplate.query(sql, new Object[]{}, new BeanPropertyRowMapper<>(User.class)); } @GetMapping("/{id}") public User getUser(@PathVariable Long id) {  // 根據主鍵ID查詢  String sql = "select * from t_user where id = ?";  return jdbcTemplate.queryForObject(sql, new Object[]{id}, new BeanPropertyRowMapper<>(User.class)); } @DeleteMapping("/{id}") public int delUser(@PathVariable Long id) {  // 根據主鍵ID刪除用戶信息  String sql = "DELETE FROM t_user WHERE id = ?";  return jdbcTemplate.update(sql, id); } @PostMapping public int addUser(@RequestBody User user) {  // 添加用戶  String sql = "insert into t_user(username, password) values(?, ?)";  return jdbcTemplate.update(sql, user.getUsername(), user.getPassword()); } @PutMapping("/{id}") public int editUser(@PathVariable Long id, @RequestBody User user) {  // 根據主鍵ID修改用戶信息  String sql = "UPDATE t_user SET username = ? ,password = ? WHERE id = ?";  return jdbcTemplate.update(sql, user.getUsername(), user.getPassword(), id); }}

測試

由于上面的接口是 restful 風格的接口，添加和修改無法通過瀏覽器完成，所以需要我們自己編寫 junit 或者使用 postman 之類的工具。

創建單元測試 Chapter4ApplicationTests ，通過 TestRestTemplate 模擬 GET 、 POST 、 PUT 、 DELETE 等請求操作

package com.battcn;import com.battcn.entity.User;import org.junit.Test;import org.junit.runner.RunWith;import org.slf4j.Logger;import org.slf4j.LoggerFactory;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.boot.test.context.SpringBootTest;import org.springframework.boot.test.web.client.TestRestTemplate;import org.springframework.boot.web.server.LocalServerPort;import org.springframework.core.ParameterizedTypeReference;import org.springframework.http.HttpMethod;import org.springframework.http.ResponseEntity;import org.springframework.test.context.junit4.SpringRunner;import java.util.List;/** * @author Levin */@RunWith(SpringRunner.class)@SpringBootTest(classes = Chapter4Application.class, webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)public class Chapter4ApplicationTests { private static final Logger log = LoggerFactory.getLogger(Chapter4ApplicationTests.class); @Autowired private TestRestTemplate template; @LocalServerPort private int port; @Test public void test1() throws Exception {  template.postForEntity("http://localhost:" + port + "/users", new User("user1", "pass1"), Integer.class);  log.info("[添加用戶成功]/n");  // TODO 如果是返回的集合,要用 exchange 而不是 getForEntity ，后者需要自己強轉類型  ResponseEntity<List<User>> response2 = template.exchange("http://localhost:" + port + "/users", HttpMethod.GET, null, new ParameterizedTypeReference<List<User>>() {  });  final List<User> body = response2.getBody();  log.info("[查詢所有] - [{}]/n", body);  Long userId = body.get(0).getId();  ResponseEntity<User> response3 = template.getForEntity("http://localhost:" + port + "/users/{id}", User.class, userId);  log.info("[主鍵查詢] - [{}]/n", response3.getBody());  template.put("http://localhost:" + port + "/users/{id}", new User("user11", "pass11"), userId);  log.info("[修改用戶成功]/n");  template.delete("http://localhost:" + port + "/users/{id}", userId);  log.info("[刪除用戶成功]"); }}

總結

本章介紹了 JdbcTemplate 常用的幾種操作，詳細請參考 JdbcTemplate API文檔

目前很多大佬都寫過關于 SpringBoot 的教程了，如有雷同，請多多包涵，本教程基于最新的 spring-boot-starter-parent：2.0.1.RELEASE 編寫，包括新版本的特性都會一起介紹…

注：相關教程知識閱讀請移步到JAVA教程頻道。

上一篇：Java微信公眾平臺之自定義菜單

下一篇：深入淺析ZooKeeper的工作原理