Skip to content

Commit

Permalink
AMQP-824: Name for deferredCloseExec thread pool
Browse files Browse the repository at this point in the history 
JIRA https://jira.spring.io/browse/AMQP-824

Taking the comments into account

Fix build

* Polishing for code style

**Cherry-pick to 2.0.x & 2.1.x**
  • Loading branch information
@artembilan
Will Droste authored and artembilan committed Jul 13, 2018
1 parent 922994f commit 7bf27de
Show file tree
Hide file tree
Showing 3 changed files with 85 additions and 29 deletions.
13 changes: 12 additions & 1 deletion ...t/src/main/java/org/springframework/amqp/rabbit/connection/AbstractConnectionFactory.java
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2002-2016 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -51,6 +51,7 @@
* @author Gary Russell
* @author Steve Powell
* @author Artem Bilan
* @author Will Droste
*
*/
public abstract class AbstractConnectionFactory implements ConnectionFactory, DisposableBean, BeanNameAware {
Expand Down Expand Up @@ -343,6 +344,16 @@ public void setBeanName(String name) {
this.beanName = name;
}

/**
* Return a bean name of the component or null if not a bean.
* @return the bean name or null.
* @since 1.7.9
*/
protected String getBeanName() {
return this.beanName;
}


protected final Connection createBareConnection() {
try {
String connectionName = this.connectionNameStrategy == null ? null
Expand Down
87 changes: 63 additions & 24 deletions ...it/src/main/java/org/springframework/amqp/rabbit/connection/CachingConnectionFactory.java
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -36,6 +36,7 @@
import java.util.concurrent.Executors;
import java.util.concurrent.LinkedBlockingDeque;
import java.util.concurrent.Semaphore;
import java.util.concurrent.ThreadFactory;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
import java.util.concurrent.atomic.AtomicBoolean;
Expand All @@ -56,6 +57,7 @@
import org.springframework.context.event.ContextClosedEvent;
import org.springframework.jmx.export.annotation.ManagedAttribute;
import org.springframework.jmx.export.annotation.ManagedResource;
import org.springframework.scheduling.concurrent.CustomizableThreadFactory;
import org.springframework.util.Assert;
import org.springframework.util.ObjectUtils;
import org.springframework.util.StringUtils;
Expand Down Expand Up @@ -92,14 +94,22 @@
* @author Gary Russell
* @author Artem Bilan
* @author Steve Powell
* @author Will Droste
*/
@ManagedResource
public class CachingConnectionFactory extends AbstractConnectionFactory
implements InitializingBean, ShutdownListener, ApplicationContextAware, ApplicationListener<ContextClosedEvent>,
PublisherCallbackChannelConnectionFactory {
PublisherCallbackChannelConnectionFactory {

private static final int DEFAULT_CHANNEL_CACHE_SIZE = 25;

private static final String DEFAULT_DEFERRED_POOL_PREFIX = "spring-rabbit-deferred-pool-";

/**
* Create a unique ID for the pool
*/
private static final AtomicInteger threadPoolId = new AtomicInteger();

private static final Set<String> txStarts = new HashSet<String>(Arrays.asList("basicPublish", "basicAck", "basicNack",
"basicReject"));

Expand All @@ -122,10 +132,10 @@ public enum CacheMode {
new HashSet<ChannelCachingConnectionProxy>();

private final Map<ChannelCachingConnectionProxy, LinkedList<ChannelProxy>>
allocatedConnectionNonTransactionalChannels = new HashMap<ChannelCachingConnectionProxy, LinkedList<ChannelProxy>>();
allocatedConnectionNonTransactionalChannels = new HashMap<ChannelCachingConnectionProxy, LinkedList<ChannelProxy>>();

private final Map<ChannelCachingConnectionProxy, LinkedList<ChannelProxy>>
allocatedConnectionTransactionalChannels = new HashMap<ChannelCachingConnectionProxy, LinkedList<ChannelProxy>>();
allocatedConnectionTransactionalChannels = new HashMap<ChannelCachingConnectionProxy, LinkedList<ChannelProxy>>();

private final BlockingDeque<ChannelCachingConnectionProxy> idleConnections =
new LinkedBlockingDeque<ChannelCachingConnectionProxy>();
Expand Down Expand Up @@ -166,12 +176,15 @@ public enum CacheMode {

private volatile ConditionalExceptionLogger closeExceptionLogger = new DefaultChannelCloseLogger();

/** Synchronization monitor for the shared Connection */
/**
* Synchronization monitor for the shared Connection
*/
private final Object connectionMonitor = new Object();

/** Executor used for deferred close if no explicit executor set. */
private final ExecutorService deferredCloseExecutor = Executors.newCachedThreadPool();

/**
* Executor used for deferred close if no explicit executor set.
*/
private ExecutorService deferredCloseExecutor;

/**
* Create a new CachingConnectionFactory initializing the hostname to be the value returned from
Expand Down Expand Up @@ -406,7 +419,7 @@ private Channel getChannel(ChannelCachingConnectionProxy connection, boolean tra
}
if (logger.isDebugEnabled()) {
logger.debug(
"Acquired permit for " + connection + ", remaining:" + checkoutPermits.availablePermits());
"Acquired permit for " + connection + ", remaining:" + checkoutPermits.availablePermits());
}
}
catch (InterruptedException e) {
Expand Down Expand Up @@ -486,7 +499,7 @@ private Channel getChannel(ChannelCachingConnectionProxy connection, boolean tra
checkoutPermits.release();
if (logger.isDebugEnabled()) {
logger.debug("Could not get channel; released permit for " + connection + ", remaining:"
+ checkoutPermits.availablePermits());
+ checkoutPermits.availablePermits());
}
}
throw e;
Expand Down Expand Up @@ -692,7 +705,9 @@ public final void destroy() {
resetConnection();
if (this.contextStopped) {
this.stopped = true;
this.deferredCloseExecutor.shutdownNow();
if (this.deferredCloseExecutor != null) {
this.deferredCloseExecutor.shutdownNow();
}
}
}

Expand Down Expand Up @@ -820,12 +835,12 @@ public Properties getCacheProperties() {
props.setProperty("connectionCacheSize", Integer.toString(this.connectionCacheSize));
props.setProperty("openConnections", Integer.toString(countOpenConnections()));
props.setProperty("idleConnections", Integer.toString(this.idleConnections.size()));
props.setProperty("idleConnectionsHighWater", Integer.toString(this.connectionHighWaterMark.get()));
props.setProperty("idleConnectionsHighWater", Integer.toString(this.connectionHighWaterMark.get()));
for (ChannelCachingConnectionProxy proxy : this.allocatedConnections) {
putConnectionName(props, proxy, ":" + proxy.getLocalPort());
}
for (Entry<ChannelCachingConnectionProxy, LinkedList<ChannelProxy>> entry :
this.allocatedConnectionTransactionalChannels.entrySet()) {
this.allocatedConnectionTransactionalChannels.entrySet()) {
int port = entry.getKey().getLocalPort();
if (port > 0 && entry.getKey().isOpen()) {
LinkedList<ChannelProxy> channelList = entry.getValue();
Expand All @@ -835,7 +850,7 @@ public Properties getCacheProperties() {
}
}
for (Entry<ChannelCachingConnectionProxy, LinkedList<ChannelProxy>> entry :
this.allocatedConnectionNonTransactionalChannels.entrySet()) {
this.allocatedConnectionNonTransactionalChannels.entrySet()) {
int port = entry.getKey().getLocalPort();
if (port > 0 && entry.getKey().isOpen()) {
LinkedList<ChannelProxy> channelList = entry.getValue();
Expand Down Expand Up @@ -880,6 +895,28 @@ private int countOpenConnections() {
return n;
}

/**
* Determine the executor service used to close connections.
* @return specified executor service otherwise the default one is created and returned.
* @since 1.7.9
*/
protected ExecutorService getDeferredCloseExecutor() {
if (getExecutorService() != null) {
return getExecutorService();
}
synchronized (this.connectionMonitor) {
if (this.deferredCloseExecutor == null) {
final String threadPrefix =
getBeanName() == null
? DEFAULT_DEFERRED_POOL_PREFIX + threadPoolId.incrementAndGet()
: getBeanName();
ThreadFactory threadPoolFactory = new CustomizableThreadFactory(threadPrefix);
this.deferredCloseExecutor = Executors.newCachedThreadPool(threadPoolFactory);
}
}
return this.deferredCloseExecutor;
}

@Override
public String toString() {
return "CachingConnectionFactory [channelCacheSize=" + this.channelCacheSize + ", host=" + getHost()
Expand Down Expand Up @@ -1033,7 +1070,7 @@ private void releasePermitIfNecessary(Object proxy) {
checkoutPermits.release();
if (logger.isDebugEnabled()) {
logger.debug("Released permit for '" + this.theConnection + "', remaining: "
+ checkoutPermits.availablePermits());
+ checkoutPermits.availablePermits());
}
}
else {
Expand Down Expand Up @@ -1097,9 +1134,7 @@ private void physicalClose() throws Exception {
if (CachingConnectionFactory.this.active &&
(CachingConnectionFactory.this.publisherConfirms ||
CachingConnectionFactory.this.publisherReturns)) {
ExecutorService executorService = (getExecutorService() != null
? getExecutorService()
: CachingConnectionFactory.this.deferredCloseExecutor);
ExecutorService executorService = getDeferredCloseExecutor();
final Channel channel = CachedChannelInvocationHandler.this.target;
executorService.execute(new Runnable() {

Expand All @@ -1116,14 +1151,18 @@ public void run() {
catch (InterruptedException e) {
Thread.currentThread().interrupt();
}
catch (Exception e) { }
catch (Exception e) {
}
finally {
try {
channel.close();
}
catch (IOException e) { }
catch (AlreadyClosedException e) { }
catch (TimeoutException e) { }
catch (IOException e) {
}
catch (AlreadyClosedException e) {
}
catch (TimeoutException e) {
}
catch (ShutdownSignalException e) {
if (!RabbitUtils.isNormalShutdown(e)) {
logger.debug("Unexpected exception on deferred close", e);
Expand Down Expand Up @@ -1253,8 +1292,8 @@ public int getLocalPort() {
@Override
public String toString() {
return "Proxy@" + ObjectUtils.getIdentityHexString(this) + " "
+ (CachingConnectionFactory.this.cacheMode == CacheMode.CHANNEL ? "Shared " : "Dedicated ")
+ "Rabbit Connection: " + this.target;
+ (CachingConnectionFactory.this.cacheMode == CacheMode.CHANNEL ? "Shared " : "Dedicated ")
+ "Rabbit Connection: " + this.target;
}

}
Expand Down
14 changes: 10 additions & 4 deletions .../java/org/springframework/amqp/rabbit/config/ListenerContainerPlaceholderParserTests.java
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2010-2016 the original author or authors.
* Copyright 2010-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand All @@ -20,6 +20,7 @@
import static org.junit.Assert.assertTrue;

import java.util.Arrays;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.ThreadPoolExecutor;

import org.junit.After;
Expand All @@ -42,6 +43,7 @@
/**
* @author Dave Syer
* @author Gary Russell
* @author Will Droste
*/
public final class ListenerContainerPlaceholderParserTests {

Expand All @@ -58,14 +60,18 @@ public void closeBeanFactory() throws Exception {
if (this.context != null) {
CachingConnectionFactory cf = this.context.getBean(CachingConnectionFactory.class);
this.context.close();
assertTrue(TestUtils.getPropertyValue(cf, "deferredCloseExecutor", ThreadPoolExecutor.class)
.isTerminated());
ExecutorService es = TestUtils.getPropertyValue(cf, "deferredCloseExecutor", ThreadPoolExecutor.class);
if (es != null) {
// if it gets started make sure its terminated..
assertTrue(es.isTerminated());
}
}
}

@Test
public void testParseWithQueueNames() throws Exception {
SimpleMessageListenerContainer container = this.context.getBean("testListener", SimpleMessageListenerContainer.class);
SimpleMessageListenerContainer container =
this.context.getBean("testListener", SimpleMessageListenerContainer.class);
assertEquals(AcknowledgeMode.MANUAL, container.getAcknowledgeMode());
assertEquals(this.context.getBean(ConnectionFactory.class), container.getConnectionFactory());
assertEquals(MessageListenerAdapter.class, container.getMessageListener().getClass());
Expand Down

0 comments on commit 7bf27de

Please sign in to comment.