您的位置:

Spring国际化

一、什么是Spring国际化

Spring国际化是一个方便地支持多种语言的应用程序的机制,它可以将一个应用程序翻译成多个语言版本。在Spring中,使用ResourceBundleMessageSource实现的。此外,Spring支持基于请求头、Session以及cookie的语言切换。

在Spring国际化中,需要准备两个文件,分别是message文件和properties文件。

其中,message文件是一个XML文件,包含了一个bean,bean的类型是org.springframework.context.support.ResourceBundleMessageSource,该bean用于读取properties文件中定义的消息。

而properties文件则是一个包含键值对的文件,每个键值对代表了一条信息。Spring默认会读取classpath下名字为messages的properties文件。

二、如何在Spring中实现国际化

1.配置ResourceBundleMessageSource实现国际化支持



<bean id="messageSource" class="org.springframework.context.support.ResourceBundleMessageSource">
  <property name="basenames">
    <list>
      <value>messages</value>
      <value>other</value>
    </list>
  </property>
</bean>

在上述配置中,我们配置了一个id为messageSource的bean,类型为ResourceBundleMessageSource,并通过basenames属性指定了需要读取的properties文件。基于这个配置,Spring容器会自动将messageSource注入到其他组件中,以便它们能通过messageSource读取不同的语言消息。

例如,可以通过以下方式读取消息:


@Autowired
private MessageSource messageSource;

public void someMethod() {
  String message = messageSource.getMessage("message.key", new Object[] {"John"}, Locale.US);
}

代码中通过@Autowired注入了MessageSource组件,并通过getMessage方法读取了指定键值的message。

使用getMessage方法,需要传入三个参数,分别是message的key,替换Message中占位符的参数以及locale语言。

2.基于请求头实现语言切换

在Spring MVC中,可以通过LocaleResolver接口实现基本的国际化支持。在这种情况下,Spring MVC会尝试通过解析请求头来获取客户端的locale语言信息。

我们可以实现OwnLocaleResolver类,该类实现了LocaleResolver接口,并实现了setLocale和getLocale方法。在setLocale方法中,我们将locale信息存入cookie中。


public class OwnLocaleResolver implements LocaleResolver {
  private static final String COOKIE_NAME = "lang";
  private static final String LANG_EN = "en";
  private static final String LANG_ZH = "zh";

  @Override
  public Locale resolveLocale(HttpServletRequest request) {
    String lang = readCookie(request, COOKIE_NAME);
    if (!StringUtils.isEmpty(lang)) {
      if (LANG_EN.equals(lang)) {
        return Locale.ENGLISH;
      } else if (LANG_ZH.equals(lang)) {
        return Locale.CHINESE;
      }
    }
    return request.getLocale();
  }

  @Override
  public void setLocale(HttpServletRequest request, HttpServletResponse response, Locale locale) {
    writeCookie(response, COOKIE_NAME, locale.getLanguage(), 30*3600*24*365);
  }

  private String readCookie(HttpServletRequest request, String cookieName) {
    Cookie[] cookies = request.getCookies();
    if (cookies != null) {
      for (Cookie cookie : cookies) {
        if (cookieName.equals(cookie.getName())) {
          return cookie.getValue();
        }
      }
    }
    return null;
  }

  private void writeCookie(HttpServletResponse response, String name, String value, int maxAge) {
    Cookie cookie = new Cookie(name, value);
    cookie.setMaxAge(maxAge);
    cookie.setPath("/");
    response.addCookie(cookie);
  }
}

在自定义的LocaleResolver生效之前,需要在配置中添加以下配置:



   
  <bean class="org.springframework.web.servlet.i18n.LocaleChangeInterceptor">
    <property name="paramName" value="lang"/>
  </bean>
</mvc:interceptors>

   

在添加自定义的LocaleResolver实现后,我们还需要启用Spring的国际化功能。最后需要在Spring MVC的ViewResolver中增加一个LocaleResolver,代码如下:


<beans:bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
    <beans:property name="viewClass" value="org.springframework.web.servlet.view.JstlView"/>
    <beans:property name="prefix" value="/WEB-INF/pages/"/>
    <beans:property name="suffix" value=".jsp"/>
    <beans:property name="localeResolver" ref="localeResolver"/>
</beans:bean>

3.基于Session实现语言切换

通过使用基于Session的LocaleResolver实现语言切换,我们可以通过透明地在用户的session中存储locale信息,来灵活地控制用户的语言环境。 为了使用SessionLocaleResolver,我们需要在Spring的Bean配置中添加如下内容:


<bean id="localeResolver" class="org.springframework.web.servlet.i18n.SessionLocaleResolver" />

启用Spring的国际化功能后,我们需要将SessionLocaleResolver注入到Controller中,并通过setLocale方法来设置语言信息。例如,可以通过以下方式实现:


@RequestMapping("testLanguage")
public String testLanguage(HttpServletRequest request, HttpServletResponse response, 
  HttpSession session) {
  Locale locale = new Locale("en", "US");
  session.setAttribute(SessionLocaleResolver.LOCALE_SESSION_ATTRIBUTE_NAME, locale);
  return "redirect:index";
}

三、 小结

通过配置ResourceBundleMessageSource、基于请求头和基于Session实现语言切换,我们可以通过简单的代码来支持多语言环境。Spring MVC支持相当复杂的国际化场景,比如用户语言环境可在页面中自由切换、不同类型的消息可在多个地方进行多语言支持等。