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

Polish "Add missing attributes to ServletRegistration annotation"

Browse Source 
See gh-45007
This commit is contained in:
Moritz Halbritter
2025-04-10 14:46:48 +02:00
parent d0128071ec
commit 5401327e4d
2 changed files with 16 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/servlet/ServletRegistration.java
View File

@@ -91,14 +91,14 @@ public @interface ServletRegistration {
int loadOnStartup() default -1;
/**
* Init parameters to set on the servlet (mirrors {@code @WebInitParam} usage).
* @return array of {@link WebInitParam}
* Init parameters to be used with the servlet.
* @return the init parameters
*/
WebInitParam[] initParameters() default {};
/**
* Multipart configuration.
* @return multipart config {@link MultipartConfig}
* The multipart configuration.
* @return the multipart configuration
*/
MultipartConfig multipartConfig() default @MultipartConfig;

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

@@ -129,6 +129,13 @@ class ServletContextInitializerBeansTests {
assertThat(servletRegistrationBean.getServletName()).isEqualTo("test");
assertThat(servletRegistrationBean.isAsyncSupported()).isFalse();
assertThat(servletRegistrationBean.getUrlMappings()).containsExactly("/test/*");
assertThat(servletRegistrationBean.getInitParameters())
.containsExactlyInAnyOrderEntriesOf(Map.of("env", "test", "debug", "true"));
assertThat(servletRegistrationBean.getMultipartConfig()).isNotNull();
assertThat(servletRegistrationBean.getMultipartConfig().getLocation()).isEqualTo("/tmp");
assertThat(servletRegistrationBean.getMultipartConfig().getMaxFileSize()).isEqualTo(1024);
assertThat(servletRegistrationBean.getMultipartConfig().getMaxRequestSize()).isEqualTo(4096);
assertThat(servletRegistrationBean.getMultipartConfig().getFileSizeThreshold()).isEqualTo(128);
});
}
@@ -209,29 +216,6 @@ class ServletContextInitializerBeansTests {
.isEqualTo(ServletConfigurationWithAnnotationAndOrder.ORDER));
}
@Test
void shouldApplyExtendedServletRegistrationAnnotation() {
load(ServletConfigurationWithExtendedAttributes.class);
ServletContextInitializerBeans initializerBeans = new ServletContextInitializerBeans(
this.context.getBeanFactory(), TestServletContextInitializer.class);
assertThatSingleServletRegistration(initializerBeans, (bean) -> {
assertThat(bean.getServletName()).isEqualTo("extended");
assertThat(bean.getUrlMappings()).containsExactly("/extended/*");
assertThat(bean.getInitParameters()).containsEntry("hello", "world").containsEntry("flag", "true");
assertThat(bean.getMultipartConfig()).isNotNull();
assertThat(bean.getMultipartConfig().getLocation()).isEqualTo("/tmp");
assertThat(bean.getMultipartConfig().getMaxFileSize()).isEqualTo(1024);
assertThat(bean.getMultipartConfig().getMaxRequestSize()).isEqualTo(4096);
assertThat(bean.getMultipartConfig().getFileSizeThreshold()).isEqualTo(128);
});
}
private void assertThatSingleServletRegistration(ServletContextInitializerBeans initializerBeans,
ThrowingConsumer<ServletRegistrationBean<?>> code) {
assertThatSingleRegistration(initializerBeans, ServletRegistrationBean.class, code::acceptThrows);
}
private void load(Class<?>... configuration) {
this.context = new AnnotationConfigApplicationContext(configuration);
}
@@ -269,7 +253,11 @@ class ServletContextInitializerBeansTests {
@Bean
@ServletRegistration(enabled = false, name = "test", asyncSupported = false, urlMappings = "/test/*",
loadOnStartup = 1)
loadOnStartup = 1,
initParameters = { @WebInitParam(name = "env", value = "test"),
@WebInitParam(name = "debug", value = "true") },
multipartConfig = @MultipartConfig(location = "/tmp", maxFileSize = 1024, maxRequestSize = 4096,
fileSizeThreshold = 128))
TestServlet testServlet() {
return new TestServlet();
}
@@ -479,19 +467,4 @@ class ServletContextInitializerBeansTests {
}
@Configuration(proxyBeanMethods = false)
static class ServletConfigurationWithExtendedAttributes {
@Bean
@ServletRegistration(name = "extended", urlMappings = "/extended/*",
initParameters = { @WebInitParam(name = "hello", value = "world"),
@WebInitParam(name = "flag", value = "true") },
multipartConfig = @MultipartConfig(location = "/tmp", maxFileSize = 1024, maxRequestSize = 4096,
fileSizeThreshold = 128))
TestServlet testServletWithInitParametersAndMultipart() {
return new TestServlet();
}
}
}