Spring MVC - Comment retourner simple Chaîne JSON dans le Reste du Contrôleur

Soit de retour text/plain (comme dans Retour seul message de la chaîne de Spring MVC 3 Contrôleur) OU de la pellicule de votre Chaîne de caractères est un objet

public class StringResponse {

    private String response;

    public StringResponse(String s) { 
       this.response = s;
    }

    //get/set omitted...
}

Définissez votre type de réponse à MediaType.APPLICATION_JSON_VALUE (= "application/json")

@RequestMapping(value = "/getString", method = RequestMethod.GET,
                produces = MediaType.APPLICATION_JSON_VALUE)

et vous aurez un JSON qui ressemble à

{  "response" : "your string value" }

Dans un projet, nous avons abordé cette aide JSONObject (maven la dépendance info). Nous avons choisi ce parce que nous avons préféré retourner une simple Chaîne de caractères plutôt qu'un objet wrapper. Interne d'une classe d'assistance pourrait facilement être utilisé à la place si vous ne voulez pas d'ajouter une nouvelle dépendance.

Exemple D'Utilisation:

@RestController
public class TestController
{
    @RequestMapping("/getString")
    public String getString()
    {
        return JSONObject.quote("Hello World");
    }
}

Simplement annuler l'inscription de la valeur par défaut StringHttpMessageConverter exemple:

@Configuration
public class WebMvcConfiguration extends WebMvcConfigurationSupport {
  /**
   * Unregister the default {@link StringHttpMessageConverter} as we want Strings
   * to be handled by the JSON converter.
   *
   * @param converters List of already configured converters
   * @see WebMvcConfigurationSupport#addDefaultHttpMessageConverters(List)
   */
  @Override
  protected void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
    converters.stream()
      .filter(c -> c instanceof StringHttpMessageConverter)
      .findFirst().ifPresent(converters::remove);
  }
}

Testé avec contrôleur d'action des méthodes de gestionnaire et de contrôleur des gestionnaires d'exception:

@RequestMapping("/foo")
public String produceFoo() {
  return "foo";
}

@ExceptionHandler(FooApiException.class)
public String fooException(HttpServletRequest request, Throwable e) {
  return e.getMessage();
}

Notes finales:

• extendMessageConverters est disponible depuis le Printemps 4.1.3, si en cours d'exécution sur une version précédente, vous pouvez appliquer la même technique à l'aide de configureMessageConverters, il faut juste un peu plus de travail.
• C'était une approche de beaucoup d'autres approches possibles, si votre application n'a jamais renvoie du JSON et pas d'autres types de contenu, vous êtes mieux de sauter le défaut de convertisseurs et de l'ajout d'un seul jackson convertisseur. Une autre approche consiste à ajouter de la valeur par défaut des convertisseurs, mais dans un ordre différent, de sorte que le jackson converter est antérieure à la chaîne un. Cela devrait permettre d'action du contrôleur méthodes de dicter la façon dont ils veulent Chaîne pour être converti selon le type de média de la réponse.

Ajouter produces = "application/json" dans @RequestMapping annotation comme:

@RequestMapping(value = "api/login", method = RequestMethod.GET, produces = "application/json")

Conseil: en tant Que valeur de retour, je vous recommande d'utiliser ResponseEntity<List<T>> type. Parce que le produit des données en JSON corps à besoin d'être un tableau ou un objet selon son cahier des charges, plutôt que d'une simple et unique chaîne. Il peut causer des problèmes parfois (par exemple, les phénomènes Observables dans les Angular2).

Différence:

retourné String json: "example"

retourné List<String> json: ["example"]

Dans spring MVC 4 le type de réponse par défaut pour les objets JSON. Donc tout ce que vous devez faire est d'envelopper votre Chaîne de caractères dans un Objet.

    public class StringResponse {

   private String response;

   public StringResponse(String s) { 
       this.response = s;
   }

    //getters and setters 
}

Pas de modifications pour le contrôleur, à l'exception de retour de la StringResponse au lieu de la Chaîne.

Ajouter cette annotation à votre méthode

@RequestMapping(value = "/getString", method = RequestMethod.GET, produces = "application/json")