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

程式猿DD發表於2020-02-13
Spring BootJDBCMySql資料庫

在第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目錄：

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

歡迎關注我的公眾號：程式猿DD，獲得獨家整理的學習資源和日常乾貨推送。

如果您對我的專題內容感興趣，也可以關注我的部落格：didispace.com

相關文章