Java 读取配置文件: Properties VS ResourceBundle

叁歲伎倆 2022-03-29 13:13 310阅读 0赞

> 在java开发中, 对于一些常用的配置性的信息, 通常会采用存放在属性文件中, 因为修改配置文件无须重新编译jar包. 对于属性文件,通常可以使用Properties和ResourceBundle 两个类来解析. 需要注意的是, 默认情况下java工程中的\*.properties文件编码格式是ISO-8859-1, Properties和ResourceBundle也是按照ISO-8859-1格式来解析属性文件中字符串的. 所以对于解析包含中文的熟悉文件时,需要额外注意.

*  ResourceBundle: 通常用于解析国际化资源属性文件, 会根据本地环境自动选择对应的国际化资源.
 *  Properties: 用来解析普通属性文件

## 1. 常用API ##

### 1. Properties 常用API ###

> Properties 继承Hashtable<Object,Object>类.

<table> 
 <thead> 
  <tr> 
   <th align="left">方法签名</th> 
   <th align="left">方法描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">public String getProperty(String key</td> 
   <td align="left">获取属性文件中的Key, 如果key不存在返回Null</td> 
  </tr> 
  <tr> 
   <td align="left">public String getProperty(String key, String defaultValue)</td> 
   <td align="left">获取属性文件中key对象的value, 如果key不存在则返回默认值defaultValue</td> 
  </tr> 
  <tr> 
   <td align="left">public Object get(String key)</td> 
   <td align="left">父类HashTable中的方法, 返回值类型为Object</td> 
  </tr> 
 </tbody> 
</table>

### 1.2 ResourceBundle 常用API ###

> ResourceBundle 是一个接口, 默认使用PropertyResourceBundle来解析属性文件.

<table> 
 <thead> 
  <tr> 
   <th align="left">方法签名</th> 
   <th align="left">方法描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">public Locale getLocale()</td> 
   <td align="left">获取本地国际化环境</td> 
  </tr> 
  <tr> 
   <td align="left">public Enumeration getKeys()</td> 
   <td align="left">获取属性文件中所有key</td> 
  </tr> 
  <tr> 
   <td align="left">public final String getString(String key)</td> 
   <td align="left">获取属性文件中key对应的value, 返回值为String, 如果不存在, 则抛出异常</td> 
  </tr> 
  <tr> 
   <td align="left">public final Object getObject(String key)</td> 
   <td align="left">获取属性文件中key对应的value, 返回值为Object, 如果不存在, 则抛出异常</td> 
  </tr> 
 </tbody> 
</table>

## 2. Properties 解析属性文件 ##

> 默认使用ISO-8859-1 解析配置文件中的字符串, 所以会导致中文乱码.

### 2.1 解析纯英文配置文件 ###

// 默认编码(ISO-8859-1)读取属性文件, 中文乱码
    @Test
    public void test_properties_en() throws IOException{ 
    	
    	// 属性文件位置, 相对路径为src/main/resources 或 src/test/resources, 不能添加classpath:/前缀
    	String propertyFileName = "jdbc.properties";
    	
    	// 获取字节流
    	InputStream is = getClass().getClassLoader().getResourceAsStream(propertyFileName);
    	
    	// 创建属性文件, 并加载文件内容
    	Properties properties = new Properties();
    	properties.load(is);
    	
    	
    	String username = properties.getProperty("jdbc.username");
    	String password = properties.getProperty("jdbc.password");
    	System.out.println("username:" + username + ", password:" + password);
    	
    }

### 2.2 解析含中文配置文件 ###

> 默认使用ISO-8859-1, 采用InputStreamReader转换为UTF8字符流.

// 指定读取文件编码方式,支持读取中文
    @Test
    public void test_properties_zh() throws IOException{ 
    	
    	// 属性文件位置, 相对路径为src/main/resources 或 src/test/resources, 不能添加classpath:/前缀
    	String propertyFileName = "jdbc.properties";
    	
    	// 获取字节流
    	InputStream is = getClass().getClassLoader().getResourceAsStream(propertyFileName);
    	
    	// 转换为UTF-8格式字符流
    	InputStreamReader isr = new InputStreamReader(is, "UTF-8");
    	
    	// 创建属性文件, 并加载文件内容
    	Properties properties = new Properties();
    	properties.load(isr);
    	
    	
    	String username = properties.getProperty("jdbc.username");
    	String password = properties.getProperty("jdbc.password");
    	System.out.println("username:" + username + ", password:" + password);
    	
    }

## 3. ResourceBundle 解析属性文件 ##

### 3.1 解析纯英文配置文件 ###

@Test
    public void testRb_en() { 
    	// 资源配置文件,无须写文件后缀名, 默认寻找properties文件
    	String bundleName = "jdbc";
    	
    	// 设置本地默认环境为英文环境
    	Locale.setDefault(Locale.ENGLISH);
    	
    	// 指定加载
    	ResourceBundle rb = ResourceBundle.getBundle(bundleName);
    	
    	String username = rb.getString("jdbc.username");
    	String password = rb.getString("jdbc.password");
    	System.out.println("username:" + username + ", password:" + password);
    }

### 3.2 解析含中文配置文件 ###

// 处理中文
    @Test
    public void testRb_zh() { 
    	// 资源配置文件,无须写文件后缀名, 默认寻找properties文件
    	String bundleName = "jdbc";
    	
    	// 根据本地默认环境加载资源配置文件
    	ResourceBundle rb = ResourceBundle.getBundle(bundleName);
    	
    	String username = iso2Utf8(rb.getString("jdbc.username"));
    	String password = iso2Utf8(rb.getString("jdbc.password"));
    	System.out.println("username:" + username + ", password:" + password);
    	
    }
    
    
    /** * @Description iso编码格式字符串转换为UTF8格式 * @param str iso 编码字符串 * @return * @author zongf * @date 2019年1月8日-下午3:55:29 */
    private String iso2Utf8(String str) { 
    	if(null == str) return null;
    	
    	try { 
    		return new String(str.getBytes("ISO-8859-1"), "UTF-8");
    	} catch (UnsupportedEncodingException e) { 
    		e.printStackTrace();
    	}
    	return null;
    }

## 4. 属性文件 ##

> 笔者创建的是maven 工程, 使用的是junit 单元测试, 所以笔者的配置文件存放在 src/test/resources 目录下.

***jdbc.properties***

jdbc.username=张三
    jdbc.password=123456

***jdbc\_zh.properties***

jdbc.username=张三
    jdbc.password=123456

***jdbc\_en.properties***

jdbc.username=zhangsan
    jdbc.password=123456

## 5. 实战推荐 ##

> 笔者认为, 一个设计良好的属性配置类应该是一个常量类, 至少需要符合两个设计原则:

1.  属性一旦设置不可动态修改, 即使在编译环境也不能调用修改方法.
2.  能够直接通过类属性进行访问, 无须通过类对象访问
3.  自动装配属性, 而无须手动解析熟悉文件(spring中可借助自带注解或自定义注解实现)

public class JdbcProperty { 
    	
    	/** 用户名 */
    	public static final String username;
    	
    	/** 用户密码 */
    	public static final String password;
    	
    	// 在Spring应用中,可借助注解或自定义注解进行自动装配,笔者此处只针对一般java应用
    	static { 
    		
    		// 加载属性文件
    		ResourceBundle resourceBundle = ResourceBundle.getBundle("jdbc");
    		
    		// 初始化属性
    		username = resourceBundle.getString("jdbc.username");
    		password = resourceBundle.getString("jdbc.password");
    		
    	}
    }