用类加载器的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中方法的用法。

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

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

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

package com.qls.commonclass;

import java.io.IOException;
import java.io.InputStream;
import java.util.Properties;

import com.qls.counter.Ok;

/**
 * 分别用类加载器的5种方法读取f.properties文件。
 * @author 秦林森
 *
 */
public class Test6 {

    public static void main(String[] args) throws IOException {
        // TODO Auto-generated method stub
        /**第一种情形获取输入流。
         * 任意类名.class.getResourceAsStream("/文件所在的位置");【文件所在的位置从包名开始写】
         * @param args
         */
        //获取输入流
        InputStream in = Test.class.getResourceAsStream("/com/qls/counter/f.properties");
        /**
         * 第二种情形获取输入流。
         * 和.properties文件在同一个目录下的类名.class.getResourceAsStream("文件所在的位置");
         * 【文件所在的位置从包名开始写，注意这里和上面的相比较少了一个斜杠/】
         * 这里随便选择一个与：f.properties在同一个目录下的类比如Ok这个类吧！
         * 这里你自然也可以写成跟第一种情况一样的形式：
         * 即：
         * InputStream in2 = Ok.class.getResourceAsStream("/com/qls/counter/f.properties");
         * 因为第一种情况是针对任意一个类而言的公式。
         */
        InputStream in2 = Ok.class.getResourceAsStream("f.properties");
        /**
         * 第三种情形获取输入流：
         * 任意类名.class.getClassLoader().getResourceAsStream("文件所在的位置");
         * 【文件所在的位置从包名开始写】
         */
        InputStream in3 = Test2.class.getClassLoader().getResourceAsStream("com/qls/counter/f.properties");
        /**
         * 第四中情形获取输入流：
         * 任意类名.class.getClassLoader().getResource("文件所在的位置").openStream();
         * 【文件所在的位置从包名开始写】
         */
        InputStream in4 = Test4.class.getClassLoader().getResource("com/qls/counter/f.properties").openStream();
        /**
         * 第五种情形获取输入流：
         * .任意类名.class.getClassLoader().getResource("文件所在的位置").openConnection().getInputStream();
         * 【文件所在的位置从包名开始写】
         */
        InputStream in5 = Test5.class.getClassLoader().getResource("com/qls/counter/f.properties").openConnection().getInputStream();
        //创建Properties
        Properties prop=new Properties();
        //把输入流in加载到prop中
        /*
         * 验证上述5中输入流是否成立。只需带入prop.load(InputStream inputStream);验证即可。
         * 也就是：
         * prop.load(in);
         * prop.load(in2);
         * prop.load(in3);
         * prop.load(in4);
         * prop.load(in5);
         */
        prop.load(in5);
        System.out.println("sixi="+prop.getProperty("sixi"));
        System.out.println("ouyangfeng="+prop.getProperty("ouyangfeng"));
        System.out.println("rape="+prop.getProperty("farm"));
    }

}/*
Output:
sixi=river
ouyangfeng=masses
farm=flower
**///:~

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

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

 private String resolveName(String name) {
        if (name == null) {
            return name;
        }
        if (!name.startsWith("/")) {
            Class<?> c = this;
            while (c.isArray()) {
                c = c.getComponentType();
            }
            String baseName = c.getName();
            int index = baseName.lastIndexOf('.');
            if (index != -1) {
                name = baseName.substring(0, index).replace('.', '/')
                    +"/"+name;
            }
        } else {
            name = name.substring(1);
        }
        return name;
    }

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

给任意一个字符串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)的源码如下：

 public InputStream getResourceAsStream(String name) {
        name = resolveName(name);//注意这里有一个resolveName(String name)方法，根据上述的分析，易知道这个源码的意思.
        ClassLoader cl = getClassLoader0();
        if (cl==null) {
            // A system class.
            return ClassLoader.getSystemResourceAsStream(name);
        }
        return cl.getResourceAsStream(name);
    }

ClassLoader中的getResourceAsStream(String name)中的源码如下：

 public InputStream getResourceAsStream(String name) {
        URL url = getResource(name);
        try {
            return url != null ? url.openStream() : null;//这句代码的意思是：如果url不是null时返回的是：url.openStream()，反之如果url为null则返回null.
        } catch (IOException e) {
            return null;
        }
    }

通过这Class.resolveName(String name)中的源代码和ClassLoader.getResourceAsStream(String name)中的源代码以及Class.getResourceAsStream（String name）中的原代码我们易知道上述五种情况是怎么来的。无需记忆。

只需学会数学推理即可。

大家在看源码是：发现Class.resolveName(String name)这个方法是private的，你用普通方法根本调用不了，下面我顺便提一下：如何调用这个方法。以便大家可以更好的理解这个方法所讲的意思。

package com.qls.commonclass;

import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;

/**
 * 用反射调用ClassLoade中的 private String resolveName(String name)
 * 验证这个方法所讲的意思。
 * @author 秦林森
 *
 */
public class Test7 {

    public static void main(String[] args) throws Exception{
        // TODO Auto-generated method stub
        //得到这个方法。
        Method method = Class.class.getDeclaredMethod("resolveName", new Class[]{String.class});
        //由于这个方法是private,所以要获取这个方法的访问权限
        method.setAccessible(true);
        //写一个实例，以便调用这个方法。
        
        Object obj = Test7.class;//Test这个类所在的包是:com.qls.commonclass
        //调用这个方法
        String invoke = (String) method.invoke(obj, new Object[]{"ouyangfeng"});
        String invoke2 = (String) method.invoke(obj, new Object[]{"/ouyangfeng"});
        System.out.println("invoke="+invoke);
        System.out.println("invoke2="+invoke2);
        
    }

}/*
Output:
invoke=com/qls/commonclass/ouyangfeng
invoke2=ouyangfeng
由此可以证明了:以/开头的字符串"/ouyangfeng"调用resolveName(String name)
这个方法之后返回的结果是：ouyangfeng
不以/开头的字符串："ouyangfeng"返回的结果是：调用这个方法的包名/name
【在本例中是Test7调用resolveName(String name),而Test7所在的包是：com.qls.commonclass
所以返回结果是：com/qls/commonclass/ouyangfeng】

*///:~