Spring MVC 国际化(i18n)和本地化(L10n)示例
欢迎阅读 Spring 国际化 (i18n) 教程。对于任何拥有全球用户的 Web 应用程序,国际化(i18n) 或本地化(L10n) 对于实现更好的用户交互都非常重要。大多数 Web 应用程序框架都提供了基于用户区域设置的简单方法来本地化应用程序。Spring 也遵循该模式,通过使用 Spring 拦截器、区域解析器和针对不同区域设置的资源包,为国际化 (i18n) 提供广泛的支持。一些关于 Java 中 i18n 的早期文章。
Spring 国际化 i18n
让我们创建一个简单的 Spring MVC 项目,我们将使用请求参数来获取用户语言环境,并在此基础上从特定于语言环境的资源包中设置响应页面标签值。在 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.journaldev</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。我们也可以删除依赖项或更新其他依赖项的版本,但为了简单起见,我保留了它们。
Spring 资源包
为简单起见,我们假设我们的应用程序仅支持两种语言环境 - en和fr。如果未指定用户语言环境,我们将使用 english 作为默认语言环境。让我们为这两个将在 JSP 页面中使用的语言环境创建 spring 资源包。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.journaldev.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> <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 页面使用。
Spring 国际化 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.journaldev.spring" />
</beans:beans>
-
注释驱动标签启用了控制器编程模型,如果没有它,Spring 将无法识别我们的 HomeController 作为客户端请求的处理程序。
-
context:component-scan提供了一个包,Spring 将在其中查找带注释的组件并将其自动注册为 Spring bean。
-
messageSource bean 配置为为我们的应用程序启用 i18n。basename属性用于提供资源包的位置。表示资源包位于类路径中并遵循名称模式。defaultEncoding 属性用于定义用于消息的编码。
classpath:messages
messages_{locale}.properties
-
localeResolver类型的 bean
org.springframework.web.servlet.i18n.CookieLocaleResolver
用于在客户端请求中设置 cookie,以便后续请求可以轻松识别用户语言环境。例如,我们可以要求用户在第一次启动 Web 应用程序时选择语言环境,通过使用 cookie,我们可以识别用户语言环境并自动发送特定于语言环境的响应。我们还可以指定默认语言环境、cookie 名称以及 cookie 的最大使用期限,否则客户端浏览器会将其过期并删除。如果您的应用程序维护用户会话,那么您也可以使用org.springframework.web.servlet.i18n.SessionLocaleResolver
localeResolver 在用户会话中使用语言环境属性。配置类似于 CookieLocaleResolver。<bean id="localeResolver" class="org.springframework.web.servlet.i18n.SessionLocaleResolver"> <property name="defaultLocale" value="en" /> </bean>
如果我们没有注册任何“localeResolver”,则默认使用AcceptHeaderLocaleResolver
accept-language
,它通过检查客户端HTTP请求中的标头来解析用户区域设置。 -
org.springframework.web.servlet.i18n.LocaleChangeInterceptor
拦截器配置为拦截用户请求并识别用户区域设置。参数名称是可配置的,我们使用区域设置的请求参数名称作为“locale”。如果没有此拦截器,我们将无法更改用户区域设置并根据用户的新区域设置发送响应。它需要成为拦截器元素的一部分,否则 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 目录中。以下是我们具有不同语言环境的应用程序主页的屏幕截图。默认主页(en 语言环境):将语言环境作为参数传递(fr 语言环境):没有语言环境的进一步请求:如您在上图中所见,我们没有在客户端请求中传递语言环境信息,但我们的应用程序仍然识别用户语言环境。您现在一定已经猜到,这是因为我们在 spring bean 配置文件中配置了 CookieLocaleResolver bean。但是,您可以检查浏览器的 cookie 数据来确认这一点。我使用的是 chrome,下图显示了应用程序存储的 cookie 数据。请注意,cookie 的有效期为 1 小时,即 3600 秒,由 cookieMaxAge 属性配置。如果您检查服务器日志,您会看到语言环境已被记录。
INFO : com.journaldev.spring.HomeController - Welcome home! The client locale is en.
INFO : com.journaldev.spring.HomeController - Welcome home! The client locale is fr.
INFO : com.journaldev.spring.HomeController - Welcome home! The client locale is fr.
这就是 Spring i18n 示例应用程序的全部内容,请从下面的链接下载示例项目并试用以了解更多信息。
下载 Spring i18n 项目