Add initParameters and servletRegistrationBeans

Signed-off-by: Daeho Kwon <[email protected]>

Author: kwondh5217

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

@@ -24,6 +24,7 @@
 
 import jakarta.servlet.DispatcherType;
 import jakarta.servlet.Filter;
+import jakarta.servlet.annotation.WebInitParam;
 
 import org.springframework.core.Ordered;
 import org.springframework.core.annotation.AliasFor;
@@ -34,6 +35,7 @@
  * annotation-based alternative to {@link FilterRegistrationBean}.
  *
  * @author Moritz Halbritter
+ * @author Daeho Kwon
  * @since 3.5.0
  * @see FilterRegistrationBean
  */
@@ -81,6 +83,12 @@
 	 */
 	boolean ignoreRegistrationFailure() default false;
 
+	/**
+	 * Init parameters to be used with the filter.
+	 * @return the init parameters
+	 */
+	WebInitParam[] initParameters() default {};
+
 	/**
 	 * Whether the filter mappings should be matched after any declared Filter mappings of
 	 * the ServletContext.
@@ -95,6 +103,12 @@
 	 */
 	String[] servletNames() default {};
 
+	/**
+	 * Servlet types that the filter will be registered against.
+	 * @return the servlet types
+	 */
+	Class<?>[] servletRegistrationBeans() default {};
+
 	/**
 	 * URL patterns, as defined in the Servlet specification, that the filter will be
 	 * registered against.

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

@@ -35,6 +35,7 @@
 import jakarta.servlet.Filter;
 import jakarta.servlet.MultipartConfigElement;
 import jakarta.servlet.Servlet;
+import jakarta.servlet.annotation.WebInitParam;
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 
@@ -369,6 +370,21 @@ private void configureFromAnnotation(FilterRegistrationBean<Filter> bean, Filter
 			if (registration.urlPatterns().length > 0) {
 				bean.setUrlPatterns(Arrays.asList(registration.urlPatterns()));
 			}
+			for (WebInitParam param : registration.initParameters()) {
+				bean.addInitParameter(param.name(), param.value());
+			}
+
+			@SuppressWarnings("unchecked")
+			Map<String, ServletRegistrationBean<?>> servletRegistrationBeans = (Map<String, ServletRegistrationBean<?>>) (Map<?, ?>) this.beanFactory
+				.getBeansOfType(ServletRegistrationBean.class);
+
+			for (Class<?> servletClass : registration.servletRegistrationBeans()) {
+				for (ServletRegistrationBean<?> registrationBean : servletRegistrationBeans.values()) {
+					if (servletClass.isInstance(registrationBean.getServlet())) {
+						bean.addServletRegistrationBeans(registrationBean);
+					}
+				}
+			}
 		}
 
 	}

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

@@ -23,6 +23,7 @@
 import jakarta.servlet.ServletContext;
 import jakarta.servlet.ServletRequest;
 import jakarta.servlet.ServletResponse;
+import jakarta.servlet.annotation.WebInitParam;
 import jakarta.servlet.http.HttpServlet;
 import jakarta.servlet.http.HttpSessionIdListener;
 import org.assertj.core.api.ThrowingConsumer;
@@ -42,6 +43,7 @@
  *
  * @author Andy Wilkinson
  * @author Moritz Halbritter
+ * @author Daeho Kwon
  */
 class ServletContextInitializerBeansTests {
 
@@ -136,6 +138,9 @@ void shouldApplyFilterRegistrationAnnotation() {
 			assertThat(filterRegistrationBean.getServletNames()).containsExactly("test");
 			assertThat(filterRegistrationBean.determineDispatcherTypes()).containsExactly(DispatcherType.ERROR);
 			assertThat(filterRegistrationBean.getUrlPatterns()).containsExactly("/test/*");
+			assertThat(filterRegistrationBean.getInitParameters()).containsEntry("env", "test")
+				.containsEntry("debug", "true");
+
 		});
 	}
 
@@ -179,6 +184,25 @@ void shouldApplyOrderFromOrderAttribute() {
 					.isEqualTo(ServletConfigurationWithAnnotationAndOrder.ORDER));
 	}
 
+	@Test
+	void shouldApplyServletRegistrationBeansInFilterRegistration() {
+		load(FilterWithServletRegistrationBeansConfiguration.class);
+
+		ServletContextInitializerBeans initializerBeans = new ServletContextInitializerBeans(
+				this.context.getBeanFactory(), TestServletContextInitializer.class);
+
+		FilterRegistrationBean<?> frb = initializerBeans.stream()
+			.filter(FilterRegistrationBean.class::isInstance)
+			.map(FilterRegistrationBean.class::cast)
+			.filter((f) -> "testFilter".equals(f.getFilterName()))
+			.findFirst()
+			.orElseThrow();
+
+		assertThat(frb.getServletRegistrationBeans()).hasSize(1);
+		assertThat(frb.getServletRegistrationBeans().iterator().next().getServletName())
+			.isEqualTo("testServletRegistrationBean");
+	}
+
 	private void load(Class<?>... configuration) {
 		this.context = new AnnotationConfigApplicationContext(configuration);
 	}
@@ -280,7 +304,24 @@ static class FilterConfigurationWithAnnotation {
 		@Bean
 		@FilterRegistration(enabled = false, name = "test", asyncSupported = false,
 				dispatcherTypes = DispatcherType.ERROR, matchAfter = true, servletNames = "test",
-				urlPatterns = "/test/*")
+				urlPatterns = "/test/*", initParameters = { @WebInitParam(name = "env", value = "test"),
+						@WebInitParam(name = "debug", value = "true") })
+		TestFilter testFilter() {
+			return new TestFilter();
+		}
+
+	}
+
+	@Configuration(proxyBeanMethods = false)
+	static class FilterWithServletRegistrationBeansConfiguration {
+
+		@Bean
+		ServletRegistrationBean<TestServlet> testServletRegistrationBean() {
+			return new ServletRegistrationBean<>(new TestServlet(), "/test");
+		}
+
+		@Bean
+		@FilterRegistration(name = "testFilter", servletRegistrationBeans = TestServlet.class)
 		TestFilter testFilter() {
 			return new TestFilter();
 		}