Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Use default phase 0 for WebSocket messaging

Browse Source 
Closes gh-27519
This commit is contained in:
rstoyanchev
2024-05-21 15:49:28 +01:00
parent d5c7a5e2db
commit 8c9b6e2205
8 changed files with 24 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
spring-websocket/src/main/java/org/springframework/web/socket/config/annotation/WebSocketMessageBrokerConfigurer.java
View File

@@ -117,11 +117,9 @@ public interface WebSocketMessageBrokerConfigurer {
* handling beans of type {@link SmartLifecycle} should run in.
* <p>The default implementation returns {@code null} which allows other
* configurers to decide. As soon as any configurer returns a value, that
* value is used. If no configurer returns a value, then by default
* {@link SmartLifecycle#DEFAULT_PHASE} is used.
* value is used. If no configurer returns a value, then 0 is used.
* <p>It is recommended to use a phase value such as 0 in order to ensure that
* components start before the web server in Spring Boot application. In 6.2.0,
* the default used will change to 0.
* components start before the web server in Spring Boot application.
* @since 6.1.4
* @see SmartLifecycle
*/

3
spring-websocket/src/main/java/org/springframework/web/socket/messaging/SubProtocolWebSocketHandler.java
View File

@@ -254,7 +254,8 @@ public class SubProtocolWebSocketHandler
/**
* Set the phase that this handler should run in.
* <p>By default, this is {@link SmartLifecycle#DEFAULT_PHASE}.
* <p>By default, this is {@link SmartLifecycle#DEFAULT_PHASE}, but with
* {@code @EnableWebSocketMessageBroker} configuration it is set to 0.
* @since 6.1.4
*/
public void setPhase(int phase) {

3
spring-websocket/src/main/java/org/springframework/web/socket/server/support/WebSocketHandlerMapping.java
View File

@@ -62,7 +62,8 @@ public class WebSocketHandlerMapping extends SimpleUrlHandlerMapping implements
/**
* Set the phase that this handler should run in.
* <p>By default, this is {@link SmartLifecycle#DEFAULT_PHASE}.
* <p>By default, this is {@link SmartLifecycle#DEFAULT_PHASE}, but with
* {@code @EnableWebSocketMessageBroker} configuration it is set to 0.
* @since 6.1.4
*/
public void setPhase(int phase) {

14
spring-websocket/src/test/java/org/springframework/web/socket/config/annotation/WebSocketMessageBrokerConfigurationSupportTests.java
View File

@@ -212,10 +212,18 @@ class WebSocketMessageBrokerConfigurationSupportTests {
}
@Test
void lifecyclePhase() {
ApplicationContext context = createContext(LifecyclePhaseConfig.class);
void lifecyclePhaseDefault() {
ApplicationContext context = createContext(TestChannelConfig.class, TestConfigurer.class);
assertPhase(context, 0);
}
int phase = 99;
@Test
void lifecyclePhaseExplicitlySet() {
ApplicationContext context = createContext(LifecyclePhaseConfig.class);
assertPhase(context, 99);
}
private static void assertPhase(ApplicationContext context, int phase) {
Consumer<String> executorTester = beanName ->
assertThat(context.getBean(beanName, ThreadPoolTaskExecutor.class).getPhase()).isEqualTo(phase);