Wie behandeln Ausnahmen in Spring MVC anders für HTML- und JSON-Anforderungen

Ich bin mit der folgenden exception-handler im Frühjahr 4.0.3 zum abfangen von Ausnahmen und zeigt eine benutzerdefinierte Fehlerseite für den Benutzer:

@ControllerAdvice
public class ExceptionHandlerController
{
    @ExceptionHandler(value = Exception.class)
    public ModelAndView handleError(HttpServletRequest request, Exception e)
    {
        ModelAndView mav = new ModelAndView("/errors/500"));
        mav.addObject("exception", e);
        return mav;
    }
}

Aber jetzt will ich eine andere Handhabung für die JSON-Anfragen, so bekomme ich JSON-Fehler-Antworten für diese Art von Anfragen, wenn eine Ausnahme aufgetreten ist. Derzeit ist der obige code wird auch ausgelöst durch die JSON-Anfragen (Mit einer Accept: application/json - header) und den JavaScript-client nicht wie die HTML-Antwort.

Wie kann ich Ausnahmen anders für HTML-und JSON-requests?

InformationsquelleAutor der Frage kayahr | 2014-05-10

  1. 9

    Den ControllerAdvice annotation ist ein element/Attribut namens basePackage, die gesetzt werden können, um zu bestimmen, welche Pakete sollte es scan-Controllern und anwenden der Tipps. Also, was Sie tun können, ist zu getrennten Controllern Umgang mit normalen Wünsche und die Handhabung von AJAX-requests in verschiedenen Paketen, dann schreiben 2-Exception Handling-Controller mit entsprechenden ControllerAdvice Anmerkungen. Zum Beispiel:

    @ControllerAdvice("com.acme.webapp.ajaxcontrollers")
public class AjaxExceptionHandlingController {
...
@ControllerAdvice("com.acme.webapp.controllers")
public class ExceptionHandlingController {

    InformationsquelleAutor der Antwort dnang

  2. 7

    Der beste Weg, dies zu tun (vor allem in der servlet 3) zu registrieren, wird eine Fehlerseite mit dem container, und verwenden Sie diese zum aufrufen einer Feder @Controller. So erhalten Sie für den Umgang mit verschiedenen Antwort-Typen in einem standard-Spring MVC Art und Weise (z.B. mit @RequestMapping mit produziert=... für Ihre Maschine-clients).

    Ich sehe aus Ihrer Frage, dass Sie mit Spring Boot. Wenn Sie ein upgrade auf eine Momentaufnahme (1.1 oder besser in anderen Worten) Sie erhalten dieses Verhalten aus der box (siehe BasicErrorController). Wenn Sie möchten, um es zu überschreiben, die Sie gerade brauchen, um anzeigen /Fehler-Pfad zu Ihrem eigenen @Controller.

    InformationsquelleAutor der Antwort Dave Syer

  3. 2

    Haben Sie das HttpServletRequest, Sie sollten in der Lage sein, um die Anforderung "Accept" - header. Dann könnten Sie verarbeiten die Ausnahme.

    Etwas wie:

    String header = request.getHeader("Accept");
if(header != null && header.equals("application/json")) {
    //Process JSON exception
} else {
    ModelAndView mav = new ModelAndView("/errors/500"));
    mav.addObject("exception", e);
    return mav;
}

    InformationsquelleAutor der Antwort Daniel

  4. 2

    Da ich nicht finden, eine Lösung für dieses, ich schrieb einige code, der manuell überprüft die accept - header der Anfrage um deren format zu bestimmen. Ich habe dann überprüfen, ob der Benutzer angemeldet ist und entweder senden Sie die kompletten stacktrace, wenn er oder eine kurze Fehlermeldung.

    Benutze ich ResponseEntity zurückkehren können sowohl JSON oder HTML wie hier.

    Code:

    @ExceptionHandler(Exception.class)
public ResponseEntity<?> handleExceptions(Exception ex, HttpServletRequest request) throws Exception {

    final HttpHeaders headers = new HttpHeaders();
    Object answer; //String if HTML, any object if JSON
    if(jsonHasPriority(request.getHeader("accept"))) {
        logger.info("Returning exception to client as json object");
        headers.setContentType(MediaType.APPLICATION_JSON);
        answer = errorJson(ex, isUserLoggedIn());
    } else {
        logger.info("Returning exception to client as html page");
        headers.setContentType(MediaType.TEXT_HTML);
        answer = errorHtml(ex, isUserLoggedIn());
    }
    final HttpStatus status = HttpStatus.INTERNAL_SERVER_ERROR;
    return new ResponseEntity<>(answer, headers, status);
}

private String errorHtml(Exception e, boolean isUserLoggedIn) {
    String error = //html code with exception information here
    return error;
}

private Object errorJson(Exception e, boolean isUserLoggedIn) {
    //return error wrapper object which will be converted to json
    return null;
}

/**
 * @param acceptString - HTTP accept header field, format according to HTTP spec:
 *      "mime1;quality1,mime2;quality2,mime3,mime4,..." (quality is optional)
 * @return true only if json is the MIME type with highest quality of all specified MIME types.
 */
private boolean jsonHasPriority(String acceptString) {
    if (acceptString != null) {
        final String[] mimes = acceptString.split(",");
        Arrays.sort(mimes, new MimeQualityComparator());
        final String firstMime = mimes[0].split(";")[0];
        return firstMime.equals("application/json");
    }
    return false;
}

private static class MimeQualityComparator implements Comparator<String> {
    @Override
    public int compare(String mime1, String mime2) {
        final double m1Quality = getQualityofMime(mime1);
        final double m2Quality = getQualityofMime(mime2);
        return Double.compare(m1Quality, m2Quality) * -1;
    }
}

/**
 * @param mimeAndQuality - "mime;quality" pair from the accept header of a HTTP request,
 *      according to HTTP spec (missing mimeQuality means quality = 1).
 * @return quality of this pair according to HTTP spec.
 */
private static Double getQualityofMime(String mimeAndQuality) {
    //split off quality factor
    final String[] mime = mimeAndQuality.split(";");
    if (mime.length <= 1) {
        return 1.0;
    } else {
        final String quality = mime[1].split("=")[1];
        return Double.parseDouble(quality);
    }
}

    InformationsquelleAutor der Antwort Katharsas

  5. 0

    Den controlleradvice Anmerkung hat mehrere Eigenschaften, die festgelegt werden können, seit dem Frühjahr 4. Sie können definieren mehrere controller Ratschläge, die unterschiedliche Regeln anwenden.

    Einer Eigenschaft ist " - Anmerkungen. Wahrscheinlich können Sie eine bestimmte Anmerkung auf das json-request-mapping oder vielleicht finden Sie eine andere Eigenschaft nützlich?

    InformationsquelleAutor der Antwort Martin Frey

  6. 0

    @ControllerAdvice
    Lassen Sie die exception-handler senden DTO enthält das Feld Fehler.

    @ExceptionHandler(MethodArgumentNotValidException.class)
@ResponseStatus(HttpStatus.BAD_REQUEST)
@ResponseBody
public ValidationErrorDTO processValidationError(MethodArgumentNotValidException ex) {
    BindingResult result = ex.getBindingResult();
    List<FieldError> fieldErrors = result.getFieldErrors();

    return processFieldErrors(fieldErrors);
}

    Dieser code ist von dieser website:http://www.petrikainulainen.net/programming/spring-framework/spring-from-the-trenches-adding-validation-to-a-rest-api/
    Schauen Sie dort für mehr info.

    InformationsquelleAutor der Antwort Michiel

  7. 0

    Der trick ist zu haben, eine REST-controller mit zwei Zuordnungen, von denen gibt "text/html" und gibt einen gültigen HTML-Quelltext. Das Beispiel unten, in der getestet wurde, in Spring Boot 2.0nimmt die Existenz einer separaten Vorlage mit dem Namen "error.html".

    @RestController
public class CustomErrorController implements ErrorController {

    @Autowired
    private ErrorAttributes errorAttributes;

    private Map<String,Object> getErrorAttributes( HttpServletRequest request ) {
        WebRequest webRequest = new ServletWebRequest(request);
        boolean includeStacktrace = false;
        return errorAttributes.getErrorAttributes(webRequest,includeStacktrace);
    }

    @GetMapping(value="/error", produces="text/html")
    ModelAndView errorHtml(HttpServletRequest request) {
        return new ModelAndView("error.html",getErrorAttributes(request));
    }

    @GetMapping(value="/error")
    Map<String,Object> error(HttpServletRequest request) {
        return getErrorAttributes(request);
    }

    @Override public String getErrorPath() { return "/error"; }

}

    Referenzen

    InformationsquelleAutor der Antwort nobar

Schreibe einen Kommentar