.properties (Java 配置文件)

此心光明,亦复何言

在我们平时写程序的时候,有些参数是经常改变的,而这种改变不是我们预知的。比如说我们开发了一个操作数据库的模块,在开发的时候我们连接本地的数据库那么IP ,数据库名称,表名称,数据库主机等信息是我们本地的,要使得这个操作数据的模块具有通用性,那么以上信息就不能写死在程序里。通常我们的做法是用配置文件来解决。

各种语言都有自己所支持的配置文件,配置文件中很多变量是经常改变的,这样做也是为了方便用户,让用户能够脱离程序本身去修改相关的变量设置。像Python支持的配置文件是.ini文件,同样,它也有自己读取配置文件的类ConfigParse,方便程序员或用户通过该类的方法来修改.ini配置文件。在Java中,其配置文件常为.properties文件,格式为文本文件,JDK 内置的java.util.Properties 类 支持.properties 文件的读写,为我们操作 .properties 文件提供了便利。

一 .properties 文件的形式

设数据如下:

#以下为服务器、数据库信息
dbPort = localhost
databaseName = mydb
dbUserName = root
dbPassword = root
#以下为数据库表信息
dbTable = mytable
#以下为服务器信息
ip = 192.168.0.9

上面的信息我们假设保存在 db.properties 文件中。其中# 开始的一行为注释信息;在等号“= ”左边的我们称之为key ;等号“= ”右边的我们称之为value 。(其实就是我们常说的键- 值对)key 应该是我们程序中的变量。而value 是我们根据实际情况配置的。


db.properties

二 Java中Properties类的操作

1 Java Properties类

Java中有个比较重要的类Properties(Java.util.Properties),主要用于读取Java的配置文件,文件的内容的格式是“键=值”的格式,文本注释信息可以用"#"来注释。

Properties类继承自Hashtable,如下:


Properties

Properties类提供了几个主要的方法:
1 load( InputStream inStream )
这个方法可以从 .properties属性文件 对应的文件输入流中,加载属性列表到Properties类对象,即通过对上面的 properties 文件进行装载来获取该文件中的所有键 - 值对。以供 getProperty ( String key) 来搜索。

如下面的代码:

Properties pro = new Properties();
FileInputStream in = new FileInputStream("a.properties");
pro.load(in);
in.close();

2 getProperty ( String key )
获取属性信息
即用指定的键在属性列表中搜索属性 也就是通过参数 key 得到 key 所对应的 value

3 setProperty ( String key, String value )
设置属性信息
即通过调用基类的put方法来设置 键 - 值对。

4 store( OutputStream out, String comments )
这个方法将Properties类对象的属性列表保存到输出流中
即与 load 方法相反,该方法将键 - 值对写入到指定的文件中去

如下面的代码:

FileOutputStream oFile = new FileOutputStream(file, "a.properties");
pro.store(oFile, "Comment");
oFile.close();

如果comments不为空,保存后的属性文件第一行会是#comments,表示注释信息;如果为空则没有注释信息。

注释信息后面是属性文件的当前保存时间信息。

5 clear( )
清除所有装载的 键 - 值对。该方法在基类中提供。

load 和 getProperty最常用
有了以上几个方法我们就可以对.properties 文件进行操作了!

2 Java读取Properties文件

Java读取Properties文件的方法有很多,但是最常用的还是通过java.lang.Class类 getResourceAsStream(String name)方法来实现,如下可以这样调用:

InputStream in = getClass().getResourceAsStream("资源Name");

或者下面这种也常用:

InputStream in = new BufferedInputStream(new FileInputStream(filepath));
3 一个比较综合的实例

根据key读取value
读取properties的全部信息
写入新的properties信息

//关于Properties类常用的操作
public class TestProperties {
    //根据Key读取Value
    public static String GetValueByKey(String filePath, String key) {
        Properties pps = new Properties();
        try {
            InputStream in = new BufferedInputStream (new FileInputStream(filePath));  
            pps.load(in);
            String value = pps.getProperty(key);
            System.out.println(key + " = " + value);
            return value;
            
        }catch (IOException e) {
            e.printStackTrace();
            return null;
        }
    }
    
    //读取Properties的全部信息
    public static void GetAllProperties(String filePath) throws IOException {
        Properties pps = new Properties();
        InputStream in = new BufferedInputStream(new FileInputStream(filePath));
        pps.load(in);
        Enumeration en = pps.propertyNames(); //得到配置文件的名字
        
        while(en.hasMoreElements()) {
            String strKey = (String) en.nextElement();
            String strValue = pps.getProperty(strKey);
            System.out.println(strKey + "=" + strValue);
        }
        
    }
    
    //写入Properties信息
    public static void WriteProperties (String filePath, String pKey, String pValue) throws IOException {
        Properties pps = new Properties();
        
        InputStream in = new FileInputStream(filePath);
        //从输入流中读取属性列表(键和元素对) 
        pps.load(in);
        //调用 Hashtable 的方法 put。使用 getProperty 方法提供并行性。  
        //强制要求为属性的键和值使用字符串。返回值是 Hashtable 调用 put 的结果。
        OutputStream out = new FileOutputStream(filePath);
        pps.setProperty(pKey, pValue);
        //以适合使用 load 方法加载到 Properties 表中的格式,  
        //将此 Properties 表中的属性列表(键和元素对)写入输出流  
        pps.store(out, "Update " + pKey + " name");
    }
    
    public static void main(String [] args) throws IOException{
        //String value = GetValueByKey("db.properties", "name");
        //System.out.println(value);
        //GetAllProperties("db.properties");
        WriteProperties("db.properties","long", "212");
    }
}

结果:
db.properties中文件的数据为:

#Update long name
#Sun Feb 23 18:17:16 CST 2014
name=JJ
Weight=4444
long=212
Height=3333

三 小结

通过上面的例子不难看出,在Java中操作配置文件是非常简单的。在一个需要用到大量配置信息的模块或系统里,我们有必要封装一个专门的类来共使用。通过最后的main函数调用。

世界上所有的追求都是因为热爱
一枚爱编码 爱生活 爱分享的IT信徒
— hongXkeX

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

相关阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 136,569评论 19 139
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 47,273评论 6 342
  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 34,719评论 18 399
  • 把风景穿在脚上 脚下走过美丽 鞋子走到哪 哪里更惬意 穿鞋也要美丽 舒适 大方 随心随性 用实惠的价格买到最好的鞋...
    机灵小不懂君阅读 229评论 0 2
  • 起个大早,去图书馆上自习,学的正high的时候,对面坐了一个男生,向来讨厌对面坐男生,因为总感觉各种不自在,我默默...
    海尔兄弟姐妹1026阅读 1,130评论 0 0

友情链接更多精彩内容