Spring事務超時時間可能存在的錯誤認識
1、先看程式碼
1.1、spring-config.xml
Java程式碼- <bean id="dataSource"class="org.springframework.jdbc.datasource.DriverManagerDataSource">
- <property name="driverClassName" value="com.mysql.jdbc.Driver"/>
- <property name="url" value="jdbc:mysql://localhost:3306/test?autoReconnect=true&useUnicode=true&characterEncoding=utf-8"
- <property name="username" value="root"/>
- <property name="password" value=""/>
- </bean>
- <bean id="txManager"class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
- <property name="dataSource" ref="dataSource"/>
- </bean>
1.2、測試用例
- @RunWith(SpringJUnit4ClassRunner.class)
- @ContextConfiguration(locations = "classpath:spring-config.xml")
- @TransactionConfiguration(transactionManager = "txManager", defaultRollback = false)
- @Transactional(timeout = 2)
- publicclass Timeout1Test {
- @Autowired
- private DataSource ds;
- @Test
- publicvoid testTimeout() throws InterruptedException {
- System.out.println(System.currentTimeMillis());
- JdbcTemplate jdbcTemplate = new JdbcTemplate(ds);
- jdbcTemplate.execute(" update test set name = name || '1'");
- System.out.println(System.currentTimeMillis());
- Thread.sleep(3000L);
- }
- }
我設定事務超時時間是2秒;但我事務肯定執行3秒以上;為什麼沒有起作用呢? 這其實是對Spring實現的事務超時的錯誤認識。那首先分析下Spring事務超時實現吧。
2、分析
2.1、在此我們分析下DataSourceTransactionManager;首先開啟事物會呼叫其doBegin方法:
Java程式碼- …………
- int timeout = determineTimeout(definition);
- if (timeout != TransactionDefinition.TIMEOUT_DEFAULT) {
- txObject.getConnectionHolder().setTimeoutInSeconds(timeout);
- }
- …………
其中determineTimeout用來獲取我們設定的事務超時時間;然後設定到ConnectionHolder物件上(其是ResourceHolder子類),接著看ResourceHolderSupport的setTimeoutInSeconds實現:
Java程式碼- publicvoid setTimeoutInSeconds(int seconds) {
- setTimeoutInMillis(seconds * 1000);
- }
- publicvoid setTimeoutInMillis(long millis) {
- this.deadline = new Date(System.currentTimeMillis() + millis);
- }
大家可以看到,其會設定一個deadline時間;用來判斷事務超時時間的;那什麼時候呼叫呢?首先檢查該類中的程式碼,會發現:
Java程式碼- publicint getTimeToLiveInSeconds() {
- double diff = ((double) getTimeToLiveInMillis()) / 1000;
- int secs = (int) Math.ceil(diff);
- checkTransactionTimeout(secs <= 0);
- return secs;
- }
- publiclong getTimeToLiveInMillis() throws TransactionTimedOutException{
- if (this.deadline == null) {
- thrownew IllegalStateException("No timeout specified for this resource holder");
- }
- long timeToLive = this.deadline.getTime() - System.currentTimeMillis();
- checkTransactionTimeout(timeToLive <= 0);
- return timeToLive;
- }
- privatevoid checkTransactionTimeout(boolean deadlineReached) throws TransactionTimedOutException {
- if (deadlineReached) {
- setRollbackOnly();
- thrownew TransactionTimedOutException("Transaction timed out: deadline was " + this.deadline);
- }
- }
會發現在呼叫getTimeToLiveInSeconds和getTimeToLiveInMillis,會檢查是否超時,如果超時設定事務回滾,並丟擲TransactionTimedOutException異常。到此我們只要找到呼叫它們的位置就好了,那什麼地方呼叫的它們呢? 最簡單的辦法使用如“IntelliJ IDEA”中的“Find Usages”找到get***的使用地方;會發現:
DataSourceUtils.applyTransactionTimeout會呼叫DataSourceUtils.applyTimeout,DataSourceUtils.applyTimeout程式碼如下:
Java程式碼- publicstaticvoid applyTimeout(Statement stmt, DataSource dataSource, int timeout) throws SQLException {
- Assert.notNull(stmt, "No Statement specified");
- Assert.notNull(dataSource, "No DataSource specified");
- ConnectionHolder holder = (ConnectionHolder) TransactionSynchronizationManager.getResource(dataSource);
- if (holder != null && holder.hasTimeout()) {
- // Remaining transaction timeout overrides specified value.
- stmt.setQueryTimeout(holder.getTimeToLiveInSeconds());
- }
- elseif (timeout > 0) {
- // No current transaction timeout -> apply specified value.
- stmt.setQueryTimeout(timeout);
- }
- }
其中其在stmt.setQueryTimeout(holder.getTimeToLiveInSeconds());中會呼叫getTimeToLiveInSeconds,此時就會檢查事務是否超時;
然後在JdbcTemplate中,執行sql之前,會呼叫其applyStatementSettings:其會呼叫DataSourceUtils.applyTimeout(stmt, getDataSource(), getQueryTimeout());設定超時時間;具體可以看其原始碼;
到此我們知道了在JdbcTemplate拿到Statement之後,執行之前會設定其queryTimeout,具體意思參考Javadoc:
3、結論
寫道 Spring事務超時 = 事務開始時到最後一個Statement建立時時間 + 最後一個Statement的執行時超時時間(即其queryTimeout)。4、因此
假設事務超時時間設定為2秒;假設sql執行時間為1秒;
如下呼叫是事務不超時的
Java程式碼- publicvoid testTimeout() throws InterruptedException {
- System.out.println(System.currentTimeMillis());
- JdbcTemplate jdbcTemplate = new JdbcTemplate(ds);
- jdbcTemplate.execute(" update test set hobby = hobby || '1'");
- System.out.println(System.currentTimeMillis());
- Thread.sleep(3000L);
- }
而如下事務超時是起作用的;
Java程式碼- publicvoid testTimeout() throws InterruptedException {
- Thread.sleep(3000L);
- System.out.println(System.currentTimeMillis());
- JdbcTemplate jdbcTemplate = new JdbcTemplate(ds);
- jdbcTemplate.execute(" update test set hobby = hobby || '1'");
- System.out.println(System.currentTimeMillis());
- }
因此,不要忽略應用中如遠端呼叫產生的事務時間和這個事務時間是否對您的事務產生影響。
另外:
1、事務超時不起作用,您要首先檢查您的事務起作用了沒:可以參考使用Aop工具類診斷常見問題
3、如果您用JDBC,但沒有用JdbcTemplate,直接使用DateSourceUtils進行事務控制時,要麼自己設定Statement的queryTimeout超時時間,要麼使用TransactionAwareDataSourceProxy,其在建立Statement時會自動設定其queryTimeout。
4、關於JDBC超時時間設定一篇不錯的翻譯:深入理解JDBC的超時設定