Add configuration key "spring.data.web.pageable.serialization-mode" d…

…efaults to DIRECT see spring-projects/spring-data-commons@5dd7b32
spring-projects · Feb 29, 2024 · 7cd5f4a · 7cd5f4a
1 parent 70769d9
commit 7cd5f4a
Show file tree

Hide file tree

Showing 4 changed files with 57 additions and 8 deletions.
diff --git a/.../java/org/springframework/boot/autoconfigure/data/web/SpringDataWebAutoConfiguration.java b/.../java/org/springframework/boot/autoconfigure/data/web/SpringDataWebAutoConfiguration.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2022 the original author or authors.
+ * Copyright 2012-2024 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -26,11 +26,13 @@
 import org.springframework.boot.autoconfigure.data.web.SpringDataWebProperties.Pageable;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Primary;
 import org.springframework.data.domain.PageRequest;
 import org.springframework.data.web.PageableHandlerMethodArgumentResolver;
 import org.springframework.data.web.config.EnableSpringDataWebSupport;
 import org.springframework.data.web.config.PageableHandlerMethodArgumentResolverCustomizer;
 import org.springframework.data.web.config.SortHandlerMethodArgumentResolverCustomizer;
+import org.springframework.data.web.config.SpringDataWebSettings;
 import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
 
 /**
@@ -42,6 +44,7 @@
  *
  * @author Andy Wilkinson
  * @author Vedran Pavic
+ * @author Yanming Zhou
  * @since 1.2.0
  */
 @AutoConfiguration(after = RepositoryRestMvcAutoConfiguration.class)
@@ -79,4 +82,10 @@ public SortHandlerMethodArgumentResolverCustomizer sortCustomizer() {
 		return (resolver) -> resolver.setSortParameter(this.properties.getSort().getSortParameter());
 	}
 
+	@Primary // override bean created by @EnableSpringDataWebSupport
+	@Bean
+	public SpringDataWebSettings springDataWebSettings() {
+		return new SpringDataWebSettings(this.properties.getPageable().getSerializationMode());
+	}
+
 }
diff --git a/...rc/main/java/org/springframework/boot/autoconfigure/data/web/SpringDataWebProperties.java b/...rc/main/java/org/springframework/boot/autoconfigure/data/web/SpringDataWebProperties.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2019 the original author or authors.
+ * Copyright 2012-2024 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,11 +17,13 @@
 package org.springframework.boot.autoconfigure.data.web;
 
 import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.data.web.config.EnableSpringDataWebSupport.PageSerializationMode;
 
 /**
  * Configuration properties for Spring Data Web.
  *
  * @author Vedran Pavic
+ * @author Yanming Zhou
  * @since 2.0.0
  */
 @ConfigurationProperties("spring.data.web")
@@ -81,6 +83,19 @@ public static class Pageable {
 		 */
 		private int maxPageSize = 2000;
 
+		/**
+		 * Configures how to render {@link org.springframework.data.domain.PageImpl}
+		 * instances. Defaults to {@link PageSerializationMode#DIRECT} for backward
+		 * compatibility reasons. Prefer explicitly setting this to
+		 * {@link PageSerializationMode#VIA_DTO}, or manually convert
+		 * {@link org.springframework.data.domain.PageImpl} instances before handing them
+		 * out of a controller method, either by manually calling
+		 * {@code new PagedModel<>(page)} or using Spring HATEOAS
+		 * {@link org.springframework.hateoas.PagedModel} abstraction.
+		 * @since 3.3
+		 */
+		private PageSerializationMode serializationMode = PageSerializationMode.DIRECT;
+
 		public String getPageParameter() {
 			return this.pageParameter;
 		}
@@ -137,6 +152,14 @@ public void setMaxPageSize(int maxPageSize) {
 			this.maxPageSize = maxPageSize;
 		}
 
+		public PageSerializationMode getSerializationMode() {
+			return this.serializationMode;
+		}
+
+		public void setSerializationMode(PageSerializationMode serializationMode) {
+			this.serializationMode = serializationMode;
+		}
+
 	}
 
 	/**

diff --git a/.../org/springframework/boot/autoconfigure/data/web/SpringDataWebAutoConfigurationTests.java b/.../org/springframework/boot/autoconfigure/data/web/SpringDataWebAutoConfigurationTests.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -24,6 +24,8 @@
 import org.springframework.data.domain.PageRequest;
 import org.springframework.data.web.PageableHandlerMethodArgumentResolver;
 import org.springframework.data.web.SortHandlerMethodArgumentResolver;
+import org.springframework.data.web.config.EnableSpringDataWebSupport.PageSerializationMode;
+import org.springframework.data.web.config.SpringDataWebSettings;
 
 import static org.assertj.core.api.Assertions.assertThat;
 
@@ -33,6 +35,7 @@
  * @author Andy Wilkinson
  * @author Vedran Pavic
  * @author Stephane Nicoll
+ * @author Yanming Zhou
  */
 class SpringDataWebAutoConfigurationTests {
 
@@ -53,20 +56,24 @@ void autoConfigurationBacksOffInNonWebApplicationContexts() {
 
 	@Test
 	void customizePageable() {
-		this.contextRunner.withPropertyValues("spring.data.web.pageable.page-parameter=p",
-				"spring.data.web.pageable.size-parameter=s", "spring.data.web.pageable.default-page-size=10",
-				"spring.data.web.pageable.prefix=abc", "spring.data.web.pageable.qualifier-delimiter=__",
-				"spring.data.web.pageable.max-page-size=100", "spring.data.web.pageable.one-indexed-parameters=true")
+		this.contextRunner
+			.withPropertyValues("spring.data.web.pageable.page-parameter=p",
+					"spring.data.web.pageable.size-parameter=s", "spring.data.web.pageable.default-page-size=10",
+					"spring.data.web.pageable.prefix=abc", "spring.data.web.pageable.qualifier-delimiter=__",
+					"spring.data.web.pageable.max-page-size=100", "spring.data.web.pageable.serialization-mode=VIA_DTO",
+					"spring.data.web.pageable.one-indexed-parameters=true")
 			.run((context) -> {
 				PageableHandlerMethodArgumentResolver argumentResolver = context
 					.getBean(PageableHandlerMethodArgumentResolver.class);
+				SpringDataWebSettings springDataWebSettings = context.getBean(SpringDataWebSettings.class);
 				assertThat(argumentResolver).hasFieldOrPropertyWithValue("pageParameterName", "p");
 				assertThat(argumentResolver).hasFieldOrPropertyWithValue("sizeParameterName", "s");
 				assertThat(argumentResolver).hasFieldOrPropertyWithValue("oneIndexedParameters", true);
 				assertThat(argumentResolver).hasFieldOrPropertyWithValue("prefix", "abc");
 				assertThat(argumentResolver).hasFieldOrPropertyWithValue("qualifierDelimiter", "__");
 				assertThat(argumentResolver).hasFieldOrPropertyWithValue("fallbackPageable", PageRequest.of(0, 10));
 				assertThat(argumentResolver).hasFieldOrPropertyWithValue("maxPageSize", 100);
+				assertThat(springDataWebSettings.pageSerializationMode()).isEqualTo(PageSerializationMode.VIA_DTO);
 			});
 	}
 
@@ -76,6 +83,7 @@ void defaultPageable() {
 			SpringDataWebProperties.Pageable properties = new SpringDataWebProperties().getPageable();
 			PageableHandlerMethodArgumentResolver argumentResolver = context
 				.getBean(PageableHandlerMethodArgumentResolver.class);
+			SpringDataWebSettings springDataWebSettings = context.getBean(SpringDataWebSettings.class);
 			assertThat(argumentResolver).hasFieldOrPropertyWithValue("pageParameterName",
 					properties.getPageParameter());
 			assertThat(argumentResolver).hasFieldOrPropertyWithValue("sizeParameterName",
@@ -88,6 +96,7 @@ void defaultPageable() {
 			assertThat(argumentResolver).hasFieldOrPropertyWithValue("fallbackPageable",
 					PageRequest.of(0, properties.getDefaultPageSize()));
 			assertThat(argumentResolver).hasFieldOrPropertyWithValue("maxPageSize", properties.getMaxPageSize());
+			assertThat(springDataWebSettings.pageSerializationMode()).isEqualTo(properties.getSerializationMode());
 		});
 	}
 
@@ -100,4 +109,12 @@ void customizeSort() {
 		});
 	}
 
+	@Test
+	void customizePageSerializationMode() {
+		this.contextRunner.withPropertyValues("spring.data.web.pageable.serialization-mode=VIA_DTO").run((context) -> {
+			SpringDataWebSettings springDataWebSettings = context.getBean(SpringDataWebSettings.class);
+			assertThat(springDataWebSettings.pageSerializationMode()).isEqualTo(PageSerializationMode.VIA_DTO);
+		});
+	}
+
 }
diff --git a/spring-boot-project/spring-boot-dependencies/build.gradle b/spring-boot-project/spring-boot-dependencies/build.gradle
@@ -1795,7 +1795,7 @@ bom {
 			releaseNotes("https://github.com/spring-projects/spring-batch/releases/tag/v{version}")
 		}
 	}
-	library("Spring Data Bom", "2023.1.3") {
+	library("Spring Data Bom", "2024.0.0-SNAPSHOT") {
 		considerSnapshots()
 		calendarName = "Spring Data Release"
 		group("org.springframework.data") {