Spring-boot-internationalization

提供:Dev Guides
移動先:案内検索

Spring Boot-国際化

国際化とは、ソースコードを工学的に変更することなく、アプリケーションをさまざまな言語や地域に適応させるプロセスです。 言い換えれば、国際化はローカライズの準備ができていることです。

この章では、Spring Bootで国際化を実装する方法について詳しく学習します。

依存関係

Spring BootでWebアプリケーションを開発するには、Spring Boot Starter WebとSpring Boot Starter Thymeleafの依存関係が必要です。

メーベン

<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-web</artifactId>
</dependency>

<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>

Gradle

compile('org.springframework.boot:spring-boot-starter-web')
compile group: 'org.springframework.boot', name: 'spring-boot-starter-thymeleaf'

LocaleResolver

アプリケーションのデフォルトのロケールを決定する必要があります。 Spring BootアプリケーションにLocaleResolver Beanを追加する必要があります。

@Bean
public LocaleResolver localeResolver() {
   SessionLocaleResolver sessionLocaleResolver = new SessionLocaleResolver();
   sessionLocaleResolver.setDefaultLocale(Locale.US);
   return sessionLocaleResolver;
}

LocaleChangeInterceptor

LocaleChangeInterceptorは、要求に追加された言語パラメーターの値に基づいて新しいロケールを変更するために使用されます。

@Bean
public LocaleChangeInterceptor localeChangeInterceptor() {
   LocaleChangeInterceptor localeChangeInterceptor = new LocaleChangeInterceptor();
   localeChangeInterceptor.setParamName("language");
   return localeChangeInterceptor;
}

この効果を得るには、アプリケーションのレジストリインターセプターにLocaleChangeInterceptorを追加する必要があります。 構成クラスは、WebMvcConfigurerAdapterクラスを拡張し、addInterceptors()メソッドをオーバーライドする必要があります。

@Override
public void addInterceptors(InterceptorRegistry registry) {
   registry.addInterceptor(localeChangeInterceptor());
}

メッセージソース

Spring Bootアプリケーションはデフォルトで、クラスパスの下の src/main/resources フォルダーからメッセージソースを取得します。 デフォルトのロケールメッセージファイル名は message.properties であり、各ロケールのファイルは messages_XX.properties である必要があります。 「XX」はロケールコードを表します。

すべてのメッセージプロパティをキーペア値として使用する必要があります。 ロケールでプロパティが見つからない場合、アプリケーションはmessages.propertiesファイルのデフォルトプロパティを使用します。

デフォルトのmessages.propertiesは次のようになります-

welcome.text=Hi Welcome to Everyone

フランス語のmessages_fr.propertiesは次のようになります-

welcome.text=Salut Bienvenue à tous

注意-メッセージのソースファイルは「UTF-8」ファイル形式で保存する必要があります。

HTMLファイル

HTMLファイルで、構文*#\ {key} *を使用して、プロパティファイルからのメッセージを表示します。

<h1 th:text = "#{welcome.text}"></h1>

完全なコードは以下の通りです

Maven – pom.xml

<?xml version = "1.0" encoding = "UTF-8"?>
<project xmlns = "http://maven.apache.org/POM/4.0.0"
   xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation = "http://maven.apache.org/POM/4.0.0
   http://maven.apache.org/xsd/maven-4.0.0.xsd">

   <modelVersion>4.0.0</modelVersion>
   <groupId>com.finddevguides</groupId>
   <artifactId>demo</artifactId>
   <version>0.0.1-SNAPSHOT</version>
   <packaging>jar</packaging>
   <name>demo</name>
   <description>Demo project for Spring Boot</description>

   <parent>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-parent</artifactId>
      <version>1.5.8.RELEASE</version>
      <relativePath/>
   </parent>

   <properties>
      <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
      <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
      <java.version>1.8</java.version>
   </properties>

   <dependencies>
      <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-web</artifactId>
      </dependency>

      <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-test</artifactId>
         <scope>test</scope>
      </dependency>

      <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-thymeleaf</artifactId>
      </dependency>
   </dependencies>

   <build>
      <plugins>
         <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
         </plugin>
      </plugins>
   </build>
</project>

Gradle – build.gradle

buildscript {
   ext {
      springBootVersion = '1.5.8.RELEASE'
   }
   repositories {
      mavenCentral()
   }
   dependencies {
      classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
   }
}
apply plugin: 'java'
apply plugin: 'eclipse'
apply plugin: 'org.springframework.boot'

group = 'com.finddevguides'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = 1.8

repositories {
   mavenCentral()
}
dependencies {
   compile('org.springframework.boot:spring-boot-starter-web')
   compile group: 'org.springframework.boot', name: 'spring-boot-starter-thymeleaf'
   testCompile('org.springframework.boot:spring-boot-starter-test')
}

メインのSpring Bootアプリケーションクラスファイルは以下のとおりです-

package com.finddevguides.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class DemoApplication {
   public static void main(String[] args) {
      SpringApplication.run(DemoApplication.class, args);
   }
}

コントローラクラスファイルは以下のとおりです-

package com.finddevguides.demo.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

@Controller
public class ViewController {
   @RequestMapping("/locale")
   public String locale() {
      return "locale";
   }
}

国際化をサポートする構成クラス

package com.finddevguides.demo;

import java.util.Locale;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.LocaleResolver;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
import org.springframework.web.servlet.i18n.LocaleChangeInterceptor;
import org.springframework.web.servlet.i18n.SessionLocaleResolver;

@Configuration
public class Internationalization extends WebMvcConfigurerAdapter {
   @Bean
   public LocaleResolver localeResolver() {
      SessionLocaleResolver sessionLocaleResolver = new SessionLocaleResolver();
      sessionLocaleResolver.setDefaultLocale(Locale.US);
      return sessionLocaleResolver;
   }
   @Bean
   public LocaleChangeInterceptor localeChangeInterceptor() {
      LocaleChangeInterceptor localeChangeInterceptor = new LocaleChangeInterceptor();
      localeChangeInterceptor.setParamName("language");
      return localeChangeInterceptor;
   }
   @Override
   public void addInterceptors(InterceptorRegistry registry) {
      registry.addInterceptor(localeChangeInterceptor());
   }
}

メッセージソース-messages.propertiesは次のとおりです-

welcome.text = Hi Welcome to Everyone

メッセージソース-message_fr.propertiesは次のとおりです-

welcome.text = Salut Bienvenue à tous

HTMLファイルlocalelは、次のようにクラスパスのテンプレートディレクトリの下に配置する必要があります-

<!DOCTYPE html>
<html>
   <head>
      <meta charset = "ISO-8859-1"/>
      <title>Internationalization</title>
   </head>
   <body>
      <h1 th:text = "#{welcome.text}"></h1>
   </body>
</html>

次のMavenまたはGradleコマンドを使用して、実行可能JARファイルを作成し、Springブートアプリケーションを実行できます-

Mavenの場合、次のコマンドを使用します-

mvn clean install

「BUILD SUCCESS」の後、ターゲットディレクトリの下にJARファイルがあります。

Gradleの場合、次のコマンドを使用します-

gradle clean build

「BUILD SUCCESSFUL」の後、build/libsディレクトリの下にJARファイルがあります。

今、示されているようにコマンドを使用してJARファイルを実行します-

java –jar <JARFILE>

Tomcatポート8080でアプリケーションが開始されていることがわかります。

Tomcat Port_8080で開始されたアプリケーション

今すぐあなたのWebブラウザでURL http://localhost:8080/locale をヒットすると、次の出力を見ることができます-

Webブラウザーの出力

URL http://localhost:8080/locale?language = fr は、次のような出力を提供します-

WebブラウザSalut Bienvenueを出力