Comment utiliser correctement PagedResourcesAssembler à partir de Données du Printemps?

Vous semblent déjà avoir trouvé la bonne façon de l'utiliser, mais je voudrais entrer dans certains détails ici un peu pour les autres à trouver. Je suis allé dans des détails semblables sur PagedResourceAssembler dans cette réponse.

Modèles de représentation de l'

Printemps HATEOAS est livré avec une variété de classes de base pour les modèles de représentation qui font qu'il est facile de créer des représentations équipé avec des liens. Il existe trois types de classes sont fournis à l'extérieur de la boîte:

• Resource - un élément de ressource. Effectivement, pour envelopper autour de certains DTO ou de l'entité qui capture un unique élément et l'enrichit avec des liens.
• Resources - une collection de ressources, qui peut être une collection de choses, mais, habituellement, sont une collection de Resource instances.
• PagedResources - une extension de Resources que les captures supplémentaires de la pagination des informations comme le nombre total de pages etc.

Toutes ces classes dérivent de ResourceSupport, qui est un conteneur pour Link instances.

Ressources assembleurs

Un ResourceAssembler est maintenant l'atténuation de la composante de convertir vos objets du domaine ou de l'Otd dans ces instances de ressources. L'important est ici, qu'il s' un objet source dans un objet cible.

De sorte que le PagedResourcesAssembler va prendre un Printemps de Données Page instance et de la transformer en un PagedResources exemple par l'évaluation de la Page et de la création de la nécessaire PageMetadata ainsi que la prev et next liens pour naviguer dans les pages. Par défaut - et c'est probablement la partie la plus intéressante ici - il utiliser une plaine SimplePagedResourceAssembler (un à l'intérieur de la classe de PRA) pour transformer les différents éléments de la page en imbriquée Resource instances.

Permettent de le personnaliser, PRA a d'autres toResource(…) des méthodes qui prennent un délégué ResourceAssembler pour traiter les éléments individuels. Si vous vous retrouvez avec quelque chose comme ceci:

 class UserResource extends ResourceSupport { … }

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

Et le code client maintenant à la recherche de quelque chose comme ceci:

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

Outlook

De Printemps à venir des Données Communes de 1,7 RC1 (et le Printemps HATEOAS de 0,9 transitivement) le prev et next liens seront générés comme RFC6540 conforme URI modèles à exposer la pagination à la demande des paramètres configurés dans le HandlerMethodArgumentResolvers pour Pageable et Sort.

La configuration que vous avez indiqué ci-dessus peut être simplifiée par l'annotation de la config de classe avec @EnableSpringDataWebSupport qui vous permet de vous débarrasser de toutes les explicite bean déclarations.

AUTRE FAÇON

Un autre moyen est d'utiliser la Gamme d'en-tête HTTP (lire la suite dans RFC 7233). Vous pouvez définir l'en-tête HTTP de cette façon:

Range: resources=20-41

Qui signifie, vous souhaitez obtenir des ressources de 20 à 41 (y compris). De cette façon permet consuments de l'API de recevoir exactement défini ressources.

C'est juste la façon alternative. La gamme est souvent utilisé avec d'autres unités (comme les octets etc.)

RECOMMANDÉ

Si vous voulez travailler avec la pagination et ont vraiment applicable API (hypermédia /HATEOAS inclus) alors je recommande d'ajouter une Page et PageSize à votre URL. Exemple:

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

Ensuite, vous pouvez lire ces données dans votre BaseApiController et de créer une certaine QueryFilter objet dans l'ensemble de vos demandes:

{
    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;
}

Votre api retourne quelques collection spéciale avec des informations sur le nombre d'éléments.

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

Votre modèle de classes peuvent hériter d'une classe avec la pagination de soutien:

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