Spring Boot - Internacionalização

A internacionalização é um processo que torna seu aplicativo adaptável a diferentes idiomas e regiões sem alterações de engenharia no código-fonte. Em qualquer uma das palavras, internacionalização é uma prontidão de localização.

Neste capítulo, vamos aprender em detalhes sobre como implementar a Internacionalização no Spring Boot.

Dependências

Precisamos da dependência Spring Boot Starter Web e Spring Boot Starter Thymeleaf para desenvolver um aplicativo da web no Spring Boot.

Maven

<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

Precisamos determinar a localidade padrão de seu aplicativo. Precisamos adicionar o bean LocaleResolver em nosso aplicativo Spring Boot.

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

LocaleChangeInterceptor

LocaleChangeInterceptor é usado para alterar o novo Locale com base no valor do parâmetro de idioma adicionado a uma solicitação.

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

Para fazer isso, precisamos adicionar LocaleChangeInterceptor ao interceptor de registro do aplicativo. A classe de configuração deve estender a classe WebMvcConfigurerAdapter e substituir o método addInterceptors ().

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

Fontes de mensagens

O aplicativo Spring Boot por padrão pega as fontes de mensagens de src/main/resourcespasta sob o classpath. O nome do arquivo de mensagem local padrão deve sermessage.properties e os arquivos para cada localidade devem ser nomeados como messages_XX.properties. O “XX” representa o código local.

Todas as propriedades da mensagem devem ser usadas como valores de pares de chaves. Se alguma propriedade não for localizada no código do idioma, o aplicativo usará a propriedade padrão do arquivo messages.properties.

O messages.properties padrão será como mostrado -

welcome.text=Hi Welcome to Everyone

As mensagens de idioma francês_fr.properties serão as mostradas -

welcome.text=Salut Bienvenue à tous

Note - O arquivo de origem das mensagens deve ser salvo no formato de arquivo “UTF-8”.

Arquivo HTML

No arquivo HTML, use a sintaxe #{key} para exibir as mensagens do arquivo de propriedades.

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

O código completo é fornecido abaixo

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.tutorialspoint</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.tutorialspoint'
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')
}

O arquivo principal da classe do aplicativo Spring Boot é fornecido abaixo -

package com.tutorialspoint.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);
   }
}

O arquivo de classe do controlador é fornecido abaixo -

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

Classe de configuração para apoiar a internacionalização

package com.tutorialspoint.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());
   }
}

As fontes de mensagens - messages.properties são mostradas -

welcome.text = Hi Welcome to Everyone

As fontes de mensagens - message_fr.properties são as mostradas -

welcome.text = Salut Bienvenue à tous

O arquivo HTML locale.html deve ser colocado no diretório de modelos no caminho de classe, conforme mostrado -

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

Você pode criar um arquivo JAR executável e executar o aplicativo Spring boot usando os seguintes comandos Maven ou Gradle -

Para Maven, use o seguinte comando -

mvn clean install

Após “BUILD SUCCESS”, você pode encontrar o arquivo JAR no diretório de destino.

Para Gradle, use o seguinte comando -

gradle clean build

Depois de “BUILD SUCCESSFUL”, você pode encontrar o arquivo JAR no diretório build / libs.

Agora, execute o arquivo JAR usando o comando conforme mostrado -

java –jar <JARFILE>

Você verá que o aplicativo foi iniciado na porta 8080 do Tomcat.

Agora acesse o URL http://localhost:8080/locale no seu navegador e você pode ver o seguinte resultado -

O URL http://localhost:8080/locale?language=fr fornecerá a saída conforme mostrado -