properties

properties是一种主要在Java相关技术中用来存储应用程序的可配置参数的文件的文件扩展名。它们也可以存储用于国际化和本地化的字符串,这种文件被称为属性资源包(Property Resource Bundles)。

每个参数被存储为一对字符串:一个存储名称参数(被称为“键”),另一个存储值。 如:key=vuale.vaule

每个properties 文件中的行通常存储单个属性。对于每一行可能有这么几种格式,包括键=值,键 = 值,键:值,以及键 值。

.properties文件可以使用井号(#)或叹号(!)作为一行中第一个非空白字符来表示它后面的所有文本都是一个注释。反斜杠(\)用于转义字符。**

Json和properties转换

在线转换工具:https://json.im/json2/json2properties.html

  1. #json
  2. {
  3. "user": {
  4. "name": "name",
  5. "num": [
  6. 101,102,103
  7. ],
  8. "org": [
  9. {
  10. "id": 1,
  11. "no": "1001",
  12. "yes": true
  13. }
  14. ]
  15. }
  16. }
  17. # properties
  18. user.name=name
  19. user.num.0=101
  20. user.num.1=102
  21. user.num.2=103
  22. user.org.0.id=1
  23. user.org.0.no=1001
  24. user.org.0.yes=true

因为配置文件非常常用,所以Java集合库提供了一个Properties来表示一组“配置”。由于历史遗留原因,Properties内部本质上是一个Hashtable,但我们只需要用到Properties自身关于读写配置的接口。

读取配置文件

Properties读取配置文件非常简单。Java默认配置文件以.properties为扩展名,每行以key=value表示,以#课开头的是注释。以下是一个典型的配置文件:

  1. # setting.properties
  2. last_open_file=/data/hello.txt
  3. auto_save_interval=60

可以从文件系统读取这个.properties文件:

  1. String f = "setting.properties";
  2. Properties props = new Properties();
  3. props.load(new java.io.FileInputStream(f));
  4. String filepath = props.getProperty("last_open_file");
  5. String interval = props.getProperty("auto_save_interval", "120");

可见,用Properties读取配置文件,一共有三步:

  1. 创建Properties实例;
  2. 调用load()读取文件;
  3. 调用getProperty()获取配置。

调用getProperty()获取配置时,如果key不存在,将返回null。我们还可以提供一个默认值,这样,当key不存在的时候,就返回默认值。
也可以从classpath读取.properties文件,因为load(InputStream)方法接收一个InputStream实例,表示一个字节流,它不一定是文件流,也可以是从jar包中读取的资源流:

  1. Properties props = new Properties();
  2. props.load(getClass().getResourceAsStream("/common/setting.properties"));

试试从内存读取一个字节流:

  1. import java.io.*;
  2. import java.util.Properties;
  3. public class Main {
  4. public static void main(String[] args) throws IOException {
  5. String settings = "# test" + "\n" + "course=Java" + "\n" + "last_open_date=2019-08-07T12:35:01";
  6. ByteArrayInputStream input = new ByteArrayInputStream(settings.getBytes("UTF-8"));
  7. Properties props = new Properties();
  8. props.load(input);
  9. System.out.println("course: " + props.getProperty("course"));
  10. System.out.println("last_open_date: " + props.getProperty("last_open_date"));
  11. System.out.println("last_open_file: " + props.getProperty("last_open_file"));
  12. System.out.println("auto_save: " + props.getProperty("auto_save", "60"));
  13. }
  14. }

如果有多个.properties文件,可以反复调用load()读取,后读取的key-value会覆盖已读取的key-value:

  1. Properties props = new Properties();
  2. props.load(getClass().getResourceAsStream("/common/setting.properties"));
  3. props.load(new FileInputStream("C:\\conf\\setting.properties"));

上面的代码演示了Properties的一个常用用法:可以把默认配置文件放到classpath中,然后,根据机器的环境编写另一个配置文件,覆盖某些默认的配置。
Properties设计的目的是存储String类型的key-value,但Properties实际上是从Hashtable派生的,它的设计实际上是有问题的,但是为了保持兼容性,现在已经没法修改了。除了getProperty()setProperty()方法外,还有从Hashtable继承下来的get()put()方法,这些方法的参数签名是Object,我们在使用Properties的时候,不要去调用这些从Hashtable继承下来的方法。

写入配置文件

如果通过setProperty()修改了Properties实例,可以把配置写入文件,以便下次启动时获得最新配置。写入配置文件使用store()方法:

  1. Properties props = new Properties();
  2. props.setProperty("url", "http://www.initit.com");
  3. props.setProperty("key", "Java");
  4. props.store(new FileOutputStream("C:\\conf\\setting.properties"), "这是写入的properties注释");

编码

早期版本的Java规定.properties文件编码是ASCII编码(ISO8859-1),如果涉及到中文就必须用name=\u4e2d\u6587来表示,非常别扭。从JDK9开始,Java的.properties文件可以使用UTF-8编码了。
不过,需要注意的是,由于load(InputStream)默认总是以ASCII编码读取字节流,所以会导致读到乱码。我们需要用另一个重载方法load(Reader)读取:

  1. Properties props = new Properties();
  2. props.load(new FileReader("settings.properties", StandardCharsets.UTF_8));

就可以正常读取中文。InputStreamReader的区别是一个是字节流,一个是字符流。字符流在内存中已经以char类型表示了,不涉及编码问题。

小结

Java集合库提供的Properties用于读写配置文件.properties.properties文件可以使用UTF-8编码。
可以从文件系统、classpath或其他任何地方读取.properties文件。
读写Properties时,注意仅使用getProperty()setProperty()方法,不要调用继承而来的get()put()等方法。

优缺点

  • 优点:简单易读,功能强大
  • 缺点:仅java用的多,其他语言或配置使用较少
  • java开发必会,因为你会遇到很多类似配置