`

读取配置文件 ResourceBundle和Properties 详解

阅读更多
一、认识国际化资源文件
 
这个类提供软件国际化的捷径。通过此类,可以使您所编写的程序可以:
         轻松地本地化或翻译成不同的语言
         一次处理多个语言环境
         以后可以轻松地进行修改,支持更多的语言环境
 
说的简单点,这个类的作用就是读取资源属性文件(properties),然后根据.properties文件的名称信息(本地化信息),匹配当前系统的国别语言信息(也可以程序指定),然后获取相应的properties文件的内容。
 
使用这个类,要注意的一点是,这个properties文件的名字是有规范的:一般的命名规范是: 自定义名_语言代码_国别代码.properties
如果是默认的,直接写为:自定义名.properties
比如:
myres_en_US.properties
myres_zh_CN.properties
myres.properties
 
当在中文操作系统下,如果myres_zh_CN.properties、myres.properties两个文件都存在,则优先会使用myres_zh_CN.properties,当myres_zh_CN.properties不存在时候,会使用默认的myres.properties。
 
没有提供语言和地区的资源文件是系统默认的资源文件。
资源文件都必须是ISO-8859-1编码,因此,对于所有非西方语系的处理,都必须先将之转换为Java Unicode Escape格式。转换方法是通过JDK自带的工具native2ascii.
 
二、实例
 
定义三个资源文件,放到src的根目录下面(必须这样,或者你放到自己配置的calsspath下面。
 
myres.properties
aaa=good
bbb=thanks

myres_en_US.properties
aaa=good
bbb=thanks

myres_zh_CN.properties
aaa=\u597d
bbb=\u591a\u8c22
 
import java.util.Locale;
import java.util.ResourceBundle;

/**
* 国际化资源绑定测试
*
* @author leizhimin 2009-7-29 21:17:42
*/

public class TestResourceBundle {
        public static void main(String[] args) {
                Locale locale1 = new Locale("zh", "CN");
                ResourceBundle resb1 = ResourceBundle.getBundle("myres", locale1);
                System.out.println(resb1.getString("aaa"));

                ResourceBundle resb2 = ResourceBundle.getBundle("myres", Locale.getDefault());
                System.out.println(resb1.getString("aaa"));

                Locale locale3 = new Locale("en", "US");
                ResourceBundle resb3 = ResourceBundle.getBundle("myres", locale3);
                System.out.println(resb3.getString("aaa"));
        }
}
 
运行结果:


good

Process finished with exit code 0
 
如果使用默认的Locale,那么在英文操作系统上,会选择myres_en_US.properties或myres.properties资源文件。
 
三、认识Locale

Locale 对象表示了特定的地理、政治和文化地区。需要 Locale 来执行其任务的操作称为语言环境敏感的 操作,它使用 Locale 为用户量身定制信息。例如,显示一个数值就是语言环境敏感的操作,应该根据用户的国家、地区或文化的风俗/传统来格式化该数值。
 
使用此类中的构造方法来创建 Locale:
 Locale(String language)
 Locale(String language, String country)
 Locale(String language, String country, String variant)
 
创建完 Locale 后,就可以查询有关其自身的信息。使用 getCountry 可获取 ISO 国家代码,使用 getLanguage 则获取 ISO 语言代码。可用使用 getDisplayCountry 来获取适合向用户显示的国家名。同样,可用使用 getDisplayLanguage 来获取适合向用户显示的语言名。有趣的是,getDisplayXXX 方法本身是语言环境敏感的,它有两个版本:一个使用默认的语言环境作为参数,另一个则使用指定的语言环境作为参数。
语言参数是一个有效的 ISO 语言代码。这些代码是由 ISO-639 定义的小写两字母代码。在许多网站上都可以找到这些代码的完整列表,如:
http://www.loc.gov/standards/iso639-2/englangn.html。    
国家参数是一个有效的 ISO 国家代码。这些代码是由 ISO-3166 定义的大写两字母代码。在许多网站上都可以找到这些代码的完整列表,如:
http://www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html。    
 
四、中文资源文件的转码 native2ascii
 
这个工具用法如下:
 
如果觉得麻烦,可以直接将中文粘贴到里面,回车就可以看到转码后的结果了。
 
 

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

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

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

示例如下:

Class TestLoad  {
           
public   static   void  main( String[] argv)  {
                     InputStream 
is   =  TestLoad. class .getResourceAsSteam( " myprops.properties " );
                     Properties p 
=   new  Properties();
                     p.load(
is );
                     System.
out .println(p. get ( " MAIL_SERVER_HOSTNAME " ));
           }

}

有时候有些简单的配置文件可以没必要使用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();
 }
}

 

分享到:
评论

相关推荐

    Java 操作Properties配置文件详解

    ResourceBundle 类是 Java 中的一个抽象类,提供了读取 Properties 配置文件的方法。可以使用 ResourceBundle.getBundle() 静态方法来获取 Properties 属性文件,不需要加.properties 后缀名。 例如: ```java ...

    Java加载properties文件实现方式详解

    在上面的代码中,我们首先创建了一个Properties对象,然后使用FileInputStream从文件中读取输入流,并将其传递给load方法,最后使用getProperty方法获取配置文件中的配置信息。 使用java.util.ResourceBundle类的...

    java文件的加载

    - **用途**:用于处理`.properties`格式的文件,可以读取并解析这些文件中的键值对。 - **示例**: ```java String path = getServletContext().getRealPath("/WEB-INF/classes/a.properties"); Properties ...

    day2-Spring IOC 和 DI 注解开发.md

    为了更好地管理和维护数据库连接信息,通常会将其存储在一个独立的配置文件中,如`jdbc.properties`文件。 ##### 5.1 提取配置文件 创建一个名为`jdbc.properties`的文件,其中包含了数据库连接的相关信息。 ```...

    java API使用-中文word

    - **Properties**:子类`Hashtable`,用于存储键值对,通常用于读写配置文件。 #### 九、异常处理 Java通过异常处理机制来管理程序中可能出现的错误情况。异常分为编译时异常(检查型异常)和运行时异常(非检查型...

    java特效 java的起源

    3. **资源文件转换**: 使用 JDK 提供的工具 `native2ascii` 来转换资源文件,确保其在不同平台上都能正确读取。例如: ```bash native2ascii MyResource.tmp MyResource_zh_CN.properties ``` 4. **Web 应用部署...

    高手总结java常用API.doc

    - **Properties**: 表示键值对的持久化属性集,常用于读取配置文件。 #### 九、异常处理 Java的异常处理机制允许程序在发生错误时进行适当的响应,避免程序崩溃。异常分为受检异常(如`IOException`)和非受检异常...

    高手总结java常用API(免费下载)

    - **Properties**: 存储和读取键值对字符串,常用于配置文件。 ```java Properties props = new Properties(); props.load(new FileInputStream("config.properties")); String username = props.getProperty(...

    XRes4J-开源

    这个库提供了一个优雅的方式来替代传统的 Java 属性文件(.properties),使得开发者能够更灵活地组织和管理应用程序的资源配置。 ### 1. XML 资源与属性 XRes4J 库的核心理念是将资源和属性数据存储在 XML 文件中...

    htmlSelect.txt

    - 同时指定 bundle 和 key:`<html:option value="1" bundle="happyhtml" key="a1"/>`,这里 `happyhtml` 指的是在 Struts 配置文件中定义的 ResourceBundle。 #### `<html:options>` 标签 `<html:options>` 标签...

    Spring MVC的国际化实现代码

    Spring MVC的国际化建立在Java的国际化机制之上,主要通过`ResourceBundle`加载不同`Locale`(地区)的资源文件。这些资源文件通常以`.properties`格式存储,例如`language_en_US.properties`代表美国英语的资源文件...

Global site tag (gtag.js) - Google Analytics