Printemps api rest champs de filtre dans la réponse

Je suis à l'aide de printemps de l'api rest 4.x. Nous avons une exigence de filtrer les champs de la réponse basée sur les paramètres de la requête.

Mon objet Utilisateur:

private class UserResource {
   private String userLastName;
   private String userFirstName;
   private String email;
   private String streetAddress;
}

E.g. URL:  curl -i http://hostname:port/api/v1/users?fields=firstName,lastName.

Dans ce cas j'ai besoin de retourner uniquement les champs qui sont dans la demande de param "champs". Sortie JSON doit contenir uniquement firstName, lastName.

Il y a plusieurs façons de filtrer les champs Jackson en fonction de l'objet. Dans mon cas, j'ai besoin de filtrer dynamiquement par l'adoption de la liste des champs à Jackson sérialiseur.

Merci de partager quelques idées.

InformationsquelleAutor Raj | 2016-02-02
  1. 11

    Merci Ali. Il est d'une grande aide. Permettez-moi de le mettre en œuvre aujourd'hui. Je vais poster le résultat

    @JsonFilter("blah.my.UserEntity")
public class UserEntity implements Serializable {
//fields goes here
}

@RequestMapping(value = "/users", method = RequestMethod.GET, produces = MediaType.APPLICATION_JSON_VALUE)
public MappingJacksonValue getUsers(@RequestParam MultiValueMap<String, String> params) {
//Build pageable here
Page<UserEntity> users = userService.findAll(pageable);

    MappingJacksonValue mappingJacksonValue = new MappingJacksonValue(users);
    FilterProvider filters = new SimpleFilterProvider()
                .addFilter("blah.my.UserEntity", SimpleBeanPropertyFilter
                        .filterOutAllExcept("userFirstName"));
    mappingJacksonValue.setFilters(filters);
    return mappingJacksonValue;
}
    • Ceci est très utile pour moi
    • Des œuvres. Cela devrait être accepté de répondre.
    InformationsquelleAutor Raj
  2. 1

    Utiliser un ResponseBodyAdvice afin de modifier la réponse avant qu'il a été écrit à la réponse HTTP. Dans beforeBodyWrite(...) méthode, vous avez accès à l'actuelle ServerHttpRequest dont vous pouvez lire le fields valeur. Votre corps conseils pourraient ressembler à ce qui suit:

    @ControllerAdvice
public class MyResponseBodyAdvisor implements ResponseBodyAdvice<UserResource> {
    @Override
    public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
        return returnType.getParameterType().equals(UserResource.class);
    }

    @Override
    public UserResource beforeBodyWrite(UserResource body, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
        String fields = ((ServletServerHttpRequest) request).getServletRequest().getParameter("fields");
        //body.set...(null) for each field not in fields

        return body;
    }
}
    • Salut Ali, Dans votre solution, nous faisons des champs vides. Mais je ne veux pas afficher le champ à tous. J'ai mis en œuvre comme décrit dans SPR-12586. Merci.
    • D'annoter vos dto avec @JsonInclude pour supprimer le empty les champs de la réponse
    InformationsquelleAutor Ali Dehghani
  3. 0

    Il semble que cela est pris en charge au Printemps 4.2 comme par https://jira.spring.io/browse/SPR-12586 via Jackson JsonFilter (si le tableau est de retourner une erreur sur le moment).

    • Salut Ben, Merci pour la réponse. Il a été très utile.
    • Voici ma solution. MappingJacksonValue mappingJacksonValue = new MappingJacksonValue(Monobjet); Dans votre contrôleur de juste retour mappingJacksonValue. assurez-vous que MyObject a @JsonFilter("monobjet") annotation.
    InformationsquelleAutor Ben M