Skip to content

Commit 17d579f

Browse files
kwondh5217mhalbritter
authored andcommitted
Add missing attributes to FilterRegistration annotation
See gh-45005
1 parent 75bc4b2 commit 17d579f

File tree

3 files changed

+61
-1
lines changed

3 files changed

+61
-1
lines changed

spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/servlet/FilterRegistration.java

+14
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424

2525
import jakarta.servlet.DispatcherType;
2626
import jakarta.servlet.Filter;
27+
import jakarta.servlet.annotation.WebInitParam;
2728

2829
import org.springframework.core.Ordered;
2930
import org.springframework.core.annotation.AliasFor;
@@ -34,6 +35,7 @@
3435
* annotation-based alternative to {@link FilterRegistrationBean}.
3536
*
3637
* @author Moritz Halbritter
38+
* @author Daeho Kwon
3739
* @since 3.5.0
3840
* @see FilterRegistrationBean
3941
*/
@@ -81,6 +83,12 @@
8183
*/
8284
boolean ignoreRegistrationFailure() default false;
8385

86+
/**
87+
* Init parameters to be used with the filter.
88+
* @return the init parameters
89+
*/
90+
WebInitParam[] initParameters() default {};
91+
8492
/**
8593
* Whether the filter mappings should be matched after any declared Filter mappings of
8694
* the ServletContext.
@@ -95,6 +103,12 @@
95103
*/
96104
String[] servletNames() default {};
97105

106+
/**
107+
* Servlet types that the filter will be registered against.
108+
* @return the servlet types
109+
*/
110+
Class<?>[] servletRegistrationBeans() default {};
111+
98112
/**
99113
* URL patterns, as defined in the Servlet specification, that the filter will be
100114
* registered against.

spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/servlet/ServletContextInitializerBeans.java

+13
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@
3535
import jakarta.servlet.Filter;
3636
import jakarta.servlet.MultipartConfigElement;
3737
import jakarta.servlet.Servlet;
38+
import jakarta.servlet.annotation.WebInitParam;
3839
import org.apache.commons.logging.Log;
3940
import org.apache.commons.logging.LogFactory;
4041

@@ -63,6 +64,7 @@
6364
* @author Phillip Webb
6465
* @author Brian Clozel
6566
* @author Moritz Halbritter
67+
* @author Daeho Kwon
6668
* @since 1.4.0
6769
*/
6870
public class ServletContextInitializerBeans extends AbstractCollection<ServletContextInitializer> {
@@ -362,6 +364,17 @@ private void configureFromAnnotation(FilterRegistrationBean<Filter> bean, Filter
362364
bean.setMatchAfter(registration.matchAfter());
363365
bean.setServletNames(Arrays.asList(registration.servletNames()));
364366
bean.setUrlPatterns(Arrays.asList(registration.urlPatterns()));
367+
for (WebInitParam param : registration.initParameters()) {
368+
bean.addInitParameter(param.name(), param.value());
369+
}
370+
371+
this.beanFactory.getBeanProvider(ServletRegistrationBean.class).forEach((servletRegistrationBean) -> {
372+
for (Class<?> servletClass : registration.servletRegistrationBeans()) {
373+
if (servletClass.isInstance(servletRegistrationBean.getServlet())) {
374+
bean.addServletRegistrationBeans(servletRegistrationBean);
375+
}
376+
}
377+
});
365378
}
366379

367380
}

spring-boot-project/spring-boot/src/test/java/org/springframework/boot/web/servlet/ServletContextInitializerBeansTests.java

+34-1
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616

1717
package org.springframework.boot.web.servlet;
1818

19+
import java.util.Collection;
1920
import java.util.EnumSet;
2021

2122
import jakarta.servlet.DispatcherType;
@@ -25,6 +26,7 @@
2526
import jakarta.servlet.ServletContext;
2627
import jakarta.servlet.ServletRequest;
2728
import jakarta.servlet.ServletResponse;
29+
import jakarta.servlet.annotation.WebInitParam;
2830
import jakarta.servlet.http.HttpServlet;
2931
import jakarta.servlet.http.HttpServletRequest;
3032
import jakarta.servlet.http.HttpServletResponse;
@@ -47,6 +49,7 @@
4749
*
4850
* @author Andy Wilkinson
4951
* @author Moritz Halbritter
52+
* @author Daeho Kwon
5053
*/
5154
class ServletContextInitializerBeansTests {
5255

@@ -141,6 +144,14 @@ void shouldApplyFilterRegistrationAnnotation() {
141144
assertThat(filterRegistrationBean.getServletNames()).containsExactly("test");
142145
assertThat(filterRegistrationBean.determineDispatcherTypes()).containsExactly(DispatcherType.ERROR);
143146
assertThat(filterRegistrationBean.getUrlPatterns()).containsExactly("/test/*");
147+
assertThat(filterRegistrationBean.getInitParameters()).containsEntry("env", "test")
148+
.containsEntry("debug", "true");
149+
Collection<ServletRegistrationBean<?>> servletRegistrationBeans = filterRegistrationBean
150+
.getServletRegistrationBeans();
151+
assertThat(servletRegistrationBeans).hasSize(1);
152+
assertThat(servletRegistrationBeans.iterator().next().getServletName())
153+
.isEqualTo("testServletRegistrationBean");
154+
144155
});
145156
}
146157

@@ -296,11 +307,33 @@ static class FilterConfigurationWithAnnotation {
296307
@Bean
297308
@FilterRegistration(enabled = false, name = "test", asyncSupported = false,
298309
dispatcherTypes = DispatcherType.ERROR, matchAfter = true, servletNames = "test",
299-
urlPatterns = "/test/*")
310+
urlPatterns = "/test/*",
311+
initParameters = { @WebInitParam(name = "env", value = "test"),
312+
@WebInitParam(name = "debug", value = "true") },
313+
servletRegistrationBeans = { TestServlet.class })
300314
TestFilter testFilter() {
301315
return new TestFilter();
302316
}
303317

318+
@Bean
319+
ServletRegistrationBean<TestServlet> testServletRegistrationBean() {
320+
return new ServletRegistrationBean<>(new TestServlet());
321+
}
322+
323+
@Bean
324+
ServletRegistrationBean<NonMatchingServlet> nonMatchingServletRegistrationBean() {
325+
return new ServletRegistrationBean<>(new NonMatchingServlet());
326+
}
327+
328+
static class NonMatchingServlet extends HttpServlet implements ServletContextInitializer {
329+
330+
@Override
331+
public void onStartup(ServletContext servletContext) {
332+
333+
}
334+
335+
}
336+
304337
}
305338

306339
@Configuration(proxyBeanMethods = false)

0 commit comments

Comments
 (0)