Toxina Virtual: 2016

Conforme prometido, vamos falar sobre I18n no Spring-Boot. Vamos utilizar o mesmo projeto das postagens anteriores:
http://toxinavirtual.blogspot.com.br/2016/09/crud-com-rest-spring-boot-e-jpa.html

Vamos criar os arquivos com as labels em Inglês, Espanhol e Português em arquivos diferentes com as diferentes traduções. Os arquivos deverão ficar dentro de uma pasta nova chamada de i18n que será criada dentro de resources. Os arquivos são de texto do tipo .properties.

No arquivo messages_en.properties, o conteúdo:

field1 = My Field 1
field2 = My Field 2

No arquivo messages_es.properties, o conteúdo:

field1 = El Campo 1
field2 = El Campo 2

No arquivo messages_pt.properties, o conteúdo:

field1 = Meu Campo 1
field2 = Meu Campo 2

Vamos criar agora o template hello.html dentro da pasta resources/template. O arquivo dever[a conter o seguinte:

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:th="http://www.thymeleaf.org">
<head lang="en">
<meta charset="UTF-8" />
<title>HELLO</title>
</head>
<body>
<div>
<label for="field1" th:text="#{field1}"></label>
<input type="text" id="field1" name="field1" />
</div>
<div>
<label for="field2" th:text="#{field2}"></label>
<input type="text" id="field2" name="field2" />
</div>
<div>
<button type="submit">Save</button>
</div>
</body>
</html>

Repare que no template temos os campos em variáveis delimitadas por "#{}". O texto com o nome da variável deverá ser substituído pelas traduções dos arquivos properties.

O arquivo de template está usando um gerenciador de templates para que o Spring-Boot consiga interpretar o arquivo. Será necessário adicionar a dependência dentro do arquivo pom.xml.

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

O template também depende de um controlador que determine a rota de acesso.

package com.example.controller;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
@Controller
public class Hello {
@RequestMapping("/hello")
public String gohome(Model model){
return "hello";
}
}

A classe mapeada para o endereço /hello deverá retornar o nome do template sem a necessidade a da extensão .html. O conteúdo do arquivo será exibido, mas por enquanto sem a tradução.

Para implementar a tradução precisaremos extender o arquivo de inicialização para a classe WebMvcConfigurerAdapter. Como o arquivo de inicialização está extendendo o deploy criaremos um novo arquivo de configuração que funcionará paralelamente.

Com as anotations @Configuration, @EnableAutoConfiguration e @ComponentScan o Spring-Boot já saberá que se trata de um arquivo de configuração que possui componentes de configuração.

Primeiramente, criaremos um Locale. O Locale determina a linguagem através da região em que o site é acessado, assim como ajuda na configuração da tradução. O Locale geralmente fica armazenado na sessão do sistema.

//I18n do pacote web.servlet
@Bean
public LocaleResolver localeResolver() {
SessionLocaleResolver slr = new SessionLocaleResolver();
slr.setDefaultLocale(Locale.US);
return slr;
}

Agora criamos um interceptador do parâmetro de linguagem.

@Bean
public LocaleChangeInterceptor localeChangeInterceptor() {
LocaleChangeInterceptor lci = new LocaleChangeInterceptor();
lci.setParamName("lang");
return lci;
}
//I18n
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(localeChangeInterceptor());
}

Em seguida criamos um MessageSource e definimos o arquivo de origem da mensagem. O Validator vai executar a troca.

@Bean
public MessageSource messageSource() {
final ReloadableResourceBundleMessageSource messageSource = new ReloadableResourceBundleMessageSource();
messageSource.setBasename("classpath:/i18n/messages");
messageSource.setUseCodeAsDefaultMessage(true);
messageSource.setDefaultEncoding("UTF-8");
return messageSource;
}
@Override
public Validator getValidator() {
LocalValidatorFactoryBean validator = new LocalValidatorFactoryBean();
validator.setValidationMessageSource(messageSource() );
return validator;
}
}

Segue o arquivo na integra:

package com.example.config;
import java.util.Locale;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.context.MessageSource;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.support.ReloadableResourceBundleMessageSource;
import org.springframework.validation.Validator;
import org.springframework.validation.beanvalidation.LocalValidatorFactoryBean;
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
@EnableAutoConfiguration
@ComponentScan
class ApplicationConfig extends WebMvcConfigurerAdapter {
//I18n do pacote web.servlet
@Bean
public LocaleResolver localeResolver() {
SessionLocaleResolver slr = new SessionLocaleResolver();
slr.setDefaultLocale(Locale.US);
return slr;
}
//I18n
@Bean
public LocaleChangeInterceptor localeChangeInterceptor() {
LocaleChangeInterceptor lci = new LocaleChangeInterceptor();
lci.setParamName("lang");
return lci;
}
//I18n
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(localeChangeInterceptor());
}
@Bean
public MessageSource messageSource() {
final ReloadableResourceBundleMessageSource messageSource = new ReloadableResourceBundleMessageSource();
messageSource.setBasename("classpath:/i18n/messages");
messageSource.setUseCodeAsDefaultMessage(true);
messageSource.setDefaultEncoding("UTF-8");
return messageSource;
}
@Override
public Validator getValidator() {
LocalValidatorFactoryBean validator = new LocalValidatorFactoryBean();
validator.setValidationMessageSource(messageSource() );
return validator;
}
}

Segue a imagem da label funcionando.

É possível ainda melhorar o projeto de várias formas, como definir a liguagem na sessão antes do login.

Mais tarde atualizo o post com o código do github.

Toxina Virtual

sexta-feira, 30 de setembro de 2016

Internacionalização no Spring-Boot