上一篇中雖然解決了儡嘶,單例RedisTemplate在事務(wù)和非事務(wù)中混用的問題,但是這兩天又發(fā)現(xiàn)如果設(shè)置了RedisTemplate啟用事務(wù)(設(shè)置 redisTemplate.setEnableTransactionSupport(true))時恍风,如果在使用中不加@Transaction注解蹦狂,會造成Redis連接不會釋放的問題。
再來看一下RedisTemplate中的execute方法:
public <T> T execute(RedisCallback<T> action, boolean exposeConnection, boolean pipeline) {
Assert.isTrue(initialized, "template not initialized; call afterPropertiesSet() before using it");
Assert.notNull(action, "Callback object must not be null");
RedisConnectionFactory factory = getConnectionFactory();
RedisConnection conn = null;
try {
if (enableTransactionSupport) {
// only bind resources in case of potential transaction synchronization
//如果設(shè)置了啟用事務(wù)朋贬,則調(diào)用bindConnection
conn = RedisConnectionUtils.bindConnection(factory, enableTransactionSupport);
} else {
conn = RedisConnectionUtils.getConnection(factory);
}
boolean existingConnection = TransactionSynchronizationManager.hasResource(factory);
//預(yù)留鉤子函數(shù)可在執(zhí)行具體操作前對connection做一些處理
RedisConnection connToUse = preProcessConnection(conn, existingConnection);
boolean pipelineStatus = connToUse.isPipelined();
if (pipeline && !pipelineStatus) {
connToUse.openPipeline();
}
RedisConnection connToExpose = (exposeConnection ? connToUse : createRedisConnectionProxy(connToUse));
T result = action.doInRedis(connToExpose);
// close pipeline
if (pipeline && !pipelineStatus) {
connToUse.closePipeline();
}
// TODO: any other connection processing?
//預(yù)留鉤子函數(shù)可在執(zhí)行具體操作后對connection做一些處理
return postProcessResult(result, connToUse, existingConnection);
} finally {
RedisConnectionUtils.releaseConnection(conn, factory);
}
}
從源碼中可以看出在最后會調(diào)用 RedisConnectionUtils.releaseConnection來釋放連接
public static void releaseConnection(RedisConnection conn, RedisConnectionFactory factory) {
if (conn == null) {
return;
}
RedisConnectionHolder connHolder = (RedisConnectionHolder) TransactionSynchronizationManager.getResource(factory);
if (connHolder != null && connHolder.isTransactionSyncronisationActive()) {
if (log.isDebugEnabled()) {
log.debug("Redis Connection will be closed when transaction finished.");
}
return;
}
// release transactional/read-only and non-transactional/non-bound connections.
// transactional connections for read-only transactions get no synchronizer registered
if (isConnectionTransactional(conn, factory)
&& TransactionSynchronizationManager.isCurrentTransactionReadOnly()) {
unbindConnection(factory);
} else if (!isConnectionTransactional(conn, factory)) {
if (log.isDebugEnabled()) {
log.debug("Closing Redis Connection");
}
conn.close();
}
}
//判斷在當(dāng)前線程中是否能取得連接
public static boolean isConnectionTransactional(RedisConnection conn, RedisConnectionFactory connFactory) {
if (connFactory == null) {
return false;
}
RedisConnectionHolder connHolder = (RedisConnectionHolder) TransactionSynchronizationManager
.getResource(connFactory);
return (connHolder != null && conn == connHolder.getConnection());
}
釋放連接的代碼中有兩種情況會釋放連接
- 如果當(dāng)前線程中取到連接并且當(dāng)前事務(wù)不是只讀的
- 如果當(dāng)前線程中沒有取到連接
isConnectionTransaction(conn,factory)是判斷當(dāng)前線程中有沒有綁定連接
TransactionSynchronizationManager.isCurrentTransactionReadOnly() 是判斷當(dāng)前事務(wù)是不是只讀的
RedisTemplate的execute方法中可以看出凯楔,只要enableTransactionSupport設(shè)置為true,都會把連接綁定到當(dāng)前線程中,我在配置時設(shè)置了true。所以isConnectionTransaction(conn,factory)一直是true
第一個判斷 isConnectionTransaction(conn,factory) 返回true妨退,
TransactionSynchronizationManager.isCurrentTransactionReadOnly() 如果我在業(yè)務(wù)方法上沒有加@Transactional注解畏梆,這里會返回false
所以第一個if是進(jìn)不去的
第二個判斷 !isConnectionTransactional(conn, factory) 返回false,所以這個if也進(jìn)不去秆撮。
因此這種情況下會造成連接不能釋放
這里大概能看出來只要設(shè)置了enableTransactionSupport=true,任何調(diào)用RedisTemplate的方法,都必須放在事務(wù)中(也不值得算不算一個bug)
所以如果想要在非事務(wù)中用RedisTemplate必須設(shè)置enableTransactionSupport=false,才能釋放連接廷没。
由于現(xiàn)在的代碼中事務(wù)和非事務(wù)的方法用的都是同一個開啟的事務(wù)支持的RedisTemplate,要改的地方比較多垂寥,并且在使用如果還要考慮是否是在事務(wù)中執(zhí)行比較麻煩并且容易出錯颠黎。
我這里的解決方案是:使用兩個RedisTemplate來解決此問題
1.創(chuàng)建了一個RedisTemplateDelegate 繼承自RedisTemplate, 這個類開啟事務(wù)支持,此類還用于代理所有與enableTransactionSupport屬性相關(guān)的方法
2.這個類中有個屬性notSupportTransactionRedisTemplate滞项,需要注入一個沒有開啟事務(wù)支持的RedisTemplate狭归。
3.RedisTemplateDelegate 中重寫了所有跟 enableTransactionSupport 屬性有關(guān)的方法。
4.通過TransactionSynchronizationManager.isActualTransactionActive()判斷 是否在事務(wù)環(huán)境中運(yùn)行(是否添加了@Transactional注解)來確定使用哪個RedisTemplate來執(zhí)行redis操作
具體代碼如下:
public class RedisTemplateDelegate<K, V> extends RedisTemplate<K, V> {
@Resource(name = "notSupportTransactionRedisTemplate")
private RedisTemplate<K, V> notSupportTransactionRedisTemplate;
@Override
public <T> T execute(RedisCallback<T> action, boolean exposeConnection, boolean pipeline) {
//判斷是否有@Transactional注解蓖扑,如果有就用支持事務(wù)的RedisTemplate
if (TransactionSynchronizationManager.isActualTransactionActive()) {
return super.execute(action, exposeConnection, pipeline);
} else {
return notSupportTransactionRedisTemplate.execute(action, exposeConnection, pipeline);
}
}
@Override
public <T> T execute(SessionCallback<T> session) {
if (TransactionSynchronizationManager.isActualTransactionActive()) {
return super.execute(session);
} else {
return notSupportTransactionRedisTemplate.execute(session);
}
}
@Override
public List<Object> executePipelined(final SessionCallback<?> session, final RedisSerializer<?> resultSerializer) {
if (TransactionSynchronizationManager.isActualTransactionActive()) {
return super.executePipelined(session, resultSerializer);
} else {
return notSupportTransactionRedisTemplate.executePipelined(session, resultSerializer);
}
}
}
Spring boot中的配置
通過此方案同樣也解決了上篇中存在的問題唉铜,并且更代碼更清晰點(diǎn)了台舱。