深入理解Java中的Properties类

更新时间：2024年01月30日 09:09:12 作者：码农研究僧

Properties类是Java中用于处理配置文件的工具类,它继承自 Hashtable类,实现了Map接口,本文主要介绍了Java中的Properties类,感兴趣的可以了解一下

前言

使用Properties出现中文乱码可看我这篇文章：properties出现中文乱码解决方法（万能）

1. 基本知识

Properties 类是 Java 中用于处理配置文件的工具类，它继承自 Hashtable 类，实现了 Map 接口。

主要用于读取和写入属性文件，以键值对的形式存储数据。
配置文件通常以 .properties 为扩展名，其中每一行表示一个属性或配置项。

使用该类可以更好的处理文件：

配置文件管理：主要用于读取和保存应用程序的配置信息，例如数据库连接信息、用户设置等。
国际化：用于加载不同语言的资源文件，方便国际化应用程序。
持久化：可以将配置信息持久化到文件，以便下次程序启动时重新加载。

对于其方法可查看其API接口：Properties API接口

构造方法如下：

方法	表述
Properties()	创建一个没有默认值的空属性列表。
Properties(int initialCapacity)	创建一个没有默认值的空属性列表，并且初始大小容纳指定数量的元素，而无需动态调整大小。
Properties(Properties defaults)	创建具有指定默认值的空属性列表。

常用的方法如下：

返回类型	方法	表述
String	getProperty(String key) getProperty(String key, String defaultValue)	在此属性列表中搜索具有指定键的属性。
void	list(PrintStream out) list(PrintWriter out)	将此属性列表打印到指定的输出流。
void	load(InputStream inStream)	从输入字节流中读取属性列表（键和元素对）。
void	load(Reader reader)	以简单的面向行的格式从输入字符流中读取属性列表（键和元素对）。
Object	setProperty(String key, String value)	调用 Hashtable方法 put 。
void	store(OutputStream out, String comments)	将此 Properties表中的此属性列表（键和元素对）以适合使用 load(InputStream)方法加载到 Properties表的格式写入输出流。
void	store(Writer writer, String comments)	将此 Properties表中的此属性列表（键和元素对）以适合使用 load(Reader)方法的格式写入输出字符流。

2. 代码示例

当使用 Properties 类时，你可以使用上述方法来读取和写入属性。以下是这些方法的一些简单的代码示例：

1. getProperty(String key)

Properties properties = new Properties();
try (InputStream input = new FileInputStream("config.properties")) {
    properties.load(input);

    // 获取属性值
    String value = properties.getProperty("key");
    System.out.println("Value for key 'key': " + value);
} catch (IOException e) {
    e.printStackTrace();
}

2. getProperty(String key, String defaultValue)

Properties properties = new Properties();
try (InputStream input = new FileInputStream("config.properties")) {
    properties.load(input);

    // 获取属性值，如果不存在则使用默认值
    String value = properties.getProperty("nonexistentKey", "default");
    System.out.println("Value for key 'nonexistentKey': " + value);
} catch (IOException e) {
    e.printStackTrace();
}

3. list(PrintStream out) / list(PrintWriter out)

Properties properties = new Properties();
try (InputStream input = new FileInputStream("config.properties")) {
    properties.load(input);

    // 打印属性列表到控制台
    properties.list(System.out);
} catch (IOException e) {
    e.printStackTrace();
}

4. load(InputStream inStream)

Properties properties = new Properties();
try (InputStream input = new FileInputStream("config.properties")) {
    // 从输入流中读取属性列表
    properties.load(input);

    // 遍历所有键值对
    for (String key : properties.stringPropertyNames()) {
        String value = properties.getProperty(key);
        System.out.println(key + ": " + value);
    }
} catch (IOException e) {
    e.printStackTrace();
}

5. store(OutputStream out, String comments)

Properties properties = new Properties();
properties.setProperty("key1", "value1");
properties.setProperty("key2", "value2");

try (OutputStream output = new FileOutputStream("output.properties")) {
    // 将属性列表写入输出流
    properties.store(output, "Comments for the output file");
} catch (IOException e) {
    e.printStackTrace();
}

6. store(Writer writer, String comments)

Properties properties = new Properties();
properties.setProperty("key1", "value1");
properties.setProperty("key2", "value2");

try (Writer writer = new FileWriter("output.properties")) {
    // 将属性列表写入输出字符流
    properties.store(writer, "Comments for the output file");
} catch (IOException e) {
    e.printStackTrace();
}

3. Demo

上述的API方法可适当选择，完整的Demo可充分了解这个类的整体逻辑：

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

public class PropertiesDemo {

    public static void main(String[] args) {
        // 创建 Properties 对象
        Properties properties = new Properties();

        // 设置属性值
        properties.setProperty("username", "码农研究僧");
        properties.setProperty("password", "123456789");
        properties.setProperty("server", "https://blog.csdn.net/weixin_47872288");

        // 将属性列表写入输出流
        try (OutputStream output = new FileOutputStream("config.properties")) {
            properties.store(output, "Sample Configuration");
            System.out.println("Properties written to config.properties");
        } catch (IOException e) {
            e.printStackTrace();
        }

        // 从输入流中读取属性列表
        try (InputStream input = new FileInputStream("config.properties")) {
            properties.load(input);

            // 获取属性值
            String username = properties.getProperty("username");
            String password = properties.getProperty("password");
            String server = properties.getProperty("server");

            System.out.println("Username: " + username);
            System.out.println("Password: " + password);
            System.out.println("Server: " + server);
        } catch (IOException e) {
            e.printStackTrace();
        }

        // 打印属性列表到控制台
        /**
         * -- listing properties --
         * password=123456789
         * server=https://blog.csdn.net/weixin_47872288
         * username=码农研究僧
         */
        properties.list(System.out);
    }
}

终端输出结果如下：

在这里插入图片描述

到此这篇关于深入理解Java中的Properties类的文章就介绍到这了,更多相关Java Properties类内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

javaWeb自定义标签用法实例详解
这篇文章主要介绍了javaWeb自定义标签用法,结合实例形式分析了javaweb自定义标签的功能、定义方法及执行原理,需要的朋友可以参考下
2017-04-04
Maven安装与配置图文教程
这篇文章主要为大家详细介绍了Maven安装与配置图文教程，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2018-10-10
一篇带你入门Java垃圾回收器
垃圾收集器是垃圾回收算法（标记-清除算法、复制算法、标记-整理算法、火车算法）的具体实现，不同商家、不同版本的JVM所提供的垃圾收集器可能会有很在差别
2021-06-06
JAVA不可变类(immutable)机制与String的不可变性(推荐)
这篇文章主要介绍了JAVA不可变类(immutable)机制与String的不可变性(推荐)的相关资料,非常不错，具有参考借鉴价值，需要的朋友可以参考下
2016-08-08
Java图像处理之RGB调色面板
这篇文章主要为大家详细介绍了Java图像处理之RGB调色面板，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2022-06-06
Java源码解析TreeMap简介
今天小编就为大家分享一篇关于Java源码解析TreeMap简介，小编觉得内容挺不错的，现在分享给大家，具有很好的参考价值，需要的朋友一起跟随小编来看看吧
2019-01-01
java构造http请求的几种方式(附源码)
本文主要介绍了java构造http请求的几种方式，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2023-02-02
java实现日历功能
这篇文章主要为大家详细介绍了java实现日历功能，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2022-06-06
Spring的初始化和XML解析的实现
这篇文章主要介绍了Spring的初始化和XML解析的实现，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2019-03-03
Java多线程Runable售票系统实现过程解析
这篇文章主要介绍了Java多线程Runable售票系统实现过程解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2020-06-06

深入理解Java中的Properties类

目录

前言

1. 基本知识

2. 代码示例

3. Demo

相关文章

最新评论

大家感兴趣的内容

最近更新的内容

常用在线小工具