Spring MVC 3：将Spring-Data Page作为JSON返回

Question

我有一个用Spring-Data制作的数据访问层。我现在正在其上创建一个Web应用程序。这个控制器方法应返回一个格式为JSON 的Spring-Data
Page
。

这样的页面是带有附加分页信息（例如记录总数等）的列表。

这可能吗？如果可以，怎么办？

与之直接相关的是，我可以定义属性名称的映射吗？例如。这意味着我需要定义如何在JSON中（与页面中不同）命名页面信息属性。这有可能吗？

Answer 1

Spring HATEOAS和Spring Data Commons中将支持这种情况。Spring
HATEOAS附带了一个PageMetadata对象，该对象本质上包含与a 相同的数据，Page但执行方式较少，因此可以更轻松地将其编组和拆组。

我们将其与Spring HATEOAS和Spring Data
commons结合实现的原因的另一方面是，仅对页面，其内容和元数据进行封送处理并没有价值，但还希望生成指向可能存在的下一页或上一页的链接，因此客户端不必构造URI即可遍历这些页面。

一个例子

假设一个域类Person：

class Person {

  Long id;
  String firstname, lastname;
}

以及相应的存储库：

interface PersonRepository extends PagingAndSortingRepository<Person, Long> { }

现在，您可以公开一个Spring MVC控制器，如下所示：

@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);
  }
}

这里可能有很多解释。让我们逐步进行：

1. 我们有一个Spring MVC控制器，将存储库连接到其中。这需要设置Spring Data（通过@Enable(Jpa|Mongo|Neo4j|Gemfire)RepositoriesXML等效项）。该controller方法映射到/persons，这意味着它将接受GET对该方法的所有请求。
2. 从该方法返回的核心类型是a PagedResources-Spring HATEOAS的类型，它表示一些内容中带有Links加号的内容PageMetadata。
3. 调用该方法时，Spring MVC将必须为Pageable和创建实例PagedResourcesAssembler。为了使此工作正常进行，您需要通过@EnableSpringDataWebSupport即将在Spring Data Commons里程碑中引入的注释或通过独立的bean定义（在此处记录）来启用Spring Data Web支持。

该Pageable会从请求信息来填充。默认配置将转向?page=0&size=10成Pageable由10个页面大小请求的第一页。

将PageableResourcesAssembler让你轻松转Page成一个PagedResources实例。它将不仅将页面元数据添加到响应中，还将基于您访问的页面以及如何Pageable配置分辨率将适当的链接html" target="_blank">添加到表示中。

为JPA启用此功能的示例JavaConfig配置如下所示：

@Configuration
@EnableWebMvc
@EnableSpringDataWebSupport
@EnableJpaRepositories
class ApplicationConfig {

  // declare infrastructure components like EntityManagerFactory etc. here
}

样本请求和响应

假设Persons数据库中有30个。现在，您可以触发请求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为即将到来的请求。这意味着，如果您更改该配置，则链接将自动遵循更改。默认情况下，汇编器指向调用该方法的控制器方法，但可以通过传递一个自定义Link来对其进行自定义，以用作基础来建立指向该PagedResourcesAssembler.toResource(…)方法重载的分页链接。

外表

这些PagedResourcesAssembler位将在Spring Data Babbage
发布系列的即将发布的里程碑版本中提供。当前快照中已提供该功能。您可以在我的Spring RESTBucks
示例应用程序中看到一个有效的示例。只需将其克隆，运行mvn jetty:run并卷曲即可http://localhost:8080/pages。