Spring MVC 3：以 JSON 格式返回 Spring-Data 页面

在Spring HATEOAS和Spring Data Commons中，有对这样的场景的支持。Spring HATEOAS附带了一个对象，该对象基本上包含与a相同的数据，但执行力更低，因此可以更轻松地对其进行封送和取消封送。PageMetadataPage

我们将它与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（通过或XML等效项）。控制器方法映射到 ，这意味着它将接受对该方法的所有请求。@Enable(Jpa|Mongo|Neo4j|Gemfire)Repositories/personsGET
2. 从该方法返回的核心类型是 PagedResources - 来自 Spring HATEOAS 的类型，表示一些内容，这些内容用加一个 .LinksPageMetadata

3. 调用该方法时，Spring MVC 必须为 和 创建实例。为了实现这一点，您需要通过即将在即将到来的Spring Data Commons里程碑中引入的注释或通过独立的bean定义（记录在这里）来启用Spring Data Web支持。PageablePagedResourcesAssembler@EnableSpringDataWebSupport

   将使用请求中的信息填充 。默认配置将变为请求页面大小为 10 的第一页。Pageable?page=0&size=10Pageable

   允许您轻松地将 a 转换为实例。它不仅会将页面元数据添加到响应中，还会根据您访问的页面以及分辨率的配置方式，将适当的链接添加到表示形式。PageableResourcesAssemblerPagePagedResourcesPageable

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

@Configuration
@EnableWebMvc
@EnableSpringDataWebSupport
@EnableJpaRepositories
class ApplicationConfig {

  // declare infrastructure components like EntityManagerFactory etc. here
}

示例请求和响应

假设数据库中有 30 个。您现在可以触发请求，您将看到类似于以下内容的内容：PersonsGET 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，并且还选取了存在的默认配置，以将参数解析为即将发出的请求的 。这意味着，如果更改该配置，链接将自动遵循更改。默认情况下，汇编程序指向调用它的控制器方法，但可以通过提交自定义来自定义，以用作构建指向方法重载的分页链接的基础。PageableLinkPagedResourcesAssembler.toResource(…)

展望

这些位将在即将到来的Spring Data Babbage发布列车的里程碑版本中提供。它已在当前快照中可用。您可以在我的Spring RESTBucks示例应用程序中看到一个工作示例。只需克隆它，运行并卷曲。PagedResourcesAssemblermvn jetty:runhttp://localhost:8080/pages

奥利弗，你的答案很棒，我把它标记为答案。这里只是为了完整性，我同时想出了什么，这可能对其他人有用。

我使用JQuery Datatables作为我的网格/表小部件。它向服务器发送非常具体的参数，除了非常具体的响应：请参阅 http://datatables.net/usage/server-side。

为了实现这一点，创建了一个自定义帮助程序对象，以反映数据表的预期内容。请注意，getter 和 setter 的命名必须像它们一样命名，否则生成的 json 是错误的（区分大小写的属性名称和数据表使用此“伪匈牙利符号”...）。

public class JQueryDatatablesPage<T> implements java.io.Serializable {

    private final int iTotalRecords;
    private final int iTotalDisplayRecords;
    private final String sEcho;
    private final List<T> aaData;

    public JQueryDatatablesPage(final List<T> pageContent,
            final int iTotalRecords,
            final int iTotalDisplayRecords,
            final String sEcho){

        this.aaData = pageContent;
        this.iTotalRecords = iTotalRecords;
        this.iTotalDisplayRecords = iTotalDisplayRecords;
        this.sEcho = sEcho;
    }

    public int getiTotalRecords(){
        return this.iTotalRecords;
    }

    public int getiTotalDisplayRecords(){
        return this.iTotalDisplayRecords;
    }

    public String getsEcho(){
        return this.sEcho;
    }

    public List<T> getaaData(){
        return this.aaData;
    }
}

第二部分是相应控制器中的方法：

@RequestMapping(value = "/search", method = RequestMethod.GET, produces = "application/json")
public @ResponseBody String search (
        @RequestParam int iDisplayStart,
        @RequestParam int iDisplayLength,
        @RequestParam int sEcho, // for datatables draw count
        @RequestParam String search) throws IOException {

    int pageNumber = (iDisplayStart + 1) / iDisplayLength;
    PageRequest pageable = new PageRequest(pageNumber, iDisplayLength);
    Page<SimpleCompound> page = compoundService.myCustomSearchMethod(search, pageable);
    int iTotalRecords = (int) (int) page.getTotalElements();
    int iTotalDisplayRecords = page.getTotalPages() * iDisplayLength;
    JQueryDatatablesPage<SimpleCompound> dtPage = new JQueryDatatablesPage<>(
            page.getContent(), iTotalRecords, iTotalDisplayRecords,
            Integer.toString(sEcho));

    String result = toJson(dtPage);
    return result;

}

private String toJson(JQueryDatatablesPage<?> dt) throws IOException {
    ObjectMapper mapper = new ObjectMapper();
    mapper.registerModule(new Hibernate4Module());
    return mapper.writeValueAsString(dt);
}

compoundService由Spring-Data存储库提供支持。它管理事务和方法级安全性。 方法使用Jackson 2.0，您需要将适当的模块注册到映射器，在我的情况下为休眠4。toJSON()

如果您有双向关系，则需要使用

@JsonIdentityInfo(generator=ObjectIdGenerators.IntSequenceGenerator.class, property="jsonId")

这使 Jackson 2.0 能够序列化循环依赖项（在早期版本中是不可能的，并且需要对实体进行批注）。

您需要添加以下依赖项：

<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-core</artifactId>
    <version>2.2.1</version>
</dependency>
<dependency>
    <groupId>com.fasterxml.jackson.datatype</groupId>
    <artifactId>jackson-datatype-hibernate4</artifactId>
    <version>2.2.1</version>
</dependency>
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-annotations</artifactId>
    <version>2.2.1</version>
    <type>jar</type>
</dependency>