ใครกำหนดประเภทเนื้อหาการตอบกลับใน Spring MVC (@ResponseBody)

ฉันมีแอปพลิเคชันเว็บ Spring MVC Java ที่ใช้ Annotation ซึ่งทำงานบนเว็บเซิร์ฟเวอร์ของท่าเทียบเรือ (ปัจจุบันอยู่ในปลั๊กอินท่าเทียบเรือ maven)

ฉันกำลังพยายามสนับสนุน AJAX ด้วยวิธีการควบคุมเดียวที่ส่งคืนข้อความช่วยเหลือเพียงสตริง ทรัพยากรอยู่ในการเข้ารหัส UTF-8 ดังนั้นสตริงก็เช่นกัน แต่การตอบสนองของฉันจากเซิร์ฟเวอร์มาพร้อมกับ

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

แม้ว่าเบราว์เซอร์ของฉันจะส่ง

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

ฉันใช้การกำหนดค่าเริ่มต้นของสปริง

ฉันพบคำใบ้ในการเพิ่ม bean นี้ในการกำหนดค่า แต่ฉันคิดว่ามันไม่ได้ใช้เพราะมันบอกว่ามันไม่รองรับการเข้ารหัสและใช้ค่าเริ่มต้นแทน

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

รหัสคอนโทรลเลอร์ของฉันคือ (โปรดทราบว่าการเปลี่ยนแปลงประเภทการตอบกลับนี้ใช้ไม่ได้สำหรับฉัน):

@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;
}

การประกาศอย่างง่ายของStringHttpMessageConverterถั่วนั้นไม่เพียงพอคุณต้องฉีดเข้าไปใน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>

อย่างไรก็ตามการใช้วิธีนี้คุณจะต้อง redefine ทั้งหมดHttpMessageConverters <mvc:annotation-driven />และยังจะไม่ได้ทำงานกับ

ดังนั้นวิธีที่สะดวกที่สุด แต่น่าเกลียดที่สุดคือการสกัดกั้นการสร้างอินสแตนซ์AnnotationMethodHandlerAdapterด้วย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 " />

ฉันพบวิธีแก้ปัญหาสำหรับ Spring 3.1 ด้วยการใช้คำอธิบายประกอบ @ResponseBody นี่คือตัวอย่างของคอนโทรลเลอร์ที่ใช้เอาต์พุต Json:

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

}

โปรดทราบว่าใน Spring MVC 3.1 คุณสามารถใช้เนมสเปซ MVC เพื่อกำหนดค่าตัวแปลงข้อความ:

<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>

หรือการกำหนดค่าตามรหัส:

@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 ...
  }
}

ในกรณีที่คุณสามารถตั้งค่าการเข้ารหัสได้ด้วยวิธีต่อไปนี้:

@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);
}

ฉันคิดว่าการใช้ StringHttpMessageConverter ดีกว่านี้

คุณสามารถเพิ่ม produce = "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);
}

ดูบล็อกนี้เพื่อดูรายละเอียดเพิ่มเติม

เมื่อเร็ว ๆ นี้ฉันกำลังต่อสู้กับปัญหานี้และพบคำตอบที่ดีกว่ามากใน Spring 3.1:

@RequestMapping(value = "ajax/gethelp", produces = "text/plain")

ดังนั้นง่ายเหมือน JAX-RS เช่นเดียวกับความคิดเห็นทั้งหมดที่ระบุว่าสามารถ / ควรจะเป็น

คุณสามารถใช้ผลิตเพื่อระบุประเภทของการตอบกลับที่คุณกำลังส่งจากคอนโทรลเลอร์ คำหลัก "สร้าง" นี้จะมีประโยชน์มากที่สุดในคำขอของ ajax และมีประโยชน์มากในโครงการของฉัน

@RequestMapping(value = "/aURLMapping.htm", method = RequestMethod.GET, produces = "text/html; charset=utf-8") 

public @ResponseBody String getMobileData() {

}

ขอบคุณ digz6666 โซลูชันของคุณใช้ได้กับฉันโดยมีการเปลี่ยนแปลงเล็กน้อยเพราะฉันใช้ json:

responseHeaders.add ("ประเภทเนื้อหา", "application / json; charset = utf-8");

คำตอบที่ได้รับจาก axtavt (สิ่งที่คุณแนะนำ) จะไม่ได้ผลสำหรับฉัน แม้ว่าฉันจะเพิ่มประเภทสื่อที่ถูกต้อง:

ถ้า (conv instanceof StringHttpMessageConverter) {                   
                    ((StringHttpMessageConverter) Conv) .setSupportedMediaTypes (
                        Arrays.asList (
                                MediaType ใหม่ ("text", "html", Charset.forName ("UTF-8")),
                                MediaType ใหม่ ("application", "json", Charset.forName ("UTF-8"))));
                }

ฉันตั้งค่าชนิดเนื้อหาใน MarshallingView ในContentNegotiatingViewResolver bean ทำงานได้ง่ายสะอาดและราบรื่น:

<property name="defaultViews">
  <list>
    <bean class="org.springframework.web.servlet.view.xml.MarshallingView">
      <constructor-arg>
        <bean class="org.springframework.oxm.xstream.XStreamMarshaller" />     
      </constructor-arg>
      <property name="contentType" value="application/xml;charset=UTF-8" />
    </bean>
  </list>
</property>

ฉันใช้ CharacterEncodingFilter ซึ่งกำหนดค่าใน web.xml บางทีนั่นอาจช่วยได้

    <filter>
    <filter-name>characterEncodingFilter</filter-name>
    <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
    <init-param>
        <param-name>encoding</param-name>
        <param-value>UTF-8</param-value>
    </init-param>
    <init-param>
        <param-name>forceEncoding</param-name>
        <param-value>true</param-value>
    </init-param>
</filter>

หากวิธีการข้างต้นไม่ได้ผลสำหรับคุณพยายามที่จะส่งคำขอ ajax ใน "POST" ไม่ใช่ "GET" ซึ่งได้ผลดีสำหรับฉัน ... ฉันยังมี characterEncodingFilter

package com.your.package.spring.fix;

import java.io.UnsupportedEncodingException;
import java.net.URLDecoder;
import java.net.URLEncoder;

/**
 * @author Szilard_Jakab (JaKi)
 * Workaround for Spring 3 @ResponseBody issue - get incorrectly 
   encoded parameters     from the URL (in example @ JSON response)
 * Tested @ Spring 3.0.4
 */
public class RepairWrongUrlParamEncoding {
    private static String restoredParamToOriginal;

    /**
    * @param wrongUrlParam
    * @return Repaired url param (UTF-8 encoded)
    * @throws UnsupportedEncodingException
    */
    public static String repair(String wrongUrlParam) throws 
                                            UnsupportedEncodingException {
    /* First step: encode the incorrectly converted UTF-8 strings back to 
                  the original URL format
    */
    restoredParamToOriginal = URLEncoder.encode(wrongUrlParam, "ISO-8859-1");

    /* Second step: decode to UTF-8 again from the original one
    */
    return URLDecoder.decode(restoredParamToOriginal, "UTF-8");
    }
}

หลังจากที่ฉันได้ลองวิธีแก้ปัญหามากมายสำหรับปัญหานี้แล้ว .. ฉันคิดออกแล้วและมันก็ใช้ได้ดี

วิธีง่ายๆในการแก้ปัญหานี้ใน Spring 3.1.1 คือ: เพิ่มรหัสการกำหนดค่าต่อไปนี้ใน servlet-context.xml

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

ไม่จำเป็นต้องลบล้างหรือดำเนินการใด ๆ

หากคุณตัดสินใจที่จะแก้ไขปัญหานี้ผ่านการกำหนดค่าต่อไปนี้:

<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>

คุณควรยืนยันว่าควรมีแท็ก mvc: annotation-driven เพียงแท็กเดียวในไฟล์ * .xml ทั้งหมดของคุณ มิฉะนั้นการกำหนดค่าอาจไม่มีผล

ตามลิงค์ "หากไม่ได้ระบุการเข้ารหัสอักขระข้อกำหนดของ Servlet กำหนดให้ใช้การเข้ารหัส ISO-8859-1" หากคุณใช้สปริง 3.1 หรือใหม่กว่าให้ใช้การกำหนดค่า fallowing เพื่อตั้งค่า charset = UTF-8 เป็น response body
@RequestMapping (value = "your mapping url", produce = "text / plain; charset = UTF-8")

public final class ConfigurableStringHttpMessageConverter extends AbstractHttpMessageConverter<String> {

    private Charset defaultCharset;

    public Charset getDefaultCharset() {
        return defaultCharset;
    }

    private final List<Charset> availableCharsets;

    private boolean writeAcceptCharset = true;

    public ConfigurableStringHttpMessageConverter() {
        super(new MediaType("text", "plain", StringHttpMessageConverter.DEFAULT_CHARSET), MediaType.ALL);
        defaultCharset = StringHttpMessageConverter.DEFAULT_CHARSET;
        this.availableCharsets = new ArrayList<Charset>(Charset.availableCharsets().values());
    }

    public ConfigurableStringHttpMessageConverter(String charsetName) {
        super(new MediaType("text", "plain", Charset.forName(charsetName)), MediaType.ALL);
        defaultCharset = Charset.forName(charsetName);
        this.availableCharsets = new ArrayList<Charset>(Charset.availableCharsets().values());
    }

    /**
     * Indicates whether the {@code Accept-Charset} should be written to any outgoing request.
     * <p>Default is {@code true}.
     */
    public void setWriteAcceptCharset(boolean writeAcceptCharset) {
        this.writeAcceptCharset = writeAcceptCharset;
    }

    @Override
    public boolean supports(Class<?> clazz) {
        return String.class.equals(clazz);
    }

    @Override
    protected String readInternal(Class clazz, HttpInputMessage inputMessage) throws IOException {
        Charset charset = getContentTypeCharset(inputMessage.getHeaders().getContentType());
        return FileCopyUtils.copyToString(new InputStreamReader(inputMessage.getBody(), charset));
    }

    @Override
    protected Long getContentLength(String s, MediaType contentType) {
        Charset charset = getContentTypeCharset(contentType);
        try {
            return (long) s.getBytes(charset.name()).length;
        }
        catch (UnsupportedEncodingException ex) {
            // should not occur
            throw new InternalError(ex.getMessage());
        }
    }

    @Override
    protected void writeInternal(String s, HttpOutputMessage outputMessage) throws IOException {
        if (writeAcceptCharset) {
            outputMessage.getHeaders().setAcceptCharset(getAcceptedCharsets());
        }
        Charset charset = getContentTypeCharset(outputMessage.getHeaders().getContentType());
        FileCopyUtils.copy(s, new OutputStreamWriter(outputMessage.getBody(), charset));
    }

    /**
     * Return the list of supported {@link Charset}.
     *
     * <p>By default, returns {@link Charset#availableCharsets()}. Can be overridden in subclasses.
     *
     * @return the list of accepted charsets
     */
    protected List<Charset> getAcceptedCharsets() {
        return this.availableCharsets;
    }

    private Charset getContentTypeCharset(MediaType contentType) {
        if (contentType != null && contentType.getCharSet() != null) {
            return contentType.getCharSet();
        }
        else {
            return defaultCharset;
        }
    }
}

การกำหนดค่าตัวอย่าง:

    <bean class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter">
        <property name="messageConverters">
            <util:list>
                <bean class="ru.dz.mvk.util.ConfigurableStringHttpMessageConverter">
                    <constructor-arg index="0" value="UTF-8"/>
                </bean>
            </util:list>
        </property>
    </bean>