如何正确使用PagedResourcesAssembler从Spring数据？

Question

我正在使用Spring 4.0.0. RELEASE，Spring数据共享1.7.0. M1，Spring Hateoas 0.8.0. RELEASE

我的资源是一个简单的POJO：

public class UserResource extends ResourceSupport { ... }

我的资源汇编程序将User对象转换为UserResources对象：

@Component
public class UserResourceAssembler extends ResourceAssemblerSupport<User, UserResource> { 
    public UserResourceAssembler() {
        super(UserController.class, UserResource.class);
    }

    @Override
    public UserResource toResource(User entity) {
        // map User to UserResource
    }
}

在我的UserController我想检索页面

@RequestMapping(value="", method=RequestMethod.GET)
PagedResources<UserResource> get(@PageableDefault Pageable p, PagedResourcesAssembler assembler) {
    Page<User> u = service.get(p)
    return assembler.toResource(u);
}

这不会调用UserResourceAssembler，只返回User的内容，而不是我的自定义UserResource。

返回单个资源有效：

@Autowired
UserResourceAssembler assembler;

@RequestMapping(value="{id}", method=RequestMethod.GET)
UserResource getById(@PathVariable ObjectId id) throws NotFoundException {
    return assembler.toResource(service.getById(id));
}

PagedResourcesAssembler需要一些泛型参数，但是我不能使用t来调用（t），因为我不想转换我的页面

所以问题是：它是如何工作的？

我的WebMVC配置支持：

@Configuration
@ComponentScan
@EnableHypermediaSupport
public class WebMvcConfig extends WebMvcConfigurationSupport {
    @Override
    protected void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers) {
        argumentResolvers.add(pageableResolver());
        argumentResolvers.add(sortResolver());
        argumentResolvers.add(pagedResourcesAssemblerArgumentResolver());
    }

    @Bean
    public HateoasPageableHandlerMethodArgumentResolver pageableResolver() {
        return new HateoasPageableHandlerMethodArgumentResolver(sortResolver());
    }

    @Bean
    public HateoasSortHandlerMethodArgumentResolver sortResolver() {
        return new HateoasSortHandlerMethodArgumentResolver();
    }

    @Bean
    public PagedResourcesAssembler<?> pagedResourcesAssembler() {
        return new PagedResourcesAssembler<Object>(pageableResolver(), null);
    }

    @Bean
    public PagedResourcesAssemblerArgumentResolver pagedResourcesAssemblerArgumentResolver() {
        return new PagedResourcesAssemblerArgumentResolver(pageableResolver(), null);
    }

    /* ... */
}

@Autowired
UserResourceAssembler assembler;

@RequestMapping(value="", method=RequestMethod.GET)
PagedResources<UserResource> get(@PageableDefault Pageable p, PagedResourcesAssembler pagedAssembler) {
    Page<User> u = service.get(p)
    return pagedAssembler.toResource(u, assembler);
}




Answer 1

替代方式

另一种方法是使用范围HTTP头（请参阅RFC 7233中的更多内容）。您可以通过以下方式定义HTTP头：

Range: resources=20-41

也就是说，你想从20到41（包括）获得资源。这种方式允许API的使用者接收精确定义的资源。

这只是另一种方式。范围通常与其他单位（如字节等）一起使用

推荐方式

如果你想使用分页，并且有真正适用的应用编程接口（包括超媒体/HATEOAS），那么我建议在你的网址中添加页面和页面大小。例如：

http://host.loc/articles?Page=1&PageSize=20

然后，您可以在BaseApiController中读取这些数据，并在所有请求中创建一些QueryFilter对象：

{
    var requestHelper = new RequestHelper(Request);

    int page = requestHelper.GetValueFromQueryString<int>("page");
    int pageSize = requestHelper.GetValueFromQueryString<int>("pagesize");

    var filter = new QueryFilter
    {
        Page = page != 0 ? page : DefaultPageNumber,
        PageSize = pageSize != 0 ? pageSize : DefaultPageSize
    };

    return filter;
}

api应该返回一些特殊集合，其中包含有关项目数量的信息。

public class ApiCollection<T>
{
    public ApiCollection()
    {
        Data = new List<T>();
    }

    public ApiCollection(int? totalItems, int? totalPages)
    {
        Data = new List<T>();
        TotalItems = totalItems;
        TotalPages = totalPages;
    }

    public IEnumerable<T> Data { get; set; }

    public int? TotalItems { get; set; }
    public int? TotalPages { get; set; }
}

模型类可以继承某些支持分页的类：

public abstract class ApiEntity
{
    public List<ApiLink> Links { get; set; }
}

public class ApiLink
{
    public ApiLink(string rel, string href)
    {
        Rel = rel;
        Href = href;
    }

    public string Href { get; set; }

    public string Rel { get; set; }
}

Answer 2

我想将资源列表转换为页面。但当给它PagedResourcesSembler时，它正在吞噬内部链接。

这会让你的名单被翻页。

 public class JobExecutionInfoResource extends ResourceSupport {
    private final JobExecutionInfo jobExecution;

    public JobExecutionInfoResource(final JobExecutionInfo jobExecution) {
        this.jobExecution = jobExecution;        
        add(ControllerLinkBuilder.linkTo(methodOn(JobsMonitorController.class).get(jobExecution.getId())).withSelfRel()); // add your own links.          
    }

    public JobExecutionInfo getJobExecution() {
        return jobExecution;
    }
}

分页资源提供资源汇编程序告诉分页资源使用它，它什么也不做，只是返回它，因为它已经是传递的资源列表。

    private final PagedResourcesAssembler<JobExecutionInfoResource> jobExecutionInfoResourcePagedResourcesAssembler;
    public static final PageRequest DEFAULT_PAGE_REQUEST = new PageRequest(0, 20);
    public static final ResourceAssembler<JobExecutionInfoResource, JobExecutionInfoResource> SIMPLE_ASSEMBLER = entity -> entity;

@GetMapping("/{clientCode}/{propertyCode}/summary")
    public PagedResources<JobExecutionInfoResource> getJobsSummary(@PathVariable String clientCode, @PathVariable String propertyCode,
                                                                   @RequestParam(required = false) String exitStatus,
                                                                   @RequestParam(required = false) String jobName,
                                                                   Pageable pageRequest) {
        List<JobExecutionInfoResource> listOfResources = // your code to generate the list of resource;
        int totalCount = 10// some code to get total count;
        Link selfLink = linkTo(methodOn(JobsMonitorController.class).getJobsSummary(clientCode, propertyCode, exitStatus, jobName, DEFAULT_PAGE_REQUEST)).withSelfRel();
        Page<JobExecutionInfoResource> page = new PageImpl<>(jobExecutions, pageRequest, totalCount);
        return jobExecutionInfoResourcePagedResourcesAssembler.toResource(page, SIMPLE_ASSEMBLER, selfLink);
    }

Answer 3

您似乎已经找到了正确的使用方法，但是我想在这里详细介绍一些细节，以便其他人也能找到。在这个答案中，我也详细介绍了PagedResourceAssembler。

Spring HATEOAS附带了各种表示模型的基类，使创建带有链接的表示变得容易。开箱即用提供了三种类型的课程：

• 资源-一个项目资源。有效地环绕一些捕获单个项目并用链接丰富它的DTO或实体。
• Resources-一个集合资源，它可以是某些东西的集合，但通常是资源实例的集合。
• PagedResources-Resources的扩展，用于捕获额外的分页信息，如总页数等。

所有这些类都源自ResourceSupport，它是Link实例的基本容器。

ResourceAssembler现在是将域对象或DTO转换为此类资源实例的缓解组件。这里的重要部分是，它将一个源对象转换为一个目标对象。

因此，PagedResourcesAssembler将获取一个Spring DataPage实例，并通过评估Page并创建必要的PageMetadata以及导航页面的prev和next链接，将其转换为PagedResources实例。默认情况下，它将使用一个普通的SimplePagedResourceAssembler（一个PRA的内部类）将页面的各个元素转换为嵌套的资源实例，这可能是这里最有趣的部分。

为了允许自定义，PRA有附加的toResources（...）方法，这些方法接受委托ResourceAssembler来处理单个项目。因此您最终会得到这样的结果：

 class UserResource extends ResourceSupport { … }

 class UserResourceAssembler extends ResourceAssemblerSupport<User, UserResource> { … }

客户端代码现在看起来像这样：

 PagedResourcesAssembler<User> parAssembler = … // obtain via DI
 UserResourceAssembler userResourceAssembler = … // obtain via DI

 Page<User> users = userRepository.findAll(new PageRequest(0, 10));

 // Tell PAR to use the user assembler for individual items.
 PagedResources<UserResource> pagedUserResource = parAssembler.toResource(
   users, userResourceAssembler);

从即将到来的Spring Data Commons 1.7 RC1（以及Spring HATEOAS 0.9过渡版）开始，prev和next链接将被生成为符合RFC6540的URI模板，以公开HandlerMethodArgumentResolver中为可分页和排序配置的分页请求参数。

通过使用@EnableSpringDataWebSupport注释config类，可以简化上面显示的配置，这将使您摆脱所有显式bean声明。