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

Posted 2023-02-26

【中文标题】如何使用 Spring RestTemplate 使用 Page<Entity> 响应

【英文标题】：How to consume Page<Entity> response using Spring RestTemplate

【发布时间】：2016-03-10 01:09:19

【问题描述】：

我正在使用 spring 数据 (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)

我应该提供什么类来成功反序列化我的实体页面？

【问题讨论】：

***.com/a/26796142/1588163提出的解决方案怎么样？

【参考方案1】：

您可能可以使用 restTemplate 的交换方法并从中获取正文..

检查以下答案https://***.com/a/31947188/3800576。 这可能对你有帮助

【讨论】：

我试过使用 ParameterizedTypeReference>() 但得到 Jackson 错误

【参考方案2】：

new TypeReference<Page<StoryResponse>>() 

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

new TypeReference<PageImpl<StoryResponse>>() 

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

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());
    

【讨论】：

别忘了添加@JsonIgnoreProperties(ignoreUnknown = true)作为类注解。此属性将有助于忽略需要自定义映射的其他功能。

我仍然给我错误。请看***.com/questions/50826061/…

【参考方案3】：

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

@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> 中已有的所有代码。

【讨论】：

当我尝试使用您的方法时遇到此异常：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

@Sriram 你检查过 1. 你的HelperPage 构造函数有@JsonCreator 注释吗？ 2. 你从你的 restTemplate 得到一个HelpPage？

这是一个比公认答案更好的解决方案。在`@JsonCreator 之后添加@JsonIgnoreProperties(ignoreUnknown = true) 还可以防止在存在未知属性时出现反序列化问题

我仍然给我错误。请看***.com/questions/50826061/…

【参考方案4】：

正如“探路者”所说，您可以使用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://***.com/a/46847429/8805916

【参考方案5】：

如果您查看此线程，并且尝试此答案 https://***.com/a/44895867/8268335

你会遇到第二个问题：

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

然后我从这里找到完美的解决方案： https://***.com/a/42002709/8268335

我根据上面的答案创建了 RestPageImpl 类并解决了问题。

【参考方案6】：

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

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

【讨论】：

您对this one 的回答帮助了我。谢谢。