本地化资源包中的枚举值

Question

我的 JSF 应用程序中的 i18n 枚举有问题。当我开始时，我有枚举，其中定义了文本。但现在，我在枚举中将密钥绑定到消息包。

我的枚举示例之一：

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;
    }

}

在视图层中，我使用类似：

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

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

在 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);
    }
}

它运行良好，但是当我需要输出 #{order.status} 时，我需要对其进行转换。 因此，我实现了一个转换器，但在 getAsObject() 方法中将 String 转换为 Object 时遇到了麻烦。

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;
    }

}

我现在对此很纠结。有人知道如何有效地国际化多个枚举吗？

Answer 1

通过转换器传递的值不是您期望的选项标签，而是选项值。最佳实践是不要在模型端执行此操作，而是在视图端执行此操作，因为模型不需要了解 i18n。

至于方法，你基本上不必要地使事情变得过于复杂。从 JSF 1.2 开始，有一个内置的 EnumConverter 会自动启动，从 JSF 2.0 开始，您可以通过新的 varf:selectItems 中的通用数组或 List code> 属性，无需在模型中的 List 上复制值。

bean 的外观如下：

public class Bean {
    private OrderStatus orderStatus;
    private OrderStatus[] orderStatuses = OrderStatus.values();

    // ...
}

视图的外观如下（假设 msg 引用您在 中定义的 faces-config.xml 中的）：

<h:selectOneMenu value="#{bean.orderStatus}">
    <f:selectItems value="#{bean.orderStatuses}" var="orderStatus" 
        itemValue="#{orderStatus}" itemLabel="#{msg[orderStatus.name]}" />
</h:selectOneMenu>

仅此而已。

---

与问题无关，您在枚举名称和消息键中输入了拼写错误，它应该是：

PENDING("enum.orderstatus.pending"),
CANCELLED("enum.orderstatus.cancelled");

并且，更干净的方法是将捆绑包密钥保留在枚举之外，并使用枚举本身作为捆绑包密钥的一部分。例如

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

Answer 2

我在这里发布了我的解决方案： 多个枚举的国际化（枚举值的翻译) - 但仍希望进一步增强。

编辑：在@Joop Eggen的帮助下，我们提出了一个非常酷的解决方案：

再次编辑：完整且随时可用的解决方案：

创建一个类

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

使其成为自定义EL函数

<?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>

将taglib添加到您的web.xml

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

中像这样的属性文件 enum_en.properties 和 enum_yourlanguage.properties

TransferStatus.NOT_TRANSFERRED = Not transferred
TransferStatus.TRANSFERRED = Transferred

将属性文件作为资源包添加到 faces-config.xml

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

将自定义标记库添加到 xhtml 文件

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

然后 - 瞧 - 您现在可以在 jsf 中访问翻译后的枚举值：

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

Answer 3

嗯，枚举只是另一个类。没有什么可以阻止您添加解析和字符串转换方法来解析和输出区域设置敏感的消息。

也许它违反了单一责任原则（是吗？），但我相信让枚举负责解析和返回区域设置感知值是正确的做法。

只需添加两个这样的方法：

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;
}

我希望我的代码是正确的，因为我现在没有使用 IDE 检查它...这是您正在寻找的吗？

Answer 4

我计算枚举中的消息键，如下所示；所以不需要在枚举上维护具有附加属性的键

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

然后我

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

在应用程序上下文中配置了 org.springframework.context.support.ReloadableResourceBundleMessageSource

<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>

Answer 5

如果有人正在寻找一个简单的实用程序库来处理枚举国际化，请查看 https:/ /github.com/thiagowolff/litefaces-enum-i18n

该工件也可以在 Maven Central 中找到：

<dependency>
    <groupId>br.com.litecode</groupId>
    <artifactId>litefaces-enum-i18n</artifactId>
    <version>1.0.1</version>
</dependency>

基本上，您只需将工件添加到您的项目中，并按照所描述的枚举命名约定定义枚举各自的键即可。可以使用提供的 EL 函数检索翻译（以及 CSS 类名称）。