Was ist der beste Weg, um verschiedene Arten von ResponseEntity in Spring-Boot zurückzugeben (Fehlerbehandlung für REST mit Spring)

Ich habe eine einfache REST-Anwendung in geschrieben Spring Boot (Spring Rahmen).

Es kehrt zurück ResponseEntity<Success> als Erfolg Reaktion in der Steuerungsebene. Aber ich möchte eine ganz andere zurückgeben Fehler Antwort ResponseEntity<Error>falls ein Fehler vorliegt (Validierungsfehler, Logikfehler, Laufzeitfehler) in der API.

Erfolg & Fehler Antworten sind für die Anwendung völlig unterschiedlich.
Success & Error sind die 2 Java-Klassen, die die Anwendung zur Darstellung verwendet Erfolg & Fehler Antworten.

Was ist der beste Weg, um verschiedene Arten von zurückzugeben ResponseEntity In Spring-Boot (Der beste Weg, um die Fehler für REST mit zu behandeln Spring)?

Ich empfehle die Verwendung von Spring’s @ControllerAdvice Fehler zu behandeln. Lesen diese Anleitung für eine gute Einführung, beginnend mit dem Abschnitt “Spring Boot Error Handling”. Für eine eingehende Diskussion gibt’s ein Artikel im Spring.io-Blog, der im April 2018 aktualisiert wurde.

Eine kurze Zusammenfassung, wie das funktioniert:

• Ihre Controller-Methode sollte nur zurückkehren ResponseEntity<Success>. Es ist nicht für die Rückgabe von Fehler- oder Ausnahmeantworten verantwortlich.
• Sie implementieren eine Klasse, die Ausnahmen für alle Controller behandelt. Diese Klasse wird mit kommentiert @ControllerAdvice
• Diese Controller Advice-Klasse enthält Methoden, die mit annotiert sind @ExceptionHandler
• Jede Ausnahmebehandlungsmethode wird so konfiguriert, dass sie einen oder mehrere Ausnahmetypen behandelt. Mit diesen Methoden geben Sie den Antworttyp für Fehler an
• Für Ihr Beispiel würden Sie (in der Controller Advice-Klasse) eine Ausnahmebehandlungsmethode für den Validierungsfehler deklarieren. Der Rückgabetyp wäre ResponseEntity<Error>

Bei diesem Ansatz müssen Sie die Ausnahmebehandlung Ihres Controllers nur an einer Stelle für alle Endpunkte in Ihrer API implementieren. Es macht es Ihrer API auch leicht, eine einheitliche Ausnahmeantwortstruktur für alle Endpunkte zu haben. Dies vereinfacht die Ausnahmebehandlung für Ihre Clients.

Sie können einen generischen Platzhalter zurückgeben <?> zurückgeben Success Und Error auf einer gleichen Anforderungszuordnungsmethode

public ResponseEntity<?> method() {
    boolean b = // some logic
    if (b)
        return new ResponseEntity<Success>(HttpStatus.OK);
    else
        return new ResponseEntity<Error>(HttpStatus.CONFLICT); //appropriate error code
}

@ Mark Norman Antwort ist der richtige Ansatz

Frühling 2 eingeführt ResponseStatusException Mit diesem können Sie zurückkehren String, anderer HTTP-Statuscode, DTO am gleiche Zeit.

@PostMapping("/save")
public ResponseEntity<UserDto> saveUser(@RequestBody UserDto userDto) {
    if(userDto.getId() != null) {
        throw new ResponseStatusException(HttpStatus.NOT_ACCEPTABLE,"A new user cannot already have an ID");
    }
    return ResponseEntity.ok(userService.saveUser(userDto));
}

Ich bin mir nicht sicher, aber ich denke, Sie können verwenden @ResponseEntity Und @ResponseBody und senden Sie 2 verschiedene, eine ist Erfolg und die zweite ist eine Fehlermeldung wie:

@RequestMapping(value ="/book2", produces =MediaType.APPLICATION_JSON_VALUE )
@ResponseBody
Book bookInfo2() {
    Book book = new Book();
    book.setBookName("Ramcharitmanas");
    book.setWriter("TulasiDas");
    return book;
}

@RequestMapping(value ="/book3", produces =MediaType.APPLICATION_JSON_VALUE )
public ResponseEntity<Book> bookInfo3() {
    Book book = new Book();
    book.setBookName("Ramayan");
    book.setWriter("Valmiki");
    return ResponseEntity.accepted().body(book);
}

Weitere Einzelheiten finden Sie hier:
http://www.concretepage.com/spring-4/spring-4-mvc-jsonp-example-with-rest-responsebody-responseentity

Sie können eine Karte mit Ihrem Objekt oder String wie unten verwenden:

@RequestMapping(value = "/path", 
        method = RequestMethod.GET, 
        produces = MediaType.APPLICATION_JSON_VALUE)
    @ResponseBody
    public ResponseEntity<Map<String,String>> getData(){

    Map<String,String> response = new HashMap<String, String>();

    boolean isValid = // some logic
    if (isValid){
        response.put("ok", "success saving data");
        return ResponseEntity.accepted().body(response);
    }
    else{
        response.put("error", "an error expected on processing file");
        return ResponseEntity.badRequest().body(response);
    }

}

Hier ist ein Weg, wie ich es tun würde:

public ResponseEntity < ? extends BaseResponse > message(@PathVariable String player) { //REST Endpoint.

 try {
  Integer.parseInt(player);
  return new ResponseEntity < ErrorResponse > (new ErrorResponse("111", "player is not found"), HttpStatus.BAD_REQUEST);
 } catch (Exception e) {


 }
 Message msg = new Message(player, "Hello " + player);
 return new ResponseEntity < Message > (msg, HttpStatus.OK);

}

@RequestMapping(value = "/getAll/{player}", method = RequestMethod.GET, produces = MediaType.APPLICATION_JSON_VALUE)
public ResponseEntity < List < ? extends BaseResponse >> messageAll(@PathVariable String player) { //REST Endpoint.

 try {
  Integer.parseInt(player);
  List < ErrorResponse > errs = new ArrayList < ErrorResponse > ();
  errs.add(new ErrorResponse("111", "player is not found"));
  return new ResponseEntity < List < ? extends BaseResponse >> (errs, HttpStatus.BAD_REQUEST);
 } catch (Exception e) {


 }
 Message msg = new Message(player, "Hello " + player);
 List < Message > msgList = new ArrayList < Message > ();
 msgList.add(msg);
 return new ResponseEntity < List < ? extends BaseResponse >> (msgList, HttpStatus.OK);

}

Sie können auch so implementieren, um Erfolg und Fehler auf derselben Anforderungszuordnungsmethode zurückzugeben, verwenden Sie die Objektklasse (übergeordnete Klasse jeder Klasse in Java): –

public ResponseEntity< Object> method() {                                                                                                                                                                                                                                                                                                                                                                                  
    boolean b = //  logic  here   
      if (b)  
        return new ResponseEntity< Object>(HttpStatus.OK);      
    else      
        return new ResponseEntity< Object>(HttpStatus.CONFLICT); //appropriate error code   
}