Spring Boot Rest Controller Farklı HTTP durum kodları nasıl döndürülür?

Spring Boot'u basit bir REST API için kullanıyorum ve bir şey başarısız olursa doğru bir HTTP durum kodu döndürmek istiyorum.

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

Spring ve Spring Boot'ta yeni olduğum için temel soru, bir şeyler yolunda gittiğinde veya başarısız olduğunda farklı durum kodlarını nasıl döndürebilirim?

Kullanabileceğiniz birkaç seçenek var. Oldukça iyi bir yol, işleme için istisnaları ve sınıfı kullanmaktır @ControllerAdvice:

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

Ayrıca HttpServletResponsedenetleyici yöntemine geçebilir ve yalnızca yanıt kodunu ayarlayabilirsiniz:

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

Ayrıntılar için lütfen bu harika blog gönderisine bakın: Spring MVC'de İstisna Yönetimi

NOT

Spring MVC'de @ResponseBodyaçıklama kullanmak gereksizdir - zaten @RestControlleraçıklamaya dahil edilmiştir .

Bunu yapmanın yollarından biri, ResponseEntity'yi dönüş nesnesi olarak kullanabilmenizdir.

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

}

Bu kodu deneyin:

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

Spring'in ResponseStatusException'ını kullanmanın güzel bir yolu

Bir ResponseEntityveya benzerini iade etmek yerine ResponseStatusException, denetleyiciden bir HttpStatusve neden ile basitçe atarsınız, örneğin:

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

veya:

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

Bu, istemciye HTTP durumunu içeren bir yanıtla sonuçlanır (ör. 400 Kötü istek) ve aşağıdaki gibi bir gövdeyle:

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

Özel tanımlı bir durum kodu döndürmek istemeniz durumunda, ResponseEntity'yi aşağıdaki gibi kullanabilirsiniz:

@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, standart HTTP Durum Kodlarının içindeki veya dışındaki herhangi bir tam sayı olabilir.

Durum kodunu döndürmenin farklı yolları vardır, 1: RestController sınıfı BaseRest sınıfını genişletmelidir, BaseRest sınıfında istisnayı ele alabilir ve beklenen hata kodlarını döndürebiliriz. Örneğin :

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