2. 程式人生 > 實用技巧 >11.SpringBoot學習(十一)——JDBC之 Spring Boot JdbcTemplate

11.SpringBoot學習(十一)——JDBC之 Spring Boot JdbcTemplate

阿新 • • 發佈：2020-07-27

1.簡介

1.1 概述

This is the central class in the JDBC core package. It simplifies the use of JDBC and helps to avoid common errors. It executes core JDBC workflow, leaving application code to provide SQL and extract results. This class executes SQL queries or updates, initiating iteration over ResultSets and catching JDBC exceptions and translating them to the generic, more informative exception hierarchy defined in the dao package.

這是JDBC核心軟體包中的中心類。它簡化了JDBC的使用並有助於避免常見錯誤。它執行核心的JDBC工作流程，留下應用程式程式碼以提供SQL並提取結果。此類執行SQL查詢或更新，在ResultSets上啟動迭代並捕獲JDBC異常，並將其轉換為dao包中定義的通用，資訊量更大的異常層次結構。

1.2 特點

2.演示環境

  1. JDK 1.8.0_201
  2. Spring Boot 2.2.0.RELEASE
  3. 構建工具（apache maven 3.6.3）
  4. 開發工具（IntelliJ IDEA ）

3.演示程式碼

3.1 程式碼說明

使用 JdbcTemplate 連線 mysql 資料庫，進行常見的資料庫操作，並在 web 專案中展示。

同時配置了兩個資料來源，分別是：master、slave，可以方便的在二者之間切換。

3.2 程式碼結構

3.3 maven 依賴

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-jdbc</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <scope>runtime</scope>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>

3.4 配置檔案

application.properties

spring.datasource.master.url=jdbc:mysql://172.16.11.125:3306/test?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8&useSSL=true
spring.datasource.master.username=root
spring.datasource.master.password=123456
spring.datasource.master.driver-class-name=com.mysql.cj.jdbc.Driver

spring.datasource.slave.url=jdbc:mysql://172.16.11.125:3306/test_jpa?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8&useSSL=true
spring.datasource.slave.username=root
spring.datasource.slave.password=123456
spring.datasource.slave.driver-class-name=com.mysql.cj.jdbc.Driver

3.5 java程式碼

UserModel.java

public class UserModel {
    private Long id;
    private String name;
    private Integer age;
    private String birthday;
    private String address;
    private String phone;

    public UserModel() {}

    public UserModel(String name, Integer age, String birthday, String address, String phone) {
        this.name = name;
        this.age = age;
        this.birthday = birthday;
        this.address = address;
        this.phone = phone;
    }

    // get&set&toString
}

DataSourceConfig.java

@Configuration
public class DataSourceConfig {

    @Bean
    @Primary
    @ConfigurationProperties(prefix = "spring.datasource.master")
    public DataSourceProperties masterDataSourceProperties() {
        return new DataSourceProperties();
    }

    @Bean
    @ConfigurationProperties(prefix = "spring.datasource.slave")
    public DataSourceProperties slaveDataSourceProperties() {
        return new DataSourceProperties();
    }

    @Bean
    @Primary
    public DataSource masterDataSource() {
        return masterDataSourceProperties().initializeDataSourceBuilder().build();
    }

    @Bean
    public DataSource slaveDataSource() {
        return slaveDataSourceProperties().initializeDataSourceBuilder().build();
    }

    @Bean(name = "masterJdbcTemplate")
    public JdbcTemplate masterJdbcTemplate() {
        return new JdbcTemplate(masterDataSource());
    }

    @Bean(name = "slaveJdbcTemplate")
    public JdbcTemplate slaveJdbcTemplate() {
        return new JdbcTemplate(slaveDataSource());
    }
}

UserRowMapper.java

public class UserRowMapper implements RowMapper<UserModel> {
    @Override
    public UserModel mapRow(ResultSet resultSet, int i) throws SQLException {
        UserModel userModel = new UserModel();
        userModel.setId(resultSet.getLong("id"));
        userModel.setName(resultSet.getString("name"));
        userModel.setAge(resultSet.getInt("age"));
        userModel.setBirthday(resultSet.getString("birthday"));
        userModel.setAddress(resultSet.getString("address"));
        userModel.setPhone(resultSet.getString("phone"));
        return userModel;
    }
}

UserService.java

public interface UserService {

    /**
     * 根據id查詢
     * @param id id
     * @return userModel
     */
    UserModel findUserById(Long id);

    /**
     * 根據名稱查詢
     * @param name name
     * @return userModel
     */
    UserModel findUserByName(String name);

    /**
     * 查詢所有
     * @return userModel
     */
    List<UserModel> findAll();

    /**
     * 新增
     * @param userModel userModel
     * @return userModel
     */
    UserModel addUser(UserModel userModel);

    /**
     * 新增2
     * @param userModel userModel
     * @return userModel
     */
    UserModel insertUser(UserModel userModel);

    /**
     * 新增並獲取主鍵
     * @param userModel userModel
     * @return userModel
     */
    UserModel insertAndGetPK(UserModel userModel);

    /**
     * 根據id更新地址
     * @param address 地址
     * @param id id
     * @return userModel
     */
    UserModel updateAddressById(String address, Long id);

    /**
     * 根據id刪除
     * @param id id
     * @return userModel
     */
    UserModel deleteById(Long id);
}

UserServiceImpl.java

@Service
public class UserServiceImpl implements UserService {

    private static final Logger LOGGER = LoggerFactory.getLogger(UserServiceImpl.class);

    @Autowired
    @Qualifier("masterJdbcTemplate")
    private JdbcTemplate jdbcTemplate;

    @Override
    public UserModel findUserById(Long id) {
        String sql = "select id, `name`, age, birthday, address, phone from t_user where id = ?";
        return jdbcTemplate.queryForObject(sql, new Object[] {id}, new UserRowMapper());
    }

    @Override
    public UserModel findUserByName(String name) {
        String sql = "select id, `name`, age, birthday, address, phone from t_user where name = ?";
        return jdbcTemplate.queryForObject(sql, new Object[] {name}, new UserRowMapper());
    }

    @Override
    public List<UserModel> findAll() {
        String sql = "select id, `name`, age, birthday, address, phone from t_user";
        // List<Map<String, Object>> maps = jdbcTemplate.queryForList(sql);
        return jdbcTemplate.query(sql, new BeanPropertyRowMapper(UserModel.class));
    }

    @Override
    public UserModel addUser(UserModel user) {
        String sql = "INSERT INTO t_user(`name`, age, birthday, address, phone) VALUES (?, ?, ?, ?, ?);";
        // jdbcTemplate.update(sql, new Object[] {user.getName(), user.getAge(), user.getBirthday(), user.getAddress(),
        // user.getPhone()});
        // 批量操作使用 batchUpdate
        jdbcTemplate.update(sql, user.getName(), user.getAge(), user.getBirthday(), user.getAddress(), user.getPhone());
        return findUserByName(user.getName());
    }

    @Override
    public UserModel insertUser(UserModel user) {
        String sql = "INSERT INTO t_user(`name`, age, birthday, address, phone) VALUES (?, ?, ?, ?, ?);";
        jdbcTemplate.update(sql, ps -> {
            ps.setString(1, user.getName());
            ps.setInt(2, user.getAge());
            ps.setString(3, user.getBirthday());
            ps.setString(4, user.getAddress());
            ps.setString(5, user.getPhone());
        });
        return findUserByName(user.getName());
    }

    @Override
    public UserModel insertAndGetPK(UserModel user) {
        String sql = "INSERT INTO t_user(`name`, age, birthday, address, phone) VALUES (?, ?, ?, ?, ?);";
        KeyHolder keyHolder = new GeneratedKeyHolder();
        jdbcTemplate.update(connection -> {
            PreparedStatement ps = connection.prepareStatement(sql, new String[] {"id"});
            ps.setString(1, user.getName());
            ps.setInt(2, user.getAge());
            ps.setString(3, user.getBirthday());
            ps.setString(4, user.getAddress());
            ps.setString(5, user.getPhone());
            return ps;
        }, keyHolder);
        long pk = keyHolder.getKey().longValue();
        LOGGER.info("insertAndGetPK pk is {}", pk);
        return findUserById(pk);
    }

    @Override
    public UserModel updateAddressById(String address, Long id) {
        String sql = "UPDATE t_user set address = ? where id = ?";
        jdbcTemplate.update(sql, address, id);
        return findUserById(id);
    }

    @Override
    public UserModel deleteById(Long id) {
        String sql = "DELETE FROM t_user where id = ?";
        UserModel user = findUserById(id);
        jdbcTemplate.update(sql, id);
        return user;
    }
}

UserController.java

@RestController
@RequestMapping("/user")
public class UserController {

    @Autowired
    private UserService userService;

    @GetMapping(value = "/list")
    public List<UserModel> list() {
        return userService.findAll();
    }

    @GetMapping(value = "/findByName/{name}")
    public UserModel findByName(@PathVariable String name) {
        return userService.findUserByName(name);
    }

    @GetMapping(value = "/findById/{id}")
    public UserModel findById(@PathVariable Long id) {
        return userService.findUserById(id);
    }

    @PostMapping(value = "/add")
    public UserModel add(@RequestBody UserModel userModel) {
        return userService.addUser(userModel);
    }

    @PostMapping(value = "/insert")
    public UserModel insert(@RequestBody UserModel userModel) {
        return userService.insertUser(userModel);
    }

    @PostMapping(value = "/insertAndGet")
    public UserModel insertAndGet(@RequestBody UserModel userModel) {
        return userService.insertAndGetPK(userModel);
    }

    @PutMapping(value = "/updateAddressById")
    public UserModel updateAddressById(@RequestBody UserModel userModel) {
        return userService.updateAddressById(userModel.getAddress(), userModel.getId());
    }

    @DeleteMapping(value = "/deleteById/{id}")
    public UserModel deleteById(@PathVariable Long id) {
        return userService.deleteById(id);
    }
}

3.6 git 地址

spring-boot/spring-boot-06-jdbc/spring-boot-jdbc-template

4.效果展示

啟動 SpringBootJdbcTemplateApplication.main 方法，在 spring-boot-jdbc-template.http 訪問下列地址，觀察輸出資訊是否符合預期。

查詢列表

### GET /user/list
GET http://localhost:8080/user/list
Accept: application/json

根據姓名查詢

### GET /user/findByName/{name}
GET http://localhost:8080/user/findByName/zhangsan
Accept: application/json

根據id查詢

### GET /user/findById/{id}
GET http://localhost:8080/user/findById/2
Accept: application/json

新增使用者

### POST /user/add
POST http://localhost:8080/user/add
Accept: application/json
Content-Type: application/json

{
  "name": "aa123",
  "age": 31,
  "birthday": "1989-05-21",
  "address": "hangzhou",
  "phone": "15666666666"
}

新增使用者2

### POST /user/insert
POST http://localhost:8080/user/insert
Accept: application/json
Content-Type: application/json

{
  "name": "bb123",
  "age": 32,
  "birthday": "1988-06-07",
  "address": "xian",
  "phone": "13455555555"
}

新增使用者並返回主鍵

POST http://localhost:8080/user/insertAndGet
Accept: application/json
Content-Type: application/json

{
  "name": "cc123",
  "age": 42,
  "birthday": "1978-03-15",
  "address": "nanjing",
  "phone": "13999999999"
}

更新使用者地址

### PUT /user/updateAddressById
PUT http://localhost:8080/user/updateAddressById
Accept: application/json
Content-Type: application/json

{
  "id": 8,
  "address": "suzhou"
}

根據id刪除

### DELETE /user/deleteById
DELETE http://localhost:8080/user/deleteById/7
Accept: application/json

5.原始碼分析

JdbcTemplate 是 spring 提供的一個操作資料庫的工具類，它是模板方法模式的一種實現。它本身不會注入到 spring 容器中，需要在使用時宣告。在建立 JdbcTemplate 物件時一般需要傳入一個 datasource，所以在 DataSourceConfig 中同時讀二者進行了宣告。

5.1 JdbcTemplate 查詢執行流程

這裡以 UserService#findUserById 為例說明，其他類似

主要流程還是 jdbc 連線資料的操作，需要使用者自己實現結果集對映，重寫 RowMapper 中的 mapRow 方法。

相關推薦

11.SpringBoot學習(十一)——JDBC之 Spring Boot JdbcTemplate

1.簡介 1.1 概述 This is the central class in the JDBC core package. It simplifies the use of JDBC and helps to avoid common errors. It executes core JDBC workflow, leaving application code to provide

12.SpringBoot學習(十二)——JDBC之 Spring Boot Mybatis

1.簡介 1.1 概述 The MyBatis-Spring-Boot-Starter help you build quickly MyBatis applications on top of the Spring Boot.

10.SpringBoot學習(十)——JDBC之 Spring Boot Jpa

1.簡介 1.1 概述 The Java Persistence API is a standard technology that lets you “map” objects to relational databases. The spring-boot-starter-data-jpa POM provides a quick way to get started. It p

Spring學習總結（十一）：Spring中的事務介紹

技術標籤：Spring學習javaspring 一、事務的介紹 1、什麼是事務 事務是資料庫操作的最基本單元，是邏輯上的一組操作。這組操作的結果要麼成功，要麼失敗。以取錢為例來說明事務：如果小明去ATM機取200塊錢，正常

Vue3學習（十一）之 table表格元件的使用

一、前言 大約有兩週沒學習更文，不是懶，而是沒心情，相親路屢戰屢敗，著實很影響心情。

大資料實戰（十八）：電商數倉（十一）之使用者行為資料採集（十一）元件安裝（七）kafka manager

kafka-manager安裝 一.kafka-manager簡介 kafka-manager是目前最受歡迎的kafka叢集管理工具，最早由雅虎開源，使用者可以在Web介面執行一些簡單的叢集管理操作。具體支援以下內容：

大資料實戰（三十八）：電商數倉（三十一）之使用者行為資料倉庫（十七）連續主題

1 最近連續三周活躍使用者數 最近3周連續活躍的使用者：通常是週一對前3周的資料做統計，該資料一週計算一次。

Java學習之Spring Boot入門

Java學習之Spring Boot入門 0x00 前言 學習完ssm的整合後，開始來學習Spring Boot，在前面學習Spring的時候會發現使用Spring開發中配置Spring的環境會非常的繁瑣，而Spring boot的出現就解決了這個問題。

實時電商數倉（二十一）之實時資料儲存與查詢（十一) Clickhouse (六) 副本與分片叢集

1 副本 副本的目的主要是保障資料的高可用性，即使一臺clickhouse節點宕機，那麼也可以從其他伺服器獲得相同的資料。

Mybatis學習十一 （日誌配置）

1.概述 Hibernate是可以配置 show_sql 顯示 自動生成的SQL 語句，用 format_sql 可以格式化SQL 語句，

SpringBoot學習（一）myeclipse搭建springboot

1.使用myeclipse搭建springboot 1） File -> New ->Other 選Spring Web 是為了嵌入一個tomcat，會在pom.xml自動增加：

SpringBoot學習（一）------------IDEA建立專案

一、建立專案 File-->New-->projects 選擇這個是因為可以直接選擇相關元件進行安裝，當然也可以直接建立maven專案然後去匯入相關的依賴，這裡我選擇用這種方法

SpringBoot 2.0 學習（八）使用Spring Boot Admin監控服務

SBA的誕生原因 上篇文章介紹了actuator的作用，細心的朋友可能會發現通過http restful api的方式檢視資訊過於繁瑣也不夠直觀，效率低下，運維人員看到JSON資料更是一臉懵逼，這時強大的SBA就出現了

SpringBoot第十一集：整合Swagger3.0與RESTful介面整合返回值（2020最新最易懂）

SpringBoot第十一集：整合Swagger3.0與RESTful介面整合返回值（2020最新最易懂） 一，整合Swagger3.0

React 學習(十一) Redux

Redux Single Data Source All states is stored in an Object Tree, and the Object Tree is stored in only one store

springboot學習（一）建立springboot專案

開啟 https://start.spring.io 這個網站， 所有配置完成後，點選最下面的 GenerateProject 按鈕，或者點選 Alt+Enter 按鍵，此時會自動下載專案，將下載下來的專案解壓，然後用 IntelliJ IDEA 或者 Eclipse 開啟即可

【FastAPI 學習 十一】 專案目錄結構demo(自己改版)

FastAPI和MySql專案生成器，使用sqlalchemy ORM。 之前呢使用FastAPI是為了配合學習Vue，嘗試性寫的API服務介面，後面放到Github上面，感覺程式碼寫的很爛，沒想到我關於FastAPI的專案有40多個老哥點star，還有幾位

走進C++11（二十二） 之lambda（匿名函式）

技術標籤：C++11c++C++11c++11 提示這篇文章可能較長，分為如下幾部分 什麼是lambda函式Lambda函式的用處Lambda函式中的變數擷取Lambda函式和STL

走進C++11（三十一） 如何用60行實現C++11 thread pool

技術標籤：C++11c++C++11thread pool 關注公眾號獲取更多資訊： 開始之前先上一下程式碼連結：

SpringBoot學習（一）@Configuration

一、 SSM中bean的建立 在springboot中可以不寫xml檔案，改為用@Configuration的方式，告訴Spring boot這是一個配置類 ~~~ 配置檔案