解決Spring?MVC中文亂碼的編碼配置

更新時(shí)間：2023年10月26日 09:00:39 作者：福

這篇文章主要為大家介紹了解決SpringMVC中文亂碼的編碼配置示例詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪

SpringMVC配置編碼方式

SpringMVC的中文亂碼問(wèn)題其實(shí)已經(jīng)不是什么問(wèn)題了，無(wú)非就是配置編碼方式->解決問(wèn)題。

但是由于SpringMVC可以通過(guò)：xml方式配置、Servlet3.0方式配置，以及是否使用@EnableWebMvc等，不同配置方式下，解決中文亂碼問(wèn)題的方案有所不同。

xml配置的方式

xml配置方式的解決方案最簡(jiǎn)單：

<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>forceRequestEncoding</param-name>
      <param-value>true</param-value>
    </init-param>
    <init-param>
      <param-name>forceResponseEncoding</param-name>
      <param-value>true</param-value>
    </init-param>
  </filter>
  <filter-mapping>
    <filter-name>CharacterEncodingFilter</filter-name>
    <url-pattern>/*</url-pattern>
  </filter-mapping>

在web.xml文件中加編碼過(guò)濾器，并強(qiáng)制過(guò)濾器對(duì)Request和Response都生效，可以解決request請(qǐng)求、以及response返回參數(shù)中的中文亂碼問(wèn)題。

但是返回體，也就是response body中的中文亂碼問(wèn)題，以上過(guò)濾器方案無(wú)法解決。

Response body中的中文亂碼問(wèn)題需要在spring MVC中增加以下配置：

<mvc:annotation-driven >
        <!--設(shè)置響應(yīng)輸出字符集-->
        <mvc:message-converters>
            <bean class="org.springframework.http.converter.StringHttpMessageConverter">
                <property name="supportedMediaTypes">
                    <list>
                        <value>text/html;charset=utf-8</value>
                    </list>
                </property>
            </bean>
        </mvc:message-converters>
    </mvc:annotation-driven>

前面一篇文章[Spring MVC 五：DispatcherServlet初始化之 mvc:annotation-driven] 分析過(guò)<mvc:annotation-driven />標(biāo)簽的解析過(guò)程，該標(biāo)簽在創(chuàng)建RequestMappingHandlerAdapter的過(guò)程中，會(huì)讀取到xml文件中messageConverters的定義并設(shè)置到RequestMappingHandlerAdapter對(duì)象的messageConverters屬性中并最終在DispatcherServlet處理請(qǐng)求的過(guò)程中生效。

Servlet3.0配置

Servlet3.0的配置方式，是指通過(guò)WebApplicationInitializer接口完成SpringMVC配置的方式。

可以通過(guò)接口方法getServletFilters增加編碼過(guò)濾器：

public class MvcInitializer
        extends AbstractAnnotationConfigDispatcherServletInitializer {
    @Override
    protected Class<?>[] getRootConfigClasses() {
//        return null;
        return new Class[] {RootConfiguration.class};
    }
    @Override
    protected Class<?>[] getServletConfigClasses() {
//        return null;
        return new Class[] {MvcConfiguration.class,CommonConfiguration.class};
    }
    @Override
    protected String[] getServletMappings() {
        return new String[] {"/"};
    }
    @Override
    protected Filter[] getServletFilters() {
//        ShallowEtagHeaderFilter shallowEtagHeaderFilter = new ShallowEtagHeaderFilter();
//        shallowEtagHeaderFilter.setWriteWeakETag(true);
        CharacterEncodingFilter characterEncodingFilter = new CharacterEncodingFilter();
        characterEncodingFilter.setEncoding("utf-8");
        characterEncodingFilter.setForceEncoding(true);
        return new Filter[]{characterEncodingFilter};
    }
}

以上方式增加過(guò)濾器后，可以解決request和response請(qǐng)求及返回參數(shù)中的中文編碼問(wèn)題。

但是無(wú)法解決response body的中文亂碼問(wèn)題。

由于WebApplicationInitializer接口并沒(méi)有提供任何關(guān)于messageConverters的接口，看了很多遍源碼也并沒(méi)有找到可以配置的地方，網(wǎng)上也沒(méi)有找到相關(guān)解決方案......所以解決這個(gè)問(wèn)題還是費(fèi)了很多周折。

由于我們已經(jīng)知道，response body的中文亂碼問(wèn)題最終是通過(guò)RequestMappingHandlerAdapter對(duì)象的messageConverters解決的，所以還是想通過(guò)定制化RequestMappingHandlerAdapter的初始化過(guò)程、設(shè)置其messageConverters的方式解決問(wèn)題。

如果沒(méi)有定制化處理的話(huà)，DispatcherServlet在初始化的過(guò)程中是在initStrategies方法中創(chuàng)建DispatcherServlet.properties文件中默認(rèn)的RequestMappingHandlerAdapter，是通過(guò)反射機(jī)制直接new出來(lái)的，最終會(huì)調(diào)用到RequestMappingHandlerAdapter的默認(rèn)構(gòu)造器：

public RequestMappingHandlerAdapter() {
        this.messageConverters = new ArrayList<>(4);
        this.messageConverters.add(new ByteArrayHttpMessageConverter());
        this.messageConverters.add(new StringHttpMessageConverter());
        try {
            this.messageConverters.add(new SourceHttpMessageConverter<>());
        }
        catch (Error err) {
            // Ignore when no TransformerFactory implementation is available
        }
        this.messageConverters.add(new AllEncompassingFormHttpMessageConverter());
    }

默認(rèn)構(gòu)造器會(huì)直接new一個(gè)StringHttpMessageConverter()加進(jìn)來(lái)，不修改的話(huà)StringHttpMessageConverter的默認(rèn)字符集是ISO_8859_1，一定會(huì)出現(xiàn)中文亂碼問(wèn)題：

public static final Charset DEFAULT_CHARSET = StandardCharsets.ISO_8859_1;

所以我們必須找到某種方式可以定制化RequestMappingHandlerAdapter的初始化過(guò)程。

繼續(xù)分析源碼：

private void initHandlerAdapters(ApplicationContext context) {
        this.handlerAdapters = null;
        if (this.detectAllHandlerAdapters) {
            // Find all HandlerAdapters in the ApplicationContext, including ancestor contexts.
            Map<String, HandlerAdapter> matchingBeans =
                    BeanFactoryUtils.beansOfTypeIncludingAncestors(context, HandlerAdapter.class, true, false);
            if (!matchingBeans.isEmpty()) {
                this.handlerAdapters = new ArrayList<>(matchingBeans.values());
                // We keep HandlerAdapters in sorted order.
                AnnotationAwareOrderComparator.sort(this.handlerAdapters);
            }
        }
        else {
            try {
                HandlerAdapter ha = context.getBean(HANDLER_ADAPTER_BEAN_NAME, HandlerAdapter.class);
                this.handlerAdapters = Collections.singletonList(ha);
            }
            catch (NoSuchBeanDefinitionException ex) {
                // Ignore, we'll add a default HandlerAdapter later.
            }
        }
        // Ensure we have at least some HandlerAdapters, by registering
        // default HandlerAdapters if no other adapters are found.
        if (this.handlerAdapters == null) {
            this.handlerAdapters = getDefaultStrategies(context, HandlerAdapter.class);
            if (logger.isTraceEnabled()) {
                logger.trace("No HandlerAdapters declared for servlet '" + getServletName() +
                        "': using default strategies from DispatcherServlet.properties");
            }
        }
    }

發(fā)現(xiàn)initHandlerAdapters方法首先會(huì)從Spring容器中獲取HandlerAdapter！

我們是否有辦法定制一個(gè)HandlerAdapter、加入到Spring容器中？Spring當(dāng)然給我們提供了這種機(jī)會(huì)，回想一下@Configuration+@Bean注解，是否就可以解決？

在MvcConfig文件中增加如下代碼：

@Configuration
@ComponentScan({"org.example.controller"})
public class MvcConfiguration  {
    @Bean
    public ViewResolver viewResolver() {
        InternalResourceViewResolver viewResolver = new InternalResourceViewResolver();
        viewResolver.setPrefix("/WEB-INF/pages/");
        viewResolver.setSuffix(".jsp");
        return viewResolver;
    }
    //定制RequestMappingHandlerAdapter
    @Bean
    public RequestMappingHandlerAdapter handlerAdapter(){
        RequestMappingHandlerAdapter handlerAdapter = new RequestMappingHandlerAdapter();
        List<HttpMessageConverter<?>> messageConverters;
        messageConverters = new ArrayList<>(4);
        messageConverters.add(new ByteArrayHttpMessageConverter());
        StringHttpMessageConverter stringHttpMessageConverter = new StringHttpMessageConverter(Charset.forName("UTF-8"));
        messageConverters.add(stringHttpMessageConverter);
        try {
            messageConverters.add(new SourceHttpMessageConverter<>());
        }
        catch (Error err) {
            // Ignore when no TransformerFactory implementation is available
        }
        messageConverters.add(new AllEncompassingFormHttpMessageConverter());
        handlerAdapter.setMessageConverters(messageConverters);
        return  handlerAdapter;
    }

參考RequestMappingHandlerAdapter默認(rèn)構(gòu)造器的代碼，修改其中StringHttpMessageConverter的創(chuàng)建過(guò)程、設(shè)置其默認(rèn)字符集為UTF-8......驗(yàn)證后發(fā)現(xiàn)，問(wèn)題已解決！

使用@EnableWebMvc

由于@EnableWebMvc是必須和@configuration配合使用的，所以，一定會(huì)存在配置類(lèi)。這種情況下，配置類(lèi)實(shí)現(xiàn)WebMvcConfigurer、通過(guò)擴(kuò)展extendMessageConverters方法解決：

@Configuration
@EnableWebMvc
@ComponentScan({"org.example.controller"})
public class MvcConfiguration implements WebMvcConfigurer{
    public MvcConfiguration(){
        System.out.println("mvc configuration constructor...");
    }
//    通過(guò)@EnableWebMVC配置的時(shí)候起作用，
    @Override
    public void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
        for(HttpMessageConverter httpMessageConverter:converters){
            if(StringHttpMessageConverter.class.isAssignableFrom(httpMessageConverter.getClass())){
                ((StringHttpMessageConverter)httpMessageConverter).setDefaultCharset(Charset.forName("UTF-8"));
            }
        }
    }
}

以上就是解決Spring MVC中文亂碼的編碼配置的詳細(xì)內(nèi)容，更多關(guān)于Spring MVC中文亂碼解決的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: