java中的Properties配置文件

一、简介

1.什么是properties文件

1、java中的properties文件是一种配置文件，主要用于表达配置信息，文件类型为*.properties，格式为文本文件，这种文件以key=value格式存储内容。
2、Properties类继承自Hashtable，是线程安全的，多个线程可以共享单个properties对象而无需进行外部同步。
3、一般这个文件作为一些参数的存储，代码就可以灵活一点。通俗点讲就相当于定义一个变量，在这个文件里面定义这些变量的值，在程序里面可以调用这些变量，好处就是，如果程序中的参数值需要变动，直接来改这个.property文件就可以了，不用在去修改源代码。

2.properties文件特点

1、键值对格式。
2、“ = ”等号后面，值前面，的空格，会自动忽略掉。
3、值后面的空格，不会忽略。
4、“ = ”等号后面的双引号，不会忽略。
5、“ # ”号后面内容，为注释，忽略。

3.常用方法

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

4.Java 读取 .properties 配置文件的几种方式

a、基于ClassLoder（类加载器）读取配置文件
注意：配置文件一定要放到当前目录下。
（目录层次也可以从src下面的文件夹开始但不必包含src，且不必包含反斜杠开头。）

import java.io.IOException;
import java.io.InputStream;
import java.util.Properties;

public class demo01 {
    public static void main(String[] args) {
        Properties properties = new Properties();
        //使用ClassLoader加载properties配置文件生成对应的输入流
        InputStream in = demo01.class.getClassLoader().getResourceAsStream("config/config.properties");
        try {
            //使用properties对象加载输入流
            properties.load(in);
            //根据key获取对应的value
            String url = properties.getProperty("url");
            System.out.println("url:"+url);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

b、基于 InputStream 读取配置文件
注意：该方式的优点在于可以读取任意路径下的配置文件.

import java.io.BufferedReader;
import java.io.FileNotFoundException;
import java.io.FileReader;
import java.io.IOException;
import java.util.Properties;

public class Demo02 {
    public static void main(String[] args) {
        Properties properties = new Properties();
        try {
            //使用InputStream流 读取配置文件
            BufferedReader bufferedReader = new BufferedReader(new FileReader("C:/Users/szwb093/Desktop/config.properties"));
            //使用properties对象加载输入流
            properties.load(bufferedReader);
            //根据key获取对应的value
            String url = properties.getProperty("url");
            System.out.println("url:"+url);

        } catch (FileNotFoundException e1) {
            e1.printStackTrace();
        }catch (IOException e) {
            e.printStackTrace();
        }
    }
}

c、通过 java.util.ResourceBundle 类来读取，这种方式比使用 Properties 要方便一些，
通过 ResourceBundle.getBundle( ) 静态方法来获取（ResourceBundle是一个抽象类），这种方式来获取properties属性文件不需要加.properties后缀名，只需要文件名即可。

//config为属性文件名，放在包config下，如果放在src下（资源文件夹下），直接用config即可
ResourceBundle resource = ResourceBundle.getBundle("config/config");
String url = resource.getString("url");
System.out.println("url:"+url);

/*
    Properties:用来读取配置文件
     */
    @Test
    public void test2() throws Exception {
        Properties pros = new Properties();
        //此时的文件默认在当前module下
        //读取配置文件的方式一
//        FileInputStream fis = new FileInputStream("jdbc1.properties");
   //     FileInputStream fis = new FileInputStream("src\\jdbc1.properties");

        pros.load(fis);

        //读取配置文件方式二
        //配置文件默认识别为：当前module的src下
        ClassLoader classloder = ClassLoaderTest.class.getClassLoader();
        InputStream is = classloder.getResourceAsStream("jdbc1.properties");
        pros.load(is);

        String user = pros.getProperty("user");
        String password = pros.getProperty("password");
        System.out.println("user =" + user + "password =" + password);
    }