Campi di filtro api di riposo a molla nella risposta

Question

Sto usando api di appoggio a molla 4.x. Abbiamo il requisito di filtrare i campi nella risposta in base ai parametri della richiesta.

mio oggetto User:

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. 

In questo caso ho bisogno di tornare solo i campi che si trovano in "campi" Richiesta di param. L'output JSON dovrebbe contenere solo firstName, lastName.

Esistono diversi modi per filtrare i campi in Jackson in base all'oggetto. Nel mio caso ho bisogno di filtrare dinamicamente passando l'elenco dei campi al serializzatore di Jackson.

Si prega di condividere alcune idee.

Answer 1

Utilizzare un ResponseBodyAdvice per modificare la risposta prima che venisse scritta nella risposta HTTP. Nel metodo beforeBodyWrite(...) si ha accesso all'attuale ServerHttpRequest che è possibile leggere il valore fields. Il tuo consiglio corpo sarà simile seguente:

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

Answer 2

Risulta questo è supportato in primavera 4.2 secondo https://jira.spring.io/browse/SPR-12586 via Jackson JsonFilter (anche se il jira restituisce un errore al momento).

Answer 3

Grazie Ali. È un grande aiuto. Lascia che io lo realizzi oggi. Pubblicherò il risultato

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