6 Möglichkeiten zum Lesen von Eigenschaftendateien, zum Sammeln empfohlen!

Das handgeschriebene verteilte Konfigurationscenter ist Schritt für Schritt im Gange.

Heutzutage verwenden wir grundsätzlich Spring Boot für die Entwicklung, und jeder weiß, dass es einen application.properties Konfigurationsdatei (einige sind auch application.yaml, jedenfalls wird es zum Speichern einiger unserer Konfigurationsinformationen verwendet), normalerweise schreiben wir einige Konfigurationsinformationen in die Eigenschaftendatei, wie zum Beispiel: Datenbank Verbindungsinformationen, Schnittstelleninformationen von Drittanbietern (Schlüssel, Benutzername, Passwort, Adresse usw.), Verbindungspool, Redis-Konfigurationsinformationen, verschiedene Konfigurationsinformationen für Komponenten von Drittanbietern usw. application.properties配置文件（也有的是application.yaml，反正就是用来保存我们的一些配置信息），通常我们会把一些配置信息写到properties文件中，比如：数据库连接信息、第三方接口信息（密钥、用户名、密码、地址等），连接池、Redis配置信息、各种第三方组件配置信息等。

单体服务，甚至一些小型的分布式架构中，项目的配置都是依赖一个application.properties配置文件来解决（可能有的项目会搞一个环境区分，比如：application-dev.properties、application-pro.properties

jdbc.driver=com.mysql.cj.jdbc.Driver
jdbc.url=mysql://localhost:3306/database?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai
jdbc.username=root
jdbc.password=123456

Nach dem Login kopieren

Jetzt möchte ich die obige Konfigurationsdatei im Java-Code-Inhalt erhalten . Der erste Weg

Der erste Weg, den wir verwenden: this.getClass().getResourceAsStream()+PropertiesCode-Implementierung:

/**
* @author tianwc  公众号：java后端技术全栈、面试专栏
* @version 1.0.0
* @date 2023年05月27日 09:13
* 在线刷题1200+，100+篇干货文章：<a href="http://woaijava.cc/">博客地址</a>
*/
public void readProperties1() throws IOException {
    //不加/会从当前包进行寻找，加上/会从src开始找
    InputStream inputStream = this.getClass().getResourceAsStream("/jdbc.properties");
    Properties properties=new Properties();
    properties.load(inputStream);
    System.out.println("jdbc.driver="+properties.getProperty("jdbc.driver"));
    System.out.println("jdbc.url="+properties.getProperty("jdbc.url"));
    System.out.println("jdbc.username="+properties.getProperty("jdbc.username"));
    System.out.println("jdbc.password="+properties.getProperty("jdbc.password"));
}

Nach dem Login kopieren

jdbc.properties 配置文件，内如如下：

public synchronized void load(InputStream inStream) throws IOException {
        load0(new LineReader(inStream));
    }

    private void load0 (LineReader lr) throws IOException {
        char[] convtBuf = new char[1024];
        int limit;
        int keyLen;
        int valueStart;
        char c;
        boolean hasSep;
        boolean precedingBackslash;
        //逐行读取
        while ((limit = lr.readLine()) >= 0) {
            c = 0;
            keyLen = 0;
            valueStart = limit;
            hasSep = false;

            //System.out.println("line=<" + new String(lineBuf, 0, limit) + ">");
            precedingBackslash = false;
            while (keyLen < limit) {
                c = lr.lineBuf[keyLen];
                //need check if escaped.
                if ((c == &#39;=&#39; ||  c == &#39;:&#39;) && !precedingBackslash) {
                    valueStart = keyLen + 1;
                    hasSep = true;
                    break;
                } else if ((c == &#39; &#39; || c == &#39;\t&#39; ||  c == &#39;\f&#39;) && !precedingBackslash) {
                    valueStart = keyLen + 1;
                    break;
                }
                if (c == &#39;\&#39;) {
                    precedingBackslash = !precedingBackslash;
                } else {
                    precedingBackslash = false;
                }
                keyLen++;
            }
            while (valueStart < limit) {
                c = lr.lineBuf[valueStart];
                if (c != &#39; &#39; && c != &#39;\t&#39; &&  c != &#39;\f&#39;) {
                    if (!hasSep && (c == &#39;=&#39; ||  c == &#39;:&#39;)) {
                        hasSep = true;
                    } else {
                        break;
                    }
                }
                valueStart++;
            }
            //前面一堆代码就是做校验和解析
            //下面两个是做转换
            String key = loadConvert(lr.lineBuf, 0, keyLen, convtBuf);
            String value = loadConvert(lr.lineBuf, valueStart, limit - valueStart, convtBuf);
            
            put(key, value);
        }
    }

Nach dem Login kopieren

现在是想要在java代码中获取上面配置文件内容。

第一种方式

第一种方式我们采用：this.getClass().getResourceAsStream()+Properties

代码实现：

public String getProperty(String key) {
    Object oval = super.get(key);
    String sval = (oval instanceof String) ? (String)oval : null;
    return ((sval == null) && (defaults != null)) ? defaults.getProperty(key) : sval;
}

下面来聊聊上面的这段代码：

this.getClass().getResourceAsStream()

具体文件和代码的位置是，代码在src/main/java目录下，资源文件在src/main/resources/

this.getClass().getResourceAsStream()

Spezifische Dateien und Der Speicherort des Codes ist, Der Code ist in /

Properties

Properties：java.util.Properties，该类主要用于读取Java的配置文件，不同的编程语言有自己所支持的配置文件，配置文件中很多变量是经常改变的，为了方便用户的配置，能让用户够脱离程序本身去修改相关的变量设置。就像在Java中，其配置文件常为.properties文件，是以键值对的形式进行参数配置的。

类关系图：

从上面的类图可以看到Properties类继承至Hashtable，相信大家都知道Hashtable是存储key-value数据结构类，也刚好对应我们properties文件内容也是key-value形式。

Properties 常见方法

getProperty(String key) ：在此属性列表中搜索具有指定键的属性。如果在此属性列表中找不到该键，则会检查默认属性列表及其默认值（递归）。如果未找到该属性，则该方法返回默认值参数。

list(PrintStream out) Drucken Sie diese Eigenschaftenliste in den angegebenen Ausgabestream. Diese Methode ist zum Debuggen nützlich.

ISO 8859-1Zeichenkodierung; das heißt, jedes Byte ist ein Latin1-Zeichen. Nicht in Latin1 enthaltene Zeichen und bestimmte Sonderzeichen werden in Schlüsseln und Elementen mithilfe von Unicode-Escapezeichen dargestellt. Nach der Rückkehr dieser Methode bleibt der angegebene Stream geöffnet. load(InputStream inStream) ：从输入字节流中读取属性列表（键和元素对）。输入流采用加载（Reader）中指定的简单的面向行的格式，并假定使用ISO 8859-1字符编码;即每个字节是一个Latin1字符。不在Latin1中的字符和某些特殊字符在使用Unicode转义符的键和元素中表示。 此方法返回后，指定的流仍保持打开状态。

setProperty(String key, String value) ：调用 Hashtable 的方法 put 。他通过调用基类的put方法来设置 键值对。

store(OutputStream out, String comments) ：将此Properties表中的此属性列表（键和元素对）以适合使用load（InputStream）方法加载到Properties表的格式写入输出流。 此Properties方法不会写出此Properties表的defaults表中的属性（如果有）。

storeToXML(OutputStream os, String comment, String encoding) ：使用指定的编码发出表示此表中包含的所有属性的XML文档。

clear() ：清除此哈希表，使其不包含任何键。

stringPropertyNames()

clear() ：Diesen Hash löschen Tabelle so, dass sie keine Schlüssel enthält. 🎜🎜properties.load(inputStream)

public synchronized void load(InputStream inStream) throws IOException {
        load0(new LineReader(inStream));
    }

    private void load0 (LineReader lr) throws IOException {
        char[] convtBuf = new char[1024];
        int limit;
        int keyLen;
        int valueStart;
        char c;
        boolean hasSep;
        boolean precedingBackslash;
        //逐行读取
        while ((limit = lr.readLine()) >= 0) {
            c = 0;
            keyLen = 0;
            valueStart = limit;
            hasSep = false;

            //System.out.println("line=<" + new String(lineBuf, 0, limit) + ">");
            precedingBackslash = false;
            while (keyLen < limit) {
                c = lr.lineBuf[keyLen];
                //need check if escaped.
                if ((c == &#39;=&#39; ||  c == &#39;:&#39;) && !precedingBackslash) {
                    valueStart = keyLen + 1;
                    hasSep = true;
                    break;
                } else if ((c == &#39; &#39; || c == &#39;\t&#39; ||  c == &#39;\f&#39;) && !precedingBackslash) {
                    valueStart = keyLen + 1;
                    break;
                }
                if (c == &#39;\\&#39;) {
                    precedingBackslash = !precedingBackslash;
                } else {
                    precedingBackslash = false;
                }
                keyLen++;
            }
            while (valueStart < limit) {
                c = lr.lineBuf[valueStart];
                if (c != &#39; &#39; && c != &#39;\t&#39; &&  c != &#39;\f&#39;) {
                    if (!hasSep && (c == &#39;=&#39; ||  c == &#39;:&#39;)) {
                        hasSep = true;
                    } else {
                        break;
                    }
                }
                valueStart++;
            }
            //前面一堆代码就是做校验和解析
            //下面两个是做转换
            String key = loadConvert(lr.lineBuf, 0, keyLen, convtBuf);
            String value = loadConvert(lr.lineBuf, valueStart, limit - valueStart, convtBuf);
            
            put(key, value);
        }
    }

Nach dem Login kopieren

最后调用put(key, value);这个put方法就是Hashtable中的put方法。这里可以这么理解：将我们的配置项保存到Hashtable中。

getProperty(String key)

public String getProperty(String key) {
    Object oval = super.get(key);
    String sval = (oval instanceof String) ? (String)oval : null;
    return ((sval == null) && (defaults != null)) ? defaults.getProperty(key) : sval;
}

Nach dem Login kopieren

Nach dem Login kopieren

super.get(key);就是调用Hashtable中的get()方法，也就是此时返回value，同时这就对应返回了properties文件中key对应的value。

第二种方式

第二种方式，我们通过当前类的加载器进行读取this.getClass().getClassLoader().getResourceAsStream()获取InputStream。

代码实现：

/**
* @author tianwc  公众号：java后端技术全栈、面试专栏
* @version 1.0.0
* @date 2023年05月27日 09:13
* 博客地址：<a href="http://woaijava.cc/">在线刷题1200+，100+篇干货文章</a>
*/
public void readProperties2() throws IOException {
    //不加/，若加了会为null
    InputStream inputStream = this.getClass().getClassLoader().getResourceAsStream("jdbc.properties");
    //如果放在config目录下
    //InputStream inputStream = this.getClass().getClassLoader().getResourceAsStream("config/jdbc.properties");
    Properties properties=new Properties();
    properties.load(inputStream);
    System.out.println("jdbc.driver="+properties.getProperty("jdbc.driver"));
    System.out.println("jdbc.url="+properties.getProperty("jdbc.url"));
    System.out.println("jdbc.username="+properties.getProperty("jdbc.username"));
    System.out.println("jdbc.password="+properties.getProperty("jdbc.password"));
}

Nach dem Login kopieren

第一看怎么觉得和第一种方式很像，下面来说说两个的区别。

• this.getClass.getResourceAsStream() </code >从当前类所在的位置开始查找配置文件位置。要找到<code style="font-size: 14px;padding: 2px 4px;border-radius: 4px;margin-right: 2px;margin-left: 2px;background -color: rgba(27, 31, 35, 0.05);font-family: „Operator Mono“, Consolas, Monaco, Menlo, monospace;word-break: break-all;color: rgb(239, 112, 96); ">jdbc.properties必须加this.getClass.getResourceAsStream() 从当前类所在的位置开始查找配置文件位置。要找到jdbc.properties必须加/从classpath下开始查找
• this.getClass().getClassLoader().getResourceAsStream() 默认就从classpath路径下开始查找，加上/会报空指针异常。

剩下的部分代码和第一种方式一样，这里就不在赘述了。

第三种方式

接下来我们采用ClassLoader类的static方法 getSystemResourceAsStream()

classpath路径下开始查找，加上/会报空指针异常。