您的位置:

Java中Properties使用详解

在Java中,有时候需要在程序中读写一些配置信息,例如数据库连接信息、系统参数等等。Properties类提供了一种方便的方式来管理这些配置信息。在本文中,我们将详细介绍Java中Properties类的使用。

一、Properties类概述

在Java编程中,Properties类是一种用来处理配置文件的工具类。它继承自Hashtable类,具有Hashtable类的所有特性,可以将一组属性配置信息保存在一个文件中以供程序读写。Properties类的键和值都是字符串类型。

Java的Properties类最常见的使用方法就是通过读写配置文件,读取和设置系统配置,所以适合于大量配置数据管理。在Properties中,每个属性都是一个键(key)和一个值(value),键和值都是字符串类型。

二、Properties类的基本用法

Properties类提供了如下的常用方法:

public Object setProperty(String key, String value) //设置key-value键值对
public String getProperty(String key)  //通过key获取value
public String getProperty(String key, String defaultValue) //通过key获取value,如果没有则返回defaultValue
public Set stringPropertyNames() //获取键集合
public void load(InputStream in) //根据输入流,将属性文件加载到Properties对象中
public void store(OutputStream out, String comments)  //将Properties对象保存到输出流中

  

下面我们来看一个简单的使用示例,在代码中我们读取了一个配置文件,保存了其中的几个属性,并将其输出到标准输出流。这是一个基本的读写配置的流程:

import java.io.*;
import java.util.Properties;

public class PropertiesTest {
    public static void main(String[] args) {
        Properties props = new Properties();
        try {
            FileInputStream input = new FileInputStream("config.properties");
            props.load(input);
            input.close();

            String server = props.getProperty("server");
            String port = props.getProperty("port");
            String user = props.getProperty("user");
            String password = props.getProperty("password");

            System.out.println("server = " + server);
            System.out.println("port = " + port);
            System.out.println("user = " + user);
            System.out.println("password = " + password);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

上述代码中,我们首先创建了一个Properties对象,然后使用FileInputStream读取配置文件,并通过load方法加载到Properties对象中,接下来就可以通过getProperty方法获取配置信息。最后我们打印了读取的配置信息。

三、Properties类的高级用法

除了基本用法外,Properties类还有许多高级用法,这里我们将介绍其中的两个核心概念:从属性文件加载Properties对象和向属性文件保存Properties对象。

1. 从属性文件加载Properties对象

从属性文件加载Properties对象需要使用Properties的load方法,在读取属性文件时需要注意以下几点:

1.1 文件的编码方式

如果配置文件是以properties扩展名保存的,它的默认编码是ISO 8859-1。如果在配置文件中使用其他编码方式,需要在读取时进行指定:

props.load(new InputStreamReader(new FileInputStream("config.properties"), "UTF-8"));

1.2 文件路径

在使用load方法时,如果指定的文件名没有给出绝对路径,那么属性文件所在的路径将由系统属性“user.dir”定义。如果属性文件不在当前目录下,需要指定配置文件的路径。

1.3 读取时不存在的属性

在读取属性文件的时候,有可能存在某些属性没有设置或者写错了,如果这种情况下调用getProperty方法,将返回一个null值。如果这些属性是必须设置的或者想为其设置默认值,需要使用setProperty方法:

props.setProperty("defaultValue","0");
int defaultValue=Integer.parseInt(props.getProperty("defaultValue"));

1.4 改变属性值

在修改属性值的时候,需要调用setProperty方法,其用法与添加属性一样。将会被替换的键必须事先存在以便改变其值:

props.setProperty("server","localhost");
props.store(new FileOutputStream("config.properties"),null);

2. 向属性文件保存Properties对象

从属性文件加载Properties对象是读取属性文件的过程,向属性文件保存Properties对象则是修改属性文件的过程。在存储Properties对象时,我们需要注意以下几点:

2.1 存储的格式

存储属性文件时使用的是store方法。默认情况下,它可以产生带注释信息的标准ASCII码文件,当然也可以使用Unicode的格式,第一个参数传入文件的输出流,第二个参数则是用于描述配置文件的字符串:

props.store(new FileOutputStream("config.properties"),null);

2.2 输出的注释

使用store方法时,可以向输出的文件中添加注释信息,注释信息必须是一个以#开头的字符串。它不会影响配置文件的语法结构,只是起到注释的作用:

props.store(new FileOutputStream("config.properties"),"updated on "+ new Date());

四、总结

在Java中,Properties提供了一种方便的方式来管理配置信息。通过本文对Java中Properties的使用详解,我们了解了Properties类的基本和高级用法,并且了解了如何使用它来管理配置信息。在实际工作中,我们可以根据需要灵活的使用Properties来完成配置信息的读写操作。