posts - 19, comments - 53, trackbacks - 0, articles - 283
            BlogJava :: 首頁 :: 新隨筆 :: 聯(lián)系 :: 聚合  :: 管理
          摘自:http://www.matrix.org.cn/thread.shtml?topicId=6d0bbeed-9157-11db-ab77-2bbe780ebfbf&forumId=19
          Java的路徑問題,非常難搞。最近的工作涉及到創(chuàng)建和讀取文件的工作,這里我就給大家徹底得解決Java路徑問題。
          我編寫了一個(gè)方法,比ClassLoader.getResource(String 相對(duì)路徑)方法的能力更強(qiáng)。它可以接受“../”這樣的參數(shù),允許我們用相對(duì)路徑來定位classpath外面的資源。這樣,我們就可以使用相對(duì)于classpath的路徑,定位所有位置的資源!

          Java路徑
          Java中使用的路徑,分為兩種:絕對(duì)路徑和相對(duì)路徑。具體而言,又分為四種:
          一、URI形式的絕對(duì)資源路徑
          如:file:/D:/java/eclipse32/workspace/jbpmtest3/bin/aaa.b
          URL是URI的特例。URL的前綴/協(xié)議,必須是Java認(rèn)識(shí)的。URL可以打開資源,而URI則不行。
          URL和URI對(duì)象可以互相轉(zhuǎn)換,使用各自的toURI(),toURL()方法即可!

          二、本地系統(tǒng)的絕對(duì)路徑
          D:/java/eclipse32/workspace/jbpmtest3/bin/aaa.b
          Java.io包中的類,需要使用這種形式的參數(shù)。
          但是,它們一般也提供了URI類型的參數(shù),而URI類型的參數(shù),接受的是URI樣式的String。因此,通過URI轉(zhuǎn)換,還是可以把URI樣式的絕對(duì)路徑用在java.io包中的類中。

          三、相對(duì)于classpath的相對(duì)路徑
          如:相對(duì)于
          file:/D:/java/eclipse32/workspace/jbpmtest3/bin/這個(gè)路徑的相對(duì)路徑。其中,bin是本項(xiàng)目的classpath。所有的Java源文件編譯后的.class文件復(fù)制到這個(gè)目錄中。


          四、相對(duì)于當(dāng)前用戶目錄的相對(duì)路徑
          就是相對(duì)于System.getProperty("user.dir")返回的路徑。
          對(duì)于一般項(xiàng)目,這是項(xiàng)目的根路徑。對(duì)于JavaEE服務(wù)器,這可能是服務(wù)器的某個(gè)路徑。這個(gè)并沒有統(tǒng)一的規(guī)范!
          所以,絕對(duì)不要使用“相對(duì)于當(dāng)前用戶目錄的相對(duì)路徑”。然而:
          默認(rèn)情況下,java.io 包中的類總是根據(jù)當(dāng)前用戶目錄來分析相對(duì)路徑名。此目錄由系統(tǒng)屬性 user.dir 指定,通常是 Java 虛擬機(jī)的調(diào)用目錄。
          這就是說,在使用java.io包中的類時(shí),最好不要使用相對(duì)路徑。否則,雖然在J2SE應(yīng)用程序中可能還算正常,但是到了J2EE程序中,一定會(huì)出問題!而且這個(gè)路徑,在不同的服務(wù)器中都是不同的!

          相對(duì)路徑最佳實(shí)踐
          推薦使用相對(duì)于當(dāng)前classpath的相對(duì)路徑
          因此,我們?cè)谑褂孟鄬?duì)路徑時(shí),應(yīng)當(dāng)使用相對(duì)于當(dāng)前classpath的相對(duì)路徑。
          ClassLoader類的getResource(String name),getResourceAsStream(String name)等方法,使用相對(duì)于當(dāng)前項(xiàng)目的classpath的相對(duì)路徑來查找資源。
          讀取屬性文件常用到的ResourceBundle類的getBundle(String path)也是如此。
          通過查看ClassLoader類及其相關(guān)類的源代碼,我發(fā)現(xiàn),它實(shí)際上還是使用了URI形式的絕對(duì)路徑。通過得到當(dāng)前classpath的URI形式的絕對(duì)路徑,構(gòu)建了相對(duì)路徑的URI形式的絕對(duì)路徑。(這個(gè)實(shí)際上是猜想,因?yàn)镴DK內(nèi)部調(diào)用了SUN的源代碼,而這些代碼不屬于JDK,不是開源的。)

          相對(duì)路徑本質(zhì)上還是絕對(duì)路徑
          因此,歸根結(jié)底,Java本質(zhì)上只能使用絕對(duì)路徑來尋找資源。所有的相對(duì)路徑尋找資源的方法,都不過是一些便利方法。不過是API在底層幫助我們構(gòu)建了絕對(duì)路徑,從而找到資源的!

          得到classpath和當(dāng)前類的絕對(duì)路徑的一些方法
              下面是一些得到classpath和當(dāng)前類的絕對(duì)路徑的一些方法。你可能需要使用其中的一些方法來得到你需要的資源的絕對(duì)路徑。
          1,F(xiàn)ileTest.class.getResource("")
          得到的是當(dāng)前類FileTest.class文件的URI目錄。不包括自己!
          如:file:/D:/java/eclipse32/workspace/jbpmtest3/bin/com/test/
          2,F(xiàn)ileTest.class.getResource("/")
          得到的是當(dāng)前的classpath的絕對(duì)URI路徑。
          如:file:/D:/java/eclipse32/workspace/jbpmtest3/bin/
          3,Thread.currentThread().getContextClassLoader().getResource("")
          得到的也是當(dāng)前ClassPath的絕對(duì)URI路徑。
          如:file:/D:/java/eclipse32/workspace/jbpmtest3/bin/
          4,F(xiàn)ileTest.class.getClassLoader().getResource("")
          得到的也是當(dāng)前ClassPath的絕對(duì)URI路徑。
          如:file:/D:/java/eclipse32/workspace/jbpmtest3/bin/
          5,ClassLoader.getSystemResource("")
          得到的也是當(dāng)前ClassPath的絕對(duì)URI路徑。
          如:file:/D:/java/eclipse32/workspace/jbpmtest3/bin/
              
          我推薦使用Thread.currentThread().getContextClassLoader().getResource("")來得到當(dāng)前的classpath的絕對(duì)路徑的URI表示法。

          Web應(yīng)用程序中資源的尋址
              上文中說過,當(dāng)前用戶目錄,即相對(duì)于System.getProperty("user.dir")返回的路徑。
          對(duì)于JavaEE服務(wù)器,這可能是服務(wù)器的某個(gè)路徑,這個(gè)并沒有統(tǒng)一的規(guī)范!
          而不是我們發(fā)布的Web應(yīng)用程序的根目錄!
          這樣,在Web應(yīng)用程序中,我們絕對(duì)不能使用相對(duì)于當(dāng)前用戶目錄的相對(duì)路徑。
          在Web應(yīng)用程序中,我們一般通過ServletContext.getRealPath("/")方法得到Web應(yīng)用程序的根目錄的絕對(duì)路徑。
          這樣,我們只需要提供相對(duì)于Web應(yīng)用程序根目錄的路徑,就可以構(gòu)建出定位資源的絕對(duì)路徑。
          這是我們開發(fā)Web應(yīng)用程序時(shí)一般所采取的策略。

          通用的相對(duì)路徑解決辦法
          Java中各種相對(duì)路徑非常多,不容易使用,非常容易出錯(cuò)。因此,我編寫了一個(gè)便利方法,幫助更容易的解決相對(duì)路徑問題。

          Web應(yīng)用程序中使用JavaSE運(yùn)行的資源尋址問題
          在JavaSE程序中,我們一般使用classpath來作為存放資源的目的地。但是,在Web應(yīng)用程序中,我們一般使用classpath外面的WEB-INF及其子目錄作為資源文件的存放地。
          在Web應(yīng)用程序中,我們一般通過ServletContext.getRealPath("/")方法得到Web應(yīng)用程序的根目錄的絕對(duì)路徑。這樣,我們只需要提供相對(duì)于Web應(yīng)用程序根目錄的路徑,就可以構(gòu)建出定位資源的絕對(duì)路徑。
          Web應(yīng)用程序,可以作為Web應(yīng)用程序進(jìn)行發(fā)布和運(yùn)行。但是,我們也常常會(huì)以JavaSE的方式來運(yùn)行Web應(yīng)用程序的某個(gè)類的main方法?;蛘?,使用JUnit測試。這都需要使用JavaSE的方式來運(yùn)行。
          這樣,我們就無法使用ServletContext.getRealPath("/")方法得到Web應(yīng)用程序的根目錄的絕對(duì)路徑。
          而JDK提供的ClassLoader類,
          它的getResource(String name),getResourceAsStream(String name)等方法,使用相對(duì)于當(dāng)前項(xiàng)目的classpath的相對(duì)路徑來查找資源。
          讀取屬性文件常用到的ResourceBundle類的getBundle(String path)也是如此。
          它們都只能使用相對(duì)路徑來讀取classpath下的資源,無法定位到classpath外面的資源。
          Classpath外配置文件讀取問題
          如,我們使用測試驅(qū)動(dòng)開發(fā)的方法,開發(fā)Spring、Hibernate、iBatis等使用配置文件的Web應(yīng)用程序,就會(huì)遇到問題。
          盡管Spring自己提供了FileSystem(也就是相對(duì)于user,dir目錄)來讀取Web配置文件的方法,但是終究不是很方便。而且與Web程序中的代碼使用方式不一致!
          至于Hibernate,iBatis就更麻煩了!只有把配置文件移到classpath下,否則根本不可能使用測試驅(qū)動(dòng)開發(fā)!

              這怎么辦?

          通用的相對(duì)路徑解決辦法
          面對(duì)這個(gè)問題,我決定編寫一個(gè)助手類ClassLoaderUtil,提供一個(gè)便利方法[public static URL getExtendResource(String relativePath)]。在Web應(yīng)用程序等一切Java程序中,需要定位classpath外的資源時(shí),都使用這個(gè)助手類的便利方法,而不使用Web應(yīng)用程序特有的ServletContext.getRealPath("/")方法來定位資源。

          利用classpath的絕對(duì)路徑,定位所有資源
          這個(gè)便利方法的實(shí)現(xiàn)原理,就是“利用classpath的絕對(duì)路徑,定位所有資源”。
          ClassLoader類的getResource("")方法能夠得到當(dāng)前classpath的絕對(duì)路徑,這是所有Java程序都擁有的能力,具有最大的適應(yīng)性!
          而目前的JDK提供的ClassLoader類的getResource(String 相對(duì)路徑)方法,只能接受一般的相對(duì)路徑。這樣,使用ClassLoader類的getResource(String 相對(duì)路徑)方法就只能定位到classpath下的資源。
          如果,它能夠接受“../”這樣的參數(shù),允許我們用相對(duì)路徑來定位classpath外面的資源,那么我們就可以定位位置的資源!
          當(dāng)然,我無法修改ClassLoader類的這個(gè)方法,于是,我編寫了一個(gè)助手類ClassLoaderUtil類,提供了[public static URL getExtendResource(String relativePath)]這個(gè)方法。它能夠接受帶有“../”符號(hào)的相對(duì)路徑,實(shí)現(xiàn)了自由尋找資源的功能。

          通過相對(duì)classpath路徑實(shí)現(xiàn)自由尋找資源的助手類的源代碼:
          package yixun.wap.tools;

          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 Nov29,2006 10:34:34AM
           *  用來加載類,classpath下的資源文件,屬性文件等。
           *  getExtendResource(StringrelativePath)方法,可以使用../符號(hào)來加載classpath外部的資源。
           
          */

          public class ClassLoaderUtil {
              
          private static Log log = LogFactory.getLog(ClassLoaderUtil.class);

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


              
          /**
               * 加載Java類。 使用全限定類名
               * 
               * @paramclassName
               * 
          @return
               
          */

              
          public static Class loadClass(String className) {
                  
          try {
                      
          return getClassLoader().loadClass(className);
                  }
           catch (ClassNotFoundException e) {
                      
          throw new RuntimeException("class not found '" + className + "'", e);
                  }

              }


              
          /**
               * 得到類加載器
               * 
               * 
          @return
               
          */

              
          public static ClassLoader getClassLoader() {
                  
          return ClassLoaderUtil.class.getClassLoader();
              }


              
          /**
               * 提供相對(duì)于classpath的資源路徑,返回文件的輸入流
               * 
               * @paramrelativePath必須傳遞資源的相對(duì)路徑。是相對(duì)于classpath的路徑。如果需要查找classpath外部的資源,需要使用../來查找
               * 
          @return 文件輸入流
               * @throwsIOException
               * @throwsMalformedURLException
               
          */

              
          public static InputStream getStream(String relativePath)
                      
          throws MalformedURLException, IOException {
                  
          if (!relativePath.contains("../")) {
                      
          return getClassLoader().getResourceAsStream(relativePath);
                  }
           else {
                      
          return ClassLoaderUtil.getStreamByExtendResource(relativePath);
                  }

              }


              
          public static InputStream getStream(URL url) throws IOException {
                  
          if (url != null{
                      
          return url.openStream();
                  }
           else {
                      
          return null;
                  }

              }


              
          /**
               * 
               * @paramrelativePath必須傳遞資源的相對(duì)路徑。是相對(duì)于classpath的路徑。如果需要查找classpath外部的資源,需要使用../來查找
               * 
          @return
               * @throwsMalformedURLException
               * @throwsIOException
               
          */

              
          public static InputStream getStreamByExtendResource(String relativePath) throws MalformedURLException, IOException {
                  
          return ClassLoaderUtil.getStream(ClassLoaderUtil.getExtendResource(relativePath));
              }


              
          /**
               * 提供相對(duì)于classpath的資源路徑,返回屬性對(duì)象,它是一個(gè)散列表
               * 
               * @paramresource
               * 
          @return
               
          */

              
          public static Properties getProperties(String resource) {
                  Properties properties 
          = new Properties();
                  
          try {
                      properties.load(getStream(resource));
                  }
           catch (IOException e) {
                      
          throw new RuntimeException("couldn't load properties file '" + resource + "'", e);
                  }

                  
          return properties;
              }


              
          /**
               * 得到本Class所在的ClassLoader的Classpat的絕對(duì)路徑。 URL形式的
               * 
               * 
          @return
               
          */

              
          public static String getAbsolutePathOfClassLoaderClassPath() {
                  ClassLoaderUtil.log.info(ClassLoaderUtil.getClassLoader().getResource(
          "").toString());
                  
          return ClassLoaderUtil.getClassLoader().getResource("").toString();
              }


              
          /**
               * 
               * @paramrelativePath 必須傳遞資源的相對(duì)路徑。是相對(duì)于classpath的路徑。如果需要查找classpath外部的資源,需要使用../來查找
               * @return資源的絕對(duì)URL
               * @throwsMalformedURLException
               
          */

              
          public static URL getExtendResource(String relativePath) throws MalformedURLException {

                  ClassLoaderUtil.log.info(
          "傳入的相對(duì)路徑:" + relativePath);
                  
          // ClassLoaderUtil.log.info(Integer.valueOf(relativePath.indexOf("../")))
                  
          // ;
                  if (!relativePath.contains("../")) {
                      
          return ClassLoaderUtil.getResource(relativePath);
                  }

                  String classPathAbsolutePath 
          = ClassLoaderUtil.getAbsolutePathOfClassLoaderClassPath();
                  
          if (relativePath.substring(01).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(
          "絕對(duì)路徑:" + resourceAbsolutePath);
                  URL resourceAbsoluteURL 
          = new URL(resourceAbsolutePath);
                  
          return resourceAbsoluteURL;
              }


              
          private static int 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;
              }


              
          private static 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
               
          */

              
          public static URL getResource(String resource) {
                  ClassLoaderUtil.log.info(
          "傳入的相對(duì)于classpath的路徑:" + resource);
                  
          return ClassLoaderUtil.getClassLoader().getResource(resource);
              }


              
          /**
               * @paramargs
               * @throwsMalformedURLException
               
          */

              
          public static void 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),雖然很簡單,但是確實(shí)可以解決大問題。
          不過這個(gè)方法還是比較簡陋的。我還想在未來有空時(shí),進(jìn)一步增強(qiáng)它的能力。比如,增加Ant風(fēng)格的匹配符。用**代表多個(gè)目錄,*代表多個(gè)字符,?代表一個(gè)字符。達(dá)到Spring那樣的能力,一次返回多個(gè)資源的URL,進(jìn)一步方便大家開發(fā)。

          總結(jié):
          1,盡量不要使用相對(duì)于System.getProperty("user.dir")當(dāng)前用戶目錄的相對(duì)路徑。這是一顆定時(shí)炸彈,隨時(shí)可能要你的命。
          2,盡量使用URI形式的絕對(duì)路徑資源。它可以很容易的轉(zhuǎn)變?yōu)閁RI,URL,F(xiàn)ile對(duì)象。
          3,盡量使用相對(duì)classpath的相對(duì)路徑。不要使用絕對(duì)路徑。使用上面ClassLoaderUtil類的public static URL getExtendResource(String relativePath)方法已經(jīng)能夠使用相對(duì)于classpath的相對(duì)路徑定位所有位置的資源。
          4,絕對(duì)不要使用硬編碼的絕對(duì)路徑。因?yàn)?,我們完全可以使用ClassLoader類的getResource("")方法得到當(dāng)前classpath的絕對(duì)路徑。
          使用硬編碼的絕對(duì)路徑是完全沒有必要的!它一定會(huì)讓你死的很難看!程序?qū)o法移植!
          如果你一定要指定一個(gè)絕對(duì)路徑,那么使用配置文件,也比硬編碼要好得多!
          當(dāng)然,我還是推薦你使用程序得到classpath的絕對(duì)路徑來拼資源的絕對(duì)路徑!
          主站蜘蛛池模板: 涪陵区| 湖北省| 凌源市| 丹巴县| 荔波县| 永登县| 平邑县| 库车县| 普格县| 麦盖提县| 赞皇县| 娄底市| 徐汇区| 当雄县| 黔东| 开化县| 廉江市| 宜章县| 佛教| 萝北县| 峡江县| 额尔古纳市| 鸡泽县| 北宁市| 高碑店市| 北票市| 嘉义市| 土默特左旗| 安国市| 沙田区| 松桃| 宣恩县| 法库县| 班玛县| 伊川县| 永登县| 肇东市| 垫江县| 宁波市| 稻城县| 互助|