Properties类和properties文件的简单总结

一、properties文件

• properties文件是以properties为后缀的文件，是一种属性文件，这种文件以"key=value"的格式存储内容
• Java中通常使用Properties类来读取这个文件，可以得到对应的数据
• properties文件的要求与特点
  • 格式：属性名=属性值
  • 每对属性占一行（即一个键值对占一行）
  • 注释：在该文件中，用#表示单行注释
  • 属性文件中所有空行被忽略
  • 扩展名：properties
  • 属性文件中不能直接写汉字，所有的汉字会转成Unicode编码

二、Properties类

1. Properties类的理解

• 可以使用这个类的实例存储键值对，我把它理解成 Map 的一个延申
• 一般情况下，可以把他当成一个可以存储键值对的map，但是这个map可以进行文件的读写操作

2. 常用方法Properties类

(1) 存储键值对

	setProperty(String key, String value)

(2) 通过key获取对应的value

	public Object get(Object key)
	public String getProperty(String key)
	public String getProperty(String key, String defaultValue)

(3) 读取文件

• 按面向行的格式从传入的字符流中读取属性列表
• 换句话说，就是把文件中的键值对存储到这个对象中
• 注意：可以读取txt文件、properties文件，但是推荐用properties保存配置信息

	public synchronized void load(InputStream inStream)
   	public synchronized void load(Reader reader)

(4) 写入文件

• 将属性列表的键值对输出到指定的输出流中

	public void list(PrintStream out)
	public void list(PrintWriter out)
 	
 	// 常用举例：
    p.list(System.out) // 打印到控制台，经常使用这个进行程序的调试

3. 简单的应用（单元测试）

(1) 键值对的简单读写

    @Test
    public void test() throws Exception  {
        
        Properties p = new Properties();
        
        // 1. 存储键值对
        p.setProperty("1", "AAA");
        p.setProperty("2", "BBB");
        
        // 2. 通过key获取values
        System.out.println(p.get("1"));
        System.out.println(p.get("2"));
        System.out.println("**********************");
        
        // 3. 通过key获取values
        System.out.println(p.getProperty("1"));
        System.out.println(p.getProperty("2"));
        System.out.println("**********************");
        
        // 4. 通过key获取values
        //      并且设置了默认值，如果key不存在，则显示values的默认值
        //      但是不会存储该数据
        System.out.println(p.getProperty("3", "CCC"));
        System.out.println(p.getProperty("4", "DDD"));
        System.out.println("**********************");
        
        // 5. 把"map"中的键值对输出到控制台
        p.list(System.out);
    }
    
    
    // -------------------------------------------------下面为输出内容
    
    /*
    AAA
    BBB
    **********************
    AAA
    BBB
    **********************
    CCC
    DDD
    **********************
    -- listing properties --
    1=AAA
    2=BBB
    */

(2) 对文件的读

• 只可以读取properties文件

    // jdbcTest1.properties：为空，没有内容
    // jdbcTest2.properties：有内容
    @Test
    public void test() throws Exception {
        // 1. 提供Properties实例对象
        Properties p1 = new Properties();
        Properties p2 = new Properties();
        
        // 2. 提供properties文件的输入流【注意：此时的文件路径默认与src同级】
        FileInputStream fs1 = new FileInputStream("doc\\jdbcTest1.properties");
        FileInputStream fs2 = new FileInputStream("doc\\jdbcTest2.properties");
        
        // 3. 读取文件
        p1.load(fs1);
        p2.load(fs2);
        
        // 4. 将读取到的内容输出到控制台中
        p1.list(System.out);
        System.out.println();
        p2.list(System.out);
    }
    
    
    // -------------------------------------------------下面为输出内容
    
    /*
    -- listing properties --
    
    -- listing properties --
    name=Tom
    id=1
    age=18
    */

(3) 对文件的写

• 可以对properties文件、txt文件进行写入
• 但是，将数据写入txt文件仅仅是为了演示操作，不建议使用该方法将数据写入txt中

@Test
    public void test() throws Exception {
        
        // 1. 提供Properties实例对象
        Properties p = new Properties();
        
        // 2. 提供数据来写入文件
        p.setProperty("id", "1");
        p.setProperty("name", "Tom");
        p.setProperty("age", "18");
        
        // 3. 提供properties文件的输入流
        PrintStream ps1 = new PrintStream("doc\\aaa.txt");
        PrintStream ps2 = new PrintStream("doc\\jdbcTest.properties");
        
        // 3. 将内容输出到对应的输出流中
        p.list(ps1);
        p.list(ps2);
    }

4. 读取properties文件的模板

	public static void test() {
        try {
            // 1. 提供Properties实例对象
            Properties p = new Properties();

            // 2. 提供properties文件的输入流
            FileInputStream fs = new FileInputStream("doc\\jdbcTest2.properties");

            // 3. 读取文件
            p.load(fs);

            // 4. 获取对应的值
            String id = p.getProperty("id");
            String name = p.getProperty("name");
            String age = p.getProperty("age");

            // 5. 处理结果
            System.out.println("id = " + id);
            System.out.println("name = " + name);
            System.out.println("age = " + age);

        } catch (Exception e) {
            System.out.println("出错了！！！");
            e.printStackTrace();
        }
    }