Properties类详细解析

た入场券 2022-08-20 13:20 308阅读 0赞

java.util
    类 Properties
    java.lang.Object
      java.util.Dictionary<K,V>
          java.util.Hashtable<Object,Object>
              java.util.Properties

所有已实现的接口：

Serializable, Cloneable, Map<Object,Object>

直接已知子类：

Provider

Public class Properties extends HashTable<Object,Object>

Properties类表示了一个持久的属性集，它是在一个文件中存储键值对儿的，其中键值对儿以等号分隔。Properties可保存在流中或从流中加载。属性列表中的每个键及其所对应的值都是字符串。Properties类是线程安全的：多个线程可以共享单个Properties对象而无需进行外部同步。一组属性示例：  
foo=bar  
fu=baz

一个属性列表可包含另一个属性列表作为它的“默认值”；如果未能在原有的属性列表中搜索到属性键，则搜索第二个属性列表。

如果在“不安全”的 Properties 对象（即包含非 String 的键或值）上调用 store 或 save 方法，则该调用将失败。类似地，如果在“不安全”的 Properties 对象（即包含非 String 的键）上调用 propertyNames 或 list 方法，则该调用将失败。

除了输入/输出流使用 ISO 8859-1 字符编码外，`load(InputStream) / store(OutputStream, String)`方法与 `load(Reader)/store(Writer, String)`对的工作方式完全相同。

`loadFromXML(InputStream)`和 `storeToXML(OutputStream, String, String)`方法按简单的 XML 格式加载和存储属性。默认使用 UTF-8 字符编码，但如果需要，可以指定某种特定的编码。XML 属性文档具有以下 DOCTYPE 声明：

<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">

一下列出了Properties的方法摘要，有关每个方法的详细使用情况，请参看API：

[http://www.apihome.cn/api/java/Properties.html][http_www.apihome.cn_api_java_Properties.html]

![这里写图片描述][20160229230327233]

**示例练习一：如何装载属性文件并列出它当前的一组键和值。**

思路：传递属性文件的输入流InputStream给load()方法，会将改属性文件中的每个键值对儿添加到Properties实例中；然后条用list()列出所有属性或者使用getProperty()获取单独的属性。（注意 list() 方法的输出中键-值对的顺序与它们在输入文件中的顺序不一样。 Properties 类在一个散列表（hashtable，事实上是一个 Hashtable 子类）中储存一组键-值对，所以不能保证顺序。 ）

代码实现：

package com.lmb.thread;
    
    import java.io.FileInputStream;
    import java.io.FileNotFoundException;
    import java.io.IOException;
    import java.util.Properties;
    
    public class PropertiesTest {
        
    
        public static void main(String[] args) {
            Properties properties = new Properties();
            try {
                properties.load(new FileInputStream("test.properties"));//加载属性文件
                properties.list(System.out);//将属性文件中的键值对儿打印到控制台
                properties.getProperty("foo");
            } catch (FileNotFoundException e) {
                e.printStackTrace();
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    
    }

**示例练习二：如何装载XML版本的属性文件并列出它当前的一组键和值。（只有装载方法有差异，其余完全相同load(),loadFromXML()）**

package com.lmb.thread;
    
    import java.io.FileInputStream;
    import java.io.FileNotFoundException;
    import java.io.IOException;
    import java.util.Properties;
    
    public class PropertiesTest {
        
    
        public static void main(String[] args) {
            Properties properties = new Properties();
            try {
                properties.loadFromXML(new FileInputStream("test.xml"));//加载属性文件
                properties.list(System.out);//将属性文件中的键值对儿打印到控制台
                properties.getProperty("foo");
            } catch (FileNotFoundException e) {
                e.printStackTrace();
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    
    }

**示例练习三：如何将文件保存到属性文件中？**

import java.util.*;
    import java.io.*;
    
    public class StoreXML {
        
      public static void main(String args[]) throws Exception {
        Properties prop = new Properties();
        prop.setProperty("one-two", "buckle my shoe");
        prop.setProperty("three-four", "shut the door");
        prop.setProperty("five-six", "pick up sticks");
        prop.setProperty("seven-eight", "lay them straight");
        prop.setProperty("nine-ten", "a big, fat hen");
        prop.storeToXML(new FileOutputStream("test.xml"), "saveXML");//将键值对儿保存到XML文件中
    prop.store(new FileOutputStream("test.properties"), "saveProperties");//将键值对儿保存到普通的属性文件中
        fos.close();
      }
    }

**将键值对儿保存到XML文件中的输出结果如下：**

<?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
    <properties>
    <comment>Rhyme</comment>
    <entry key="seven-eight">lay them straight</entry>
    <entry key="five-six">pick up sticks</entry>
    <entry key="nine-ten">a big, fat hen</entry>
    <entry key="three-four">shut the door</entry>
    <entry key="one-two">buckle my shoe</entry>
    </properties>

**将键值对儿保存到普通的属性文件中输出结果如下：**

one-two=buckle my shoe
    three-four=shut the door
    five-six=pick up sticks
    seven-eight=lay them straight
    nine-ten=a big, fat hen

**注意：从一个XML文件中装载一组属性，其DTD文件如下：**

<?xml version="1.0" encoding="UTF-8"?>
    
    <!ELEMENT properties ( comment?, entry* ) >
    <!ATTLIST properties version CDATA #FIXED "1.0">
    <!ELEMENT comment (#PCDATA) >
    <!ELEMENT entry (#PCDATA) >
    <!ATTLIST entry key CDATA #REQUIRED>

在外围 `<properties>` 标签中包装的是一个 `<comment>` 标签，后面是任意数量的 `<entry>`标签。对每一个 `<entry>` 标签，有一个键属性，输入的内容就是它的值。

**Properties获取数据乱码解决**

1.原因

Properties调用load(InputStream)时，读取文件时使用的默认编码为ISO-8859-1；当我们将中文放入到properties文件中，通过getProperty(key)获取值时，取到得数据是ISO-8859-1格式的，但是ISO-8859-1是不能识别中文的。

2.解决方法

通过getProperty()获取的数据data既然是ISO-8859-1编码的，就通过data.getByte(“iso-8859-1”)获取获取，使用new String(data.getByte(“iso-8859-1”),”UTF-8”)进行转换。当然properties文件的编码类型需要和new String(Byte\[\],charset)中的第二个参数的编码类型相同。

[http_www.apihome.cn_api_java_Properties.html]: http://www.apihome.cn/api/java/Properties.html
[20160229230327233]: /images/20220731/239798cd9b514473a2cd9a804c81f15f.png