Provide a SlicedModel DTO to render stable JSON representations of Slice - #3541
Open
arnabnandy7 wants to merge 1 commit into
Open
arnabnandy7 wants to merge 1 commit into
arnabnandy7 wants to merge 1 commit into
Conversation
…ice. Signed-off-by: Arnab Nandy <arnab_nandy7@yahoo.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Provide a SlicedModel DTO to render stable JSON representations of Slice.
org.springframework.data.web.PagedModelwas introduced in 3.3 via #3024 as a middle ground between serializingPageImpldirectly and adopting Spring HATEOAS. There was previously no equivalent forSlice.Problem
Returning a
Slicefrom a Spring MVC controller carried stability risks:SliceImplis a domain type and serializing it directly exposes internal structure that can change across releases.DIRECTmode, no warning was emitted forSliceImplinstances.SlicedResourcesAssembler) had to define custom DTOs per project to wrapSlice.Solution
This PR introduces
SlicedModel<T>inorg.springframework.data.web, mirroringPagedModelin shape and usage:SlicedModel<T>andSliceMetadata:contentandpagemetadata (size,number,numberOfElements,hasNext).totalElementsandtotalPagesas that information is unavailable on aSlice.equals(Object)andhashCode().PageSerializationMode.VIA_DTO, registers a mix-in onSliceImpl.classwithSliceModelConverterto wrapSliceImplinstances intoSlicedModel.PageSerializationMode.DIRECT, emits a one-time warning log highlighting stability risks and suggestingSlicedModelorSlicedResourcesAssembler.@EnableSpringDataWebSupportandPageSerializationModeJavadocs to documentSliceImplandSlicedModel.WebRuntimeHintsforSlicedModel,SliceMetadata, andSliceModelConverter.SlicedModelincore-extensions-web.adocandaot.adoc.SlicedModelUnitTests,PageImplJsonSerializationUnitTests,PageImplJsonJackson2SerializationUnitTests,EnableSpringDataWebSupportIntegrationTests, andWebRuntimeHintsUnitTests.Closes #3516