Localisation des valeurs enum dans le regroupement de ressources

J'ai un problème avec i18n les énumérations dans mon application JSF. Quand j'ai commencé, j'ai eu des enums avec le texte défini à l'intérieur. Mais maintenant, j'ai des touches liée à message embarque dans l'enum.

Exemple un de mes énumérations:

public enum OrderStatus implements CustomEnum {
    PENDING("enum.orderstatus.pending"),
    CANCELED("enum.orderstatus.canceled");

    /**
     * key in message bundle
     */
    private String name;

    OrderStatus(String name) {
        this.name = name;
    }

    @Override
    public String getName() {
        return name;
    }

}

Dans la couche de la vue, j'utilise quelque chose comme:

<!-- input -->
<h:selectOneMenu value="#{order.status}">
    <f:selectItems value="#{flowUtils.orderStatuses}"/>
</h:selectOneMenu>

<!-- output -->
<h:outputText value="#{order.status}"/>

et en Java:

public class FlowUtils {
    public List<SelectItem> getOrderStatuses() {
        ArrayList<SelectItem> l = new ArrayList<SelectItem>();
        for(OrderStatus c: OrderStatus.values()) {
            //before i18n
            //l.add(new SelectItem(c, c.getName()));

            //after i18n
            l.add(new SelectItem(c, FacesUtil.getMessageValue(c.getName())));
        }
        return l;               
    }
}

public class FacesUtil {
    public static String getMessageValue(String name) {
        FacesContext context = FacesContext.getCurrentInstance();
        return context.getApplication().getResourceBundle(context, "m").getString(name);
    }
}

Il a bien fonctionné, mais quand j'ai eu besoin de sortie #{order.status}j'avais besoin de le convertir.
J'ai donc mis en place un convertisseur, mais a eu des ennuis avec la conversion de String à Object dans le getAsObject() méthode.

web.xml:

<converter>
  <converter-for-class>model.helpers.OrderStatus</converter-for-class>
  <converter-class>model.helpers.EnumTypeConverter</converter-class>
</converter>

Java:

public class EnumTypeConverter implements Converter {

    @Override
    public Object getAsObject(FacesContext context, UIComponent comp,
            String value) throws ConverterException {
        //value = localized value :(
        Class enumType = comp.getValueBinding("value").getType(context);
        return Enum.valueOf(enumType, value);
    }

    @Override
    public String getAsString(FacesContext context, UIComponent component,
            Object object) throws ConverterException {
        if (object == null) {
            return null;
        }
        CustomEnum type = (CustomEnum) object;
        ResourceBundle messages = context.getApplication().getResourceBundle(context, "m");
        String text = messages.getString(type.getName());
        return text;
    }

}

Je suis empêtré aujourd'hui. Quelqu'un sait comment internationaliser plusieurs Énumérations de manière efficace?

source d'informationauteur marioosh

25

La valeur qui est passé à travers le convertisseur n'est pas l'option étiquette, comme vous semblez le penser, mais la valeur de l'option. La meilleure pratique est de ne pas faire cela dans le côté du modèle, mais dans la vue de côté, parce que le modèle n'a pas besoin d'être i18n conscient.

De l'approche, vous êtes essentiellement de surcharger inutilement les choses. Depuis JSF 1.2, il y a un builtin EnumConverter qui donnera un coup de pied dans automatiquement et depuis JSF 2.0, vous pouvez effectuer une itération sur un generic array ou List dans f:selectItems par la nouvelle var attribut sans la nécessité de dupliquer les valeurs sur une List<SelectItem> dans le modèle.

Voici comment le haricot peut ressembler à:
```
public class Bean {
    private OrderStatus orderStatus;
    private OrderStatus[] orderStatuses = OrderStatus.values();

    //...
}
```
Et voici comment la vue peut ressembler (en supposant que msg se réfère à la <var> comme vous l'avez défini dans <resource-bundle> dans faces-config.xml):
```
<h:selectOneMenu value="#{bean.orderStatus}">
    <f:selectItems value="#{bean.orderStatuses}" var="orderStatus" 
        itemValue="#{orderStatus}" itemLabel="#{msg[orderStatus.name]}" />
</h:selectOneMenu>
```
C'est tout.

Sans rapport avec le problème, vous avez de fautes de frappe dans le nom enum et les clés de message, il doit être:
```
PENDING("enum.orderstatus.pending"),
CANCELLED("enum.orderstatus.cancelled");
```
Et, plus propre serait de garder le bundle clés de l'enum et l'utilisation d'enum comme faisant partie du bundle clé. E. g.
```
PENDING,
CANCELLED;
```
```
<h:selectOneMenu value="#{bean.orderStatus}">
    <f:selectItems value="#{bean.orderStatuses}" var="orderStatus" 
        itemValue="#{orderStatus}" itemLabel="#{msg['enum.orderstatus.' += orderStatus]}" />
</h:selectOneMenu>
```
```
enum.orderstatus.PENDING = Pending
enum.orderstatus.CANCELLED = Cancelled
```

J'ai posté ma solution ici: L'internationalisation de plusieurs énumérations (traduction de valeurs enum) - mais toujours l'espoir d'amélioration.

EDIT: avec l'aide de @Joop Eggen, nous sommes venus avec une super solution:

MODIFIER à nouveau: complet et prêt-à-utiliser la solution:

Faire une classe

public final class EnumTranslator {
  public static String getMessageKey(Enum<?> e) {
    return e.getClass().getSimpleName() + '.' + e.name();
  }
}

En faire un personnalisé EL fonction

<?xml version="1.0" encoding="UTF-8"?>
<facelet-taglib 
xmlns="http://java.sun.com/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-facelettaglibrary_2_0.xsd"
version="2.0">
<namespace>http://example.com/enumi18n</namespace>
<function>
    <function-name>xlate</function-name>
    <function-class>your.package.EnumTranslator</function-class>
    <function-signature>String getMessageKey(java.lang.Enum)</function-signature>
</function>
</facelet-taglib>

Ajouter la bibliothèque de tags à votre web.xml

<context-param>
    <param-name>javax.faces.FACELETS_LIBRARIES</param-name>
    <param-value>/WEB-INF/enumi18n.taglib.xml</param-value>
</context-param>

Ont des propriétés des fichiers enum_en.propriétés et enum_yourlanguage.les propriétés de ce type

TransferStatus.NOT_TRANSFERRED = Not transferred
TransferStatus.TRANSFERRED = Transferred

Ajouter les fichiers de propriétés que les ressources de votre faces-config.xml

    <resource-bundle>
        <base-name>kk.os.obj.jsf.i18n.enum</base-name>
        <var>enum</var>
    </resource-bundle>

Ajouter la coutume bibliothèque de tags de vos fichiers xhtml

<html ... xmlns:l="http://example.com/enumi18n">

Et voilà - vous avez maintenant accès à la traduire les valeurs de l'enum dans jsf:

<h:outputText value="#{enum[l:xlate(order.transferStatus)]}" />

1

Bien, enum est juste une autre classe. Il n'y a rien qui vous empêche d'ajouter l'analyse et à la conversion de chaîne méthodes qui leur permettront d'analyser et de sortie des paramètres régionaux de messages sensibles.

Peut-être qu'il viole Seule Responsable Principe (n'est ce pas?), mais je crois que faire enum responsable de l'analyse et de revenir aux paramètres régionaux de conscience des valeurs est la bonne chose à faire.

Juste ajouter deux méthodes comme ceci:
```
public String toString(FacesContext context) {
   //need to modify the method   
   FacesUtil.getMessageValue(context, name);
}

public OrderStatus parse(FacesContext context, String theName) {
  for (OrderStatus value : values()) {
    if (value.toString(context).equals(theName) {
      return value;
    }
  }
  //think of something better
  return null;
}
```
J'espère que j'ai le bon code, car je ne suis pas le vérifier avec l'IDE maintenant... Est-ce ce que vous recherchez?

- Je calculer la clé du message de l'enum, comme indiqué ci-dessous; donc pas besoin de maintenir les touches avec des attributs supplémentaires sur l'enum

public String getMessageKey() {
    return String.format("enum_%s_%s", this.getClass().getSimpleName(),
            this.name());
}

Puis-je l'utiliser comme ceci

     <p:selectOneMenu id="type"
        value="#{xyzBean.type}" required="true">
            <f:selectItems
                value="#{xyzBean.possibleTypes}"
                var="type" itemLabel="#{msg[type.messageKey]}">
            </f:selectItems>
     </p:selectOneMenu>

d'avoir configuré un org.springframework.contexte.de soutien.ReloadableResourceBundleMessageSource dans le contexte de l'application

<bean id="msg"
    class="org.springframework.context.support.ReloadableResourceBundleMessageSource">
    <property name="basename" value="/resources/locale/messages" />
    <property name="useCodeAsDefaultMessage" value="true" />
    <property name="cacheSeconds" value="1" />
</bean>

0

Au cas où quelqu'un est à la recherche d'un utilitaire simple bibliothèque pour gérer enum internationalisation, veuillez jeter un oeil à https://github.com/thiagowolff/litefaces-enum-i18n

L'artefact est également disponible dans Maven Central:
```
<dependency>
    <groupId>br.com.litecode</groupId>
    <artifactId>litefaces-enum-i18n</artifactId>
    <version>1.0.1</version>
</dependency>
```
Fondamentalement, vous avez juste besoin d'ajouter de l'artefact de votre projet et de définir les enum clés respectifs à la suite de la décrit le protocole enum conventions de nommage. Les traductions (et aussi les noms de classe CSS) peuvent être récupérées à l'aide du EL fonctions.

Vous devez vous connecter pour publier un commentaire.