大數據

Spring事務源碼分析專題（一）JdbcTemplate使用及源碼分析

2020-07-21

# 前言

本系列文章為事務專欄分析文章，整個事務分析專題將按下面這張圖完成

image-20200718220712800

對源碼分析前，我希望先介紹一下Spring中數據訪問的相關內容，然後層層遞進到事物的源碼分析，主要分為兩個部分

  1. JdbcTemplate使用及源碼分析
  2. Mybatis的基本使用及Spring對Mybatis的整合

本文將要介紹的是第一點。

JdbcTemplate使用示例

public class DmzService {

    private JdbcTemplate jdbcTemplate;

    public void setDataSource(DataSource dataSource) {
        jdbcTemplate = new JdbcTemplate(dataSource);
    }

    /**
     * 查詢
     * @param id 根據id查詢
     * @return 對應idd的user對象
     */
    public User getUserById(int id) {
        return jdbcTemplate
                .queryForObject("select * from `user` where id  =  ?", new RowMapper<User>() {
                    @Override
                    public User mapRow(ResultSet rs, int rowNum) throws SQLException {
                        User user = new User();
                        user.setId(rs.getInt("id"));
                        user.setAge(rs.getInt("age"));
                        user.setName(rs.getString("name"));
                        return user;
                    }
                }, id);
    }

    public int saveUser(User user){
        return jdbcTemplate.update("insert into user values(?,?,?)",
                new Object[]{user.getId(),user.getName(),user.getAge()});
    }
}
public class Main {
    public static void main(String[] args) {
        ClassPathXmlApplicationContext cc = new ClassPathXmlApplicationContext("tx.xml");
        DmzService dmzService = cc.getBean(DmzService.class);
        User userById = dmzService.getUserById(1);
        System.out.println("查詢的數據為：" + userById);
        userById.setId(userById.getId() + 1);
        int i = dmzService.saveUser(userById);
        System.out.println("插入了" + i + "條數據");
    }
}

數據庫中目前只有一條數據：

image-20200708153438245

配置文件如下：

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

    <bean class="org.springframework.jdbc.datasource.DriverManagerDataSource" id="dataSource">
        <property name="password" value="123"/>
        <property name="username" value="root"/>
        <property name="driverClassName" value="com.mysql.jdbc.Driver"/>
        <property name="url"
                  value="jdbc:mysql://localhost:3306/test?serverTimezone=UTC"/>

    </bean>

    <bean id="dmzService" class="com.dmz.spring.tx.service.DmzService">
        <property name="dataSource" ref="dataSource"/>
     </bean>
</beans>

程序允許結果：

查詢的數據為：User{id=1, name='dmz', age=18}
插入了1條數據

image-20200708153656393

運行後數據庫中確實插入了一條數據

對於JdbcTemplate的簡單使用，建議大家還是要有一定熟悉，雖然我現在在項目中不會直接使用JdbcTemplate的API。本文關於使用不做過多介紹，主要目的是分析它底層的源碼

JdbcTemplate源碼分析

我們直接以其queryForObject方法為入口，對應源碼如下：

queryForObject方法分析

public <T> T queryForObject(String sql, RowMapper<T> rowMapper, @Nullable Object... args) throws DataAccessException {
   
    // 核心在這個query方法中
    List<T> results = query(sql, args, new RowMapperResultSetExtractor<>(rowMapper, 1));
   
    // 這個方法很簡單，就是返回結果集中的數據
    // 如果少於1條或者多餘1條都報錯
    return DataAccessUtils.nullableSingleResult(results);
}

query方法分析

// 第一步，對傳入的參數進行封裝，將參數封裝成ArgumentPreparedStatementSetter
public <T> T query(String sql, @Nullable Object[] args, ResultSetExtractor<T> rse) throws DataAccessException {
    return query(sql, newArgPreparedStatementSetter(args), rse);
}

// 第二步：對sql語句進行封裝，將sql語句封裝成SimplePreparedStatementCreator
public <T> T query(String sql, @Nullable PreparedStatementSetter pss, ResultSetExtractor<T> rse) throws DataAccessException {
    return query(new SimplePreparedStatementCreator(sql), pss, rse);
}


public <T> T query(
    PreparedStatementCreator psc, @Nullable final PreparedStatementSetter pss, final ResultSetExtractor<T> rse)
    throws DataAccessException {
    // query方法在完成對參數及sql語句的封裝後，直接調用了execute方法
    // execute方法是jdbcTemplate的基本API，不管是查詢、更新還是保存
    // 最終都會進入到這個方法中
    return execute(psc, new PreparedStatementCallback<T>() {
        @Override
        @Nullable
        public T doInPreparedStatement(PreparedStatement ps) throws SQLException {
            ResultSet rs = null;
            try {
                if (pss != null) {
                    pss.setValues(ps);
                }
                rs = ps.executeQuery();
                return rse.extractData(rs);
            }
            finally {
                JdbcUtils.closeResultSet(rs);
                if (pss instanceof ParameterDisposer) {
                    ((ParameterDisposer) pss).cleanupParameters();
                }
            }
        }
    });
}

execute方法分析

// execute方法封裝了一次數據庫訪問的基本操作
// 例如：獲取連接，釋放連接等
// 其定製化操作是通過傳入的PreparedStatementCallback參數來實現的
public <T> T execute(PreparedStatementCreator psc, PreparedStatementCallback<T> action)
    throws DataAccessException {
    // 1.獲取數據庫連接
    Connection con = DataSourceUtils.getConnection(obtainDataSource());
    PreparedStatement ps = null;
    try {
        // 2.獲取一個PreparedStatement，並應用用戶設定的參數
        ps = psc.createPreparedStatement(con);
        applyStatementSettings(ps);
        // 3.執行sql並返回結果
        T result = action.doInPreparedStatement(ps);
        // 4.處理警告
        handleWarnings(ps);
        return result;
    }
    catch (SQLException ex) {
          // 出現異常的話，需要關閉數據庫連接
        if (psc instanceof ParameterDisposer) {
            ((ParameterDisposer) psc).cleanupParameters();
        }
        String sql = getSql(psc);
        psc = null;
        JdbcUtils.closeStatement(ps);
        ps = null;
        DataSourceUtils.releaseConnection(con, getDataSource());
        con = null;
        throw translateException("PreparedStatementCallback", sql, ex);
    }
    finally {
        // 關閉資源
        if (psc instanceof ParameterDisposer) {
            ((ParameterDisposer) psc).cleanupParameters();
        }
        JdbcUtils.closeStatement(ps);
        DataSourceUtils.releaseConnection(con, getDataSource());
    }
}

1、獲取數據庫連接

對應源碼如下：

public static Connection getConnection(DataSource dataSource) throws CannotGetJdbcConnectionException {
    // 這裡省略了異常處理
    // 直接調用了doGetConnection方法
    return doGetConnection(dataSource);    
  
}

doGetConnection方法是最終獲取連接的方法

public static Connection doGetConnection(DataSource dataSource) throws SQLException {
    Assert.notNull(dataSource, "No DataSource specified");

    // 如果使用了事務管理器來對事務進行管理（申明式事務跟編程式事務都依賴於事務管理器）
    // 那麼在開啟事務時，Spring會提前綁定一個數據庫連接到當前線程中
    // 這裡做的就是從當前線程中獲取對應的連接池中的連接
    ConnectionHolder conHolder = (ConnectionHolder) TransactionSynchronizationManager.getResource(dataSource);
    if (conHolder != null && (conHolder.hasConnection() || conHolder.isSynchronizedWithTransaction())) {
        // 記錄當前這個連接被使用的次數，每次調用+1
        conHolder.requested();
        if (!conHolder.hasConnection()) {
            logger.debug("Fetching resumed JDBC Connection from DataSource");
            conHolder.setConnection(fetchConnection(dataSource));
        }
        return conHolder.getConnection();
    }
    Connection con = fetchConnection(dataSource);

    // 如果開啟了一個空事務（例如事務的傳播級別設置為SUPPORTS時，就會開啟一個空事務）
    // 會激活同步，那麼在這裡需要將連接綁定到當前線程
    if (TransactionSynchronizationManager.isSynchronizationActive()) {
        try {
            ConnectionHolder holderToUse = conHolder;
            if (holderToUse == null) {
                holderToUse = new ConnectionHolder(con);
            }
            else {
                holderToUse.setConnection(con);
            }
            // 當前連接被使用的次數+1（能進入到這個方法，說明這個連接是剛剛從連接池中獲取到）
            // 當釋放資源時，只有被使用的次數歸為0時才放回到連接池中
            holderToUse.requested();
            TransactionSynchronizationManager.registerSynchronization(
                new ConnectionSynchronization(holderToUse, dataSource));
            holderToUse.setSynchronizedWithTransaction(true);
            if (holderToUse != conHolder) {
                TransactionSynchronizationManager.bindResource(dataSource, holderToUse);
            }
        }
        catch (RuntimeException ex) {
            // 出現異常時釋放連接，如果開啟了事務，不會真正調用close方法關閉連接
            // 而是把當前連接的使用數-1
            releaseConnection(con, dataSource);
            throw ex;
        }
    }

    return con;
}

2、應用用戶設定的參數

protected void applyStatementSettings(Statement stmt) throws SQLException {
    int fetchSize = getFetchSize();
    if (fetchSize != -1) {
        stmt.setFetchSize(fetchSize);
    }
    int maxRows = getMaxRows();
    if (maxRows != -1) {
        stmt.setMaxRows(maxRows);
    }
    DataSourceUtils.applyTimeout(stmt, getDataSource(), getQueryTimeout());
}

從上面代碼可以看出，主要設立了兩個參數

  1. fetchSize：該參數的設計目的主要是為了減少網絡交互，當訪問ResultSet的時候，如果它每次只從服務器讀取一條數據，則會產生大量的開銷，setFetchSize的含義在於，當調用rs.next時，它可以直接從內存中獲取而不需要網絡交互，提高了效率。這個設置可能會被某些JDBC驅動忽略，而且設置過大會造成內存上升
  2. setMaxRows，是將此Statement生成的所有ResultSet的最大返回行數限定為指定數，作用類似於limit。

3、執行Sql

沒啥好說的，底層其實就是調用了jdbc的一系列API

4、處理警告

也沒啥好說的，處理Statement中的警告信息

protected void handleWarnings(Statement stmt) throws SQLException {
    if (isIgnoreWarnings()) {
        if (logger.isDebugEnabled()) {
            SQLWarning warningToLog = stmt.getWarnings();
            while (warningToLog != null) {
                logger.debug("SQLWarning ignored: SQL state '" + warningToLog.getSQLState() + "', error code '" +
                             warningToLog.getErrorCode() + "', message [" + warningToLog.getMessage() + "]");
                warningToLog = warningToLog.getNextWarning();
            }
        }
    }
    else {
        handleWarnings(stmt.getWarnings());
    }
}

5、關閉資源

最終會調用到DataSourceUtils的doReleaseConnection方法，源碼如下：

public static void doReleaseConnection(@Nullable Connection con, @Nullable DataSource dataSource) throws SQLException {
    if (con == null) {
        return;
    }
    if (dataSource != null) {
        ConnectionHolder conHolder = (ConnectionHolder) TransactionSynchronizationManager.getResource(dataSource);
        if (conHolder != null && connectionEquals(conHolder, con)) {
            // 說明開啟了事務，那麼不會調用close方法，之後將連接的佔用數減1
            conHolder.released();
            return;
        }
    }
    // 調用close方法關閉連接
    doCloseConnection(con, dataSource);
}

總結

總的來說，這篇文章涉及到的內容都是比較簡單的，通過這篇文章是希望讓大家對Spring中的數據訪問有一定了解，相當於熱身吧，後面的文章難度會加大，下篇文章我們將介紹更高級的數據訪問，myBatis的使用以及基本原理、事務管理以及它跟Spring的整合原理。

如果本文對你由幫助的話，記得點個贊吧！也歡迎關注我的公眾號，微信搜索：程序員DMZ，或者掃描下方二維碼，跟著我一起認認真真學Java,踏踏實實做一個coder。

我叫DMZ，一個在學習路上匍匐前行的小菜鳥！

Leave a Reply

Your email address will not be published. Required fields are marked *