Spring MVC 国际化（i18n）和本地化（L10n）示例

2 年 ago
科, 雅
9 minutes

欢迎来到Spring国际化（i18n）教程。对于在全球用户中使用的任何Web应用程序，国际化（i18n）或本地化（L10n）对于更好的用户互动非常重要。大多数Web应用程序框架都提供了根据用户区域设置本地化应用程序的简便方法。Spring也遵循这一模式，并通过使用Spring拦截器、区域解析器和不同区域的资源包提供了广泛的国际化（i18n）支持。以下是关于Java中的国际化的一些早期文章。

  • Java Internationalization Example
  • Struts2 Internationalization Example

春季国际化 i18n

让我们创建一个简单的Spring MVC项目，在其中使用请求参数来获取用户的区域设置，并根据此设置来从特定于区域设置的资源包中设置响应页面的标签值。在Spring Tool Suite中创建一个Spring MVC项目，以获得我们应用程序的基本代码。如果您对Spring Tool Suite或Spring MVC项目不熟悉，请阅读Spring MVC示例。我们最终的本地化更改项目如下图所示。我们将逐一研究应用程序的所有部分。

春天国际化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.Olivia</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.2.RELEASE版本。我们也可以删除依赖项或者更新其他依赖项的版本，但为了简单起见，我保持其不变。

春季资源包

为了简化起见，让我们假设我们的应用程序只支持两种语言环境-英语和法语。如果未指定用户的语言环境，我们将使用英语作为默认语言环境。我们将为这两种语言环境创建用于在JSP页面中使用的Spring资源包。 messages_en.properties代码：

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

以下是messages_fr.properties代码的中文释义:

messages_fr.properties代码:

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

请注意，我正在在法国地区资源包中使用Unicode对特殊字符进行编码，以便在响应HTML发送给客户端请求时能够正确解释。另一个重要的注意点是，资源包都在应用程序的类路径中，并且它们的名称遵循“messages_{locale}.properties”的模式。我们将在稍后看到这些为什么重要。

春天的i18n控制器类 de i18n

我们的控制器类非常简单，它只是记录用户的语言环境，并作为响应返回home.jsp页面。

package com.Olivia.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";
	}
	
}

春季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> <strong><spring:message
								code="label.firstName" /></strong>
				</label></td>
				<td><input name="firstName" /></td>
			</tr>
			<tr>
				<td><label> <strong><spring:message
								code="label.lastName" /></strong>
				</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页面使用。

春季国际化 – 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.Olivia.spring" />

</beans:beans>
    1. 通过注解驱动的标签来启用控制器编程模型，在没有它的情况下，Spring将不会将我们的HomeController识别为客户端请求的处理程序。

上下文扫描提供了Spring将查找注释组件并自动将其注册为Spring bean的包。

配置了messageSource bean以为我们的应用启用国际化。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拦截器，用于拦截用户请求并识别用户的语言环境。参数名称是可配置的，我们使用的是名为“locale”的请求参数名称作为语言环境。如果没有这个拦截器，我们将无法更改用户的语言环境并根据用户的新语言环境设置发送响应。它需要作为interceptors元素的一部分，否则Spring将不会将其配置为拦截器。

如果你对告诉Spring框架加载我们的上下文配置文件的配置感到困惑，这个配置位于我们的MVC应用程序部署描述符中。

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

我们可以通过更改web.xml配置来改变上下文文件的位置或名称。我们的Spring i18n应用程序已经准备好了，只需要在任何Servlet容器中部署它。通常情况下，我将其导出为WAR文件，放在独立的Tomcat Web服务器的webapps目录下。下面是我们应用程序主页在不同语言环境下的截图。默认主页（英语环境）：传递语言环境作为参数（法语环境）：没有指定语言环境的进一步请求：从上面的图像可以看出，我们在客户端请求中没有传递语言环境信息，但我们的应用程序仍然可以识别用户的语言环境。你可能已经猜到了，这是因为我们在Spring bean配置文件中配置了CookieLocaleResolver bean。不过，你可以检查浏览器的cookie数据来确认这个情况。我正在使用Chrome浏览器，下面的图片显示了应用程序存储的cookie数据。请注意，cookie的过期时间是一个小时，即3600秒，这是由cookieMaxAge属性配置的。如果你查看服务器日志，你会看到语言环境被记录下来了。

INFO : com.Olivia.spring.HomeController - Welcome home! The client locale is en.
INFO : com.Olivia.spring.HomeController - Welcome home! The client locale is fr.
INFO : com.Olivia.spring.HomeController - Welcome home! The client locale is fr.

这就是关于Spring i18n示例应用的全部内容，请从下方链接下载示例项目并进行操作，以便更多地了解。

下载Spring i18n项目

发表回复 0

Your email address will not be published. Required fields are marked *

✖
广告
将在 10 秒后关闭
bannerAds