如何使用Spring RestTemplate消费Page<Entity>响应

Question

我正在使用Spring Data（MongoDB），并且我已经有了我的存储库：

public interface StoriesRepository extends PagingAndSortingRepository<Story, String> {}

然后我有一个控制器：

@RequestMapping(method = RequestMethod.GET)
public ResponseEntity<Page<StoryResponse>> getStories(Pageable pageable) {
    Page<StoryResponse> stories = storiesRepository.findAll(pageable).map(StoryResponseMapper::toStoryResponse);
    return ResponseEntity.ok(stories);
}

一切都很好，但我无法使用RestTemplate getForEntity方法消费我的端点：

def entity = restTemplate.getForEntity(getLocalhost("/story"), new TypeReference<Page<StoryResponse>>(){}.class)

我应该提供哪个类才能成功地反序列化我的实体页面？

- bgalek

---

https://dev59.com/yWAg5IYBdhLWcg3wYZ-6#26796142 提出的解决方案怎么样？ - clapas

Answer 1

new TypeReference<Page<StoryResponse>>() {}

这个声明的问题在于Jackson无法实例化抽象类型。您应该向Jackson提供有关如何使用具体类型实例化Page的信息。但它的具体类型PageImpl没有默认构造函数，也没有任何@JsonCreator，因此您也不能使用以下代码：

new TypeReference<PageImpl<StoryResponse>>() {}

由于您无法向Page类添加所需的信息，因此最好创建一个实现了默认无参构造函数的Page接口的自定义实现，例如这个答案。然后在类型引用中使用该自定义实现，如下所示：

new TypeReference<CustomPageImpl<StoryResponse>>() {}

这里是定制实现，从链接的问题中复制而来:

public class CustomPageImpl<T> extends PageImpl<T> {
    private static final long serialVersionUID = 1L;
    private int number;
    private int size;
    private int totalPages;
    private int numberOfElements;
    private long totalElements;
    private boolean previousPage;
    private boolean firstPage;
    private boolean nextPage;
    private boolean lastPage;
    private List<T> content;
    private Sort sort;

    public CustomPageImpl() {
        super(new ArrayList<>());
    }

    @Override
    public int getNumber() {
        return number;
    }

    public void setNumber(int number) {
        this.number = number;
    }

    @Override
    public int getSize() {
        return size;
    }

    public void setSize(int size) {
        this.size = size;
    }

    @Override
    public int getTotalPages() {
        return totalPages;
    }

    public void setTotalPages(int totalPages) {
        this.totalPages = totalPages;
    }

    @Override
    public int getNumberOfElements() {
        return numberOfElements;
    }

    public void setNumberOfElements(int numberOfElements) {
        this.numberOfElements = numberOfElements;
    }

    @Override
    public long getTotalElements() {
        return totalElements;
    }

    public void setTotalElements(long totalElements) {
        this.totalElements = totalElements;
    }

    public boolean isPreviousPage() {
        return previousPage;
    }

    public void setPreviousPage(boolean previousPage) {
        this.previousPage = previousPage;
    }

    public boolean isFirstPage() {
        return firstPage;
    }

    public void setFirstPage(boolean firstPage) {
        this.firstPage = firstPage;
    }

    public boolean isNextPage() {
        return nextPage;
    }

    public void setNextPage(boolean nextPage) {
        this.nextPage = nextPage;
    }

    public boolean isLastPage() {
        return lastPage;
    }

    public void setLastPage(boolean lastPage) {
        this.lastPage = lastPage;
    }

    @Override
    public List<T> getContent() {
        return content;
    }

    public void setContent(List<T> content) {
        this.content = content;
    }

    @Override
    public Sort getSort() {
        return sort;
    }

    public void setSort(Sort sort) {
        this.sort = sort;
    }

    public Page<T> pageImpl() {
        return new PageImpl<>(getContent(), new PageRequest(getNumber(),
                getSize(), getSort()), getTotalElements());
    }
}

- Ali Dehghani

---

不要忘记在类注释中添加@JsonIgnoreProperties(ignoreUnknown = true)。此属性将有助于忽略需要自定义映射的附加特性。 - Menelaos Kotsollaris

它仍然给我错误。请查看https://dev59.com/B1UL5IYBdhLWcg3wHU_M - Shaunyl

Answer 2

我知道这个帖子有点旧，但希望有人能从中受益。

@Ali Dehghani的回答很好，只是重新实现了PageImpl<T>已经完成的工作。我认为这是不必要的。我找到了一个更好的解决方案，通过创建一个继承PageImpl<T>并指定@JsonCreator构造函数的类：

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.company.model.HelperModel;
import org.springframework.data.domain.PageImpl;
import org.springframework.data.domain.PageRequest;

import java.util.List;

public class HelperPage extends PageImpl<HelperModel> {

    @JsonCreator
    // Note: I don't need a sort, so I'm not including one here.
    // It shouldn't be too hard to add it in tho.
    public HelperPage(@JsonProperty("content") List<HelperModel> content,
                      @JsonProperty("number") int number,
                      @JsonProperty("size") int size,
                      @JsonProperty("totalElements") Long totalElements) {
        super(content, new PageRequest(number, size), totalElements);
    }
}

然后：

HelperPage page = restTemplate.getForObject(url, HelperPage.class);

这与创建一个CustomPageImpl<T>类相同，但允许我们利用已经存在于PageImpl<T>中的所有代码。

- teuber789

---

当我尝试使用你的方法时，我遇到了这个异常： org.springframework.http.converter.HttpMessageConversionException: Type definition error: [simple type, class org.springframework.data.domain.Pageable]; nested exception is com.fasterxml.jackson.databind.exc.InvalidDefinitionException: Can not construct instance of org.springframework.data.domain.Pageable (no Creators, like default construct, exist): abstract types either need to be mapped to concrete types, have custom deserializer, or contain additional type information - Sri

@Sriram 你检查过以下两点了吗？1. 你的 HelperPage 构造函数是否有 @JsonCreator 注解？2. 你从 restTemplate 中获取到了一个 HelpPage 吗？ - Isammoc

这是比被接受的答案更好的解决方案。在@JsonCreator之后添加@JsonIgnoreProperties(ignoreUnknown = true)也可以防止反序列化时出现未知属性的问题。 - robjwilkins

它仍然给我错误。请查看https://dev59.com/B1UL5IYBdhLWcg3wHU_M - Shaunyl

Answer 3

正如“pathfinder”所提到的，您可以使用RestTemplate的exchange方法。但是，您应该传递ParameterizedTypeReference<PagedResources<StoryResponse>>()而不是ParameterizedTypeReference<Page<StoryResponse>>()。当您获取响应时，可以检索内容-Collection<StoryResponse>。

代码应该像这样：

ResponseEntity<PagedResources<StoryResponse>> response = restTemplate.exchange(getLocalhost("/story"),
        HttpMethod.GET, null, new ParameterizedTypeReference<PagedResources<StoryResponse>>() {});
PagedResources<StoryResponse> storiesResources = response.getBody();
Collection<StoryResponse> stories = storiesResources.getContent();

除了 storiesResources 内容之外，它还包含页面元数据和链接。

这里提供了更详细的逐步说明：https://dev59.com/KFsW5IYBdhLWcg3wuZRy#46847429

- Vladimir Mitev

Answer 4

如果您使用spring-cloud-openfeign，您可以使用PageJacksonModule。只需在对象映射器中注册PageJacksonModule即可：

final ObjectMapper mapper = new ObjectMapper()
mapper.registerModule(new PageJacksonModule());

- Egor

---

你的回答 this one 对我很有帮助。谢谢。 - Filipe Fonseca

Answer 5

如果您正在查看此线程，并尝试此答案https://dev59.com/sFsX5IYBdhLWcg3wNtLA#44895867，您将遇到第二个问题：

Can not construct instance of org.springframework.data.domain.Pageable

我从这里找到了完美的解决方案： https://dev59.com/KFsW5IYBdhLWcg3wuZRy#42002709

我创建了RestPageImpl类，问题得以解决。

- Terrence Wei

Answer 6

在一个使用了Spring Boot默认启用Jackson模块的现代Spring Boot应用程序中，你可以做一些非常简单的事情，比如：

@JsonIgnoreProperties("pageable")
public class JacksonPage<T> extends PageImpl<T> {
    private JacksonPage(List<T> content, int number, int size, long totalElements) {
        super(content, PageRequest.of(number, size), totalElements);
    }
}

- raven

Answer 7

你可以使用restTemplate的exchange方法，并从中获取响应体。

请参考以下答案https://dev59.com/yWAg5IYBdhLWcg3wYZ-6#31947188。这可能会对您有所帮助。

- pathfinder

---

我尝试使用ParameterizedTypeReference<Page<StoryResponse>>()，但出现了Jackson错误。 - bgalek