ResourceBundle和Properties

骑猪看日落 2022-08-09 17:52 145阅读 0赞

转载：

一般来说，ResourceBundle类通常是用于针对不同的语言来使用的属性文件。

而如果你的应用程序中的属性文件只是一些配置，并不是针对多国语言的目的。那么使用Properties类就可以了。

通常可以把这些属性文件放在某个jar文件中。然后，通过调用class的getResourceAsStream方法，来获得该属性文件的流对象，再用Properties类的load方法来装载。

示例如下：

![ExpandedBlockStart.gif][]Class TestLoad  \{  
![ExpandedSubBlockStart.gif][]              public    static    void  main( String\[\] argv)  \{  
![InBlock.gif][]                      InputStream   is   =  TestLoad.  class .getResourceAsSteam( " myprops.properties" );  
![InBlock.gif][]                      Properties p  =    new  Properties();  
![InBlock.gif][]                      p.load(  is );  
![InBlock.gif][]                      System.  out .println(p.  get ( " MAIL\_SERVER\_HOSTNAME " ));  
![ExpandedSubBlockEnd.gif][]            \}   
![ExpandedBlockEnd.gif][] \}   
![None.gif][]

[关于ResourceBundle][ResourceBundle]

有时候有些简单的配置文件可以没必要使用xml，其实ResourceBundle类就已经做的很好的。它甚至可以搜索到classpath里的jar文件中一些properties文件。

例如在jar文件中的根目录放置一个文件：test.properties，然后只要这个jar文件在classpath里。就可以使用这样的语句来获得一些属性：

ResourceBundle rb = ResourceBundle.getBundle("test");  
  String s = rb.getString("MQ\_Server\_Address");  
  System.out.println(s);

我们可以在每个对象中用ResourceBundle来读配置文件设置自己的值，也可以用一个固定的对象去读取然后保存下来以便以后使用。在每个 class中都去读配置文件会导致代码散乱，所以，只用一个class来进行读取是比较合理的做法。另外，由于I/O的速度比较慢，如果负责读取配置文件 的class是在每次用到这些配置项的时候去读文件，就容易成为性能上的瓶颈。为避免这样的情况，可以在初始化的时候就把配置项一次全部读入，并保存在静 态成员变量中。不过不排除会有对配置项进行动态读取的需求（因为某些应用是不能停掉的，比如应用服务器。在这些应用运行期间更新了配置文件，就需要在不不 关闭应用的情况下重新读入配置项）。以下的例子只考虑了静态读取的情况，如果是动态读取，则可以把读取配置文件的代码放到某个方法中，通过对某个事件的响 应来调用该方法更新配置项。

假设我们用来读取配置文件的class叫TestResourceBundle，配置项的值来自一个叫 property\_en.properties的文件（该文件应该放到TestResourceBundle所对应的CLASSPATH的目录），有两个 值需要配置：name和value。首先，需要在该class中定义一些字符串常量，如下：

public static final String PROPERTIES\_FILE\_NAME = "property";  
public static final String MY\_NAME\_KEY = "name";  
public static final String MY\_VALUE\_KEY = "value";

其中PROPERTIES\_FILE\_NAME指出了文件的名字。实际读取的文件应该是property\_en.properties，但 是只需要告诉ResourceBundle文件名是"property"就足够了。下划线和后面的"en"表示的是本地化信息。这里的en代 表"ENGLISH"，后缀properties是默认的。MY\_NAME\_KEY和MY\_VALUE\_KEY表示配置项在配置文件中的名字，用 ResourceBundle的getString方法根据这些名字去读取相应的值。

然后，定义需要配置的变量。这些变量应该是静态的：  
private static String myName;  
private static String myValue;

然后进行静态初始化：  
static \{  
 try \{  
   ResourceBundle bundle = ResourceBundle  
     .getBundle(PROPERTIES\_FILE\_NAME, Locale.ENGLISH);  
   myName = bundle.getString(MY\_NAME\_KEY).trim();  
   myValue = bundle.getString(MY\_VALUE\_KEY).trim();  
 \}  
 catch(Exception ex) \{  
   System.err.println(  "\[Property\]:Can't Load property.properties");  
   myName = "default name";  
   myValue = "default value";  
   System.out.println(  "myName will use the default value: " + myName);  
   System.out.println(  "myValue will use the default value: " + myValue);  
 \}  
\}  
 **ResourceBundle bundle = ResourceBundle  
  .getBundle(PROPERTIES\_FILE\_NAME, Locale.ENGLISH);**  
这 行代码初始化了一个ResourceBundle，Locale.ENGLISH用于指明本地化情况，因此会 从"property\_en.properties"中去读取配置项。如果是Locale.CHINA，则会从 property\_zh.properties中读取。这种机制使得程序的本地化变得简单。  
 myName = bundle.getString(MY\_NAME\_KEY).trim();  
这行代码读入配置文件中名为"name"的变量的值，并赋给静态变量myName。  
此外这段代码还包含了例外处理，当读取失败的时候，配置项会使用缺省值。  
这样，该类就通过ResourceBundle读取外存上的配置文件对数据进行了配置。

property\_en.properties文件的内容如下  
\# properties sample  
\#  
name=sega  
value=100

其中以'\#'开头的行为注释，ResourceBundle在遇到这些行的时候会忽略掉。

以下为完整的测试代码：

public class TestResourceBundle \{  
 public static final String PROPERTIES\_FILE\_NAME = "property";  
 public static final String MY\_NAME\_KEY = "name";  
 public static final String MY\_VALUE\_KEY = "value";  
   
 private static String myName;  
 private static String myValue;  
 static \{  
   try \{  
     ResourceBundle bundle = ResourceBundle  
  .getBundle(PROPERTIES\_FILE\_NAME, Locale.ENGLISH);  
     myName = bundle.getString(MY\_NAME\_KEY).trim();  
     myValue = bundle.getString(MY\_VALUE\_KEY).trim();  
   \}  
   catch(Exception ex) \{  
  System.err.println(    "\[Property\]:Can't Load property.properties");  
  myName = "default name";  
  myValue = "default value";  
  System.out.println(    "myName will use the default value: " + myName);  
  System.out.println(    "myValue will use the default value: " + myValue);  
   \}  
 \}  
   
 public void print() \{  
  System.out.println("My name is: " + myName);  
  System.out.println("My value is: " + myValue);  
 \}  
 public static void main(String\[\] args) \{  
  TestResourceBundle test = new TestResourceBundle();  
  test.print();  
 \}  
\}

[ExpandedBlockStart.gif]: /images/20220731/1911776aeb254c37b5cb2ec6107fb99e.png
[ExpandedSubBlockStart.gif]: /images/20220731/53ff5605a56349099b38f499dcb4eada.png
[InBlock.gif]: /images/20220731/6eaf5a5ad2254eb89a0fae1f699f4f52.png
[ExpandedSubBlockEnd.gif]: /images/20220731/d6ca248364ff4c0f8c1f3b532f15fbe7.png
[ExpandedBlockEnd.gif]: /images/20220731/be9806c3dceb4772a5ca7dff4d46e51d.png
[None.gif]: /images/20220731/7b1c31eecf2f4aaf84f9183296f443eb.png
[ResourceBundle]: http://blog.csdn.net/shrek_cn/archive/2005/03/17/322174.aspx