Java 操作Properties配置文件詳解

更新時間：2017年05月06日 14:34:23 作者：象

本篇文章主要介紹了Java 操作Properties配置文件詳解，詳細的介紹了Properties和主要方法，有興趣的可以了解下

1 簡介：

JDK提供的java.util.Properties類繼承自Hashtable類并且實現(xiàn)了Map接口，是使用一種鍵值對的形式來保存屬性集，其中鍵和值都是字符串類型。

java.util.Properties類提供了getProperty()和setProperty()方法來操作屬性文件，同時使用load()方法和store()方法加載和保存Properties配置文件。

java.util.ResourceBundle類也提供了讀取Properties配置文件的方法,ResourceBundle是一個抽象類。

2.Properties中的主要方法

1)load(InputStream inStream):該方法可以從.properties屬性文件對應(yīng)的文件數(shù)入流中，加載屬性列表到Properties類對象中。load有兩個方法的重載：load(InputStream inStream)、load(Reader reader)，可根據(jù)不同的方式來加載屬性文件。

InputStream inStream = TestProperties.class.getClassLoader().getResourceAsStream("demo.properties"); 
//通過當(dāng)前類加載器的getResourceAsStream方法獲取
//TestProperties當(dāng)前類名；TestProperties.class.取得當(dāng)前對象所屬的Class對象； getClassLoader()：取得該Class對象的類裝載器

InputStream in = ClassLoader.getSystemResourceAsStream("filePath");

InputStream inStream = new FileInputStream(new File("filePath")); //從文件獲取
InputStream in = context.getResourceAsStream("filePath");     //在servlet中，可以通過context來獲取InputStream
InputStream inStream = new URL("path").openStream(); 　　　　　　　　　　 //通過URL來獲取

讀取方法如下：

Properties pro = new Properties();    　　　　　　　　　　　　　　　//實例化一個Properties對象
InputStream inStream = new FileInputStream("demo.properties");  　　　//獲取屬性文件的文件輸入流
pro.load(nStream);
inStream.close();

2)store(OutputStream out,String comments):這個方法將Properties類對象的屬性列表寫入.properties配置文件。如下：

FileOutputStream outStream = new FileOutputStream("demo.properties");
pro.store(outStream,"Comment");
outStream.close();

3 ResourceBundle中的主要方法

通過ResourceBundle.getBundle()靜態(tài)方法來獲取，此方法獲取properties屬性文件不需要加.properties后綴名。也可以從InputStream中獲取ResourceBundle對象。

ResourceBundle resource = ResourceBundle.getBundle("com/xiang/demo");//emo為屬性文件名，放在包com.xiang下，如果是放在src下，直接用test即可 
ResourceBundle resource1 = new PropertyResourceBundle(inStream);  
String value = resource.getString("name");

在使用中遇到的問題可能是配置文件的路徑，當(dāng)配置文件不在當(dāng)前類所在的包下，則需要使用包名限定；若屬性文件在src根目錄下，則直接使用demo.properties或demo即可。

4 Properties操作實例

import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import java.util.Properties;

/**
 * Java中Preperties配置文件工具類
 * @author shu
 *
 */
public class PropsUtil {
  private String path = "";
  private Properties properties ;
  
  /**
   * 默認構(gòu)造函數(shù)
   */
  public PropsUtil() {}
  
  /**
   * 構(gòu)造函數(shù)
   * @param path 傳入Properties地址值
   */
  public PropsUtil(String path) {
    this.path = path;
  }
  
  /**
   * 加載properties文件
   * @return 返回讀取到的properties對象
   */
  public Properties loadProps(){
    InputStream inStream = ClassLoader.getSystemResourceAsStream(path);    
    try {
      if(inStream==null)
        throw new FileNotFoundException(path + " file is not found");
      properties = new Properties();
      properties.load(inStream);
      inStream.close();
    } catch (IOException e) {
      e.printStackTrace();
    }
    return properties;
  }
  
  /**
   * 將配置寫入到文件
   */
  public void writeFile(){
    // 獲取文件輸出流
    try {
      FileOutputStream outputStream = new FileOutputStream( new File(ClassLoader.getSystemResource(path).toURI()));
      properties.store(outputStream, null);
      outputStream.close();
    } catch (Exception e) {
      // TODO Auto-generated catch block
      e.printStackTrace();
    }
  }
  
  /**
   * 通過關(guān)鍵字獲取值
   * @param key
   * @return 返回對應(yīng)的字符串，如果無，返回null
   */
  public String getValueByKey(String key) {
    if(properties==null)
      properties = loadProps();
    String val = properties.getProperty(key.trim());
    return val;
  }
  
  /**
   * 通過關(guān)鍵字獲取值
   * @param key 需要獲取的關(guān)鍵字
   * @param defaultValue 若找不到對應(yīng)的關(guān)鍵字時返回的值
   * @return 返回找到的字符串
   */
  public String getValueByKey(String key,String defaultValue){
    if(properties==null)
      properties = loadProps();
    return properties.getProperty(key, defaultValue);
  }
  
  /**
   * 獲取Properties所有的值
   * @return 返回Properties的鍵值對
   */
  public Map<String, String> getAllProperties() {
    if(properties==null)
      properties = loadProps();
    Map<String, String> map = new HashMap<String, String>();
    // 獲取所有的鍵值
    Iterator<String> it=properties.stringPropertyNames().iterator();
    while(it.hasNext()){
      String key=it.next();
      map.put(key, properties.getProperty(key));
    }
    /*Enumeration enumeration = properties.propertyNames();
    while (enumeration.hasMoreElements()) {
      String key = (String) enumeration.nextElement();
      String value = getValueByKey(key);
      map.put(key, value);
    }*/
    return map;
  }

  /**
   * 往Properties寫入新的鍵值且保存
   * @param key 對應(yīng)的鍵
   * @param value 對應(yīng)的值
   */
  public void addProperties(String key, String value) {
    if(properties==null)
      properties = loadProps();
    properties.setProperty(key, value);
    try {
      writeFile();
    } catch (Exception e) {
      throw new RuntimeException("write fail");
    }
  }
  
  /**
   * 更新配置文件
   * @param key 對應(yīng)的鍵
   * @param value 對應(yīng)的值
   */
   public void update(String key,String value){
     if(properties==null)
      properties = loadProps();
     if(properties.containsKey(key))
       properties.replace(key, value);
    try {
      writeFile();
    } catch (Exception e) {
      throw new RuntimeException("write fail");
    }
   }
   
   /**
   * 刪除某一鍵值對
   * @param key
   */
   public void deleteByKey(String key){
     if(properties==null)
      properties = loadProps();
     if(!properties.containsKey(key))
       throw new RuntimeException("not such key");
     properties.remove(key);
     try {
      writeFile();
     } catch (Exception e) {
      throw new RuntimeException("write fail");
    }
   }
   
   /**
   * 設(shè)置path值
   * @param path
   */
   public void setPath(String path){
     this.path = path;
   }
}

以上就是本文的全部內(nèi)容，希望對大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: