黑马程序员技术交流社区

标题: 【成都校区】java读写Properties属性文件公用方法 [打印本页]

作者: 小刀葛小伦    时间: 2019-8-30 09:45
标题: 【成都校区】java读写Properties属性文件公用方法
Java中有个比较重要的类Properties(Java.util.Properties),主要用于读取Java的配置文件,各种语言都有自己所支持的配置文件,配置文件中很多变量是经常改变的,这样做也是为了方便用户,让用户能够脱离程序本身去修改相关的变量设置。像Python支持的配置文件是.ini文件,同样,它也有自己读取配置文件的类ConfigParse,方便程序员或用户通过该类的方法来修改.ini配置文件。在Java中,其配置文件常为.properties文件,格式为文本文件,文件的内容的格式是“键=值”的格式,文本注释信息可以用"#"来注释。

它提供了几个主要的方法:
1. getProperty ( String key),用指定的键在此属性列表中搜索属性。也就是通过参数 key ,得到 key 所对应的 value。
2. load ( InputStream inStream),从输入流中读取属性列表(键和元素对)。通过对指定的文件(比如说上面的 test.properties 文件)进行装载来获取该文件中的所有键 - 值对。以供 getProperty ( String key) 来搜索。
3. setProperty ( String key, String value) ,调用 Hashtable 的方法 put 。他通过调用基类的put方法来设置 键 - 值对。
4. store ( OutputStream out, String comments),以适合使用 load 方法加载到 Properties 表中的格式,将此 Properties 表中的属性列表(键和元素对)写入输出流。与 load 方法相反,该方法将键 - 值对写入到指定的文件中去。
5. clear (),清除所有装载的 键 - 值对。该方法在基类中提供。

如下示例代码提供了一套读写配置文件的公用实用方法,可以根据自己的项目进行引入:
[Java] 纯文本查看 复制代码
import java.io.BufferedInputStream;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.Enumeration;
import java.util.Properties;
import org.apache.log4j.Logger;
public class PropertieUtil {
    private static Logger logger = Logger.getLogger(PropertieUtil.class);
    private PropertieUtil() {
    }
    /**
     * 读取配置文件某属性
     */
    public static String readValue(String filePath, String key) {
        Properties props = new Properties();
        try {
            // 注意路径以 / 开始,没有则处理
            if (!filePath.startsWith("/"))
                filePath = "/" + filePath;
            InputStream in = PropertieUtil.class.getResourceAsStream(filePath);
            props.load(in);
            String value = props.getProperty(key);
            return value;
        } catch (Exception e) {
            logger.error(e);
            return null;
        }
    }
    /**
     * 打印配置文件全部内容(filePath,配置文件名,如果有路径,props/test.properties)
     */
    public static void readProperties(String filePath) {
        Properties props = new Properties();
        try {
            // 注意路径以 / 开始,没有则处理
            if (!filePath.startsWith("/"))
                filePath = "/" + filePath;
            InputStream in = PropertieUtil.class.getResourceAsStream(filePath);
            props.load(in);
            Enumeration<?> en = props.propertyNames();
            // 遍历打印
            while (en.hasMoreElements()) {
                String key = (String) en.nextElement();
                String Property = props.getProperty(key);
                logger.info(key + ":" + Property);
            }
        } catch (Exception e) {
            logger.error(e);
        }
    }
    /**
     * 将值写入配置文件
     */
    public static void writeProperties(String fileName, String parameterName, String parameterValue) throws Exception {
        // 本地测试特别注意,如果是maven项目,请到\target目录下查看文件,而不是源代码下
        // 注意路径不能加 / 了,加了则移除掉
        if (fileName.startsWith("/"))
            fileName.substring(1);
        String filePath = PropertieUtil.class.getResource("/").getPath()+fileName;
        // 获取配置文件
        Properties pps = new Properties();
        InputStream in = new BufferedInputStream(new FileInputStream(filePath));
        pps.load(in);
        in.close();
        OutputStream out = new FileOutputStream(filePath);
        // 设置配置名称和值
        pps.setProperty(parameterName, parameterValue);
        // comments 等于配置文件的注释
        pps.store(out, "Update " + parameterName + " name");
        out.flush();
        out.close();
    }
    public static void main(String[] args) throws Exception {
        readProperties("jdbc.properties");
//      logger.info(readValue("jdbc.properties", "JAVABLOG_WRITE_URL"));
//      writeProperties("test.properties", "test", "test");
    }
}






欢迎光临 黑马程序员技术交流社区 (http://bbs.itheima.com/) 黑马程序员IT技术论坛 X3.2