Spring Boot Rest Controller làm thế nào để trả về các mã trạng thái HTTP khác nhau?

Tôi đang sử dụng Spring Boot cho một API REST đơn giản và muốn trả lại mã trạng thái HTTP chính xác nếu có sự cố.

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

Mới sử dụng Spring và Spring Boot, câu hỏi cơ bản là làm cách nào để trả lại các mã trạng thái khác nhau khi có điều gì đó ổn hoặc không thành công?

Có một số tùy chọn bạn có thể sử dụng. Cách khá tốt là sử dụng các ngoại lệ và lớp để xử lý được gọi là @ControllerAdvice:

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

Ngoài ra, bạn có thể chuyển HttpServletResponseđến phương thức điều khiển và chỉ cần đặt mã phản hồi:

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

Vui lòng tham khảo bài đăng blog tuyệt vời này để biết chi tiết: Xử lý ngoại lệ trong Spring MVC

GHI CHÚ

Trong Spring MVC, sử dụng @ResponseBodychú thích là không cần thiết - nó đã được đưa vào @RestControllerchú thích.

Một trong những cách để làm điều này là bạn có thể sử dụng ResponseEntity làm đối tượng trả về.

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

}

Hãy thử mã này:

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

Một cách hay là sử dụng Spring's ResponseStatusException

Thay vì trả về một ResponseEntityhoặc tương tự, bạn chỉ cần ném ResponseStatusExceptiontừ bộ điều khiển với một HttpStatusvà nguyên nhân, ví dụ:

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

hoặc là:

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

Điều này dẫn đến phản hồi cho ứng dụng khách có trạng thái HTTP (ví dụ: 400 Yêu cầu không hợp lệ) với nội dung như:

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

Trong trường hợp bạn muốn trả về mã trạng thái được xác định tùy chỉnh, bạn có thể sử dụng ResponseEntity như sau:

@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 có thể là bất kỳ số nguyên nào bên trong hoặc bên ngoài Mã trạng thái HTTP tiêu chuẩn.

Có nhiều cách khác nhau để trả về mã trạng thái, 1: Lớp RestController nên mở rộng lớp BaseRest, trong lớp BaseRest chúng ta có thể xử lý ngoại lệ và trả về mã lỗi mong đợi. ví dụ :

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