我有一个使用 Spring-Data 制作的数据访问层。我现在正在它之上创建一个 Web 应用程序。这个 Controller 方法应该返回 Spring-Data Page格式为 JSON。
这样的页面是一个列表,其中包含额外的分页信息,例如记录总数等。
这可能吗?如果可以,怎么做?
与此直接相关,我可以定义属性名称的映射吗?例如。这意味着我需要定义如何在 JSON 中命名分页信息属性(不同于在页面中)。这可能吗?如何实现?
最佳答案
在 Spring HATEOAS 和 Spring Data Commons 中支持这样的场景。 Spring HATEOAS 带有 PageMetadata
本质上包含与 Page
相同数据的对象但以一种不那么强制的方式,以便更容易地编码和解码。
我们结合 Spring HATEOAS 和 Spring Data commons 实现此功能的另一个方面是,简单地编码页面、内容和元数据没有什么值(value),但还希望生成可能存在的下一页或上一页的链接,因此客户端不必自己构造 URI 来遍历这些页面。
一个例子
假设一个域类 Person
:
class Person {
Long id;
String firstname, lastname;
}
以及它对应的仓库:
interface PersonRepository extends PagingAndSortingRepository<Person, Long> { }
您现在可以按如下方式公开 Spring MVC Controller :
@Controller
class PersonController {
@Autowired PersonRepository repository;
@RequestMapping(value = "/persons", method = RequestMethod.GET)
HttpEntity<PagedResources<Person>> persons(Pageable pageable,
PagedResourcesAssembler assembler) {
Page<Person> persons = repository.findAll(pageable);
return new ResponseEntity<>(assembler.toResources(persons), HttpStatus.OK);
}
}
这里可能有很多需要解释的地方。让我们一步一步来:
- 我们有一个 Spring MVC Controller ,将存储库连接到其中。这需要设置 Spring Data(通过
@Enable(Jpa|Mongo|Neo4j|Gemfire)Repositories
或 XML 等效项)。 Controller 方法映射到/persons
,这意味着它将接受所有GET
对该方法的请求。 - 方法返回的核心类型是
PagedResources
- 来自 Spring HATEOAS 的一种类型,它表示一些富含Links
的内容加上PageMetadata
. 调用该方法时,Spring MVC 必须为
Pageable
创建实例和PagedResourcesAssembler
.要使其正常工作,您需要通过@EnableSpringDataWebSupport
启用 Spring Data Web 支持。即将在即将到来的 Spring Data Commons 里程碑中或通过独立 bean 定义引入的注解(记录在 here 中)。Pageable
将填充来自请求的信息。默认配置会变成?page=0&size=10
变成Pageable
以 10 的页面大小请求第一页。PageableResourcesAssembler
让您轻松转一个Page
变成PagedResources
实例。它不仅会将页面元数据添加到响应中,还会根据您访问的页面以及您的Pageable
的方式向表示添加适当的链接。分辨率已配置。
为 JPA 启用此功能的示例 JavaConfig 配置如下所示:
@Configuration
@EnableWebMvc
@EnableSpringDataWebSupport
@EnableJpaRepositories
class ApplicationConfig {
// declare infrastructure components like EntityManagerFactory etc. here
}
请求和响应示例
假设我们有 30 个 Persons
在数据库中。您现在可以触发请求 GET http://localhost:8080/persons
你会看到类似这样的东西:
{ "links" : [
{ "rel" : "next", "href" : "http://localhost:8080/persons?page=1&size=20 }
],
"content" : [
… // 20 Person instances rendered here
],
"pageMetadata" : {
"size" : 20,
"totalElements" : 30,
"totalPages" : 2,
"number" : 0
}
}
请注意,汇编器生成了正确的 URI,并且还选择了默认配置以将参数解析为 Pageable
。对于即将到来的请求。这意味着,如果您更改该配置,链接将自动遵循更改。默认情况下,汇编器指向调用它的 Controller 方法,但可以通过提交自定义 Link
来进行自定义。用作构建指向 PagedResourcesAssembler.toResource(…)
重载的分页链接的基础方法。
展望
PagedResourcesAssembler
bits 将在即将发布的 Spring Data Babbage 里程碑版本中提供 release train .它已在当前快照中可用。您可以在我的 Spring RESTBucks sample application 中看到一个工作示例。 .只需克隆它,运行 mvn jetty:run
和 curl http://localhost:8080/pages
.
关于java - Spring MVC 3 : return a Spring-Data Page as JSON,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/16790371/