Benutzerdefinierte HttpMessageConverter in Spring MVC

Bei der Implementierung von RESTful API ich wickle alle meine Daten in ein Objekt, so sieht es so aus.

{error: null, code: 200, data: {...actual data...}}

Diese Ergebnisse bei sich wiederholenden code, den ich überall verwenden zu wickeln Daten:

@Transactional
@RequestMapping(value = "/", method = RequestMethod.GET)
public @ResponseBody Result<List<BookShortDTO>> books() {

    List<Book> books = booksDao.readBooks();
    return Result.ok(books); //this gets repeated everywhere
}

Die Frage ist also, wie ändere ich diese (vielleicht mit Verwendung von benutzerdefinierten HttpMessageConverter vielleicht noch andere Möglichkeiten?) gerade zurück booksDao.readBooks() und, um es gewickelt automatisch.

  • Hinzufügen jackson 2+, um den Klassenpfad für die zu serialisieren und Deserialisieren von JSON mit MappingJackson2HttpMessageConverter.
  • Es ist bereits da. Die Frage ist, dass ich will, es zu wrap-mein Ergebnis in der Ergebnis-Objekt automatisch, so dass ich nicht zum schreiben zurück Führen.ok(Bücher); in jeder Antwort
  • Durch Result.ok, sollten wir davon ausgehen, dass Sie andere Result Methoden für die verschiedenen Fehlercodes und Nachrichten?
  • Gut, ja. Zum Beispiel kann ich das Ergebnis zurückgeben.verboten (ist), wenn der Benutzer nicht über entsprechende Rechte
InformationsquelleAutor Yanis | 2014-04-06
  1. 12

    Wie @Ralph vorgeschlagen, die Sie verwenden können, eine HandlerMethodReturnValueHandler zu wickeln Sie Ihre Handler-Wert zurückgeben.

    Der einfachste Weg dies zu erreichen ist durch die Erweiterung RequestResponseBodyMethodProcessor und verändern, es ist Verhalten ein bisschen. Am besten erstellen Sie eine benutzerdefinierte Beschriftung zu markieren Sie Ihre handler-Methoden mit. Dies wird sicherstellen, dass Ihr HandlerMethodReturnValueHandler aufgerufen werden, anstatt von anderen, die RequestMappingHandlerAdapter standardmäßig.

    @Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface ResultResponseBody {}

    Hier ist eine einfache Implementierung des benutzerdefinierten HandlerMethodReturnValueHandler namens ResultResponseHandlerMethodProcessor die Unterstützung Rückgabewerte von Methoden, annotiert mit ResultResponseBody. Es ist ziemlich einfach. Nur das überschreiben der supportsReturnType() und handleReturnValue() Methoden entsprechend Ihren Anforderungen (wickeln Sie den Rückgabewert in eine Result - Typ).

    public class ResultResponseHandlerMethodProcessor extends RequestResponseBodyMethodProcessor {
    public ResultResponseHandlerMethodProcessor(final List<HttpMessageConverter<?>> messageConverters) {
        super(messageConverters);
    }

    public ResultResponseHandlerMethodProcessor(final List<HttpMessageConverter<?>> messageConverters, final ContentNegotiationManager contentNegotiationManager) {
        super(messageConverters, contentNegotiationManager);
    }

    @Override
    public boolean supportsReturnType(final MethodParameter returnType) {
        return returnType.getMethodAnnotation(ResultResponseBody.class) != null;
    }

    @Override
    public void handleReturnValue(final Object returnValue, final MethodParameter returnType, final ModelAndViewContainer mavContainer, final NativeWebRequest webRequest) throws IOException, HttpMediaTypeNotAcceptableException {
        super.handleReturnValue(Result.ok(returnValue), returnType, mavContainer, webRequest);
    }
}

    Das einzige, was Links ist, fügen Sie diese Klasse, um die Liste der benutzerdefinierten HandlerMethodReturnValueHandlers und bieten es mit einem MappingJackson2HttpMessageConverter Instanz.

    @EnableWebMvc
@Configuration
public class ApplicationConfiguration extends WebMvcConfigurerAdapter
    @Override
    public void addReturnValueHandlers(final List<HandlerMethodReturnValueHandler> returnValueHandlers) {
        List<HttpMessageConverter<?>> messageConverters = new ArrayList<>();
        messageConverters.add(new MappingJackson2HttpMessageConverter());
        returnValueHandlers.add(new ResultResponseHandlerMethodProcessor(messageConverters));
    }
}
    • Das ist genau das was ich gesucht habe! Danke!
    • Sie brauchen nicht zu überschreiben supportsReturnType so lange es nicht die gleiche wie die super-Klasse - oder habe ich etwas verpasst?
    • Wenn Sie möchten, unterstützt Sie die benutzerdefinierte Anmerkung aus, die Sie tun. Für alles, was ich glaube, du hast Recht.
    • sorry, Sie haben absolut Recht - Du es beschrieben hast im text oben "am Besten erstellen Sie eine benutzerdefinierte Beschriftung zu markieren Sie Ihre handler-Methoden mit..."
    • Gekommen, an es zu denken. Wenn die supportsReturnType ist das gleiche wie RequestResponseBodyMethodProcessor dann RequestResponseBodyMethodProcessor wird das zu handhaben ist der Rückgabewert. Nicht die benutzerdefinierte handler.
    InformationsquelleAutor Bart
  2. 2

    Denke ich, eher als eine änderung der message-Wandler (was funktionieren würde), würde ich eine AOP-Ansatz - um-Beratung in allen die entsprechenden controller-Methoden wäre Recht einfach einzurichten. Es würde Ihnen auch einen schöneren Programmier-Modell, und feinere Kontrolle über die Methoden abgefangen werden.

    • Können Sie bitte einige Beispiele?
    • Spring MVC ist RequestMappingHandlerAdapter bietet eine Liste von HandlerMethodReturnValueHandlers, so dass Sie nicht haben, um resort-AOP. Ich würde AOP nur, wenn es die Letzte mögliche Lösung.
    InformationsquelleAutor Dave Syer
  3. 2

    Könnte man eine HandlerMethodReturnValueHandler zu ersetzen, das Ergebnis.

    Der entscheidende Punkt ist: ersetzen Sie die return-Wert vor der übertragung der (modifizierten) retunr Wert auf das serialisieren.

    Finden Sie in diesem blog: http://martypitt.wordpress.com/2012/11/05/custom-json-views-with-spring-mvc-and-jackson/ für ein Beispiel, wie so archivieren Sie eine ähnliche (nicht die gleichen) Ziel. Es auch beschreiben, eine Methode für die Registrierung der HandlerMethodReturnValueHandler (für einen anderen sehen Barts Antwort)

    • Während dieser Zusammenhang kann eine Antwort auf die Frage, ist es besser, die wesentlichen Teile der Antwort hier und den link zur Referenz. Link-nur Antworten können ungültig werden, wenn die verlinkten Seite ändert.
    • J - im Allgemeinen hast du Recht, aber: 1) die Antwort ist "verwenden Sie ein HandlerMethodReturnValueHandler" (statt einer HttpMessageConverter). 2) ich habe nur eine mobile phpne wenn ich tippe: es gab also nur zwei Möglichkeiten: nicht, um ein Beispiel zu geben, oder ein Beispiel, das nur einen link zu einem blog.
    InformationsquelleAutor Ralph
  4. 2

    Möchte ich versuchen, und Sie davon überzeugen, dass das, was Sie tun, ist richtig und erfordert keine änderungen.

    Als du gepostet hast in den Kommentaren zu Ihrer Frage, Sie haben eine Reihe von verschiedenen Result Methoden, die die Fehlermeldung, der code und die Daten. So etwas wie

    Result.ok(data)
Result.forbidden()
Result.badRequest("<Something> caused a syntax error.") 
Result.notModified("The entity was not modified.")

    Ich gehe davon aus, dass diese Methoden sind gedacht, um anzeigen zu den verschiedenen HTTP-status-codes, aber mit benutzerdefinierten Fehlermeldungen.

    Ihre @Controller handler-Methoden sind gedacht, um zu behandeln eine Anfrage und bereiten eine Antwort. Das ist, was Ihre Methode ist derzeit dabei und es ist sehr explizit über was Sie tut,. Der Logik über das, was die Result werden sollten, gehört zu der hf-Methode, nicht eine HandlerMethodReturnValueHandler, wie andere vorschlagen.

    Ich würde auch vorschlagen, mit ResponseEntity statt @ResponseBody. Kehren Sie ein ResponseEntity und setzen Sie den HTTP-Antwort-Header und der status-code explizit. Sie würde auch die Antwort Körper.

    Etwas wie

    return new ResponseEntity<>(Result.ok(books));

    In diesem Fall werden die Standard-status-code 200.

    Aber wenn Sie wollte 

    return Result.forbidden();

    verwenden Sie

    return new ResponseEntity<>(Result.forbidden(), HttpStatus.FORBIDDEN);

    Frühjahr wird die gleiche HttpMessageConverter konvertieren Sie Ihre Result in JSON, aber hier haben Sie mehr Kontrolle über den HTTP-Antwort.

    • Danke, ich wusste nicht, über ResponseEntity<> es sieht aus, praktisch,
    • +1 Das macht sehr viel Sinn. Stattdessen fokussieren Sie auf den wollte Lösung konzentriert sich auf die beste Lösung für das gegebene problem. In der Tat, wenn ich gebeten wurde, zu implementieren, der REST-controller, ich würde es tun, genau wie diese. Dies sollte als "Antwort" gekennzeichnet.
    InformationsquelleAutor Sotirios Delimanolis
  5. 0

    Ich denke, es ist notwendig, um

    ersetzen Sie die Standard-RequestResponseBodyMethodProcessor mit Besitzer
    Prozessor

    ansonsten wird der default-RequestResponseBodyMethodProcessor übernehmen die Kontrolle von handling return Wert.

    InformationsquelleAutor Jenkin Zhou
Schreibe einen Kommentar