Java路径问题终于解决方式—可定位全部资源的相对路径寻址

Posted 2020-09-20 blfbuaa

1、在Java项目中，应该通过绝对路径訪问文件。下面为訪问的经常用法：

第一种方法：类名.class.getResource("/").getPath()+文件名称

另外一种方法：Thread.currentThread().getContextClassLoader().getResource("").getPath()+文件名称【主要使用】

如果文件夹结构例如以下

如今src文件夹下的类文件须要訪问config文件夹下的配置文件。

2、使用第一种方法

new FileInputStream(LoadProperties.class.getResource("/").getPath() + "seed.txt");

new FileInputStream(MyCrawler.class.getResource("/").getPath() + "search.properties")

如果Jediael项目被部署在E:\Project\.metadata\.plugins\org.eclipse.wst.server.core\tmp0\wtpwebapps\，则
类名.class.getResource("/") 返回file:\E:\Project\.metadata\.plugins\org.eclipse.wst.server.core\tmp0\wtpwebapps\Jediael\WEB-INF\classes，即类文件的要文件夹

类名.class.getResource("") 返回file:\E:\Project\.metadata\.plugins\org.eclipse.wst.server.core\tmp0\wtpwebapps\Jediael\WEB-INF\classes\com\jediael\，即类全部的位置
上述2个方法均返回URI的格式，再通过getPath()来获取路径，即将前面的file:\去掉。

3、使用另外一种方法

new FileInputStream(Thread.currentThread().getContextClassLoader().getResource("").getPath() + "search.properties")

new FileInputStream(Thread.currentThread().getContextClassLoader().getResource("").getPath() + "seed.txt");

二者均返回：E:\Project\.metadata\.plugins\org.eclipse.wst.server.core\tmp0\wtpwebapps\Jediael\WEB-INF\classes

推荐使用另外一种方法。！

下面内容转载自：http://blog.csdn.net/shendl/article/details/1427475

前言

Java的路径问题，很难搞。

近期的工作涉及到创建和读取文件的工作，这里我就给大家彻底得解决Java路径问题。

我编写了一个方法，比ClassLoader.getResource(String 相对路径)方法的能力更强。它能够接受“../”这种參数。同意我们用相对路径来定位classpath外面的资源。这样，我们就能够使用相对于classpath的路径，定位全部位置的资源。

 

Java路径

Java中使用的路径。分为两种：绝对路径和相对路径。详细而言，又分为四种：

一、URI形式的绝对资源路径

如：file:/D:/java/eclipse32/workspace/jbpmtest3/bin/aaa.b

URL是URI的特例。URL的前缀/协议。必须是Java认识的。

URL能够打开资源。而URI则不行。

URL和URI对象能够互相转换。使用各自的toURI(),toURL()方法就可以！

 

二、本地系统的绝对路径

D:/java/eclipse32/workspace/jbpmtest3/bin/aaa.b

Java.io包中的类，须要使用这样的形式的參数。

可是，它们一般也提供了URI类型的參数。而URI类型的參数，接受的是URI样式的String。因此，通过URI转换。还是能够把URI样式的绝对路径用在java.io包中的类中。

 

三、相对于classpath的相对路径

如：相对于

file:/D:/java/eclipse32/workspace/jbpmtest3/bin/这个路径的相对路径。当中。bin是本项目的classpath。全部的Java源文件编译后的.class文件拷贝到这个文件夹中。

 

 

四、相对于当前用户文件夹的相对路径

就是相对于System.getProperty("user.dir")返回的路径。

对于一般项目，这是项目的根路径。对于JavaEEserver。这可能是server的某个路径。

这个并没有统一的规范！

所以，绝对不要使用“相对于当前用户文件夹的相对路径”。然而：

默认情况下。java.io 包中的类总是依据当前用户文件夹来分析相对路径名。

此文件夹由系统属性 user.dir 指定，一般是 Java 虚拟机的调用文件夹。

这就是说。在使用java.io包中的类时，最好不要使用相对路径。否则，尽管在J2SE应用程序中可能还算正常，可是到了J2EE程序中，一定会出问题！

并且这个路径，在不同的server中都是不同的！

 

相对路径最佳实践

推荐使用相对于当前classpath的相对路径

因此，我们在使用相对路径时，应当使用相对于当前classpath的相对路径。

ClassLoader类的getResource(String name),getResourceAsStream(String name)等方法，使用相对于当前项目的classpath的相对路径来查找资源。

读取属性文件经常使用到的ResourceBundle类的getBundle(String path)也是如此。

通过查看ClassLoader类及其相关类的源码，我发现，它实际上还是使用了URI形式的绝对路径。

通过得到当前classpath的URI形式的绝对路径。构建了相对路径的URI形式的绝对路径。（这个实际上是猜想，由于JDK内部调用了SUN的源码。而这些代码不属于JDK。不是开源的。）

 

相对路径本质上还是绝对路径

因此，归根结底，Java本质上仅仅能使用绝对路径来寻找资源。

全部的相对路径寻找资源的方法。都只是是一些便利方法。只是是API在底层帮助我们构建了绝对路径，从而找到资源的！

 

得到classpath和当前类的绝对路径的一些方法

    以下是一些得到classpath和当前类的绝对路径的一些方法。

你可能须要使用当中的一些方法来得到你须要的资源的绝对路径。

1，FileTest.class.getResource("")

得到的是当前类FileTest.class文件的URI文件夹。

不包含自己！

如：file:/D:/java/eclipse32/workspace/jbpmtest3/bin/com/test/

2，FileTest.class.getResource("/")

得到的是当前的classpath的绝对URI路径。

如：file:/D:/java/eclipse32/workspace/jbpmtest3/bin/

3，Thread.currentThread().getContextClassLoader().getResource("")

得到的也是当前ClassPath的绝对URI路径。

如：file:/D:/java/eclipse32/workspace/jbpmtest3/bin/

4。FileTest.class.getClassLoader().getResource("")

得到的也是当前ClassPath的绝对URI路径。

如：file:/D:/java/eclipse32/workspace/jbpmtest3/bin/

5，ClassLoader.getSystemResource("")

得到的也是当前ClassPath的绝对URI路径。

如：file:/D:/java/eclipse32/workspace/jbpmtest3/bin/

   

我推荐使用Thread.currentThread().getContextClassLoader().getResource("")来得到当前的classpath的绝对路径的URI表示法。

 

Web应用程序中资源的寻址

    上文中说过，当前用户文件夹，即相对于System.getProperty("user.dir")返回的路径。

对于JavaEEserver，这可能是server的某个路径，这个并没有统一的规范！

而不是我们公布的Web应用程序的根文件夹！

这样。在Web应用程序中，我们绝对不能使用相对于当前用户文件夹的相对路径。

在Web应用程序中，我们一般通过ServletContext.getRealPath("/")方法得到Web应用程序的根文件夹的绝对路径。

这样，我们仅仅须要提供相对于Web应用程序根文件夹的路径。就能够构建出定位资源的绝对路径。

这是我们开发Web应用程序时一般所採取的策略。

 

通用的相对路径解决的方法

Java中各种相对路径许多，不easy使用，很easy出错。因此，我编写了一个便利方法。帮助更easy的解决相对路径问题。

 

Web应用程序中使用JavaSE执行的资源寻址问题

在JavaSE程序中，我们一般使用classpath来作为存放资源的目的地。可是。在Web应用程序中。我们一般使用classpath外面的WEB-INF及其子文件夹作为资源文件的存放地。

在Web应用程序中，我们一般通过ServletContext.getRealPath("/")方法得到Web应用程序的根文件夹的绝对路径。这样，我们仅仅须要提供相对于Web应用程序根文件夹的路径。就能够构建出定位资源的绝对路径。

Web应用程序，能够作为Web应用程序进行公布和执行。可是，我们也经常会以JavaSE的方式来执行Web应用程序的某个类的main方法。

或者，使用JUnit測试。这都须要使用JavaSE的方式来执行。

这样，我们就无法使用ServletContext.getRealPath("/")方法得到Web应用程序的根文件夹的绝对路径。

而JDK提供的ClassLoader类。

它的getResource(String name),getResourceAsStream(String name)等方法。使用相对于当前项目的classpath的相对路径来查找资源。

读取属性文件经常使用到的ResourceBundle类的getBundle(String path)也是如此。

它们都仅仅能使用相对路径来读取classpath下的资源。无法定位到classpath外面的资源。

Classpath外配置文件读取问题

如，我们使用測试驱动开发的方法，开发Spring、Hibernate、iBatis等使用配置文件的Web应用程序。就会遇到问题。

虽然Spring自己提供了FileSystem（也就是相对于user,dir文件夹）来读取Web配置文件的方法。可是终究不是非常方便。并且与Web程序中的代码使用方式不一致。

至于Hibernate，iBatis就更麻烦了！仅仅有把配置文件移到classpath下，否则根本不可能使用測试驱动开发！

 

    这怎么办？

 

通用的相对路径解决的方法

面对这个问题。我决定编写一个助手类ClassLoaderUtil，提供一个便利方法[public static URL getExtendResource(String relativePath)]。

在Web应用程序等一切Java程序中，须要定位classpath外的资源时。都使用这个助手类的便利方法，而不使用Web应用程序特有的ServletContext.getRealPath("/")方法来定位资源。

 

利用classpath的绝对路径，定位全部资源

这个便利方法的实现原理，就是“利用classpath的绝对路径，定位全部资源”。

ClassLoader类的getResource("")方法可以得到当前classpath的绝对路径，这是全部Java程序都拥有的能力。具有最大的适应性。

而眼下的JDK提供的ClassLoader类的getResource(String 相对路径)方法，仅仅能接受一般的相对路径。这样。使用ClassLoader类的getResource(String 相对路径)方法就仅仅能定位到classpath下的资源。

假设，它可以接受“../”这种參数，同意我们用相对路径来定位classpath外面的资源，那么我们就行定位位置的资源！

当然，我无法改动ClassLoader类的这种方法。于是。我编写了一个助手类ClassLoaderUtil类。提供了[public static URL getExtendResource(String relativePath)]这种方法。它可以接受带有“../”符号的相对路径，实现了自由寻找资源的功能。

 

通过相对classpath路径实现自由寻找资源的助手类的源码：

import java.io.IOException;

import java.io.InputStream;

import java.net.MalformedURLException;

import java.net.URL;

import java.util.Properties;

 

import org.apache.commons.logging.Log;

import org.apache.commons.logging.LogFactory;

 

/**

 *@author沈东良[email protected]

 *Nov29,2006 10:34:34AM

 *用来载入类，ｃｌａｓｓｐａｔｈ下的资源文件，属性文件等。

 *getExtendResource(StringrelativePath)方法。能够使用../符号来载入classpath外部的资源。

 */

publicclass ClassLoaderUtil {

    privatestatic Log log=LogFactory.getLog(ClassLoaderUtil.class);

    /**

     *Thread.currentThread().getContextClassLoader().getResource("")

     */

   

    /**

     *载入Java类。 使用全限定类名

     *@paramclassName

     *@return

     */

    publicstatic Class loadClass(String className) {

        try {

          return getClassLoader().loadClass(className);

        } catch (ClassNotFoundException e) {

          thrownew RuntimeException("class not found ‘"+className+"‘", e);

        }

     }

     /**

       *得到类载入器

       *@return

       */

     publicstatic ClassLoader getClassLoader() {

     

        return ClassLoaderUtil.class.getClassLoader();

     }

     /**

       *提供相对于classpath的资源路径。返回文件的输入流

       *@paramrelativePath必须传递资源的相对路径。

是相对于classpath的路径。假设须要查找classpath外部的资源。须要使用../来查找

       *@return 文件输入流

     *@throwsIOException

     *@throwsMalformedURLException

       */

     publicstatic InputStream getStream(String relativePath) throws MalformedURLException, IOException {

         if(!relativePath.contains("../")){

             return getClassLoader().getResourceAsStream(relativePath);

             

         }else{

             return ClassLoaderUtil.getStreamByExtendResource(relativePath);

         }

       

     }

     /**

       *

       *@paramurl

       *@return

       *@throwsIOException

       */

     publicstatic InputStream getStream(URL url) throws IOException{

         if(url!=null){

             

                return url.openStream();

           

             

         }else{

             returnnull;

         }

     }

     /**

       *

       *@paramrelativePath必须传递资源的相对路径。是相对于classpath的路径。假设须要查找classpath外部的资源。须要使用../来查找

       *@return

       *@throwsMalformedURLException

       *@throwsIOException

       */

     publicstatic InputStream getStreamByExtendResource(String relativePath) throws MalformedURLException, IOException{

        return ClassLoaderUtil.getStream(ClassLoaderUtil.getExtendResource(relativePath));

         

         

     }

     

      /**

       *提供相对于classpath的资源路径。返回属性对象，它是一个散列表

       *@paramresource

       *@return

       */

     publicstatic Properties getProperties(String resource) {

        Properties properties = new Properties();

        try {

          properties.load(getStream(resource));

        } catch (IOException e) {

          thrownew RuntimeException("couldn‘t load properties file ‘"+resource+"‘", e);

        }

        return properties;

     }

     /**

       *得到本Class所在的ClassLoader的Classpat的绝对路径。

       *URL形式的

       *@return

       */

     publicstatic String getAbsolutePathOfClassLoaderClassPath(){

         

         

         ClassLoaderUtil.log.info(ClassLoaderUtil.getClassLoader().getResource("").toString());

         return ClassLoaderUtil.getClassLoader().getResource("").toString();

         

     }

     /**

       *

       *@paramrelativePath 必须传递资源的相对路径。

是相对于classpath的路径。假设须要查找classpath外部的资源，须要使用../来查找

       *@return资源的绝对URL

     *@throwsMalformedURLException

       */

     publicstatic URL getExtendResource(String relativePath) throws MalformedURLException{

     

         ClassLoaderUtil.log.info("传入的相对路径："+relativePath) ;

         //ClassLoaderUtil.log.info(Integer.valueOf(relativePath.indexOf("../"))) ;

         if(!relativePath.contains("../")){

             return ClassLoaderUtil.getResource(relativePath);

             

         }

         String classPathAbsolutePath=ClassLoaderUtil.getAbsolutePathOfClassLoaderClassPath();

         if(relativePath.substring(0, 1).equals("/")){

             relativePath=relativePath.substring(1);

         }

         ClassLoaderUtil.log.info(Integer.valueOf(relativePath.lastIndexOf("../"))) ;

       

         String wildcardString=relativePath.substring(0,relativePath.lastIndexOf("../")+3);

        relativePath=relativePath.substring(relativePath.lastIndexOf("../")+3);

         int containSum=ClassLoaderUtil.containSum(wildcardString, "../");

         classPathAbsolutePath= ClassLoaderUtil.cutLastString(classPathAbsolutePath, "/", containSum);

         String resourceAbsolutePath=classPathAbsolutePath+relativePath;

         ClassLoaderUtil.log.info("绝对路径："+resourceAbsolutePath) ;

         URL resourceAbsoluteURL=new URL(resourceAbsolutePath);

         return resourceAbsoluteURL;

     }

     /**

      *

       *@paramsource

       *@paramdest

       *@return

       */

     privatestaticint containSum(String source,String dest){

         int containSum=0;

         int destLength=dest.length();

         while(source.contains(dest)){

             containSum=containSum+1;

             source=source.substring(destLength);

             

         }

         

         

         return containSum;

     }

     /**

       *

       *@paramsource

       *@paramdest

       *@paramnum

       *@return

       */

     privatestatic String cutLastString(String source,String dest,int num){

         // String cutSource=null;

         for(int i=0;i<num;i++){

             source=source.substring(0, source.lastIndexOf(dest, source.length()-2)+1);

             

             

         }

         

         

         

         return source;

     }

     /**

       *

       *@paramresource

       *@return

       */

      publicstatic URL getResource(String resource){

      ClassLoaderUtil.log.info("传入的相对于classpath的路径："+resource) ;

         return ClassLoaderUtil.getClassLoader().getResource(resource);

     }

    

 

     

 

    /**

     *@paramargs

     *@throwsMalformedURLException

     */

    publicstaticvoid main(String[] args) throws MalformedURLException {

       

            //ClassLoaderUtil.getExtendResource("../spring/dao.xml");

        //ClassLoaderUtil.getExtendResource("../../../src/log4j.properties");

        ClassLoaderUtil.getExtendResource("log4j.properties");

       

        System.out.println(ClassLoaderUtil.getClassLoader().getResource("log4j.properties").toString());

 

    }

 

}

 

后记

ClassLoaderUtil类的public static URL getExtendResource(String relativePath)，尽管非常easy。可是确实能够解决大问题。

只是这种方法还是比較简陋的。

我还想在未来有空时，进一步增强它的能力。比方，添加Ant风格的匹配符。用**代表多个文件夹。*代表多个字符，？代表一个字符。达到Spring那样的能力。一次返回多个资源的URL。进一步方便大家开发。

 

总结：

1。尽量不要使用相对于System.getProperty("user.dir")当前用户文件夹的相对路径。这是一颗定时炸弹。随时可能要你的命。

2，尽量使用URI形式的绝对路径资源。它能够非常easy的转变为URI,URL。File对象。

3，尽量使用相对classpath的相对路径。不要使用绝对路径。

使用上面ClassLoaderUtil类的public static URL getExtendResource(String relativePath)方法已经可以使用相对于classpath的相对路径定位全部位置的资源。

4。绝对不要使用硬编码的绝对路径。由于，我们全然能够使用ClassLoader类的getResource("")方法得到当前classpath的绝对路径。

使用硬编码的绝对路径是全然没有必要的。它一定会让你死的非常难看！

程序将无法移植。

假设你一定要指定一个绝对路径，那么使用配置文件，也比硬编码要好得多！

当然，我还是推荐你使用程序得到classpath的绝对路径来拼资源的绝对路径！