Spring MVCの国際化（i18n）とローカライゼーション（L10n）の例

2年 ago
陽, 向宇
9 minutes

「Spring Internationalization (i18n) チュートリアルへようこそ。世界中のユーザーを持つウェブアプリケーションにおいて、国際化（i18n）やローカリゼーション（L10n）はユーザーとのより良い相互作用のために非常に重要です。ほとんどのウェブアプリケーションフレームワークは、ユーザーのロケール設定に基づいてアプリケーションを簡単にローカライズする方法を提供しています。Springも同様のパターンに従い、Springインターセプター、ロケールリゾルバー、および異なるロケールに対するリソースバンドルを使用して国際化（i18n）を広範にサポートしています。Javaに関するi18nについてのいくつかの以前の記事もあります。」

  • Java Internationalization Example
  • Struts2 Internationalization Example

春の国際化 i18n

シンプルなSpring MVCプロジェクトを作成しましょう。このプロジェクトでは、リクエストパラメータを使用してユーザーのロケールを取得し、それに基づいてロケール固有のリソースバンドルから応答ページのラベル値を設定します。Spring Tool SuiteでSpring MVCプロジェクトを作成し、アプリケーションの基本コードを用意しましょう。Spring Tool SuiteやSpring MVCプロジェクトに馴染みがない場合は、「Spring MVC Example」をお読みください。最終的なローカライズの変更が施されたプロジェクトの全体像は以下の画像のようになります。アプリケーションの各部分を順番に見ていきましょう。

スプリングの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.scdev</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に更新しました。依存関係を削除したり、他の依存関係のバージョンを更新することもできますが、簡単のためにそのままにしておきました。

スプリングリソースバンドル

簡単にするため、私たちのアプリケーションはenとfrの2つのロケールのみをサポートするものとします。ユーザのロケールが指定されていない場合、デフォルトのロケールとして英語を使用します。JSPページで使用されるため、これらのロケールのためにSpringリソースバンドルを作成しましょう。messages_en.propertiesのコード：

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

メッセージが見つかりませんでした。

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

「フランスのロケールリソースバンドルでは、特殊文字にはUnicodeを使用しています。これにより、クライアントのリクエストに送信される応答HTMLで適切に解釈されるようになります。また、重要なポイントとして、両方のリソースバンドルはアプリケーションのクラスパスにあり、その名前は「messages_{ロケール}.properties」というパターンになっていることに注意してください。これらがなぜ重要かは後で見てみましょう。」

春のi18nコントローラークラス

私たちのコントローラークラスは非常にシンプルで、ユーザーのロケールをログに記録し、応答としてhome.jspページを返します。

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

春の多言語対応された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を使用することです。Springのタグライブラリがtaglib jspディレクティブを使用して設定されていることを確認してください。Springは適切なリソースバンドルメッセージをロードし、JSPページが使用できるようにします。

Spring国際化i18n – ビーン設定ファイル

Spring Beanの設定ファイルは、すべての魔法が行われる場所です。これはSpringフレームワークの魅力であり、ビジネスロジックに重点を置くのに役立つため、ささいなタスクのコーディングに時間を費やす必要がありません。さあ、私たちのSpring 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.scdev.spring" />

</beans:beans>
    1. アノテーションを使用したタグは、Controllerプログラミングモデルを有効にし、それがなければSpringはHomeControllerをクライアントリクエストのハンドラとして認識しません。

context:component-scanは、Springがアノテーション付きコンポーネントを探すパッケージを提供し、それらを自動的にSpringビーンとして登録します。

messageSourceビーンは、アプリケーションのi18nを有効にするために設定されます。basenameプロパティはリソースバンドルの場所を指定するために使用されます。classpath:messagesは、リソースバンドルがクラスパスにあり、messages_{locale}.propertiesという名前のパターンに従うことを意味します。defaultEncodingプロパティは、メッセージに使用されるエンコーディングを定義するために使用されます。

タイプがorg.springframework.web.servlet.i18n.CookieLocaleResolverのlocaleResolverビーンは、クライアントリクエストにクッキーを設定するために使用されます。これにより、次のリクエストでユーザのロケールを簡単に認識することができます。たとえば、ユーザに初回起動時にロケールを選択するように依頼し、クッキーを使用してユーザのロケールを特定し、自動的にロケール固有のレスポンスを送信することができます。デフォルトのロケール、クッキー名、クッキーの有効期限の前に削除されるまでの最大年齢も指定することができます。アプリケーションがユーザセッションを維持する場合は、ユーザのセッションにロケール属性を使用するために、localeResolverとしてorg.springframework.web.servlet.i18n.SessionLocaleResolverを使用することもできます。設定はCookieLocaleResolverに似ています。

もし「localeResolver」を登録しない場合、デフォルトでAcceptHeaderLocaleResolverが使用され、クライアントのHTTPリクエストのaccept-languageヘッダーを確認してユーザのロケールを解決します。

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アプリケーションは準備ができており、任意のサーブレットコンテナにデプロイすることができます。通常、スタンドアロンのTomcatウェブサーバーのwebappsディレクトリにWARファイルとしてエクスポートします。以下は、異なるロケールでのアプリケーションのホームページのスクリーンショットです。デフォルトのホームページ（enのロケール）：パラメータとしてロケールを渡す（frのロケール）：ロケールなしの追加のリクエスト：以上の画像でわかるように、クライアントのリクエストにロケール情報を渡していませんが、アプリケーションはユーザーのロケールを識別しています。これは、私たちがSpringのBean構成ファイルで設定したCookieLocaleResolverビーンのおかげです。ただし、ブラウザのクッキーデータを確認して確認することもできます。私はChromeを使用しており、以下の画像はアプリケーションが保存したクッキーデータを示しています。クッキーの有効期限は1時間であり、cookieMaxAgeプロパティで設定されています。サーバーログを確認すると、ロケールが記録されていることがわかります。

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

これで春のi18nの例アプリケーションは以上です。以下のリンクから例プロジェクトをダウンロードし、それを使用してもっと学ぶために試してみてください。

「Springのi18nプロジェクトをダウンロードしてください。」

コメントを残す 0

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