Java路徑問題終於解決方式—可定位全部資源的相對路徑尋址




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 沈東良 shendl_s@hotmail.com
  * Nov 29, 2006   10:34:34 AM
  * 用來載入類,classpath下的資源文件,屬性文件等。
  * getExtendResource(String relativePath) 方法。能夠使用../符號來載入classpath外部的資源。

  */
publicclass  ClassLoaderUtil {
     privatestatic  Log  log =LogFactory.getLog(ClassLoaderUtil. class );
     /**
      * Thread.currentThread().getContextClassLoader().getResource("")
      */
   
     /**
      * 載入Java類。   使用全限定類名
      * @param className
      * @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的資源路徑。返回文件的輸入流
        * @param relativePath 必須傳遞資源的相對路徑。

是相對於classpath的路徑。假設須要查找classpath外部的資源。須要使用../來查找

        * @return   文件輸入流
      * @throws IOException
      * @throws MalformedURLException
        */
      publicstatic  InputStream getStream(String relativePath)  throws  MalformedURLException, IOException {
          if (!relativePath.contains( "../" )){
              return  getClassLoader().getResourceAsStream(relativePath);
             
         } else {
              return  ClassLoaderUtil.getStreamByExtendResource(relativePath);
         }
       
     }
      /**
        *
        * @param url
        * @return
        * @throws IOException
        */
      publicstatic  InputStream getStream(URL url)  throws  IOException{
          if (url!= null ){
             
                 return  url.openStream();
           
             
         } else {
              returnnull ;
         }
     }
      /**
        *
        * @param relativePath 必須傳遞資源的相對路徑。是相對於classpath的路徑。假設須要查找classpath外部的資源。須要使用../來查找
        * @return
        * @throws MalformedURLException
        * @throws IOException
        */
      publicstatic  InputStream getStreamByExtendResource(String relativePath)  throws  MalformedURLException, IOException{
         return  ClassLoaderUtil.getStream(ClassLoaderUtil.getExtendResource(relativePath));
         
         
     }
     
       /**
        * 提供相對於classpath的資源路徑。返回屬性對象,它是一個散列表
        * @param resource
        * @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();
         
     }
      /**
        *
        * @param relativePath   必須傳遞資源的相對路徑。

是相對於classpath的路徑。假設須要查找classpath外部的資源,須要使用../來查找

        * @return 資源的絕對URL
      * @throws MalformedURLException
        */
      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;
     }
      /**
       *
        * @param source
        * @param dest
        * @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;
     }
      /**
        *
        * @param source
        * @param dest
        * @param num
        * @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;
     }
      /**
        *
        * @param resource
        * @return
        */
       publicstatic  URL getResource(String resource){
      ClassLoaderUtil. log .info( " 傳入的相對於classpath的路徑:" +resource) ;
          return  ClassLoaderUtil.getClassLoader().getResource(resource);
     }
    
 
     
 
     /**
      * @param args
      * @throws MalformedURLException
      */
     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的絕對路徑來拼資源的絕對路徑!


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM