JAVA路径操作的详解

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. 1.FileTest.class.getResource("")   
2. 得到的是当前类FileTest.class文件的URI目录。不包括自己！   
3. 如：file:/D:/java/eclipse32/workspace/jbpmtest3/bin/com/test/   
4. 2.FileTest.class.getResource("/")   
5. 得到的是当前的classpath的绝对URI路径。   
6. 如：file:/D:/java/eclipse32/workspace/jbpmtest3/bin/   
7. 3.Thread.currentThread().getContextClassLoader().getResource("")   
8. 得到的也是当前ClassPath的绝对URI路径。   
9. 如：file:/D:/java/eclipse32/workspace/jbpmtest3/bin/   
10. 4.FileTest.class.getClassLoader().getResource("")   
11. 得到的也是当前ClassPath的绝对URI路径。   
12. 如：file:/D:/java/eclipse32/workspace/jbpmtest3/bin/   
13. 5.ClassLoader.getSystemResource("")   
14. 得到的也是当前ClassPath的绝对URI路径。   
15. 如：file:/D:/java/eclipse32/workspace/jbpmtest3/bin/   
16. 我推荐使用Thread.currentThread().getContextClassLoader().getResource("")来得到当前的classpath的绝对路径的URI表示法。   

 

　　Web应用程序中资源的寻址

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

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

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

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

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

　　这样，我们只需要提供相对于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路径实现自由寻找资源的助手类的源代码： 

Java代码  

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

 

　　后记

　　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的绝对路径来拼资源的绝对路径！

1.如何获得当前文件路径 
常用： 
字符串类型：System.getProperty("user.dir"); 
综合： 

Java代码  

1. package com.zcjl.test.base;   
2. import java.io.File;   
3. public class Test {   
4.     public static void main(String[] args) throws Exception {   
5.         System.out.println(   
6.             Thread.currentThread().getContextClassLoader().getResource(""));   
7.         System.out.println(Test.class.getClassLoader().getResource(""));   
8.         System.out.println(ClassLoader.getSystemResource(""));   
9.         System.out.println(Test.class.getResource(""));   
10.         System.out.println(Test.class.getResource("/"));   
11.         System.out.println(new File("").getAbsolutePath());   
12.         System.out.println(System.getProperty("user.dir"));   
13.     }   
14. }   
15. file:/E:/workSpace/javaTest/target/classes/   
16. file:/E:/workSpace/javaTest/target/classes/   
17. file:/E:/workSpace/javaTest/target/classes/   
18. file:/E:/workSpace/javaTest/target/classes/javaAPI/   
19. file:/E:/workSpace/javaTest/target/classes/   
20. E:\workSpace\javaTest   
21. E:\workSpace\javaTest   

 

2.Web服务中 
(1).Weblogic 
WebApplication的系统文件根目录是你的weblogic安装所在根目录。 
例如：如果你的weblogic安装在c:\bea\weblogic700..... 
那么，你的文件根路径就是c:\. 
所以，有两种方式能够让你访问你的服务器端的文件： 
a.使用绝对路径： 
比如将你的参数文件放在c:\yourconfig\yourconf.properties， 
直接使用 new FileInputStream("/yourconfig/yourconf.properties"); 
b.使用相对路径： 
相对路径的根目录就是你的webapplication的根路径，即WEB-INF的上一级目录，将你的参数文件放在yourwebapp\yourconfig\yourconf.properties， 
这样使用： 
new FileInputStream("yourconfig/yourconf.properties"); 
这两种方式均可，自己选择。 
(2).Tomcat 
在类中输出System.getProperty("user.dir");显示的是%Tomcat_Home%/bin 
(3).Resin 
不是你的JSP放的相对路径,是JSP引擎执行这个JSP编译成SERVLET 
的路径为根.比如用新建文件法测试File f = new File("a.htm"); 
这个a.htm在resin的安装目录下 
(4).如何读相对路径哪？ 
在Java文件中getResource或getResourceAsStream均可 
例：getClass().getResourceAsStream(filePath);//filePath可以是"/filename",这里的/代表web发布根路径下WEB-INF/classes 
也可以getClass().getClassLoader().getResourceAsStream(filePath)//filePath不是带“/”的 
(5).获得文件真实路径 
string  file_real_path=request.getRealPath("mypath/filename");  
通常使用request.getRealPath("/");  
4.遗留问题 
目前new FileInputStream()只会使用绝对路径，相对

Java代码  

1. InputStream in1 = new FileInputStream("abc1.properties"); // 相对路径   
2. InputStream in2 = new FileInputStream("/abc2.properties"); // 绝对路径，E盘下   
3. InputStream in3 = new FileInputStream("e://abc3.properties"); //相对路径   

 

5.按Java文件类型分类读取配置文件 
配 置文件是应用系统中不可缺少的，可以增加程序的灵活性。java.util.Properties是从jdk1.2就有的类，一直到现在都支持load ()方法，jdk1.4以后save(output,string) ->store(output,string)

。如果只是单纯的读，根本不存在烦恼的问题。web层可以通过 Thread.currentThread().getContextClassLoader(). 
getResourceAsStream("xx.properties") 获取； 
Application可以通过new FileInputStream("xx.properties");直接在classes一级获取。关键是有时我们需要通过web修改配置文件，我们不 能将路径写死了。经过测试觉得有以下心得： 
1.servlet中读写。如果运用Struts 或者Servlet可以直接在初始化参数中配置，调用时根据servlet的getRealPath("/")获取真实路径，再根据String file = this.servlet.getInitParameter("abc");

获取相对的WEB-INF的相对路径。 
例： 

Java代码  

1. InputStream input = Thread.currentThread().getContextClassLoader().   
2. getResourceAsStream("abc.properties");   
3. Properties prop = new Properties();   
4. prop.load(input);   
5. input.close();   
6. OutputStream out = new FileOutputStream(path);   
7. prop.setProperty("abc", “test");   
8. prop.store(out, “–test–");   
9. out.close();   

 

2.直接在jsp中操作，通过jsp内置对象获取可操作的绝对地址。 
例： 

Java代码  

1. // jsp页面   
2. String path = pageContext.getServletContext().getRealPath("/");   
3. String realPath = path+"/WEB-INF/classes/abc.properties";   
4. //java 程序   
5. InputStream in = getClass().getClassLoader().getResourceAsStream("abc.properties"); // abc.properties放在webroot/WEB-INF/classes/目录下   
6. prop.load(in);   
7. in.close();   
8. OutputStream out = new FileOutputStream(path); // path为通过页面传入的路径   
9. prop.setProperty("abc", “abcccccc");   
10. prop.store(out, “–test–");   
11. out.close();   
12. 3.只通过Java程序操作资源文件   
13. InputStream in = new FileInputStream("abc.properties"); // 相对路径,项目下的路径   
14. OutputStream out = new FileOutputStream("abc.properties");