Question

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

这样的页面是一个列表，其中包含额外的分页信息，例如记录总数等等。

这是可能的，如果是，如何？

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

Answer 1

支持Spring HATEOAS和Spring Data Commons即将发布的场景。 Spring HATEOAS附带一个PageMetadata对象，它基本上包含与Page相同的数据，但执行方式较少，因此可以更容易地编组和解组。

我们与Spring HATEOAS和Spring Data共同实现这一点的另一个方面是，简单封送页面，内容和元数据几乎没有价值，但也想生成可能存在的下一页或前一页的链接，以便客户端不必构造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);
  }
}

这里可能有相当多的解释。让我们一步一步来看：

我们有一个Spring MVC控制器将存储库连接到它。这需要设置Spring Data（通过@Enable(Jpa|Mongo|Neo4j|Gemfire)Repositories或XML等价物）。控制器方法映射到/persons，这意味着它将接受对该方法的所有GET个请求。
从该方法返回的核心类型是PagedResources - 来自Spring HATEOAS的一种类型，表示一些内容丰富了Links加上PageMetadata。
调用该方法时，Spring MVC必须为Pageable和PagedResourcesAssembler创建实例。为了实现这一点，您需要通过即将在Spring Data Commons的里程碑中引入的@EnableSpringDataWebSupport注释或通过独立的bean定义（记录为here）来启用Spring Data Web支持。

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即将发出的请求。这意味着，如果更改该配置，链接将自动遵循更改。默认情况下，汇编程序指向它所调用的控制器方法，但可以通过交换自定义Link来定制，以用作基础来构建PagedResourcesAssembler.toResource(…)方法重载的分页链接。 / p>

观

PagedResourcesAssembler位将在即将发布的Spring Data Babbage release train里程碑版本中提供。它已在当前快照中可用。你可以在我的Spring RESTBucks sample application中看到一个这样的工作示例。只需克隆它，运行mvn jetty:run并卷曲http://localhost:8080/pages。

Answer 2

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

我使用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存储库提供支持。它管理事务和方法级别的安全性。 toJSON()方法使用Jackson 2.0，你需要将相应的模块注册到映射器，就我的情况而言是hibernate 4。

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

注释所有实体类

@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>

Answer 3

使用Spring Boot（对于Mongo DB），我能够执行以下操作并获得成功的结果：

@RestController
@RequestMapping("/product")
public class ProductController {
   //...
    @RequestMapping(value = "/all", method = RequestMethod.GET, produces = {MediaType.APPLICATION_JSON_VALUE })
       HttpEntity<PagedResources<Product>> get(@PageableDefault Pageable p, PagedResourcesAssembler assembler) {
       Page<Product> product = productRepository.findAll(p);
       return new ResponseEntity<>(assembler.toResource(product), HttpStatus.OK);
    }
}

和模型类是这样的：

@Document(collection = "my_product")
@Data
@ToString(callSuper = true)
public class Product extends BaseProduct {
    private String itemCode;
    private String brand;
    private String sku;    
}

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

3 个答案:

一个例子

样本请求和响应

观