扩展ResourceBundle 实现xml、java的文件资源捆绑

ResourceBundle类很好用，但是只能处理特定的文件类型:property

所以我们可以扩展ResourceBundle类来处理自己定义的文件类型和文件格式。在JDK1.6的帮助文档中给出了一个简单的例子，这里给出一个更具代表的例子，比较贴合实际。

 

这里我们需要继承ResourceBundle类并实现handleGetObject方法，这个方法是在getString("key")时被调用的，及getKeys方法。

 

通过ResourceBundle类的一个静态方法getBundle(String baseName, ResourceBundle.Control control)
我们可以看到ResourceBundle.Control 类并不是一个final类，所以我们可以扩展这个类实现自己的控制类，而Locale是一个final类，所以我们没有办法扩展此类。

 

我们扩展ResourceBundle.Control 类是必须要实现如下方法getFormats、newBundle方法。getFormats，主要是返回支持的文件类型(后缀名)，通过返回文件类型列表，后续才能依次通过拼接字符串来定位具体的文件。这样说也许不大太清楚，那么举个例子吧，比如getFormats返回的是xml、data两个元素的list，那么后续定位资源文件的时候,资源文件名也就是name+.xml=name.xml , name+.data=name.data 。

 

再说一下newBundle通过这个方法名我们就知道它是创建ResourceBundle的。这时我们就可以通过这个方法new 出我们扩展的ResourceBundle类了。

 

注意getFormats 先被调用，后将结果传给newBundle方法。

 

在说说ResourceBundle类中本身提供的几个重要方法。我们通过这几个重要方法的组合就可以完成newBundle方法的逻辑。

toBundleName: 这个方法主要是负责将Locale中的Country，Language，Variant 和name拼接成name_Language_Country,如myres_zh_CN

toResourceName:这个方法是final方法，也就是说我们不可能重写它，这个类主要是负责将资源文件名转化为特定操作系统的文件路径。

 

好到此为止基本的概念和思路已经完成，现在看看代码的实现。

 

实现xml的资源捆绑:

    Strings.xml

   

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
<properties>
<entry key="Key">Value</entry>
</properties> 

 

 

package com.rqzhou.test;

import java.io.BufferedInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import java.net.URLConnection;
import java.util.Collections;
import java.util.Enumeration;
import java.util.List;
import java.util.Locale;
import java.util.Properties;
import java.util.ResourceBundle;
import java.util.Set;

public class XMLResourceBundleControl extends ResourceBundle.Control {
  private static String XML = "xml";

  public List<String> getFormats(String baseName) {
    return Collections.singletonList(XML);
  }

  public ResourceBundle newBundle(String baseName, Locale locale, String format,
      ClassLoader loader, boolean reload) throws IllegalAccessException, InstantiationException,
      IOException {

    if ((baseName == null) || (locale == null) || (format == null) || (loader == null)) {
      throw new NullPointerException();
    }
    ResourceBundle bundle = null;
    if (!format.equals(XML)) {
      return null;
    }

    String bundleName = toBundleName(baseName, locale);
    String resourceName = toResourceName(bundleName, format);
    URL url = loader.getResource(resourceName);
    if (url == null) {
      return null;
    }
    URLConnection connection = url.openConnection();
    if (connection == null) {
      return null;
    }
    if (reload) {
      connection.setUseCaches(false);
    }
    InputStream stream = connection.getInputStream();
    if (stream == null) {
      return null;
    }
    BufferedInputStream bis = new BufferedInputStream(stream);
    bundle = new XMLResourceBundle(bis);
    bis.close();

    return bundle;
  }

  public static void main(String args[]) {
    ResourceBundle bundle = ResourceBundle.getBundle("com.rqzhou.test.Strings", new XMLResourceBundleControl());
    String string = bundle.getString("Key");
    System.out.println("Key: " + string);
  }
}

class XMLResourceBundle extends ResourceBundle {
  private Properties props;

  XMLResourceBundle(InputStream stream) throws IOException {
    props = new Properties();
    props.loadFromXML(stream);
  }

  protected Object handleGetObject(String key) {
    return props.getProperty(key);
  }

  public Enumeration<String> getKeys() {
    Set<String> handleKeys = props.stringPropertyNames();
    return Collections.enumeration(handleKeys);
  }
}

 

 下面是基于java的文件资源捆绑

import java.util.Enumeration;
import java.util.Locale;
import java.util.ResourceBundle;
import java.util.MissingResourceException;

public class HelloResourceBundleExample {

  public static void main(String [] argv) {
    try {
      Locale frenchLocale = new Locale("fr", "FR");
      ResourceBundle rb = ResourceBundle.getBundle("HelloResourceBundle", frenchLocale);

      System.out.println(rb.getString("Hello"));
      System.out.println(rb.getString("Goodbye"));

    } catch (MissingResourceException mre) {
      mre.printStackTrace();
    }
  }
}
import java.util.Enumeration;
import java.util.ResourceBundle;
import java.util.StringTokenizer;

public class HelloResourceBundle extends ResourceBundle {

  private String keys = "Hello Goodbye";

    public Object handleGetObject(String key) {
      if (key.equals("Hello")) return "Hello";
      if (key.equals("Goodbye")) return "Goodbye";

      return null;
    }

    public Enumeration getKeys() {
      StringTokenizer keyTokenizer = new StringTokenizer(keys);

      return keyTokenizer;
    }
}
import java.util.Enumeration;
import java.util.ResourceBundle;
import java.util.StringTokenizer;

public class HelloResourceBundle_fr extends HelloResourceBundle {

  public Object handleGetObject(String key) {
    if (key.equals("Hello")) return "Bonjour";

    return null;
  }
}
import java.util.Enumeration;
import java.util.ResourceBundle;
import java.util.StringTokenizer;

public class HelloResourceBundle_fr_FR extends HelloResourceBundle_fr {

  public Object handleGetObject(String key) {
    if (key.equals("Goodbye")) return "Au Revoir";

    return null;
  }
}