How to use multilanguage in JSF? (Cómo usar multilenguaje en JSF?) en martes, febrero 12, 2008

Para la creación de una aplicación en JSF que soporte multilenguaje, se pueden seguir los siguientes pasos:

CREAMOS NUESTRO PROPERTIES

La creación de un archivo de texto properties, es para seguir un patrón a seguir por el framework y de esta forma estandarizar.

En este archivo se compone de una forma parecida a un hashmap, es decir, se tiene un key un value. Un ejemplo de este tipo de archivo:

Resources_es.properties

Mensaje1 = Hola

Boton = Seleccionar

Mensaje-Boton = Boton seleccionado

La parte que se encuentra a la izquierda del “=” es el key por el cual ubicaremos nuestro value, que en este caso es un string.

NOTA: No se puede colocar keys de la forma mensaje.submensaje, debido a que el punto “.” es reservado por JSF para obtener las propiedades de los objetos.

CONFIGURAR FACES-CONFIG.XML

El siguiente paso a seguir es el configurar nuestro Faces-Config.xml de tal manera que le indiquemos dónde se encontrará nuestro archivo de mensajes (el properties) y qué idiomas puede soportar, así como también el archivo de mensajes por default. Un ejemplo de configuración se puede ver a continuación:

Faces-config.xml

Ahora explicaremos cómo funciona esto:

El JSF va a tomar en cuenta el archivo que se indica en el message-bundle, el cual servirá para los idiomas respectivos.

El default-locale es el idioma que va a ser elegido por default si es que el locale del cliente no se encuentra dentro de los supported-locale, caso contrario, se elegirá ese supported-locale.

El uso de los locale es el siguiente. Supongamos el caso de Perú, la configuración de la PC está con español(Perú), entonces el locale que va a detectar la aplicación, va a ser “es”, por lo tanto, el archivo de mensajes que utilizará, no será el oracle.backing.pages.view.ApplicationResources.properties, sino que elegirá oracle.backing.pages.view.ApplicationResources_es.properties. Es decir, los archivos se tomarán de la siguiente forma

archivo_la_pa.properties

archivo = oracle.backing.pages.view.ApplicationResources

la = Representa el idioma o lenguaje que se tiene seteado en la configuración de la PC, para el caso de Perú es “es”, para USA “en”, etc.

pa = Representa el pais del cliente, el cual puede ser “pe”, “gb”, etc.

Entonces, teniendo este ejemplo, si es que el cliente es de USA, el archivo que tomará el framework será:

oracle.backing.pages.view.ApplicationResources_en_us.properties

Se deben de colocar tantos como archivos de properties se tenga.

¿CÓMO USAR EL MULTILENGUAJE?

Coloquemos este escenario para entenderlo mejor. El cliente se conecta desde Perú y su PC está configurada en español(Perú). Al momento de conectarse, debe de aparecer un mensaje diciéndole “Hola” en su idioma nativo.

Entonces el código debe de verse de la siguiente forma:

Explicación del código:

Se puede ver que se tiene que colocar un f:loadBundle para tener una variable con el archivo, en su propiedad “basename” colocamos el mismo direccionamiento que colocamos en el faces-config.xml, pero sin la extensión properties.

Y la forma de llamar a alguna de sus keys es con EL Expression, #{msg.Key}, donde Key es la llave que quieren visualizar, de esta forma se verá un mensaje de “Hola”.

¿Cómo modificar el idioma de forma dinámica?

Para la modificación del idioma o archivo de mensajes que utiliza el framework, se tiene que utilizar el siguiente código:

FacesContext miContexto = FacesContext.getCurrentInstance();

Locale miLocale = new Locale("en","us");

miContexto.getViewRoot().setLocale(miLocale);

Donde el constructor de Locale recibe como primer parámetro el lenguaje o idioma, mientras que el segundo parámetro es el país del cliente.

If you want to use multilanguage in JSF, you can follow the next steps:

LET’S CREATE OUR PROPERTIES FILES

Our properties file is like a hashmap, where we have a key and a value. This example is of my properties:

oracle.backing.pages.view.ApplicationResources_es.properties

Mensaje1 = Hola

Boton = Seleccionar

Mensaje-Boton = Boton seleccionado

The part on the left of the “=” is our key, on the right we have our values, this is a string.

NOTA: You can’t put the key of this way mensaje.submensaje, Because JSF uses “.” to get the property of a object.

CONFIGURATION faces-config.xml

The next step is configurate the faces-config.xml, we need to indicate it the browse of our properties and what languages can your application support, also, we need to indicate the language by default. Here we have an example:

Faces-config.xml

Let’s explain it:

JSF will take the file in message-bundle for the languages.

The default-locale is the language by default. If the language of the client is not in the list of supported-locale, JSF will take the default-locale.

How does locale work? Let’s think we are in Perú, we have español(Perú) in our PC configuration. So, the locale will detect “es” as a language, so JSF won’t use oracle.backing.pages.view.ApplicationResources.properties, else

oracle.backing.pages.view.ApplicationResources_es.properties.

Let’s explain more how JSF take the files:

file_la_co.properties

file = oracle.backing.pages.view.ApplicationResources

la = This is the language of the PC.

co = This is the country, like Pe(Perú), US(USA), etc.

So, if the client is from USA, JSF will take the file:

oracle.backing.pages.view.ApplicationResources_en_us.properties

You should have a propertie file for each supported-locale.

¿How to use multilanguage?

For example, if we are in Perú, JSf will show me just spanish messages like “hola”.

Then, we have the next example code:

Here we have f:loadBundle where we put the browse of the properties (this is the same of the faces-config,xml, but without the “.properties”).

The way to call a message is with a EL Expression, like #{msg.Key}.

In our example we well see the message “Hola” of our propertie file oracle.backing.pages.view.ApplicationResources_es.properties.

¿How to change the language of our application?

We can modif. the language or message file of our application with the next code:

FacesContext miContexto = FacesContext.getCurrentInstance();

Locale miLocale = new Locale("en","us");

miContexto.getViewRoot().setLocale(miLocale);

The constructor of Locale will receive (language, country)

ANEXO!!!!(ADITIONAL)
Bueno, comenzaré diciendo que el libro de "JSF IN ACTION" asegura que no se puede usar keys con punto, debido a que es reservado por JSF. Hasta cierto punto esto es cierto, pero hay una forma de seguir con el estándar de usar el punto. ¿Cómo realizarlo?
Para dar el ejemplo, utilizaré el mismo código de antes, pero esta vez haré el cambio. Supongamos que ahora mi properties, tiene un nuevo key que es así:

miKey.mensaje = Nuevo mensaje

Entonces, para llamar a un key de esta forma, modificaremos el código JSF de la siguiente forma



Como pueden ver, en el value del outputText ahora no se coloca msg.key, sino que se hace lo siguiente: msg['miKey.mensaje'], de esta forma mostraremos lo que habíamos colocado antes, es decir "Nuevo mensaje".

Entonces, de esta forma estaremos listos para utilizar los mensajes de una forma multilanguage.
Espero que haya servido esta aclaración, muchas gracias a Lennon Shimokawa por la duda que tuvo, porque sino no hubiese extendido esto para que les sirva más.

Sobre lo de no utilizar el f:loadBundle, creo que hay una forma de hacerlo, que es cargando el Bundle en el BackBean, mas o menos debes de buscarlo en el FacesContext.getCurrentInstance() y algo más, pero a las finales, eso te generará una variable, es decir, estarás haciendo lo mismo que el bundle, pero por backbean.

Yo por el momento para el proyecto en el cual estaremos, he propuesto colocar lo del load bundle en el template, de tal forma que no se tiene que escribir a cada momento.

Un gusto (Luego lo paso a inglés)

Muchas gracias por siempre estar leyendo estos humildes artículos que los hago con tiempo algo ajustado, espero sus opiniones, críticas y colaboraciones. Muy agradecido

Buen día

Thxs everyone for visit my blog and read my articles, i hope you enjoy the article and your comments, opinions, colaborations and others. Thxs =)

bye bye


Shinji


P.d. Does anyone know how to put tags without have problems in the blog?