如何使用 Spring RestTemplate 使用 Page<Entity> 响应
How to consume Page<Entity> response using Spring RestTemplate
我正在使用 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)
我应该提供什么 class 才能成功反序列化我的实体页面?
你或许可以使用 restTemplate 的交换方法并从中获取正文..
检查以下答案 。
这可能对您有所帮助
new TypeReference<Page<StoryResponse>>() {}
此语句的问题在于 Jackson 无法实例化抽象类型。您应该向 Jackson 提供有关如何使用具体类型实例化 Page
的信息。但它的具体类型 PageImpl
没有默认构造函数或任何 @JsonCreator
,因此您可以 而不是 使用以下代码:
new TypeReference<PageImpl<StoryResponse>>() {}
由于您无法将所需信息添加到 Page
class,因此最好为具有默认无参数构造函数的 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());
}
}
我知道这个帖子有点旧,但希望有人能从中受益。
@Ali Dehghani 的回答很好,只是它重新实现了 PageImpl<T>
已经完成的工作。我认为这是相当不必要的。我通过创建扩展 PageImpl<T>
并指定 @JsonCreator
构造函数的 class 找到了更好的解决方案:
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>
class 相同,但允许我们利用 PageImpl<T>
.
中已有的所有代码
如 "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
还包含页面元数据和链接。
此处提供更详细的说明:
如果您查看此线程,并且尝试此答案
你会遇到第二个问题:
Can not construct instance of org.springframework.data.domain.Pageable
然后我从这里找到了完美的解决方案:
我根据上面的答案创建了 class RestPageImpl
并解决了问题。
如果您使用 spring-cloud-openfeign,您可以使用 PageJacksonModule。
只需在您的对象映射器中注册 PageJacksonModule:
final ObjectMapper mapper = new ObjectMapper()
mapper.registerModule(new PageJacksonModule());
我正在使用 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)
我应该提供什么 class 才能成功反序列化我的实体页面?
你或许可以使用 restTemplate 的交换方法并从中获取正文..
检查以下答案 。 这可能对您有所帮助
new TypeReference<Page<StoryResponse>>() {}
此语句的问题在于 Jackson 无法实例化抽象类型。您应该向 Jackson 提供有关如何使用具体类型实例化 Page
的信息。但它的具体类型 PageImpl
没有默认构造函数或任何 @JsonCreator
,因此您可以 而不是 使用以下代码:
new TypeReference<PageImpl<StoryResponse>>() {}
由于您无法将所需信息添加到 Page
class,因此最好为具有默认无参数构造函数的 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());
}
}
我知道这个帖子有点旧,但希望有人能从中受益。
@Ali Dehghani 的回答很好,只是它重新实现了 PageImpl<T>
已经完成的工作。我认为这是相当不必要的。我通过创建扩展 PageImpl<T>
并指定 @JsonCreator
构造函数的 class 找到了更好的解决方案:
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>
class 相同,但允许我们利用 PageImpl<T>
.
如 "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
还包含页面元数据和链接。
此处提供更详细的说明:
如果您查看此线程,并且尝试此答案
你会遇到第二个问题:
Can not construct instance of org.springframework.data.domain.Pageable
然后我从这里找到了完美的解决方案:
我根据上面的答案创建了 class RestPageImpl
并解决了问题。
如果您使用 spring-cloud-openfeign,您可以使用 PageJacksonModule。 只需在您的对象映射器中注册 PageJacksonModule:
final ObjectMapper mapper = new ObjectMapper()
mapper.registerModule(new PageJacksonModule());