Spring 學習筆記(6)Spring和資料庫程式設計

RioTian 發表於 2022-01-26
資料庫 Spring

本文介紹 Spring 中 資料庫使用以及 JdbcTemplate 的使用方式。

傳統 JDBC 回顧

JDBC 我們一定不陌生,剛開始學習的時候,我們寫過很多很多重複的模板程式碼:

public Student getOne(int id) {

    String sql = "select id,name from student where id = ?";
    Student student = null;
    // 宣告 JDBC 變數
    Connection con = null;
    PreparedStatement ps = null;
    ResultSet rs = null;
    try {
        // 註冊驅動程式
        Class.forName("com.myql.jdbc.Driver");
        // 獲取連線
        con = DriverManager.getConnection("jdbc://mysql://localhost:" +
                "3306/student", "root", "root");
        // 預編譯SQL
        ps = con.prepareStatement(sql);
        // 設定引數
        ps.setInt(1, id);
        // 執行SQL
        rs = ps.executeQuery();
        // 組裝結果集返回 POJO
        if (rs.next()) {
            student = new Student();
            student.setId(rs.getInt(1));
            student.setName(rs.getString(1));
        }
    } catch (ClassNotFoundException | SQLException e) {
        e.printStackTrace();
    } finally {
        // 關閉資料庫連線資源
        try {
            if (rs != null && !rs.isClosed()) {
                rs.close();
            }
        } catch (SQLException e) {
            e.printStackTrace();
        }
        try {
            if (ps != null && !ps.isClosed()) {
                ps.close();
            }
        } catch (SQLException e) {
            e.printStackTrace();
        }
        try {
            if (con != null && con.isClosed()) {
                con.close();
            }
        } catch (SQLException e) {
            e.printStackTrace();
        }
    }
    return student;
}

現在光是看著就頭大,並且我還把它完整的寫了出來..

同時這還僅僅是一個 JDBC 的方法,並且最主要的程式碼只有ps = con.prepareStatement(sql);這麼一句,而且有很多模板化的程式碼,包括建立連線以及關閉連線..我們必須想辦法解決一下!

優化傳統的 JDBC

第一步:建立 DBUtil 類

我想第一步我們可以把重複的模板程式碼提出來建立一個 DBUtil 資料庫工具類:

package util;

import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.SQLException;

public class DBUtil {
    static String ip = "127.0.0.1";
    static int port = 3306;
    static String database = "student";
    static String encoding = "UTF-8";
    static String loginName = "root";
    static String password = "root";

    static {
        try {
            Class.forName("com.mysql.jdbc.Driver");
        } catch (ClassNotFoundException e) {
            e.printStackTrace();
        }
    }

    public static Connection getConnection() throws SQLException {
        String url = String.format("jdbc:mysql://%s:%d/%s?characterEncoding=%s&useSSL=false", ip, port, database, encoding);
        return DriverManager.getConnection(url, loginName, password);
    }
}

這樣我們就可以把上面的程式碼變成這樣:

public Student getOne(int id) {

    String sql = "select id,name from student where id = ?";
    Student student = null;
    // 宣告 JDBC 變數
    Connection con = null;
    PreparedStatement ps = null;
    ResultSet rs = null;
    try {
        // 獲取連線
        con = DBUtil.getConnection();
        // 預編譯SQL
        ps = con.prepareStatement(sql);
        // 設定引數
        ps.setInt(1, id);
        // 執行SQL
        rs = ps.executeQuery();
        // 組裝結果集返回 POJO
        ....
    } catch (SQLException e) {
        e.printStackTrace();
    } finally {
        // 關閉資料庫連線資源
        ....
    }
    return student;
}

也只是少寫了一句註冊驅動程式少處理了一個異常而已,並沒有什麼大的變化,必須再優化一下

第二步:使用 try-catch 語句自動關閉資源

自動資源關閉是 JDK 7 中新引入的特性,不瞭解的同學可以去看一下三顆心大佬寫的Java 7新特性詳解

於是程式碼可以進一步優化成這樣:

public Student getOne(int id) {

    String sql = "select id,name from student where id = ?";
    Student student = null;
    // 將 JDBC 宣告變數包含在 try(..) 裡將自動關閉資源
    try (Connection con = DBUtil.getConnection(); PreparedStatement ps = con.prepareStatement(sql)) {

        // 設定引數
        ps.setInt(1, id);
        // 執行SQL
        ResultSet rs = ps.executeQuery();
        // 組裝結果集返回 POJO
        if (rs.next()) {
            student = new Student();
            student.setId(rs.getInt(1));
            student.setName(rs.getString(1));
        }
    } catch (SQLException e) {
        e.printStackTrace();
    }
    return student;
}

這樣看著好太多了,但仍然不太滿意,因為我們最核心的程式碼也就只是執行 SQL 語句並拿到返回集,再來再來

再進一步改進 DBUtil 類:

DBUtil 類中新增一個方法,用來直接返回結果集:

public static ResultSet getResultSet(String sql, Object[] objects) throws SQLException {

    ResultSet rs = null;
    try (Connection con = getConnection(); PreparedStatement ps = con.prepareStatement(sql)) {

        // 根據傳遞進來的引數,設定 SQL 佔位符的值
        for (int i = 0; i < objects.length; i++) {
            ps.setObject(i + 1, objects[i]);
        }
        // 執行 SQL 語句並接受結果集
        rs = ps.executeQuery();
    }
    // 返回結果集
    return rs;
}

這樣我們就可以把我們最開始的程式碼優化成這樣了:

public Student getOne(int id) {

    String sql = "select id,name from student where id = ?";
    Object[] objects = {id};
    Student student = null;
    try (ResultSet rs = DBUtil.getResultSet(sql, objects);) {
        student.setId(rs.getInt(1));
        student.setName(rs.getString(1));
    } catch (SQLException e) {
        // 處理異常
        e.printStackTrace();
    }
    return student;
}

wooh!看著爽多了,但美中不足的就是沒有把 try-catch 語句去掉,我們也可以不進行異常處理直接把 SQLException 丟擲去:

public Student getOne(int id) throws SQLException {

    String sql = "select id,name from student where id = ?";
    Object[] objects = {id};
    Student student = null;
    try (ResultSet rs = DBUtil.getResultSet(sql, objects);) {
        student.setId(rs.getInt(1));
        student.setName(rs.getString(1));
    }
    return student;
}

其實上面的版本已經夠好了,這樣做只是有些強迫症。

我們自己定義的 DBUtil 工具已經很實用了,因為是從模板化的程式碼中抽離出來的,所以我們可以一直使用

Spring 中的 JDBC

要想使用 Spring 中的 JDBC 模組,就必須引入相應的 jar 檔案:

  • 需要引入的 jar 包:

  • spring-jdbc-4.3.16.RELEASE.jar

  • spring-tx-4.3.16.RELEASE.jar

  • Maven 座標引用

    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>5.1.32</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-jdbc</artifactId>
        <version>5.0.5.RELEASE</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-tx</artifactId>
        <version>5.0.5.RELEASE</version>
    </dependency>
    

好在 IDEA 在建立 Spring 專案的時候已經為我們自動部署好了,接下來我們來實際在 Spring 中使用一下 JDBC:

配置資料庫資源

就像我們建立 DBUtil 類,將其中連線的資訊封裝在裡面一樣,我們需要將這些資料庫資源配置起來

  • 配置方式:
  • 使用簡單資料庫配置
  • 使用第三方資料庫連線池

我們可以使用 Spring 內建的類來配置,但大部分時候我們都會使用第三方資料庫連線池來進行配置,由於使用第三方的類,一般採用 XML 檔案配置的方式,我們這裡也使用 XML 檔案配置的形式:

使用簡單資料庫配置

首先我們來試試 Spring 的內建類 org.springframework.jdbc.datasource.SimpleDriverDataSource

<bean id="dateSource" class="org.springframework.jdbc.datasource.SimpleDriverDataSource">
    <property name="username" value="root"/>
    <property name="password" value="root"/>
    <property name="driverClass" value="com.mysql.jdbc.Driver"/>
    <property name="url" value="jdbc://mysql://locolhost:3306/student"/>
</bean>

我們來測試一下,先把我們的 JDBC 操作類寫成這個樣子:

@Component("jdbc")
public class JDBCtest {

    @Autowired
    private DataSource dataSource;

    public User getOne(int stuID) throws SQLException {
        // id username password email
        String sql = "select id, username from user where id = " + stuID;
        User user = new User();
        Connection conn = dataSource.getConnection();
        Statement st = conn.createStatement();
        ResultSet rs = st.executeQuery(sql);
        if (rs.next()) {
            user.setId(rs.getLong("id"));
            user.setUsername(rs.getString("username"));
        }
        return user;
    }
}

然後編寫測試類:

@Test
public void test() throws SQLException {
    ApplicationContext context =
            new ClassPathXmlApplicationContext("applicationContext.xml");
    JDBCtest jdbc = (JDBCtest) context.getBean("jdbc");
    User user = jdbc.getOne(1);
    System.out.println(user.getId());
    System.out.println(user.getUsername());
}

成功取出資料庫中的資料:

Spring 學習筆記(6)Spring和資料庫程式設計

使用第三方資料庫連線池

上面配置的這個簡單的資料來源一般用於測試,因為它不是一個資料庫連線池,知識一個很簡單的資料庫連線的應用。在更多的時候,我們需要使用第三方的資料庫連線,比如使用 C3P0資料庫連線池:

<!--1、載入jdbc.properties-->
<context:property-placeholder location="classpath:jdbc.properties"/>

<!--2、配置資料來源物件-->
<bean id="dataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource">
    <property name="driverClass" value="${jdbc.driver}"/>
    <property name="jdbcUrl" value="${jdbc.url}"/>
    <property name="user" value="${jdbc.username}"/>
    <property name="password" value="${jdbc.password}"/>
    <property name="initialPoolSize" value="3"></property>
    <property name="maxPoolSize" value="10"></property>
    <property name="maxStatements" value="100"></property>
    <property name="acquireIncrement" value="2"></property>
</bean>

<!--3、配置JdbcTemplate物件-->
<bean id="jdbcTemplate" class="org.springframework.jdbc.core.JdbcTemplate">
    <property name="dataSource" ref="dataSource"></property>
</bean>

跟上面的測試差不多,不同的是需要引入相關支援 C3P0 資料庫連線池的 jar 包而已。

Jdbc Template

Spring 中提供了一個 Jdbc Template 類,它自己已經封裝了一個 DataSource 型別的變數,我們可以直接使用:

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:aop="http://www.springframework.org/schema/aop"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context
        http://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd">

    <bean id="dataSrouce" class="org.springframework.jdbc.datasource.SimpleDriverDataSource">
        <property name="driverClass" value="com.mysql.jdbc.Driver"/>
        <property name="url" value="jdbc:mysql://localhost:3306/javat?useSSL=false"/>
        <property name="username" value="root"/>
        <property name="password" value="root"/>
    </bean>

    <context:component-scan base-package="jdbc" />

    <bean id="jdbcTemplate" class="org.springframework.jdbc.core.JdbcTemplate">
        <property name="dataSource" ref="dataSrouce"/>
    </bean>

</beans>

我們來改寫一下 JDBC 操作的類:

@Component("jdbc")
public class JDBCtest {

    @Autowired
    private JdbcTemplate jdbcTemplate;

    public User getOne(int stuID) throws SQLException {
        // id username password email
        String sql = "SELECT id, username FROM user WHERE id = ?";
        User user = jdbcTemplate.queryForObject(sql, new RowMapper<User>() {
            @Override
            public User mapRow(ResultSet resultSet, int i) throws SQLException {
                User stu = new User();
                stu.setId(resultSet.getLong("id"));
                stu.setUsername(resultSet.getString("username"));
                return stu;
            }
        }, stuID);
        return user;
    }
}

測試類不變,執行可以獲得正確的結果:

Spring 學習筆記(6)Spring和資料庫程式設計

但是好像並沒有簡單多少的樣子,那我們來看看其他 CRUD 的例子:

    /**
     * 增加一條資料
     *
     * @param user
     */
    public void add(User user) {
        this.jdbcTemplate.update("INSERT INTO student(id,username,password,email) VALUES(?,?,?,?)",user.getId(),user.getUsername(),user.getPassword(),user.getEmail());
    }

    /**
     * 更新 username
     *
     * @param user
     */
    public void update(User user) {
        this.jdbcTemplate.update("update user set name = ? where id = ?", user.getUsername(),user.getId());
    }

    /**
     * 刪除一條資料
     *
     * @param id
     */
    public void delete(int id) {
        this.jdbcTemplate.update("delete from user from id = ?", id);
    }

現在應該簡單多了吧,返回集合的話只需要稍微改寫一下上面的 getOne() 方法就可以了


參考資料:

擴充套件閱讀:官方文件Spring 中 JdbcTemplate 實現增刪改查① 徹底理解資料庫事務② Spring事務管理詳解③ Spring 事務管理(詳解+例項)④ 全面分析 Spring 的程式設計式事務管理及宣告式事務管理