Spring MVC国际化(i18n)和本地化(L10n)示例

时间:2020-02-23 14:35:56  来源:igfitidea点击:

欢迎使用Spring国际化(i18n)教程。
任何具有世界各地用户,国际化(i18n)或者本地化(L10n)用户的Web应用程序对于实现更好的用户交互都是非常重要的。

大多数Web应用程序框架都提供了基于用户区域设置来对应用程序进行本地化的简便方法。
Spring还遵循该模式,并通过使用Spring拦截器,语言环境解析器和用于不同语言环境的资源包为国际化(i18n)提供广泛的支持。

Java中有关i18n的一些早期文章。

  • Java国际化示例
  • Struts2国际化示例

Spring国际化i18n

让我们创建一个简单的Spring MVC项目,在该项目中,我们将使用request参数获取用户区域设置,并根据该设置来设置区域设置特定资源包中的响应页面标签值。

在Spring Tool Suite中创建一个Spring MVC项目,以获取我们应用程序的基本代码。
如果您不熟悉Spring Tool Suite或者Spring MVC项目,请阅读Spring MVC示例。

下图是我们本地化更改的最终项目。
我们将逐一研究应用程序的所有部分。

Spring i18n Maven配置

我们的Spring MVC pom.xml如下所示。

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="https://maven.apache.org/POM/4.0.0" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="https://maven.apache.org/POM/4.0.0 https://maven.apache.org/maven-v4_0_0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<groupId>com.theitroad</groupId>
	<artifactId>spring</artifactId>
	<name>Springi18nExample</name>
	<packaging>war</packaging>
	<version>1.0.0-BUILD-SNAPSHOT</version>
	<properties>
		<java-version>1.6</java-version>
		<org.springframework-version>4.0.2.RELEASE</org.springframework-version>
		<org.aspectj-version>1.7.4</org.aspectj-version>
		<org.slf4j-version>1.7.5</org.slf4j-version>
	</properties>
	<dependencies>
		<!-- Spring -->
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-context</artifactId>
			<version>${org.springframework-version}</version>
			<exclusions>
				<!-- Exclude Commons Logging in favor of SLF4j -->
				<exclusion>
					<groupId>commons-logging</groupId>
					<artifactId>commons-logging</artifactId>
				 </exclusion>
			</exclusions>
		</dependency>
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-webmvc</artifactId>
			<version>${org.springframework-version}</version>
		</dependency>
				
		<!-- AspectJ -->
		<dependency>
			<groupId>org.aspectj</groupId>
			<artifactId>aspectjrt</artifactId>
			<version>${org.aspectj-version}</version>
		</dependency>	
		
		<!-- Logging -->
		<dependency>
			<groupId>org.slf4j</groupId>
			<artifactId>slf4j-api</artifactId>
			<version>${org.slf4j-version}</version>
		</dependency>
		<dependency>
			<groupId>org.slf4j</groupId>
			<artifactId>jcl-over-slf4j</artifactId>
			<version>${org.slf4j-version}</version>
			<scope>runtime</scope>
		</dependency>
		<dependency>
			<groupId>org.slf4j</groupId>
			<artifactId>slf4j-log4j12</artifactId>
			<version>${org.slf4j-version}</version>
			<scope>runtime</scope>
		</dependency>
		<dependency>
			<groupId>log4j</groupId>
			<artifactId>log4j</artifactId>
			<version>1.2.15</version>
			<exclusions>
				<exclusion>
					<groupId>javax.mail</groupId>
					<artifactId>mail</artifactId>
				</exclusion>
				<exclusion>
					<groupId>javax.jms</groupId>
					<artifactId>jms</artifactId>
				</exclusion>
				<exclusion>
					<groupId>com.sun.jdmk</groupId>
					<artifactId>jmxtools</artifactId>
				</exclusion>
				<exclusion>
					<groupId>com.sun.jmx</groupId>
					<artifactId>jmxri</artifactId>
				</exclusion>
			</exclusions>
			<scope>runtime</scope>
		</dependency>

		<!-- @Inject -->
		<dependency>
			<groupId>javax.inject</groupId>
			<artifactId>javax.inject</artifactId>
			<version>1</version>
		</dependency>
				
		<!-- Servlet -->
		<dependency>
			<groupId>javax.servlet</groupId>
			<artifactId>servlet-api</artifactId>
			<version>2.5</version>
			<scope>provided</scope>
		</dependency>
		<dependency>
			<groupId>javax.servlet.jsp</groupId>
			<artifactId>jsp-api</artifactId>
			<version>2.1</version>
			<scope>provided</scope>
		</dependency>
		<dependency>
			<groupId>javax.servlet</groupId>
			<artifactId>jstl</artifactId>
			<version>1.2</version>
		</dependency>
	
		<!-- Test -->
		<dependency>
			<groupId>junit</groupId>
			<artifactId>junit</artifactId>
			<version>4.7</version>
			<scope>test</scope>
		</dependency>        
	</dependencies>
  <build>
      <plugins>
          <plugin>
              <artifactId>maven-eclipse-plugin</artifactId>
              <version>2.9</version>
              <configuration>
                  <additionalProjectnatures>
                      <projectnature>org.springframework.ide.eclipse.core.springnature</projectnature>
                  </additionalProjectnatures>
                  <additionalBuildcommands>
                      <buildcommand>org.springframework.ide.eclipse.core.springbuilder</buildcommand>
                  </additionalBuildcommands>
                  <downloadSources>true</downloadSources>
                  <downloadJavadocs>true</downloadJavadocs>
              </configuration>
          </plugin>
          <plugin>
              <groupId>org.apache.maven.plugins</groupId>
              <artifactId>maven-compiler-plugin</artifactId>
              <version>2.5.1</version>
              <configuration>
                  <source>1.6</source>
                  <target>1.6</target>
                  <compilerArgument>-Xlint:all</compilerArgument>
                  <showWarnings>true</showWarnings>
                  <showDeprecation>true</showDeprecation>
              </configuration>
          </plugin>
          <plugin>
              <groupId>org.codehaus.mojo</groupId>
              <artifactId>exec-maven-plugin</artifactId>
              <version>1.2.1</version>
              <configuration>
                  <mainClass>org.test.int1.Main</mainClass>
              </configuration>
          </plugin>
      </plugins>
  </build>
</project>

大部分代码是由STS自动生成的,除了我已更新Spring版本以使用最新版本4.0.2RELEASE。
我们也可以删除依赖项或者更新其他依赖项的版本,但为简单起见,我将其保留下来。

Spring资源包

为简单起见,假设我们的应用程序仅支持两种语言环境-en和fr。
如果未指定用户语言环境,我们将使用英语作为默认语言环境。
让我们为这两个语言环境创建Spring资源包,这些资源包将在JSP页面中使用。

messages_en.properties代码:

label.title=Login Page
label.firstName=First Name
label.lastName=Last Name
label.submit=Login

messages_fr.properties代码:

label.title=Connectez-vous page
label.firstName=Pr\u00E9nom
label.lastName=Nom
label.submit=Connexion

请注意,我在法语语言环境资源包中对特殊字符使用了unicode,以便可以在发送给客户端请求的响应HTML中正确地解释它。

要注意的另一个重要点是,两个资源束都在应用程序的类路径中,并且它们的名称具有" messages_ {locale} .properties"的模式。
我们将在后面看到为什么这些很重要。

Spring i18n控制器类

我们的控制器类非常简单,它仅记录用户区域设置并返回home.jsp页面作为响应。

package com.theitroad.spring;

import java.util.Locale;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

/**
 * Handles requests for the application home page.
 */
@Controller
public class HomeController {
	
	private static final Logger logger = LoggerFactory.getLogger(HomeController.class);
	
	/**
	 * Simply selects the home view to render by returning its name.
	 */
	@RequestMapping(value = "/", method = RequestMethod.GET)
	public String home(Locale locale, Model model) {
		logger.info("Welcome home! The client locale is {}.", locale);
	
		return "home";
	}
	
}

Spring i18n JSP页面

我们的home.jsp页面代码如下所示。

<%@taglib uri="https://www.springframework.org/tags" prefix="spring"%>
<%@ page session="false"%>
<html>
<head>
<title><spring:message code="label.title" </title>
</head>
<body>
	<form method="post" action="login">
		<table>
			<tr>
				<td><label> <spring:message
								code="label.firstName" 
				</label></td>
				<td><input name="firstName" </td>
			</tr>
			<tr>
				<td><label> <spring:message
								code="label.lastName" 
				</label></td>
				<td><input name="lastName" </td>
			</tr>
			<tr>
				<spring:message code="label.submit" var="labelSubmit"></spring:message>
				<td colspan="2"><input type="submit" value="${labelSubmit}" </td>
			</tr>
		</table>
	</form>
</body>
</html>

唯一值得一提的是使用spring:message检索具有给定代码的消息。
确保使用taglib jsp指令配置了Spring标记库。
Spring负责加载适当的资源包消息,并使其可供JSP页面使用。

Spring Internationalization i18n – Bean配置文件

Spring Bean配置文件是发生所有魔术的地方。
这就是Spring框架的美,因为它帮助我们将更多的精力放在业务逻辑上,而不是为琐碎的任务编写代码。
让我们看看我们的spring bean配置文件的外观,然后我们将每个bean一对一地看。

servlet-context.xml代码:

<?xml version="1.0" encoding="UTF-8"?>
<beans:beans xmlns="https://www.springframework.org/schema/mvc"
	xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xmlns:beans="https://www.springframework.org/schema/beans"
	xmlns:context="https://www.springframework.org/schema/context"
	xsi:schemaLocation="https://www.springframework.org/schema/mvc https://www.springframework.org/schema/mvc/spring-mvc.xsd
		https://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd
		https://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd">

	<!-- DispatcherServlet Context: defines this servlet's request-processing 
		infrastructure -->

	<!-- Enables the Spring MVC @Controller programming model -->
	<annotation-driven 

	<!-- Handles HTTP GET requests for /resources/** by efficiently serving 
		up static resources in the ${webappRoot}/resources directory -->
	<resources mapping="/resources/**" location="/resources/" 

	<!-- Resolves views selected for rendering by @Controllers to .jsp resources 
		in the /WEB-INF/views directory -->
	<beans:bean
		class="org.springframework.web.servlet.view.InternalResourceViewResolver">
		<beans:property name="prefix" value="/WEB-INF/views/" 
		<beans:property name="suffix" value=".jsp" 
	</beans:bean>

	<beans:bean id="messageSource"
		class="org.springframework.context.support.ReloadableResourceBundleMessageSource">
		<beans:property name="basename" value="classpath:messages" 
		<beans:property name="defaultEncoding" value="UTF-8" 
	</beans:bean>

	<beans:bean id="localeResolver"
		class="org.springframework.web.servlet.i18n.CookieLocaleResolver">
		<beans:property name="defaultLocale" value="en" 
		<beans:property name="cookieName" value="myAppLocaleCookie"></beans:property>
		<beans:property name="cookieMaxAge" value="3600"></beans:property>
	</beans:bean>

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

	<context:component-scan base-package="com.theitroad.spring" 

</beans:beans>
  • 注释驱动的标签启用了Controller编程模型,没有它,Spring不会将我们的HomeController识别为客户端请求的处理程序。

  • context:component-scan提供了一个包,Spring将在该包中查找带注释的组件并将其自动注册为Spring Bean。

  • messageSource bean已配置为为我们的应用程序启用i18n。
    basename属性用于提供资源束的位置。
    " classpath:messages"表示资源束位于类路径中,并遵循名称模式,称为" messages_ {locale} .properties"。
    defaultEncoding属性用于定义用于消息的编码。

  • 类型为org.springframework.web.servlet.i18n.CookieLocaleResolver的localeResolver bean用于在客户端请求中设置Cookie,以便其他请求可以轻松识别用户区域设置。
    例如,我们可以要求用户在首次启动Web应用程序时选择区域设置,并且使用cookie,我们可以识别用户区域设置并自动发送特定于区域设置的响应。
    我们还可以指定默认语言环境,cookie名称和cookie的最长使用期限(在客户机浏览器过期和删除之前)。
    如果您的应用程序维护用户会话,那么您也可以使用org.springframework.web.servlet.i18n。
    SessionLocaleResolver 作为localeResolver在用户会话中使用locale属性。
    该配置类似于CookieLocaleResolver。

如果我们未注册任何" localeResolver",则默认情况下将使用AcceptHeaderLocaleResolver,它通过检查客户端HTTP请求中的" accept-language"标头来解析用户区域设置。

  • org.springframework.web.servlet.i18n.LocaleChangeInterceptor拦截器配置为拦截用户请求并标识用户区域设置。
    参数名称是可配置的,我们将语言环境的请求参数名称用作"语言环境"。
    如果没有此拦截器,我们将无法更改用户的语言环境并根据用户的新语言环境设置发送响应。
    它必须是拦截器元素的一部分,否则Spring不会将其配置为拦截器。

如果您想知道告诉Spring框架加载我们的上下文配置的配置,它会出现在我们MVC应用程序的部署描述符中。

<bean id="localeResolver"
	class="org.springframework.web.servlet.i18n.SessionLocaleResolver">
	<property name="defaultLocale" value="en" 
</bean>

我们可以通过更改web.xml配置来更改上下文文件的位置或者名称。

我们的Spring i18n应用程序已准备就绪,只需将其部署在任何servlet容器中。
通常,我将其作为WAR文件导出到独立的tomcat Web服务器webapps目录中。

这是具有不同区域设置的应用程序主页的屏幕截图。

默认主页(按区域设置):

传递语言环境作为参数(fr语言环境):

没有语言环境的其他要求:

如上图所示,我们没有在客户端请求中传递语言环境信息,但是我们的应用程序仍在标识用户语言环境。
您现在必须已经猜到是因为我们在Spring bean配置文件中配置了CookieLocaleResolver bean。
但是,您可以检查您的浏览器Cookie数据以进行确认。
我正在使用chrome,下图显示了应用程序存储的cookie数据。

请注意,cookie有效期为一小时,即由cookieMaxAge属性配置的3600秒。

如果您将检查服务器日志,则可以看到正在记录语言环境。

<servlet>
	<servlet-name>appServlet</servlet-name>
	<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
	<init-param>
		<param-name>contextConfigLocation</param-name>
		<param-value>/WEB-INF/spring/appServlet/servlet-context.xml</param-value>
	</init-param>
	<load-on-startup>1</load-on-startup>
</servlet>
		
<servlet-mapping>
	<servlet-name>appServlet</servlet-name>
	<url-pattern>/</url-pattern>
</servlet-mapping>