Spring/spring-boot
Spring/spring-boot
1
0
Fork 0
mirror of https://github.com/spring-projects/spring-boot.git synced 2024-09-03 04:26:12 +08:00
Code Issues Packages Projects Releases Wiki Activity

Disable bind on init for all Tomcat connectors

Browse Source 
If a connector is bound on init, it won't be unbound when stop()
is called. This leaves the connector running when it should have
been stopped. We currently disable bind on init for the main
connector but not for any additional connectors. This commit
disables bind on it for all connectors unless it is been
explicitly enabled through the bindOnInit property.

Closes gh-38564

Co-authored-by: Moritz Halbritter <moritz.halbritter@broadcom.com>
This commit is contained in:
Andy Wilkinson 2023-11-29 14:02:43 +00:00
parent 62a6d384f6
commit 8de81cb06e
4 changed files with 36 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/embedded/tomcat/TomcatReactiveWebServerFactory.java
View File

@ -200,8 +200,6 @@ public class TomcatReactiveWebServerFactory extends AbstractReactiveWebServerFac
if (getUriEncoding() != null) {
connector.setURIEncoding(getUriEncoding().name());
}
// Don't bind to the socket prematurely if ApplicationContext is slow to start
connector.setProperty("bindOnInit", "false");
if (getHttp2() != null && getHttp2().isEnabled()) {
connector.addUpgradeProtocol(new Http2Protocol());
}

2
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/embedded/tomcat/TomcatServletWebServerFactory.java
View File

@ -342,8 +342,6 @@ public class TomcatServletWebServerFactory extends AbstractServletWebServerFacto
if (getUriEncoding() != null) {
connector.setURIEncoding(getUriEncoding().name());
}
// Don't bind to the socket prematurely if ApplicationContext is slow to start
connector.setProperty("bindOnInit", "false");
if (getHttp2() != null && getHttp2().isEnabled()) {
connector.addUpgradeProtocol(new Http2Protocol());
}

24
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/embedded/tomcat/TomcatWebServer.java
View File

@ -20,6 +20,7 @@ import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.function.BiConsumer;
import java.util.stream.Collectors;
import javax.naming.NamingException;
@ -119,6 +120,8 @@ public class TomcatWebServer implements WebServer {
}
});
disableBindOnInit();
// Start the server to trigger initialization listeners
this.tomcat.start();
@ -162,12 +165,29 @@ public class TomcatWebServer implements WebServer {
}
private void removeServiceConnectors() {
for (Service service : this.tomcat.getServer().findServices()) {
Connector[] connectors = service.findConnectors().clone();
doWithConnectors((service, connectors) -> {
this.serviceConnectors.put(service, connectors);
for (Connector connector : connectors) {
service.removeConnector(connector);
}
});
}
private void disableBindOnInit() {
doWithConnectors((service, connectors) -> {
for (Connector connector : connectors) {
Object bindOnInit = connector.getProperty("bindOnInit");
if (bindOnInit == null) {
connector.setProperty("bindOnInit", "false");
}
}
});
}
private void doWithConnectors(BiConsumer<Service, Connector[]> consumer) {
for (Service service : this.tomcat.getServer().findServices()) {
Connector[] connectors = service.findConnectors().clone();
consumer.accept(service, connectors);
}
}

16
spring-boot-project/spring-boot/src/test/java/org/springframework/boot/web/embedded/tomcat/TomcatServletWebServerFactoryTests.java
View File

@ -237,11 +237,23 @@ class TomcatServletWebServerFactoryTests extends AbstractServletWebServerFactory
void tomcatAdditionalConnectors() {
TomcatServletWebServerFactory factory = getFactory();
Connector[] connectors = new Connector[4];
Arrays.setAll(connectors, (i) -> new Connector());
Arrays.setAll(connectors, (i) -> {
Connector connector = new Connector();
connector.setPort(0);
return connector;
});
factory.addAdditionalTomcatConnectors(connectors);
this.webServer = factory.getWebServer();
Map<Service, Connector[]> connectorsByService = ((TomcatWebServer) this.webServer).getServiceConnectors();
Map<Service, Connector[]> connectorsByService = new HashMap<>(
((TomcatWebServer) this.webServer).getServiceConnectors());
assertThat(connectorsByService.values().iterator().next()).hasSize(connectors.length + 1);
this.webServer.start();
this.webServer.stop();
connectorsByService.forEach((service, serviceConnectors) -> {
for (Connector connector : serviceConnectors) {
assertThat(connector.getProtocolHandler()).extracting("endpoint.serverSock").isNull();
}
});
}
@Test