6種@Transactional註解的失效場景
一、事務
事務管理在系統開發中是不可缺少的一部分,Spring
提供了很好事務管理機制,主要分為程式設計式事務
和宣告式事務
兩種。
程式設計式事務:是指在程式碼中手動的管理事務的提交、回滾等操作,程式碼侵入性比較強,如下示例:
try {
//TODO something
transactionManager.commit(status);
} catch (Exception e) {
transactionManager.rollback(status);
throw new InvoiceApplyException("異常失敗");
}
複製程式碼
宣告式事務:基於AOP
TX
和AOP
的xml配置檔案方式,二種就是基於@Transactional註解了。
@Transactional
@GetMapping("/test")
public String test() {
int insert = cityInfoDictMapper.insert(cityInfoDict);
}
複製程式碼
二、@Transactional介紹
1、@Transactional註解可以作用於哪些地方?
@Transactional 可以作用在介面
、類
、類方法
。
-
作用於類:當把@Transactional 註解放在類上時,表示所有該類的
public
方法都配置相同的事務屬性資訊。 -
作用於方法:當類配置了@Transactional,方法也配置了@Transactional,方法的事務會覆蓋類的事務配置資訊。
-
作用於介面:不推薦這種使用方法,因為一旦標註在Interface上並且配置了Spring AOP 使用CGLib動態代理,將會導致@Transactional註解失效
@Transactional
@RestController
@RequestMapping
public class MybatisPlusController {
@Autowired
private CityInfoDictMapper cityInfoDictMapper;
@Transactional(rollbackFor = Exception.class)
@GetMapping("/test")
public String test() throws Exception {
CityInfoDict cityInfoDict = new CityInfoDict();
cityInfoDict.setParentCityId(2);
cityInfoDict.setCityName("2");
cityInfoDict.setCityLevel("2");
cityInfoDict.setCityCode("2");
int insert = cityInfoDictMapper.insert(cityInfoDict);
return insert + "";
}
}
複製程式碼
2、@Transactional注有哪些屬性?
propagation屬性
propagation
代表事務的傳播行為,預設值為Propagation.REQUIRED
,其他的屬性資訊如下:
-
Propagation.REQUIRED
:如果當前存在事務,則加入該事務,如果當前不存在事務,則建立一個新的事務。(也就是說如果A方法和B方法都添加了註解,在預設傳播模式下,A方法內部呼叫B方法,會把兩個方法的事務合併為一個事務) -
Propagation.SUPPORTS
:如果當前存在事務,則加入該事務;如果當前不存在事務,則以非事務的方式繼續執行。 -
Propagation.MANDATORY
:如果當前存在事務,則加入該事務;如果當前不存在事務,則丟擲異常。 -
Propagation.REQUIRES_NEW
:重新建立一個新的事務,如果當前存在事務,暫停當前的事務。(當類A中的 a 方法用預設Propagation.REQUIRED
模式,類B中的 b方法加上採用Propagation.REQUIRES_NEW
模式,然後在 a 方法中呼叫 b方法操作資料庫,然而 a方法丟擲異常後,b方法並沒有進行回滾,因為Propagation.REQUIRES_NEW
會暫停 a方法的事務) -
Propagation.NOT_SUPPORTED
:以非事務的方式執行,如果當前存在事務,暫停當前的事務。 -
Propagation.NEVER
:以非事務的方式執行,如果當前存在事務,則丟擲異常。 -
Propagation.NESTED
:和 Propagation.REQUIRED 效果一樣。
isolation 屬性
isolation
:事務的隔離級別,預設值為Isolation.DEFAULT
。
- Isolation.DEFAULT:使用底層資料庫預設的隔離級別。
- Isolation.READ_UNCOMMITTED
- Isolation.READ_COMMITTED
- Isolation.REPEATABLE_READ
- Isolation.SERIALIZABLE
timeout 屬性
timeout
:事務的超時時間,預設值為 -1。如果超過該時間限制但事務還沒有完成,則自動回滾事務。
readOnly 屬性
readOnly
:指定事務是否為只讀事務,預設值為 false;為了忽略那些不需要事務的方法,比如讀取資料,可以設定 read-only 為 true。
rollbackFor 屬性
rollbackFor
:用於指定能夠觸發事務回滾的異常型別,可以指定多個異常型別。
noRollbackFor屬性**
noRollbackFor
:丟擲指定的異常型別,不回滾事務,也可以指定多個異常型別。
二、@Transactional失效場景
接下來我們結合具體的程式碼分析一下哪些場景下,@Transactional 註解會失效。
1、@Transactional 應用在非 public 修飾的方法上
如果Transactional
註解應用在非public
修飾的方法上,Transactional將會失效。
之所以會失效是因為在Spring AOP 代理時,如上圖所示TransactionInterceptor
(事務攔截器)在目標方法執行前後進行攔截,DynamicAdvisedInterceptor
(CglibAopProxy 的內部類)的 intercept 方法或JdkDynamicAopProxy
的 invoke 方法會間接呼叫AbstractFallbackTransactionAttributeSource
的computeTransactionAttribute
方法,獲取Transactional 註解的事務配置資訊。
protected TransactionAttribute computeTransactionAttribute(Method method,
Class<?> targetClass) {
// Don't allow no-public methods as required.
if (allowPublicMethodsOnly() && !Modifier.isPublic(method.getModifiers())) {
return null;
}
複製程式碼
此方法會檢查目標方法的修飾符是否為 public,不是 public則不會獲取@Transactional 的屬性配置資訊。
注意:protected
、private
修飾的方法上使用@Transactional
註解,雖然事務無效,但不會有任何報錯,這是我們很容犯錯的一點。
2、@Transactional 註解屬性 propagation 設定錯誤
這種失效是由於配置錯誤,若是錯誤的配置以下三種 propagation,事務將不會發生回滾。
TransactionDefinition.PROPAGATION_SUPPORTS
:如果當前存在事務,則加入該事務;如果當前沒有事務,則以非事務的方式繼續執行。TransactionDefinition.PROPAGATION_NOT_SUPPORTED
:以非事務方式執行,如果當前存在事務,則把當前事務掛起。TransactionDefinition.PROPAGATION_NEVER
:以非事務方式執行,如果當前存在事務,則丟擲異常。
3、@Transactional 註解屬性 rollbackFor 設定錯誤
rollbackFor
可以指定能夠觸發事務回滾的異常型別。Spring預設丟擲了未檢查unchecked
異常(繼承自RuntimeException
的異常)或者Error
才回滾事務;其他異常不會觸發回滾事務。如果在事務中丟擲其他型別的異常,但卻期望 Spring 能夠回滾事務,就需要指定rollbackFor屬性。
// 希望自定義的異常可以進行回滾
@Transactional(propagation= Propagation.REQUIRED,rollbackFor= MyException.class
複製程式碼
若在目標方法中丟擲的異常是rollbackFor
指定的異常的子類,事務同樣會回滾。Spring原始碼如下:
private int getDepth(Class<?> exceptionClass, int depth) {
if (exceptionClass.getName().contains(this.exceptionName)) {
// Found it!
return depth;
}
// If we've gone as far as we can go and haven't found it...
if (exceptionClass == Throwable.class) {
return -1;
}
return getDepth(exceptionClass.getSuperclass(), depth + 1);
}
複製程式碼
4、同一個類中方法呼叫,導致@Transactional失效
開發中避免不了會對同一個類裡面的方法呼叫,比如有一個類Test,它的一個方法A,A再呼叫本類的方法B(不論方法B是用public還是private修飾),但方法A沒有宣告註解事務,而B方法有。則外部呼叫方法A之後,方法B的事務是不會起作用的。這也是經常犯錯誤的一個地方。
那為啥會出現這種情況?其實這還是由於使用Spring AOP
代理造成的,因為只有當事務方法被當前類以外的程式碼呼叫時,才會由Spring
生成的代理物件來管理。
//@Transactional
@GetMapping("/test")
private Integer A() throws Exception {
CityInfoDict cityInfoDict = new CityInfoDict();
cityInfoDict.setCityName("2");
/**
* B 插入欄位為 3的資料
*/
this.insertB();
/**
* A 插入欄位為 2的資料
*/
int insert = cityInfoDictMapper.insert(cityInfoDict);
return insert;
}
@Transactional()
public Integer insertB() throws Exception {
CityInfoDict cityInfoDict = new CityInfoDict();
cityInfoDict.setCityName("3");
cityInfoDict.setParentCityId(3);
return cityInfoDictMapper.insert(cityInfoDict);
}
複製程式碼
5、異常被你的 catch“吃了”導致@Transactional失效
這種情況是最常見的一種@Transactional註解失效場景,
@Transactional
private Integer A() throws Exception {
int insert = 0;
try {
CityInfoDict cityInfoDict = new CityInfoDict();
cityInfoDict.setCityName("2");
cityInfoDict.setParentCityId(2);
/**
* A 插入欄位為 2的資料
*/
insert = cityInfoDictMapper.insert(cityInfoDict);
/**
* B 插入欄位為 3的資料
*/
b.insertB();
} catch (Exception e) {
e.printStackTrace();
}
}
複製程式碼
如果B方法內部拋了異常,而A方法此時try catch了B方法的異常,那這個事務還能正常回滾嗎?
答案:不能!
會丟擲異常:
org.springframework.transaction.UnexpectedRollbackException: Transaction rolled back because it has been marked as rollback-only
複製程式碼
因為當ServiceB
中丟擲了一個異常以後,ServiceB
標識當前事務需要rollback
。但是ServiceA
中由於你手動的捕獲這個異常並進行處理,ServiceA
認為當前事務應該正常commit
。此時就出現了前後不一致,也就是因為這樣,丟擲了前面的UnexpectedRollbackException
異常。
spring
的事務是在呼叫業務方法之前開始的,業務方法執行完畢之後才執行commit
orrollback
,事務是否執行取決於是否丟擲runtime異常
。如果丟擲runtime exception
並在你的業務方法中沒有catch到的話,事務會回滾。
在業務方法中一般不需要catch異常,如果非要catch一定要丟擲throw new RuntimeException()
,或者註解中指定拋異常型別@Transactional(rollbackFor=Exception.class)
,否則會導致事務失效,資料commit造成資料不一致,所以有些時候try catch反倒會畫蛇添足。
6、資料庫引擎不支援事務
這種情況出現的概率並不高,事務能否生效資料庫引擎是否支援事務是關鍵。常用的MySQL資料庫預設使用支援事務的innodb
引擎。一旦資料庫引擎切換成不支援事務的myisam
,那事務就從根本上失效了。