Skip to content

With multiple ResourceHandlerRegistrationCustomizer beans in the context, only one of them is used #43494

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

With multiple ResourceHandlerRegistrationCustomizer beans in the context, only one of them is used #43494

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 9 additions & 11 deletions ...in/java/org/springframework/boot/autoconfigure/web/reactive/WebFluxAutoConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
package org.springframework.boot.autoconfigure.web.reactive;

import java.time.Duration;
import java.util.List;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
Expand Down Expand Up @@ -163,22 +164,22 @@ public static class WebFluxConfig implements WebFluxConfigurer {

private final ObjectProvider<CodecCustomizer> codecCustomizers;

private final ResourceHandlerRegistrationCustomizer resourceHandlerRegistrationCustomizer;
private final ObjectProvider<ResourceHandlerRegistrationCustomizer> resourceHandlerRegistrationCustomizers;

private final ObjectProvider<ViewResolver> viewResolvers;

public WebFluxConfig(Environment environment, WebProperties webProperties, WebFluxProperties webFluxProperties,
ListableBeanFactory beanFactory, ObjectProvider<HandlerMethodArgumentResolver> resolvers,
ObjectProvider<CodecCustomizer> codecCustomizers,
ObjectProvider<ResourceHandlerRegistrationCustomizer> resourceHandlerRegistrationCustomizer,
ObjectProvider<ResourceHandlerRegistrationCustomizer> resourceHandlerRegistrationCustomizers,
ObjectProvider<ViewResolver> viewResolvers) {
this.environment = environment;
this.resourceProperties = webProperties.getResources();
this.webFluxProperties = webFluxProperties;
this.beanFactory = beanFactory;
this.argumentResolvers = resolvers;
this.codecCustomizers = codecCustomizers;
this.resourceHandlerRegistrationCustomizer = resourceHandlerRegistrationCustomizer.getIfAvailable();
this.resourceHandlerRegistrationCustomizers = resourceHandlerRegistrationCustomizers;
this.viewResolvers = viewResolvers;
}

Expand Down Expand Up @@ -210,19 +211,22 @@ public void addResourceHandlers(ResourceHandlerRegistry registry) {
logger.debug("Default resource handling disabled");
return;
}
List<ResourceHandlerRegistrationCustomizer> resourceHandlerRegistrationCustomizers = this.resourceHandlerRegistrationCustomizers
.orderedStream()
.toList();
String webjarsPathPattern = this.webFluxProperties.getWebjarsPathPattern();
if (!registry.hasMappingForPattern(webjarsPathPattern)) {
ResourceHandlerRegistration registration = registry.addResourceHandler(webjarsPathPattern)
.addResourceLocations("classpath:/META-INF/resources/webjars/");
configureResourceCaching(registration);
customizeResourceHandlerRegistration(registration);
resourceHandlerRegistrationCustomizers.forEach((customizer) -> customizer.customize(registration));
}
String staticPathPattern = this.webFluxProperties.getStaticPathPattern();
if (!registry.hasMappingForPattern(staticPathPattern)) {
ResourceHandlerRegistration registration = registry.addResourceHandler(staticPathPattern)
.addResourceLocations(this.resourceProperties.getStaticLocations());
configureResourceCaching(registration);
customizeResourceHandlerRegistration(registration);
resourceHandlerRegistrationCustomizers.forEach((customizer) -> customizer.customize(registration));
}
}

Expand All @@ -247,12 +251,6 @@ public void addFormatters(FormatterRegistry registry) {
ApplicationConversionService.addBeans(registry, this.beanFactory);
}

private void customizeResourceHandlerRegistration(ResourceHandlerRegistration registration) {
if (this.resourceHandlerRegistrationCustomizer != null) {
this.resourceHandlerRegistrationCustomizer.customize(registration);
}
}

}

/**
Expand Down
29 changes: 29 additions & 0 deletions ...va/org/springframework/boot/autoconfigure/web/reactive/WebFluxAutoConfigurationTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@
import org.springframework.web.reactive.accept.RequestedContentTypeResolver;
import org.springframework.web.reactive.config.BlockingExecutionConfigurer;
import org.springframework.web.reactive.config.DelegatingWebFluxConfiguration;
import org.springframework.web.reactive.config.ResourceHandlerRegistration;
import org.springframework.web.reactive.config.WebFluxConfigurationSupport;
import org.springframework.web.reactive.config.WebFluxConfigurer;
import org.springframework.web.reactive.function.server.support.RouterFunctionMapping;
Expand Down Expand Up @@ -122,6 +123,7 @@
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.BDDMockito.then;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.times;

/**
* Tests for {@link WebFluxAutoConfiguration}.
Expand Down Expand Up @@ -182,6 +184,18 @@ void shouldCustomizeCodecs() {
});
}

@Test
void shouldCustomizeResources() {
this.contextRunner.withUserConfiguration(ResourceHandlerRegistrationCustomizers.class).run((context) -> {
ResourceHandlerRegistrationCustomizer customizer1 = context
.getBean("firstResourceHandlerRegistrationCustomizer", ResourceHandlerRegistrationCustomizer.class);
ResourceHandlerRegistrationCustomizer customizer2 = context
.getBean("secondResourceHandlerRegistrationCustomizer", ResourceHandlerRegistrationCustomizer.class);
then(customizer1).should(times(2)).customize(any(ResourceHandlerRegistration.class));
then(customizer2).should(times(2)).customize(any(ResourceHandlerRegistration.class));
});
}

@Test
void shouldRegisterResourceHandlerMapping() {
this.contextRunner.run((context) -> {
Expand Down Expand Up @@ -843,6 +857,21 @@ CodecCustomizer firstCodecCustomizer() {

}

@Configuration(proxyBeanMethods = false)
static class ResourceHandlerRegistrationCustomizers {

@Bean
ResourceHandlerRegistrationCustomizer firstResourceHandlerRegistrationCustomizer() {
return mock(ResourceHandlerRegistrationCustomizer.class);
}

@Bean
ResourceHandlerRegistrationCustomizer secondResourceHandlerRegistrationCustomizer() {
return mock(ResourceHandlerRegistrationCustomizer.class);
}

}

@Configuration(proxyBeanMethods = false)
static class ViewResolvers {

Expand Down
Loading