Fix #1324: Add @JsonAlias support to SimplePageable for SNAKE_CASE co…

spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/PageJacksonModule.java

@@ -243,8 +243,10 @@ static class SimplePageable implements Pageable {
 
 		private final PageRequest delegate;
 
-		SimplePageable(@JsonProperty("pageNumber") int number, @JsonProperty("pageSize") int size,
-				@JsonProperty("sort") Sort sort) {
+		SimplePageable(
+			@JsonProperty("pageNumber") @JsonAlias({"page-number", "page_number", "pagenumber", "PageNumber"}) int number,
+			@JsonProperty("pageSize") @JsonAlias({"page-size", "page_size", "pagesize", "PageSize"}) int size,
+			@JsonProperty("sort") Sort sort) {
 			delegate = buildPageRequest(number, size, sort);
 		}
 

spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/support/PageJacksonModuleTests.java

@@ -189,4 +189,71 @@ void serializeAndDeserializeFilledMultipleCascade() {
 		assertThat(cascadedResult.getPageable().getPageNumber()).isEqualTo(6);
 	}
 
+	@Test
+	void deserializePageableWithHyphenatedAlias() {
+		// Given
+		File file = new File("./src/test/resources/withPageableAliasHyphen.json");
+		// When
+		Page<?> result = objectMapper.readValue(file, Page.class);
+		// Then
+		assertThat(result).isNotNull();
+		assertThat(result.getTotalElements()).isEqualTo(15);
+		assertThat(result.getContent()).hasSize(10);
+		assertThat(result.getPageable()).isNotNull();
+		assertThat(result.getPageable().getPageNumber()).isEqualTo(2);
+		assertThat(result.getPageable().getPageSize()).isEqualTo(3);
+		assertThat(result.getPageable().getSort().getOrderFor("firstName").getDirection())
+			.isEqualTo(Sort.Direction.ASC);
+	}
+
+	@Test
+	void deserializePageableWithUnderscoreAlias() {
+		// Given
+		File file = new File("./src/test/resources/withPageableAliasUnderscore.json");
+		// When
+		Page<?> result = objectMapper.readValue(file, Page.class);
+		// Then
+		assertThat(result).isNotNull();
+		assertThat(result.getTotalElements()).isEqualTo(10);
+		assertThat(result.getContent()).hasSize(10);
+		assertThat(result.getPageable()).isNotNull();
+		assertThat(result.getPageable().getPageNumber()).isEqualTo(1);
+		assertThat(result.getPageable().getPageSize()).isEqualTo(2);
+		assertThat(result.getPageable().getSort().getOrderFor("lastName").getDirection())
+			.isEqualTo(Sort.Direction.DESC);
+	}
+
+	@Test
+	void deserializePageableWithLowercaseAlias() {
+		// Given
+		File file = new File("./src/test/resources/withPageableAliasLowercase.json");
+		// When
+		Page<?> result = objectMapper.readValue(file, Page.class);
+		// Then
+		assertThat(result).isNotNull();
+		assertThat(result.getTotalElements()).isEqualTo(8);
+		assertThat(result.getContent()).hasSize(10);
+		assertThat(result.getPageable()).isNotNull();
+		assertThat(result.getPageable().getPageNumber()).isEqualTo(0);
+		assertThat(result.getPageable().getPageSize()).isEqualTo(4);
+		assertThat(result.getPageable().getSort()).isEqualTo(Sort.unsorted());
+	}
+
+	@Test
+	void deserializePageableWithPascalCaseAlias() {
+		// Given
+		File file = new File("./src/test/resources/withPageableAliasPascalCase.json");
+		// When
+		Page<?> result = objectMapper.readValue(file, Page.class);
+		// Then
+		assertThat(result).isNotNull();
+		assertThat(result.getTotalElements()).isEqualTo(20);
+		assertThat(result.getContent()).hasSize(10);
+		assertThat(result.getPageable()).isNotNull();
+		assertThat(result.getPageable().getPageNumber()).isEqualTo(3);
+		assertThat(result.getPageable().getPageSize()).isEqualTo(2);
+		assertThat(result.getPageable().getSort().getOrderFor("firstName").getDirection())
+			.isEqualTo(Sort.Direction.ASC);
+	}
+
 }

spring-cloud-openfeign-core/src/test/resources/withPageableAliasHyphen.json

@@ -0,0 +1,77 @@
+{
+	"content": [
+		{
+			"id": 3,
+			"lastName": "Williams",
+			"firstName": "Thomas",
+			"email": "w.t@my.domain.com"
+		},
+		{
+			"id": 1,
+			"lastName": "Smith",
+			"firstName": "James",
+			"email": "s.j@my.domain.com"
+		},
+		{
+			"id": 11,
+			"lastName": "Scott",
+			"firstName": "Steven",
+			"email": "s.s@my.domain.com"
+		},
+		{
+			"id": 8,
+			"lastName": "Rodriguez",
+			"firstName": "Daniel",
+			"email": "r.d@my.domain.com"
+		},
+		{
+			"id": 9,
+			"lastName": "Martinez",
+			"firstName": "Robert",
+			"email": "m.r@my.domain.com"
+		},
+		{
+			"id": 5,
+			"lastName": "Jones",
+			"firstName": "James",
+			"email": "j.j@my.domain.com"
+		},
+		{
+			"id": 2,
+			"lastName": "Johnson",
+			"firstName": "Robert",
+			"email": "j.r@my.domain.com"
+		},
+		{
+			"id": 6,
+			"lastName": "Garcia",
+			"firstName": "William",
+			"email": "g.w@my.domain.com"
+		},
+		{
+			"id": 7,
+			"lastName": "Davis",
+			"firstName": "Richard",
+			"email": "d.r@my.domain.com"
+		},
+		{
+			"id": 4,
+			"lastName": "Brown",
+			"firstName": "Paul",
+			"email": "b.p@my.domain.com"
+		}
+	],
+	"pageable": {
+		"page-number": 2,
+		"page-size": 3,
+		"sort": {
+			"orders": [
+				{
+					"direction": "ASC",
+					"property": "firstName"
+				}
+			]
+		}
+	},
+	"totalElements": 15
+}

spring-cloud-openfeign-core/src/test/resources/withPageableAliasLowercase.json

@@ -0,0 +1,72 @@
+{
+	"content": [
+		{
+			"id": 3,
+			"lastName": "Williams",
+			"firstName": "Thomas",
+			"email": "w.t@my.domain.com"
+		},
+		{
+			"id": 1,
+			"lastName": "Smith",
+			"firstName": "James",
+			"email": "s.j@my.domain.com"
+		},
+		{
+			"id": 11,
+			"lastName": "Scott",
+			"firstName": "Steven",
+			"email": "s.s@my.domain.com"
+		},
+		{
+			"id": 8,
+			"lastName": "Rodriguez",
+			"firstName": "Daniel",
+			"email": "r.d@my.domain.com"
+		},
+		{
+			"id": 9,
+			"lastName": "Martinez",
+			"firstName": "Robert",
+			"email": "m.r@my.domain.com"
+		},
+		{
+			"id": 5,
+			"lastName": "Jones",
+			"firstName": "James",
+			"email": "j.j@my.domain.com"
+		},
+		{
+			"id": 2,
+			"lastName": "Johnson",
+			"firstName": "Robert",
+			"email": "j.r@my.domain.com"
+		},
+		{
+			"id": 6,
+			"lastName": "Garcia",
+			"firstName": "William",
+			"email": "g.w@my.domain.com"
+		},
+		{
+			"id": 7,
+			"lastName": "Davis",
+			"firstName": "Richard",
+			"email": "d.r@my.domain.com"
+		},
+		{
+			"id": 4,
+			"lastName": "Brown",
+			"firstName": "Paul",
+			"email": "b.p@my.domain.com"
+		}
+	],
+	"pageable": {
+		"pagenumber": 0,
+		"pagesize": 4,
+		"sort": {
+			"orders": []
+		}
+	},
+	"totalElements": 8
+}

spring-cloud-openfeign-core/src/test/resources/withPageableAliasPascalCase.json

@@ -0,0 +1,77 @@
+{
+	"content": [
+		{
+			"id": 3,
+			"lastName": "Williams",
+			"firstName": "Thomas",
+			"email": "w.t@my.domain.com"
+		},
+		{
+			"id": 1,
+			"lastName": "Smith",
+			"firstName": "James",
+			"email": "s.j@my.domain.com"
+		},
+		{
+			"id": 11,
+			"lastName": "Scott",
+			"firstName": "Steven",
+			"email": "s.s@my.domain.com"
+		},
+		{
+			"id": 8,
+			"lastName": "Rodriguez",
+			"firstName": "Daniel",
+			"email": "r.d@my.domain.com"
+		},
+		{
+			"id": 9,
+			"lastName": "Martinez",
+			"firstName": "Robert",
+			"email": "m.r@my.domain.com"
+		},
+		{
+			"id": 5,
+			"lastName": "Jones",
+			"firstName": "James",
+			"email": "j.j@my.domain.com"
+		},
+		{
+			"id": 2,
+			"lastName": "Johnson",
+			"firstName": "Robert",
+			"email": "j.r@my.domain.com"
+		},
+		{
+			"id": 6,
+			"lastName": "Garcia",
+			"firstName": "William",
+			"email": "g.w@my.domain.com"
+		},
+		{
+			"id": 7,
+			"lastName": "Davis",
+			"firstName": "Richard",
+			"email": "d.r@my.domain.com"
+		},
+		{
+			"id": 4,
+			"lastName": "Brown",
+			"firstName": "Paul",
+			"email": "b.p@my.domain.com"
+		}
+	],
+	"pageable": {
+		"PageNumber": 3,
+		"PageSize": 2,
+		"sort": {
+			"orders": [
+				{
+					"direction": "ASC",
+					"property": "firstName"
+				}
+			]
+		}
+	},
+	"totalElements": 20
+}

spring-cloud-openfeign-core/src/test/resources/withPageableAliasUnderscore.json

@@ -0,0 +1,77 @@
+{
+	"content": [
+		{
+			"id": 3,
+			"lastName": "Williams",
+			"firstName": "Thomas",
+			"email": "w.t@my.domain.com"
+		},
+		{
+			"id": 1,
+			"lastName": "Smith",
+			"firstName": "James",
+			"email": "s.j@my.domain.com"
+		},
+		{
+			"id": 11,
+			"lastName": "Scott",
+			"firstName": "Steven",
+			"email": "s.s@my.domain.com"
+		},
+		{
+			"id": 8,
+			"lastName": "Rodriguez",
+			"firstName": "Daniel",
+			"email": "r.d@my.domain.com"
+		},
+		{
+			"id": 9,
+			"lastName": "Martinez",
+			"firstName": "Robert",
+			"email": "m.r@my.domain.com"
+		},
+		{
+			"id": 5,
+			"lastName": "Jones",
+			"firstName": "James",
+			"email": "j.j@my.domain.com"
+		},
+		{
+			"id": 2,
+			"lastName": "Johnson",
+			"firstName": "Robert",
+			"email": "j.r@my.domain.com"
+		},
+		{
+			"id": 6,
+			"lastName": "Garcia",
+			"firstName": "William",
+			"email": "g.w@my.domain.com"
+		},
+		{
+			"id": 7,
+			"lastName": "Davis",
+			"firstName": "Richard",
+			"email": "d.r@my.domain.com"
+		},
+		{
+			"id": 4,
+			"lastName": "Brown",
+			"firstName": "Paul",
+			"email": "b.p@my.domain.com"
+		}
+	],
+	"pageable": {
+		"page_number": 1,
+		"page_size": 2,
+		"sort": {
+			"orders": [
+				{
+					"direction": "DESC",
+					"property": "lastName"
+				}
+			]
+		}
+	},
+	"totalElements": 10
+}