前言
使用Spring-Jdbc的情況下，在有些場(chǎng)景中没佑，我們需要根據(jù)數(shù)據(jù)庫(kù)報(bào)的異常類型的不同，來(lái)編寫我們的業(yè)務(wù)代碼温赔。比如說(shuō)蛤奢，我們有這樣一段邏輯，如果我們新插入的記錄陶贼，存在唯一約束沖突啤贩，就會(huì)返回給客戶端描述：記錄已存在，請(qǐng)勿重復(fù)操作
代碼一般是這么寫的：
@Resource
private JdbcTemplate jdbcTemplate;
public String testAdd(){
try {
jdbcTemplate.execute("INSERT INTO user_info (user_id, user_name, email, nick_name, status, address) VALUES (80002, '張三豐', 'xxx@126.com', '張真人', 1, '武當(dāng)山');");
return "OK";
}catch (DuplicateKeyException e){
return "記錄已存在拜秧，請(qǐng)勿重復(fù)操作";
}
}
測(cè)試一下：
file
如上圖提示痹屹，并且無(wú)論什么更換什么數(shù)據(jù)庫(kù)（Spring-Jdbc支持的），代碼都不用改動(dòng)
那么Spring-Jdbc是在使用不同數(shù)據(jù)庫(kù)時(shí)枉氮，Spring如何幫我們實(shí)現(xiàn)對(duì)異常的抽象的呢?
代碼實(shí)現(xiàn)
我們來(lái)正向看下代碼：
首先入口JdbcTemplate.execute方法：
public void execute(final String sql) throws DataAccessException {
if (this.logger.isDebugEnabled()) {
this.logger.debug("Executing SQL statement [" + sql + "]");
}
...
//實(shí)際執(zhí)行入口
this.execute(new ExecuteStatementCallback(), true);
}
內(nèi)部方法execute
@Nullable
private <T> T execute(StatementCallback<T> action, boolean closeResources) throws DataAccessException {
Assert.notNull(action, "Callback object must not be null");
Connection con = DataSourceUtils.getConnection(this.obtainDataSource());
Statement stmt = null;
Object var12;
try {
stmt = con.createStatement();
this.applyStatementSettings(stmt);
T result = action.doInStatement(stmt);
this.handleWarnings(stmt);
var12 = result;
} catch (SQLException var10) {
String sql = getSql(action);
JdbcUtils.closeStatement(stmt);
stmt = null;
DataSourceUtils.releaseConnection(con, this.getDataSource());
con = null;
//SQL出現(xiàn)異常后志衍，在這里進(jìn)行異常轉(zhuǎn)換
throw this.translateException("StatementCallback", sql, var10);
} finally {
if (closeResources) {
JdbcUtils.closeStatement(stmt);
DataSourceUtils.releaseConnection(con, this.getDataSource());
}
}
return var12;
}
異常轉(zhuǎn)換方法translateException
protected DataAccessException translateException(String task, @Nullable String sql, SQLException ex) {
//獲取異常轉(zhuǎn)換器，然后根據(jù)數(shù)據(jù)庫(kù)返回碼相關(guān)信息執(zhí)行轉(zhuǎn)換操作
//轉(zhuǎn)換不成功聊替，也有兜底異常UncategorizedSQLException
DataAccessException dae = this.getExceptionTranslator().translate(task, sql, ex);
return (DataAccessException)(dae != null ? dae : new UncategorizedSQLException(task, sql, ex));
}
獲取轉(zhuǎn)換器方法getExceptionTranslator
public SQLExceptionTranslator getExceptionTranslator() {
//獲取轉(zhuǎn)換器屬性楼肪，如果為空，則生成一個(gè)
SQLExceptionTranslator exceptionTranslator = this.exceptionTranslator;
if (exceptionTranslator != null) {
return exceptionTranslator;
} else {
synchronized(this) {
SQLExceptionTranslator exceptionTranslator = this.exceptionTranslator;
if (exceptionTranslator == null) {
DataSource dataSource = this.getDataSource();
//shouldIgnoreXml是一個(gè)標(biāo)記惹悄，就是不通過(guò)xml加載bean春叫，默認(rèn)false
if (shouldIgnoreXml) {
exceptionTranslator = new SQLExceptionSubclassTranslator();
} else if (dataSource != null) {
//如果DataSource不為空，則生成轉(zhuǎn)換器SQLErrorCodeSQLExceptionTranslator
exceptionTranslator = new SQLErrorCodeSQLExceptionTranslator(dataSource);
} else {
// 其他情況泣港，生成SQLStateSQLExceptionTranslator轉(zhuǎn)換器
exceptionTranslator = new SQLStateSQLExceptionTranslator();
}
this.exceptionTranslator = (SQLExceptionTranslator)exceptionTranslator;
}
return (SQLExceptionTranslator)exceptionTranslator;
}
}
}
轉(zhuǎn)換方法：
因?yàn)槟J(rèn)的轉(zhuǎn)換器是SQLErrorCodeSQLExceptionTranslator暂殖，所以這里調(diào)用SQLErrorCodeSQLExceptionTranslator的doTranslate方法
file
類圖調(diào)用關(guān)系如上，實(shí)際先調(diào)用的是AbstractFallbackSQLExceptionTranslator.translate的方法
@Nullable
public DataAccessException translate(String task, @Nullable String sql, SQLException ex) {
Assert.notNull(ex, "Cannot translate a null SQLException");
//這里才真正調(diào)用SQLErrorCodeSQLExceptionTranslator.doTranslate方法
DataAccessException dae = this.doTranslate(task, sql, ex);
if (dae != null) {
return dae;
} else {
//如果沒有找到響應(yīng)的異常当纱，則調(diào)用其他轉(zhuǎn)換器呛每，輸入遞歸調(diào)用，這里后面說(shuō)
SQLExceptionTranslator fallback = this.getFallbackTranslator();
return fallback != null ? fallback.translate(task, sql, ex) : null;
}
}
實(shí)際轉(zhuǎn)換類SQLErrorCodeSQLExceptionTranslator的方法：
//這里省略了一些無(wú)關(guān)代碼惫东，只保留了核心代碼
//先獲取SQLErrorCodes集合莉给，在根據(jù)返回的SQLException中獲取的ErrorCode進(jìn)行匹配，根據(jù)匹配結(jié)果進(jìn)行返回響應(yīng)的異常
protected DataAccessException doTranslate(String task, @Nullable String sql, SQLException ex) {
....
SQLErrorCodes sqlErrorCodes = this.getSqlErrorCodes();
String errorCode = Integer.toString(ex.getErrorCode());
...
if (Arrays.binarySearch(sqlErrorCodes.getDuplicateKeyCodes(), errorCode) >= 0) {
this.logTranslation(task, sql, sqlEx, false);
return new DuplicateKeyException(this.buildMessage(task, sql, sqlEx), sqlEx);
}
...
return null;
}
上面的SQLErrorCodes是一個(gè)錯(cuò)誤碼集合廉沮，但是不是全部數(shù)據(jù)庫(kù)的所有錯(cuò)誤碼集合颓遏，而是只取了相應(yīng)數(shù)據(jù)庫(kù)的錯(cuò)誤碼集合，怎么保證獲取的是當(dāng)前使用的數(shù)據(jù)庫(kù)的錯(cuò)誤碼滞时，而不是其他數(shù)據(jù)庫(kù)的錯(cuò)誤碼呢叁幢？當(dāng)然Spring為我們實(shí)現(xiàn)了，在SQLErrorCodeSQLExceptionTranslator中：
public class SQLErrorCodeSQLExceptionTranslator extends AbstractFallbackSQLExceptionTranslator {
private SingletonSupplier<SQLErrorCodes> sqlErrorCodes;
//默認(rèn)構(gòu)造方法坪稽，設(shè)置了如果轉(zhuǎn)換失敗曼玩，下一個(gè)轉(zhuǎn)換器是SQLExceptionSubclassTranslator
public SQLErrorCodeSQLExceptionTranslator() {
this.setFallbackTranslator(new SQLExceptionSubclassTranslator());
}
//前面生成轉(zhuǎn)換器的時(shí)候鳞骤，exceptionTranslator = new SQLErrorCodeSQLExceptionTranslator(dataSource);
//使用的是本構(gòu)造方法，傳入了DataSource黍判，其中有數(shù)據(jù)庫(kù)廠商信息豫尽，本文中是MYSQL
public SQLErrorCodeSQLExceptionTranslator(DataSource dataSource) {
this();
this.setDataSource(dataSource);
}
//從錯(cuò)誤碼工廠SQLErrorCodesFactory里，獲取和數(shù)據(jù)源對(duì)應(yīng)的廠商的所有錯(cuò)誤碼
public void setDataSource(DataSource dataSource) {
this.sqlErrorCodes = SingletonSupplier.of(() -> {
return SQLErrorCodesFactory.getInstance().resolveErrorCodes(dataSource);
});
this.sqlErrorCodes.get();
}
}
錯(cuò)誤碼工廠SQLErrorCodesFactory的resolveErrorCodes方法：
//既然是工廠顷帖，里面肯定有各種數(shù)據(jù)庫(kù)的錯(cuò)誤碼美旧，本文中使用的是MYSQL，我們看一下實(shí)現(xiàn)邏輯
@Nullable
public SQLErrorCodes resolveErrorCodes(DataSource dataSource) {
Assert.notNull(dataSource, "DataSource must not be null");
if (logger.isDebugEnabled()) {
logger.debug("Looking up default SQLErrorCodes for DataSource [" + this.identify(dataSource) + "]");
}
//從緩存中拿MYSQL對(duì)應(yīng)的SQLErrorCodes
SQLErrorCodes sec = (SQLErrorCodes)this.dataSourceCache.get(dataSource);
if (sec == null) {
synchronized(this.dataSourceCache) {
sec = (SQLErrorCodes)this.dataSourceCache.get(dataSource);
if (sec == null) {
try {
String name = (String)JdbcUtils.extractDatabaseMetaData(dataSource, DatabaseMetaData::getDatabaseProductName);
if (StringUtils.hasLength(name)) {
SQLErrorCodes var10000 = this.registerDatabase(dataSource, name);
return var10000;
}
} catch (MetaDataAccessException var6) {
logger.warn("Error while extracting database name", var6);
}
return null;
}
}
}
if (logger.isDebugEnabled()) {
logger.debug("SQLErrorCodes found in cache for DataSource [" + this.identify(dataSource) + "]");
}
return sec;
}
**緩存dataSourceCache如何生成的贬墩？ **
public SQLErrorCodes registerDatabase(DataSource dataSource, String databaseName) {
//根據(jù)數(shù)據(jù)庫(kù)類型名稱（這里是MySQL）榴嗅，獲取錯(cuò)誤碼列表
SQLErrorCodes sec = this.getErrorCodes(databaseName);
if (logger.isDebugEnabled()) {
logger.debug("Caching SQL error codes for DataSource [" + this.identify(dataSource) + "]: database product name is '" + databaseName + "'");
}
this.dataSourceCache.put(dataSource, sec);
return sec;
}
public SQLErrorCodes getErrorCodes(String databaseName) {
Assert.notNull(databaseName, "Database product name must not be null");
//從errorCodesMap根據(jù)key=MYSQL獲取SQLErrorCodes
SQLErrorCodes sec = (SQLErrorCodes)this.errorCodesMap.get(databaseName);
if (sec == null) {
Iterator var3 = this.errorCodesMap.values().iterator();
while(var3.hasNext()) {
SQLErrorCodes candidate = (SQLErrorCodes)var3.next();
if (PatternMatchUtils.simpleMatch(candidate.getDatabaseProductNames(), databaseName)) {
sec = candidate;
break;
}
}
}
if (sec != null) {
this.checkCustomTranslatorRegistry(databaseName, sec);
if (logger.isDebugEnabled()) {
logger.debug("SQL error codes for '" + databaseName + "' found");
}
return sec;
} else {
if (logger.isDebugEnabled()) {
logger.debug("SQL error codes for '" + databaseName + "' not found");
}
return new SQLErrorCodes();
}
}
//SQLErrorCodesFactory構(gòu)造方法中，生成的errorCodesMap陶舞，map的內(nèi)容來(lái)自org/springframework/jdbc/support/sql-error-codes.xml文件
protected SQLErrorCodesFactory() {
Map errorCodes;
try {
DefaultListableBeanFactory lbf = new DefaultListableBeanFactory();
lbf.setBeanClassLoader(this.getClass().getClassLoader());
XmlBeanDefinitionReader bdr = new XmlBeanDefinitionReader(lbf);
Resource resource = this.loadResource("org/springframework/jdbc/support/sql-error-codes.xml");
if (resource != null && resource.exists()) {
bdr.loadBeanDefinitions(resource);
} else {
logger.info("Default sql-error-codes.xml not found (should be included in spring-jdbc jar)");
}
resource = this.loadResource("sql-error-codes.xml");
if (resource != null && resource.exists()) {
bdr.loadBeanDefinitions(resource);
logger.debug("Found custom sql-error-codes.xml file at the root of the classpath");
}
errorCodes = lbf.getBeansOfType(SQLErrorCodes.class, true, false);
if (logger.isTraceEnabled()) {
logger.trace("SQLErrorCodes loaded: " + errorCodes.keySet());
}
} catch (BeansException var5) {
logger.warn("Error loading SQL error codes from config file", var5);
errorCodes = Collections.emptyMap();
}
this.errorCodesMap = errorCodes;
}
sql-error-codes.xml文件中配置了各個(gè)數(shù)據(jù)庫(kù)的主要的錯(cuò)誤碼
這里列舉了MYSQL部分嗽测，當(dāng)然還有其他部分，我們可以看到唯一性約束錯(cuò)誤碼是1062肿孵，就可以翻譯成DuplicateKeyException異常了
<bean id="MySQL" class="org.springframework.jdbc.support.SQLErrorCodes">
<property name="databaseProductNames">
<list>
<value>MySQL</value>
<value>MariaDB</value>
</list>
</property>
<property name="badSqlGrammarCodes">
<value>1054,1064,1146</value>
</property>
<property name="duplicateKeyCodes">
<value>1062</value>
</property>
<property name="dataIntegrityViolationCodes">
<value>630,839,840,893,1169,1215,1216,1217,1364,1451,1452,1557</value>
</property>
<property name="dataAccessResourceFailureCodes">
<value>1</value>
</property>
<property name="cannotAcquireLockCodes">
<value>1205,3572</value>
</property>
<property name="deadlockLoserCodes">
<value>1213</value>
</property>
</bean>
你已經(jīng)看到唠粥，比如上面的錯(cuò)誤碼值列舉了一部分，如果出現(xiàn)了一個(gè)不在其中的錯(cuò)誤碼肯定是匹配不到颁井，Spring當(dāng)然能想到這種情況了
/**
*@公-眾-號(hào)：程序員阿牛
*在AbstractFallbackSQLExceptionTranslator中厅贪，看到如果查找失敗會(huì)獲取下一個(gè)后續(xù)轉(zhuǎn)換器
*/
@Nullable
public DataAccessException translate(String task, @Nullable String sql, SQLException ex) {
Assert.notNull(ex, "Cannot translate a null SQLException");
DataAccessException dae = this.doTranslate(task, sql, ex);
if (dae != null) {
return dae;
} else {
SQLExceptionTranslator fallback = this.getFallbackTranslator();
return fallback != null ? fallback.translate(task, sql, ex) : null;
}
}
SQLErrorCodeSQLExceptionTranslator的后置轉(zhuǎn)換器是什么？
//構(gòu)造方法中已經(jīng)指定雅宾，SQLExceptionSubclassTranslator
public SQLErrorCodeSQLExceptionTranslator() {
this.setFallbackTranslator(new SQLExceptionSubclassTranslator());
}
SQLExceptionSubclassTranslator的轉(zhuǎn)換方法邏輯如下：
/**
*@公-眾-號(hào)：程序員阿牛
*可以看出實(shí)際按照子類類型來(lái)判斷养涮，返回相應(yīng)的錯(cuò)誤類，如果匹配不到眉抬，則找到下一個(gè)處理器贯吓，這里的處理其我們可以根據(jù)構(gòu)造方法青松找到*SQLStateSQLExceptionTranslator
*/
@Nullable
protected DataAccessException doTranslate(String task, @Nullable String sql, SQLException ex) {
if (ex instanceof SQLTransientException) {
if (ex instanceof SQLTransientConnectionException) {
return new TransientDataAccessResourceException(this.buildMessage(task, sql, ex), ex);
}
if (ex instanceof SQLTransactionRollbackException) {
return new ConcurrencyFailureException(this.buildMessage(task, sql, ex), ex);
}
if (ex instanceof SQLTimeoutException) {
return new QueryTimeoutException(this.buildMessage(task, sql, ex), ex);
}
} else if (ex instanceof SQLNonTransientException) {
if (ex instanceof SQLNonTransientConnectionException) {
return new DataAccessResourceFailureException(this.buildMessage(task, sql, ex), ex);
}
if (ex instanceof SQLDataException) {
return new DataIntegrityViolationException(this.buildMessage(task, sql, ex), ex);
}
if (ex instanceof SQLIntegrityConstraintViolationException) {
return new DataIntegrityViolationException(this.buildMessage(task, sql, ex), ex);
}
if (ex instanceof SQLInvalidAuthorizationSpecException) {
return new PermissionDeniedDataAccessException(this.buildMessage(task, sql, ex), ex);
}
if (ex instanceof SQLSyntaxErrorException) {
return new BadSqlGrammarException(task, sql != null ? sql : "", ex);
}
if (ex instanceof SQLFeatureNotSupportedException) {
return new InvalidDataAccessApiUsageException(this.buildMessage(task, sql, ex), ex);
}
} else if (ex instanceof SQLRecoverableException) {
return new RecoverableDataAccessException(this.buildMessage(task, sql, ex), ex);
}
return null;
}
SQLStateSQLExceptionTranslator的轉(zhuǎn)換方法：
/**
*@公-眾-號(hào)：程序員阿牛
*可以看出根據(jù)SQLState的前兩位來(lái)判斷異常，根據(jù)匹配結(jié)果返回相應(yīng)的異常信息
*/
@Nullable
protected DataAccessException doTranslate(String task, @Nullable String sql, SQLException ex) {
String sqlState = this.getSqlState(ex);
if (sqlState != null && sqlState.length() >= 2) {
String classCode = sqlState.substring(0, 2);
if (this.logger.isDebugEnabled()) {
this.logger.debug("Extracted SQL state class '" + classCode + "' from value '" + sqlState + "'");
}
if (BAD_SQL_GRAMMAR_CODES.contains(classCode)) {
return new BadSqlGrammarException(task, sql != null ? sql : "", ex);
}
if (DATA_INTEGRITY_VIOLATION_CODES.contains(classCode)) {
return new DataIntegrityViolationException(this.buildMessage(task, sql, ex), ex);
}
if (DATA_ACCESS_RESOURCE_FAILURE_CODES.contains(classCode)) {
return new DataAccessResourceFailureException(this.buildMessage(task, sql, ex), ex);
}
if (TRANSIENT_DATA_ACCESS_RESOURCE_CODES.contains(classCode)) {
return new TransientDataAccessResourceException(this.buildMessage(task, sql, ex), ex);
}
if (CONCURRENCY_FAILURE_CODES.contains(classCode)) {
return new ConcurrencyFailureException(this.buildMessage(task, sql, ex), ex);
}
}
return ex.getClass().getName().contains("Timeout") ? new QueryTimeoutException(this.buildMessage(task, sql, ex), ex) : null;
}
為什么SQLState可以得出錯(cuò)誤類型蜀变？
因?yàn)閿?shù)據(jù)庫(kù)是根據(jù) X/Open 和 SQL Access Group SQL CAE 規(guī)范 (1992) 所進(jìn)行的定義悄谐，SQLERROR 返回 SQLSTATE 值。SQLSTATE 值是包含五個(gè)字符的字符串 库北。五個(gè)字符包含數(shù)值或者大寫字母爬舰， 代表各種錯(cuò)誤或者警告條件的代碼。SQLSTATE 有個(gè)層次化的模式：頭兩個(gè)字符標(biāo)識(shí)條件的通常表示錯(cuò)誤條件的類別寒瓦， 后三個(gè)字符表示在該通用類中的子類情屹。成功的狀態(tài)是由 00000 標(biāo)識(shí)的。SQLSTATE 代碼在大多數(shù)地方都是定義在 SQL 標(biāo)準(zhǔn)里
處理流程圖
file
用到了哪些設(shè)計(jì)模式杂腰？
組合模式
file
通過(guò)上圖大家有沒有發(fā)現(xiàn)三個(gè)實(shí)現(xiàn)類之間的關(guān)系—組合關(guān)系垃你，組合關(guān)系在父類AbstractFallbackSQLExceptionTranslator中變成了遞歸調(diào)用，這里充滿了智慧(Composite設(shè)計(jì)模式)。
單例模式
在SQLErrorCodesFactory（單例模式）
策略模式
根據(jù)數(shù)據(jù)庫(kù)的不同惜颇，獲取不同的errorcodes集合
---------------------END---------------------
關(guān)注：程序員阿牛皆刺，Spring系列更多文章，為你呈現(xiàn)
