用类加载器读取.properties文件的几种方式

我会带着你远行 2022-04-14 01:59 389阅读 0赞

# [用类加载器的5种方式读取.properties文件][5_.properties] #

用类加载器的5中形式读取.properties文件（这个.properties文件一般放在src的下面）

用类加载器进行读取：这里采取先向大家讲读取类加载器的几种方法；然后写一个例子把几种方法融进去，让大家直观感受。最后分析原理。（主要是结合所牵涉的方法的源代码的角度进行分析）

这里先介绍用类加载器读取的几种方法:

1.任意类名.class.getResourceAsStream("/文件所在的位置");【文件所在的位置从包名开始写】

2.和.properties文件在同一个目录下的类名.class.getResourceAsStream("文件所在的位置");【文件所在的位置从包名开始写，注意这里和上面的相比较少了一个斜杠/】

当然你也可以写成跟1一样的形式即：任意类名.class.getResourceAsStream("/文件所在的位置");

3.任意类名.class.getClassLoader().getResourceAsStream("文件所在的位置");【文件所在的位置从包名开始写】

4.任意类名.class.getClassLoader().getResource("文件所在的位置").openStream();【文件所在的位置从包名开始写】

5.任意类名.class.getClassLoader().getResource("文件所在的位置")..openConnection().getInputStream();【文件所在的位置从包名开始写】

//一个例子，说明上述5中方法的用法。

![1069788-20161215154735714-1388035685.png][]

上面图片中的各个红色矩形就是我要读取的properties文件。主要是两类。一类直接放在src下面。另一类是放在某个文件夹下面.

//f.properties文件的内容如下图所示；

![1069788-20161215162031620-251792883.png][]

//上述五种情况说明的代码如下：

![复制代码][Image 1]

1 package com.qls.commonclass;
     2 
     3 import java.io.IOException;
     4 import java.io.InputStream;
     5 import java.util.Properties;
     6 
     7 import com.qls.counter.Ok;
     8 
     9 /**
    10  * 分别用类加载器的5种方法读取f.properties文件。
    11  * @author 秦林森
    12  *
    13  */
    14 public class Test6 {
    15 
    16     public static void main(String[] args) throws IOException {
    17         // TODO Auto-generated method stub
    18         /**第一种情形获取输入流。
    19          * 任意类名.class.getResourceAsStream("/文件所在的位置");【文件所在的位置从包名开始写】
    20          * @param args
    21          */
    22         //获取输入流
    23         InputStream in = Test.class.getResourceAsStream("/com/qls/counter/f.properties");
    24         /**
    25          * 第二种情形获取输入流。
    26          * 和.properties文件在同一个目录下的类名.class.getResourceAsStream("文件所在的位置");
    27          * 【文件所在的位置从包名开始写，注意这里和上面的相比较少了一个斜杠/】
    28          * 这里随便选择一个与：f.properties在同一个目录下的类比如Ok这个类吧！
    29          * 这里你自然也可以写成跟第一种情况一样的形式：
    30          * 即：
    31          * InputStream in2 = Ok.class.getResourceAsStream("/com/qls/counter/f.properties");
    32          * 因为第一种情况是针对任意一个类而言的公式。
    33          */
    34         InputStream in2 = Ok.class.getResourceAsStream("f.properties");
    35         /**
    36          * 第三种情形获取输入流：
    37          * 任意类名.class.getClassLoader().getResourceAsStream("文件所在的位置");
    38          * 【文件所在的位置从包名开始写】
    39          */
    40         InputStream in3 = Test2.class.getClassLoader().getResourceAsStream("com/qls/counter/f.properties");
    41         /**
    42          * 第四中情形获取输入流：
    43          * 任意类名.class.getClassLoader().getResource("文件所在的位置").openStream();
    44          * 【文件所在的位置从包名开始写】
    45          */
    46         InputStream in4 = Test4.class.getClassLoader().getResource("com/qls/counter/f.properties").openStream();
    47         /**
    48          * 第五种情形获取输入流：
    49          * .任意类名.class.getClassLoader().getResource("文件所在的位置").openConnection().getInputStream();
    50          * 【文件所在的位置从包名开始写】
    51          */
    52         InputStream in5 = Test5.class.getClassLoader().getResource("com/qls/counter/f.properties").openConnection().getInputStream();
    53         //创建Properties
    54         Properties prop=new Properties();
    55         //把输入流in加载到prop中
    56         /*
    57          * 验证上述5中输入流是否成立。只需带入prop.load(InputStream inputStream);验证即可。
    58          * 也就是：
    59          * prop.load(in);
    60          * prop.load(in2);
    61          * prop.load(in3);
    62          * prop.load(in4);
    63          * prop.load(in5);
    64          */
    65         prop.load(in5);
    66         System.out.println("sixi="+prop.getProperty("sixi"));
    67         System.out.println("ouyangfeng="+prop.getProperty("ouyangfeng"));
    68         System.out.println("rape="+prop.getProperty("farm"));
    69     }
    70 
    71 }/*
    72 Output:
    73 sixi=river
    74 ouyangfeng=masses
    75 farm=flower
    76 **///:~

![复制代码][Image 1]

上述5中方法的原理分析。

首先看看Class中的resolveName(String name)究竟是干什么的。源码如下所示：

![复制代码][Image 1]

1  private String resolveName(String name) {
     2         if (name == null) {
     3             return name;
     4         }
     5         if (!name.startsWith("/")) {
     6             Class<?> c = this;
     7             while (c.isArray()) {
     8                 c = c.getComponentType();
     9             }
    10             String baseName = c.getName();
    11             int index = baseName.lastIndexOf('.');
    12             if (index != -1) {
    13                 name = baseName.substring(0, index).replace('.', '/')
    14                     +"/"+name;
    15             }
    16         } else {
    17             name = name.substring(1);
    18         }
    19         return name;
    20     }

![复制代码][Image 1]

下面我把这个源码讲的内容翻译人类语言：

给任意一个字符串name，如果该name是以/开始的，则该函数返回的是：去掉/这个字符的字符串。（如name="/ouyangfeng" 则调用该函数之后得到的结果是：name=ouyangfeng）。  
如果该name这个字符串不是以/开始的，则该函数返回的结果是调用这个函数类所在的包名+name组成的字符串（例如假设Test5所在的包名是：com.qls.mount 。则：Test5.class.resolveName("ouyangfeng");返回结果是：com/qls/mount/ouyangfeng）

也就是帮助文档讲述的：

*  If the `name` begins with a `'/'` ('\\u002f'), then the absolute name of the resource is the portion of the `name` following the `'/'`.
 *  Otherwise, the absolute name is of the following form:
    
    > `modified_package_name/name`
    
    Where the `modified_package_name` is the package name of this object with `'/'` substituted for `'.'` ('\\u002e').

*  上述英文我简要翻译一下：如果name是以一个`/开头，则这个资源的绝对name就是：name中/之后的部分内容。`
 *  否则：这这个绝对name就是如下形式。包名/name,把这里包名中的.用/代替掉。【如：com.qls.river把.用/代替掉就是：com/qls/river】
 *  然后我们再看看Class类中的getResourceAsStream(String name)的源码和ClassLoader中的getResourceAsStream(String name)中的源码。
    
     
    
    Class类中的getResourceAsStream(String name)的源码如下：
    
    ![复制代码][Image 1]
    
        1  public InputStream getResourceAsStream(String name) {
        2         name = resolveName(name);//注意这里有一个resolveName(String name)方法，根据上述的分析，易知道这个源码的意思.
        3         ClassLoader cl = getClassLoader0();
        4         if (cl==null) {
        5             // A system class.
        6             return ClassLoader.getSystemResourceAsStream(name);
        7         }
        8         return cl.getResourceAsStream(name);
        9     }
    
    ![复制代码][Image 1]
    
    ClassLoader中的getResourceAsStream(String name)中的源码如下：
    
    ![复制代码][Image 1]
    
        1  public InputStream getResourceAsStream(String name) {
        2         URL url = getResource(name);
        3         try {
        4             return url != null ? url.openStream() : null;//这句代码的意思是：如果url不是null时返回的是：url.openStream()，反之如果url为null则返回null.
        5         } catch (IOException e) {
        6             return null;
        7         }
        8     }
    
    ![复制代码][Image 1]
    
    通过这Class.resolveName(String name)中的源代码和ClassLoader.getResourceAsStream(String name)中的源代码以及Class.getResourceAsStream（String name）中的原代码我们易知道上述五种情况是怎么来的。无需记忆。
    
    只需学会数学推理即可。
    
    大家在看源码是：发现Class.resolveName(String name)这个方法是private的，你用普通方法根本调用不了，下面我顺便提一下：如何调用这个方法。以便大家可以更好的理解这个方法所讲的意思。
    
    ![复制代码][Image 1]
    
        1 package com.qls.commonclass;
         2 
         3 import java.lang.reflect.InvocationTargetException;
         4 import java.lang.reflect.Method;
         5 
         6 /**
         7  * 用反射调用ClassLoade中的 private String resolveName(String name)
         8  * 验证这个方法所讲的意思。
         9  * @author 秦林森
        10  *
        11  */
        12 public class Test7 {
        13 
        14     public static void main(String[] args) throws Exception{
        15         // TODO Auto-generated method stub
        16         //得到这个方法。
        17         Method method = Class.class.getDeclaredMethod("resolveName", new Class[]{String.class});
        18         //由于这个方法是private,所以要获取这个方法的访问权限
        19         method.setAccessible(true);
        20         //写一个实例，以便调用这个方法。
        21         
        22         Object obj = Test7.class;//Test这个类所在的包是:com.qls.commonclass
        23         //调用这个方法
        24         String invoke = (String) method.invoke(obj, new Object[]{"ouyangfeng"});
        25         String invoke2 = (String) method.invoke(obj, new Object[]{"/ouyangfeng"});
        26         System.out.println("invoke="+invoke);
        27         System.out.println("invoke2="+invoke2);
        28         
        29     }
        30 
        31 }/*
        32 Output:
        33 invoke=com/qls/commonclass/ouyangfeng
        34 invoke2=ouyangfeng
        35 由此可以证明了:以/开头的字符串"/ouyangfeng"调用resolveName(String name)
        36 这个方法之后返回的结果是：ouyangfeng
        37 不以/开头的字符串："ouyangfeng"返回的结果是：调用这个方法的包名/name
        38 【在本例中是Test7调用resolveName(String name),而Test7所在的包是：com.qls.commonclass
        39 所以返回结果是：com/qls/commonclass/ouyangfeng】
        40 
        41 *///:~
    
    ![复制代码][Image 1]
    
     
    
    好文要顶 关注我 收藏该文 ![Image 1][] ![Image 1][]
    
    [![Image 1][]][Image 1 1]
    
    [技术让世界更精彩][Image 1 1]  
    [关注 - 1][- 1]  
    [粉丝 - 8][- 8]
    
    \+加关注
    
    0
    
    0
    
    [« ][Link 1] 上一篇： [如何用cookie保存用户的登录的密码和用户名][Link 1]  
    [» ][Link 2] 下一篇： [用ServletContext读取.properties文件][Link 2]  
    
    
        </div>
        	<div class="postDesc">posted @ <span id="post-date">2016-12-15 17:30</span> <a href="https://www.cnblogs.com/1540340840qls/">技术让世界更精彩</a> 阅读(<span id="post_view_count">3147</span>) 评论(<span id="post_comment_count">1</span>)  <a href="https://i.cnblogs.com/EditPosts.aspx?postid=6184109" rel="nofollow">编辑</a> <a href="#" onclick="AddToWz(6184109);return false;">收藏</a></div>
        </div>
        <script type="text/javascript">var allowComments=true,cb_blogId=318934,cb_entryId=6184109,cb_blogApp=currentBlogApp,cb_blogUserGuid='93bade86-bab2-e611-845c-ac853d9f53ac',cb_entryCreatedDate='2016/12/15 17:30:00';loadViewCount(cb_entryId);var cb_postType=1;</script>

[5_.properties]: https://www.cnblogs.com/1540340840qls/p/6184109.html
[1069788-20161215154735714-1388035685.png]: /images/20220414/121c180b6af9400dbef023034d8753d9.png
[1069788-20161215162031620-251792883.png]: /images/20220414/1b52792679ba481dae42a56063e2b1b7.png
[Image 1]: 
[Image 1 1]: http://home.cnblogs.com/u/1540340840qls/
[- 1]: http://home.cnblogs.com/u/1540340840qls/followees
[- 8]: http://home.cnblogs.com/u/1540340840qls/followers
[Link 1]: https://www.cnblogs.com/1540340840qls/p/6163258.html
[Link 2]: https://www.cnblogs.com/1540340840qls/p/6185518.html