Java路径问题总结

原文出处http://java.chinaitlab.com/base/532062.html

前言

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")返回的路径。

对于一般项目，这是项目的根路径。对于JavaEE服务器，这可能是服务器的某个路径。这个并没有统一的规范！

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

默认情况下，java.io 包中的类总是根据当前用户目录来分析相对路径名。此目录由系统属性 user.dir 指定，通常是 Java 虚拟机的调用目录。

这就是说，在使用java.io包中的类时，最好不要使用相对路径。否则，虽然在J2SE应用程序中可能还算正常，但是到了J2EE程序中，一定会出问题！而且这个路径，在不同的服务器中都是不同的！

相对路径最佳实践

推荐使用相对于当前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")返回的路径。

对于JavaEE服务器，这可能是服务器的某个路径，这个并没有统一的规范！

而不是我们发布的Web应用程序的根目录！

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

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

这样，我们只需要提供相对于Web应用程序根目录的路径，就可以构建出定位资源的绝对路径。

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

通用的相对路径解决办法

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

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，提供一个便利方法[publicstatic 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类，提供了[publicstatic URL getExtendResource(String relativePath)]这个方法。它能够接受带有“../”符号的相对路径，实现了自由寻找资源的功能。

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

  1 package utils;
  2 
  3 import java.io.IOException;
  4 import java.io.InputStream;
  5 import java.net.MalformedURLException;
  6 import java.net.URL;
  7 import java.util.Properties;
  8 import org.apache.commons.logging.Log;
  9 import org.apache.commons.logging.LogFactory;
 10 
 11 /**
 12  * 用来加载类，classpath下的资源文件，属性文件等。
 13  * getExtendResource(StringrelativePath)方法，可以使用../符号来加载classpath外部的资源。
 14  */
 15 public class ClassLoaderUtil {
 16     private static Log logger = LogFactory.getLog(ClassLoaderUtil.class);
 17 
 18     /** *Thread.currentThread().getContextClassLoader().getResource("") */
 19     /**
 20      * 加载Java类。 使用全限定类名
 21      * 
 22      * @paramclassName
 23      * @return
 24      */
 25     public static Class loadClass(String className) {
 26         try {
 27             return getClassLoader().loadClass(className);
 28         } catch (ClassNotFoundException e) {
 29             throw new RuntimeException("class not found '" + className + "'", e);
 30         }
 31     }
 32 
 33     /**
 34      * 得到类加载器
 35      * 
 36      * @return
 37      */
 38     public static ClassLoader getClassLoader() {
 39         return ClassLoaderUtil.class.getClassLoader();
 40     }
 41 
 42     /**
 43      * 提供相对于classpath的资源路径，返回文件的输入流
 44      * 
 45      * @param relativePath
 46      *            必须传递资源的相对路径。是相对于classpath的路径。如果需要查找classpath外部的资源，需要使用../来查找
 47      * @return 文件输入流
 48      * @throwsIOException
 49      * @throwsMalformedURLException
 50      */
 51     public static InputStream getStream(String relativePath)
 52             throws MalformedURLException, IOException {
 53         if (!relativePath.contains("../")) {
 54             return getClassLoader().getResourceAsStream(relativePath);
 55         } else {
 56             return ClassLoaderUtil.getStreamByExtendResource(relativePath);
 57         }
 58     }
 59 
 60     /**
 61      * @param url
 62      * @return
 63      * @throwsIOException
 64      */
 65     public static InputStream getStream(URL url) throws IOException {
 66         if (url != null) {
 67             return url.openStream();
 68         } else {
 69             return null;
 70         }
 71     }
 72 
 73     /**
 74      * @param relativePath
 75      *            必须传递资源的相对路径。是相对于classpath的路径。如果需要查找classpath外部的资源，需要使用../来查找
 76      * @return
 77      * @throwsMalformedURLException
 78      * @throwsIOException
 79      */
 80     public static InputStream getStreamByExtendResource(String relativePath)
 81             throws MalformedURLException, IOException {
 82         return ClassLoaderUtil.getStream(ClassLoaderUtil
 83                 .getExtendResource(relativePath));
 84     }
 85 
 86     /**
 87      * 提供相对于classpath的资源路径，返回属性对象，它是一个散列表
 88      * 
 89      * @param resource
 90      * @return
 91      */
 92     public static Properties getProperties(String resource) {
 93         Properties properties = new Properties();
 94         try {
 95             properties.load(getStream(resource));
 96         } catch (IOException e) {
 97             throw new RuntimeException("couldn't load properties file '"
 98                     + resource + "'", e);
 99         }
100         return properties;
101     }
102 
103     /**
104      * 得到本Class所在的ClassLoader的Classpat的绝对路径。 URL形式的
105      * 
106      * @return
107      */
108     public static String getAbsolutePathOfClassLoaderClassPath() {
109         ClassLoaderUtil.logger.info(ClassLoaderUtil.getClassLoader()
110                 .getResource("").toString());
111         return ClassLoaderUtil.getClassLoader().getResource("").toString();
112     }
113 
114     /**
115      * @param relativePath
116      *            必须传递资源的相对路径。是相对于classpath的路径。如果需要查找classpath外部的资源，需要使用../来查找
117      * @return 资源的绝对URL
118      * @throwsMalformedURLException
119      */
120     public static URL getExtendResource(String relativePath)
121             throws MalformedURLException {
122         ClassLoaderUtil.logger.info("传入的相对路径：" + relativePath);
123         // ClassLoaderUtil.log.info(Integer.valueOf(relativePath.indexOf("../")))
124         // ;
125         if (!relativePath.contains("../")) {
126             return ClassLoaderUtil.getResource(relativePath);
127         }
128         String classPathAbsolutePath = ClassLoaderUtil
129                 .getAbsolutePathOfClassLoaderClassPath();
130         if (relativePath.substring(0, 1).equals("/")) {
131             relativePath = relativePath.substring(1);
132         }
133         ClassLoaderUtil.logger.info(Integer.valueOf(relativePath
134                 .lastIndexOf("../")));
135         String wildcardString = relativePath.substring(0,
136                 relativePath.lastIndexOf("../") + 3);
137         relativePath = relativePath
138                 .substring(relativePath.lastIndexOf("../") + 3);
139         int containSum = ClassLoaderUtil.containSum(wildcardString, "../");
140         classPathAbsolutePath = ClassLoaderUtil.cutLastString(
141                 classPathAbsolutePath, "/", containSum);
142         String resourceAbsolutePath = classPathAbsolutePath + relativePath;
143         ClassLoaderUtil.logger.info("绝对路径：" + resourceAbsolutePath);
144         URL resourceAbsoluteURL = new URL(resourceAbsolutePath);
145         return resourceAbsoluteURL;
146     }
147 
148     /**
149      * @paramsource
150      * @paramdest
151      * @return
152      */
153     private static int containSum(String source, String dest) {
154         int containSum = 0;
155         int destLength = dest.length();
156         while (source.contains(dest)) {
157             containSum = containSum + 1;
158             source = source.substring(destLength);
159         }
160         return containSum;
161     }
162 
163     /**
164      * @paramsource
165      * @paramdest
166      * @paramnum
167      * @return
168      */
169     private static String cutLastString(String source, String dest, int num) {
170         // String cutSource=null;
171         for (int i = 0; i < num; i++) {
172             source = source.substring(0,
173                     source.lastIndexOf(dest, source.length() - 2) + 1);
174         }
175         return source;
176     }
177 
178     /**
179      * @paramresource
180      * @return
181      */
182     public static URL getResource(String resource) {
183         ClassLoaderUtil.logger.info("传入的相对于classpath的路径：" + resource);
184 
185         return ClassLoaderUtil.getClassLoader().getResource(resource);
186     }
187 
188     /**
189      * @paramargs
190      * @throwsMalformedURLException
191      */
192     public static void main(String[] args) throws MalformedURLException {
193         // ClassLoaderUtil.getExtendResource("../spring/dao.xml");
194         // ClassLoaderUtil.getExtendResource("../../../src/log4j.properties");
195         ClassLoaderUtil.getExtendResource("log4j.properties");
196         System.out.println(ClassLoaderUtil.getClassLoader()
197                 .getResource("log4j.properties").toString());
198     }
199 
200 }

后记

ClassLoaderUtil类的public static URL getExtendResource(String relativePath)，虽然很简单，但是确实可以解决大问题。

不过这个方法还是比较简陋的。我还想在未来有空时，进一步增强它的能力。比如，增加Ant风格的匹配符。用**代表多个目录，*代表多个字符，？代表一个字符。达到Spring那样的能力，一次返回多个资源的URL，进一步方便大家开发。

总结：

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

2，尽量使用URI形式的绝对路径资源。它可以很容易的转变为URI,URL，File对象。

3，尽量使用相对classpath的相对路径。不要使用绝对路径。使用上面ClassLoaderUtil类的public static URL getExtendResource(String relativePath)方法已经能够使用相对于classpath的相对路径定位所有位置的资源。

4，绝对不要使用硬编码的绝对路径。因为，我们完全可以使用ClassLoader类的getResource("")方法得到当前classpath的绝对路径。

使用硬编码的绝对路径是完全没有必要的！它一定会让你死的很难看！程序将无法移植！

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

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