Spring Boot 2.x基礎教程：使用JdbcTemplate訪問MySQL數據庫

在第2章節中，我們介紹了如何通過Spring Boot來實現HTTP接口，以及圍繞HTTP接口相關的單元測試、文檔生成等實用技能。但是，這些內容還不足以幫助我們構建一個動態應用的服務端程序。不論我們是要做App、小程序、還是傳統的Web站點，對於用戶的信息、相關業務的內容，通常都需要對其進行存儲，而不是像第2章節中那樣，把用戶信息存儲在內存中（重啟就丟了！）。

對於信息的存儲，現在已經有非常非常多的產品可以選擇，其中不乏許多非常優秀的開源免費產品，比如：MySQL，Redis等。接下來，在第3章節，我們將繼續學習在使用Spring Boot開發服務端程序的時候，如何實現對各流行數據存儲產品的增刪改查操作。

作為數據訪問章節的第一篇，我們將從最為常用的關系型數據庫開始。通過一個簡單例子，學習在Spring Boot中最基本的數據訪問工具：JdbcTemplate。

數據源配置

在我們訪問數據庫的時候，需要先配置一個數據源，下面分別介紹一下幾種不同的數據庫配置方式。

首先，為了連接數據庫需要引入jdbc支持，在pom.xml中引入如下配置：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>

嵌入式數據庫支持

嵌入式數據庫通常用於開發和測試環境，不推薦用於生產環境。Spring Boot提供自動配置的嵌入式數據庫有H2、HSQL、Derby，你不需要提供任何連接配置就能使用。

比如，我們可以在pom.xml中引入如下配置使用HSQL

<dependency>
    <groupId>org.hsqldb</groupId>
    <artifactId>hsqldb</artifactId>
    <scope>runtime</scope>
</dependency>

連接生產數據源

以MySQL數據庫為例，先引入MySQL連接的依賴包，在pom.xml中加入：

<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>5.1.46</version>
</dependency>

在src/main/resources/application.properties中配置數據源信息

spring.datasource.url=jdbc:mysql://localhost:3306/test
spring.datasource.username=dbuser
spring.datasource.password=dbpass
spring.datasource.driver-class-name=com.mysql.jdbc.Driver

連接JNDI數據源

當你將應用部署於應用服務器上的時候想讓數據源由應用服務器管理，那么可以使用如下配置方式引入JNDI數據源。

spring.datasource.jndi-name=java:jboss/datasources/customers

使用JdbcTemplate操作數據庫

Spring的JdbcTemplate是自動配置的，你可以直接使用@Autowired或構造函數（推薦）來注入到你自己的bean中來使用。

下面就來一起完成一個增刪改查的例子：

准備數據庫

先創建User表，包含屬性name、age。可以通過執行下面的建表語句：：

CREATE TABLE `User` (
  `name` varchar(100) COLLATE utf8mb4_general_ci NOT NULL,
  `age` int NOT NULL
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci

編寫領域對象

根據數據庫中創建的User表，創建領域對象：

@Data
@NoArgsConstructor
public class User {

    private String name;
    private Integer age;

}

這里使用了Lombok的@Data和@NoArgsConstructor注解來自動生成各參數的Set、Get函數以及不帶參數的構造函數。如果您對Lombok還不了解，可以看看這篇文章：Java開發神器Lombok的使用與原理。

編寫數據訪問對象

• 定義包含有插入、刪除、查詢的抽象接口UserService

public interface UserService {

    /**
     * 新增一個用戶
     *
     * @param name
     * @param age
     */
    int create(String name, Integer age);

    /**
     * 根據name查詢用戶
     *
     * @param name
     * @return
     */
    List<User> getByName(String name);

    /**
     * 根據name刪除用戶
     *
     * @param name
     */
    int deleteByName(String name);

    /**
     * 獲取用戶總量
     */
    int getAllUsers();

    /**
     * 刪除所有用戶
     */
    int deleteAllUsers();

}

• 通過JdbcTemplate實現UserService中定義的數據訪問操作

@Service
public class UserServiceImpl implements UserService {

    private JdbcTemplate jdbcTemplate;

    UserServiceImpl(JdbcTemplate jdbcTemplate) {
        this.jdbcTemplate = jdbcTemplate;
    }

    @Override
    public int create(String name, Integer age) {
        return jdbcTemplate.update("insert into USER(NAME, AGE) values(?, ?)", name, age);
    }

    @Override
    public List<User> getByName(String name) {
        List<User> users = jdbcTemplate.query("select NAME, AGE from USER where NAME = ?", (resultSet, i) -> {
            User user = new User();
            user.setName(resultSet.getString("NAME"));
            user.setAge(resultSet.getInt("AGE"));
            return user;
        }, name);
        return users;
    }

    @Override
    public int deleteByName(String name) {
        return jdbcTemplate.update("delete from USER where NAME = ?", name);
    }

    @Override
    public int getAllUsers() {
        return jdbcTemplate.queryForObject("select count(1) from USER", Integer.class);
    }

    @Override
    public int deleteAllUsers() {
        return jdbcTemplate.update("delete from USER");
    }

}

編寫單元測試用例

• 創建對UserService的單元測試用例，通過創建、刪除和查詢來驗證數據庫操作的正確性。

@RunWith(SpringRunner.class)
@SpringBootTest
public class Chapter31ApplicationTests {

    @Autowired
    private UserService userSerivce;

    @Before
    public void setUp() {
        // 准備，清空user表
        userSerivce.deleteAllUsers();
    }

    @Test
    public void test() throws Exception {
        // 插入5個用戶
        userSerivce.create("Tom", 10);
        userSerivce.create("Mike", 11);
        userSerivce.create("Didispace", 30);
        userSerivce.create("Oscar", 21);
        userSerivce.create("Linda", 17);

        // 查詢名為Oscar的用戶，判斷年齡是否匹配
        List<User> userList = userSerivce.getByName("Oscar");
        Assert.assertEquals(21, userList.get(0).getAge().intValue());

        // 查數據庫，應該有5個用戶
        Assert.assertEquals(5, userSerivce.getAllUsers());

        // 刪除兩個用戶
        userSerivce.deleteByName("Tom");
        userSerivce.deleteByName("Mike");

        // 查數據庫，應該有5個用戶
        Assert.assertEquals(3, userSerivce.getAllUsers());

    }

}

上面介紹的JdbcTemplate只是最基本的幾個操作，更多其他數據訪問操作的使用請參考：JdbcTemplate API

通過上面這個簡單的例子，我們可以看到在Spring Boot下訪問數據庫的配置依然秉承了框架的初衷：簡單。我們只需要在pom.xml中加入數據庫依賴，再到application.properties中配置連接信息，不需要像Spring應用中創建JdbcTemplate的Bean，就可以直接在自己的對象中注入使用。

代碼示例

本文的相關例子可以查看下面倉庫中的chapter3-1目錄：

• Github：https://github.com/dyc87112/SpringBoot-Learning/
• Gitee：https://gitee.com/didispace/SpringBoot-Learning/

如果您覺得本文不錯，歡迎Star支持，您的關注是我堅持的動力！

歡迎關注我的公眾號：程序猿DD，獲得獨家整理的學習資源和日常干貨推送。
如果您對我的專題內容感興趣，也可以關注我的博客：didispace.com