Spring Boot Rest Controller come restituire diversi codici di stato HTTP?

Sto usando Spring Boot per una semplice API REST e vorrei restituire uno stato HTTP corretto se qualcosa non funziona.

@RequestMapping(value="/rawdata/", method = RequestMethod.PUT)
@ResponseBody
@ResponseStatus( HttpStatus.OK )
public RestModel create(@RequestBody String data) {
    // code ommitted..
    // how do i return a correct status code if something fails?
}

Essendo nuovo in Spring e Spring Boot, la domanda di base è come restituire codici di stato diversi quando qualcosa va bene o non funziona?

Ci sono diverse opzioni che puoi usare. Un modo abbastanza buono è usare eccezioni e classi per la gestione di chiamate @ControllerAdvice:

@ControllerAdvice
class GlobalControllerExceptionHandler {
    @ResponseStatus(HttpStatus.CONFLICT)  // 409
    @ExceptionHandler(DataIntegrityViolationException.class)
    public void handleConflict() {
        // Nothing to do
    }
}

Inoltre puoi passare HttpServletResponseal metodo del controller e impostare semplicemente il codice di risposta:

public RestModel create(@RequestBody String data, HttpServletResponse response) {
    // response committed...
    response.setStatus(HttpServletResponse.SC_ACCEPTED);
}

Fare riferimento a questo fantastico post del blog per i dettagli: Gestione delle eccezioni in Spring MVC

NOTA

In Spring MVC l'uso @ResponseBodydell'annotazione è ridondante: è già incluso nell'annotazione @RestController.

Uno dei modi per farlo è usare ResponseEntity come oggetto di ritorno.

@RequestMapping(value="/rawdata/", method = RequestMethod.PUT)

public ResponseEntity<?> create(@RequestBody String data) {

if(everything_fine)
    return new ResponseEntity<>(RestModel, HttpStatus.OK);
else
    return new ResponseEntity<>(null, HttpStatus.INTERNAL_SERVER_ERROR);

}

Prova questo codice:

@RequestMapping(value = "/validate", method = RequestMethod.GET, produces = "application/json")
public ResponseEntity<ErrorBean> validateUser(@QueryParam("jsonInput") final String jsonInput) {
    int numberHTTPDesired = 400;
    ErrorBean responseBean = new ErrorBean();
    responseBean.setError("ERROR");
    responseBean.setMensaje("Error in validation!");

    return new ResponseEntity<ErrorBean>(responseBean, HttpStatus.valueOf(numberHTTPDesired));
}

Un bel modo è usare ResponseStatusException di Spring

Piuttosto che restituire un ResponseEntityo simile, devi semplicemente lanciare il ResponseStatusExceptiondal controller con una HttpStatuscausa e, ad esempio:

throw new ResponseStatusException(HttpStatus.BAD_REQUEST, "Cause description here");

o:

throw new ResponseStatusException(HttpStatus.INTERNAL_SERVER_ERROR, "Cause description here");

Ciò si traduce in una risposta al client contenente lo stato HTTP (ad esempio 400 Bad request) con un corpo come:

{
  "timestamp": "2020-07-09T04:43:04.695+0000",
  "status": 400,
  "error": "Bad Request",
  "message": "Cause description here",
  "path": "/test-api/v1/search"
}

Nel caso in cui desideri restituire un codice di stato definito personalizzato, puoi utilizzare ResponseEntity come qui:

@RequestMapping(value="/rawdata/", method = RequestMethod.PUT)
public ResponseEntity<?> create(@RequestBody String data) {
    int customHttpStatusValue = 499;
    Foo foo = bar();
    return ResponseEntity.status(customHttpStatusValue).body(foo);
}

CustomHttpStatusValue può essere qualsiasi numero intero all'interno o all'esterno dei codici di stato HTTP standard.

Esistono diversi modi per restituire il codice di stato, 1: la classe RestController dovrebbe estendere la classe BaseRest, nella classe BaseRest possiamo gestire le eccezioni e restituire i codici di errore previsti. per esempio :

@RestController
@RequestMapping
class RestController extends BaseRest{

}

@ControllerAdvice
public class BaseRest {
@ExceptionHandler({Exception.class,...})
    @ResponseStatus(value=HttpStatus.INTERNAL_SERVER_ERROR)
    public ErrorModel genericError(HttpServletRequest request, 
            HttpServletResponse response, Exception exception) {
        
        ErrorModel error = new ErrorModel();
        resource.addError("error code", exception.getLocalizedMessage());
        return error;
    }