Qui définit le type de contenu de la réponse dans Spring MVC (@ResponseBody)

Question

J'ai une application web Java Spring MVC pilotée par des annotations et exécutée sur un serveur web jetty (actuellement dans le plugin maven jetty).

J'essaie de mettre en place un support AJAX avec une méthode de contrôleur renvoyant un texte d'aide sous forme de chaîne. Les ressources sont en encodage UTF-8 et la chaîne aussi, mais ma réponse du serveur vient avec

content-encoding: text/plain;charset=ISO-8859-1 

même lorsque mon navigateur envoie

Accept-Charset  windows-1250,utf-8;q=0.7,*;q=0.7

J'utilise en quelque sorte la configuration par défaut de Spring

J'ai trouvé une astuce pour ajouter ce bean à la configuration, mais je pense qu'il n'est tout simplement pas utilisé, parce qu'il dit qu'il ne supporte pas l'encodage et qu'un encodage par défaut est utilisé à la place.

<bean class="org.springframework.http.converter.StringHttpMessageConverter">
    <property name="supportedMediaTypes" value="text/plain;charset=UTF-8" />
</bean>

Le code de mon contrôleur est le suivant (notez que ce changement de type de réponse ne fonctionne pas pour moi) :

@RequestMapping(value = "ajax/gethelp")
public @ResponseBody String handleGetHelp(Locale loc, String code, HttpServletResponse response) {
    log.debug("Getting help for code: " + code);
    response.setContentType("text/plain;charset=UTF-8");
    String help = messageSource.getMessage(code, null, loc);
    log.debug("Help is: " + help);
    return help;
}

Answer 1

J'ai trouvé une solution pour Spring 3.1. en utilisant l'annotation @ResponseBody. Voici un exemple de contrôleur utilisant la sortie Json :

@RequestMapping(value = "/getDealers", method = RequestMethod.GET, 
produces = "application/json; charset=utf-8")
@ResponseBody
public String sendMobileData() {

}

Answer 2

Simple déclaration de la StringHttpMessageConverter n'est pas suffisant, il faut l'injecter dans le fichier AnnotationMethodHandlerAdapter :

<bean class = "org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter">
    <property name="messageConverters">
        <array>
            <bean class = "org.springframework.http.converter.StringHttpMessageConverter">
                <property name="supportedMediaTypes" value = "text/plain;charset=UTF-8" />
            </bean>
        </array>
    </property>
</bean>

Cependant, en utilisant cette méthode, vous devez redéfinir tous les HttpMessageConverter et ne fonctionne pas non plus avec les <mvc:annotation-driven /> .

Ainsi, la méthode la plus pratique, mais la plus laide, consiste à intercepter l'instanciation de l'élément AnnotationMethodHandlerAdapter con BeanPostProcessor :

public class EncodingPostProcessor implements BeanPostProcessor {
    public Object postProcessBeforeInitialization(Object bean, String name)
            throws BeansException {
        if (bean instanceof AnnotationMethodHandlerAdapter) {
            HttpMessageConverter<?>[] convs = ((AnnotationMethodHandlerAdapter) bean).getMessageConverters();
            for (HttpMessageConverter<?> conv: convs) {
                if (conv instanceof StringHttpMessageConverter) {
                    ((StringHttpMessageConverter) conv).setSupportedMediaTypes(
                        Arrays.asList(new MediaType("text", "html", 
                            Charset.forName("UTF-8"))));
                }
            }
        }
        return bean;
    }

    public Object postProcessAfterInitialization(Object bean, String name)
            throws BeansException {
        return bean;
    }
}

-

<bean class = "EncodingPostProcessor " />

Answer 3

Notez que dans Spring MVC 3.1, vous pouvez utiliser l'espace de noms MVC pour configurer les convertisseurs de messages :

<mvc:annotation-driven>
  <mvc:message-converters register-defaults="true">
    <bean class="org.springframework.http.converter.StringHttpMessageConverter">
      <property name="supportedMediaTypes" value = "text/plain;charset=UTF-8" />
    </bean>
  </mvc:message-converters>
</mvc:annotation-driven>

Ou configuration basée sur un code :

@Configuration
@EnableWebMvc
public class WebConfig extends WebMvcConfigurerAdapter {

  private static final Charset UTF8 = Charset.forName("UTF-8");

  @Override
  public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
    StringHttpMessageConverter stringConverter = new StringHttpMessageConverter();
    stringConverter.setSupportedMediaTypes(Arrays.asList(new MediaType("text", "plain", UTF8)));
    converters.add(stringConverter);

    // Add other converters ...
  }
}

Answer 4

Au cas où, vous pouvez également définir l'encodage de la manière suivante :

@RequestMapping(value = "ajax/gethelp")
public ResponseEntity<String> handleGetHelp(Locale loc, String code, HttpServletResponse response) {
    HttpHeaders responseHeaders = new HttpHeaders();
    responseHeaders.add("Content-Type", "text/html; charset=utf-8");

    log.debug("Getting help for code: " + code);
    String help = messageSource.getMessage(code, null, loc);
    log.debug("Help is: " + help);

    return new ResponseEntity<String>("returning: " + help, responseHeaders, HttpStatus.CREATED);
}

Je pense que l'utilisation de StringHttpMessageConverter est préférable.

Answer 5

Vous pouvez ajouter produces = "text/plain;charset=UTF-8" à RequestMapping

@RequestMapping(value = "/rest/create/document", produces = "text/plain;charset=UTF-8")
@ResponseBody
public String create(Document document, HttpServletRespone respone) throws UnsupportedEncodingException {

    Document newDocument = DocumentService.create(Document);

    return jsonSerializer.serialize(newDocument);
}