JAVA檔案中擷取路徑及WEB應用程式擷取路徑方法

標籤：

原文地址:http://my.oschina.net/xianggao/blog/85172?fromerr=WnWLB6aV

 

1. 基本概念的理解

`絕對路徑`：你應用上的檔案或目錄在硬碟上真正的路徑，如：URL、實體路徑

例如：

c:/xyz/test.txt代表了test.txt檔案的絕對路徑；

http://www.sun.com/index.htm也代表了一個URL絕對路徑；

`相對路徑`：相對與某個基準目錄的路徑，包含Web的相對路徑（HTML中的相對目錄）。

例如：

在Servlet中，"/"代表Web應用的根目錄，和實體路徑的相對錶示。

例如：

"./"代表目前的目錄，"../"代表上級目錄。這種類似的表示，也是屬於相對路徑。

2. 關於JSP/Servlet中的相對路徑和絕對路徑。 2.1 伺服器端的地址

`伺服器端的相對位址`：指的是相對於你的web應用的地址，這個地址是在伺服器端解析的（不同於html和javascript中的相對位址，他們是由用戶端瀏覽器解析的）也就是說這時候在jsp和servlet中的相對位址應該是相對於你的web應用，即相對於http://192.168.0.1/webapp/的。

其用到的地方有：

`forward：servlet中的request.getRequestDispatcher(address);`這個address是在伺服器端解析的，所以，你要forward到a.jsp應該這麼寫：

`request.getRequestDispatcher(“/user/a.jsp”)`這個/相對於當前的web應用webapp，其絕對位址就是：http://192.168.0.1/webapp/user/a.jsp。

2.2 用戶端的地址

`所有的html頁面中的相對位址`都是相對於伺服器根目錄(http://192.168.0.1/)的，而不是(根目錄下的該Web應用的目錄)http://192.168.0.1/webapp/的。

`Html中的form表單的action屬性的地址`應該是相對於伺服器根目錄(http://192.168.0.1/)的，所以，如果提交到a.jsp為：action＝"/webapp/user/a.jsp"或action="/user/a.jsp"，提交到servlet為action＝"/webapp/handleservlet"。

Javascript也是在用戶端解析的，所以其相對路徑和form表單一樣。

因此，一般情況下，在JSP/HTML頁面等引用的CSS，Javascript，Action等屬性前面最好都加上webapp應用程式名稱，以確保所引用的檔案都屬於Web應用中的目錄。

另外，應該盡量避免使用類似"."，"./"，"../../"等類似的相對該檔案位置的相對路徑，這樣當檔案移動時，很容易出問題。

3. JSP/Servlet中獲得當前應用的相對路徑和絕對路徑 3.1 JSP中獲得當前應用的相對路徑和絕對路徑

根目錄所對應的絕對路徑：`request.getRequestURI();`

檔案的絕對路徑：`application.getRealPath(request.getRequestURI());`

當前web應用的絕對路徑：`application.getRealPath("/");`

取得請求檔案的上層目錄:`newFile(application.getRealPath(request.getRequestURI())).getParent();`

3.2 Servlet中獲得當前應用的相對路徑和絕對路徑

根目錄所對應的絕對路徑：`request.getServletPath();`

檔案的絕對路徑：`request.getSession().getServletContext().getRealPath();`

當前web應用的絕對路徑：`servletConfig.getServletContext().getRealPath("/");`

ServletContext對象獲得幾種方式：

 

javax.servlet.http.HttpSession.getServletContext()javax.servlet.jsp.PageContext.getServletContext()javax.servlet.ServletConfig.getServletContext()

 

  4. java的Class中獲得相對路徑，絕對路徑的方法 4.1 單獨的Java類中獲得絕對路徑

根據java.io.File的Doc文擋，可知：`預設情況下newFile("/")代表的目錄為：System.getProperty("user.dir");`。

以下程式獲得執行類的當前路徑：

 

package org.cheng.file; import java.io.File; public class FileTest{     public static void main(String[]args)throws Exception{         System.out.println(Thread.currentThread().getContextClassLoader().getResource(""));         System.out.println(FileTest.class.getClassLoader().getResource(""));         System.out.println(ClassLoader.getSystemResource(""));         System.out.println(FileTest.class.getResource(""));         System.out.println(FileTest.class.getResource("/"));//Class檔案所在路徑         System.out.println(newFile("/").getAbsolutePath());         System.out.println(System.getProperty("user.dir"));     } }

 

 

4.2 伺服器中的Java類獲得當前路徑（來自網路）

(1).Weblogic

WebApplication的系統檔案根目錄是你的weblogic安裝所在根目錄。

例如：如果你的weblogic安裝在c:eaweblogic700.....

那麼，你的檔案根路徑就是c:.

所以，有兩種方式能夠讓你訪問你的伺服器端的檔案：

a.使用絕對路徑：

比如將你的參數檔案放在c:yourconfig/yourconf.properties，

直接使用newFileInputStream("yourconfig/yourconf.properties");

b.使用相對路徑：

相對路徑的根目錄就是你的webapplication的根路徑，即WEB-INF的上一級目錄，將你的參數檔案放在yourwebapp/yourconfig/yourconf.properties，

這樣使用：

newFileInputStream("./yourconfig/yourconf.properties");

這兩種方式均可，自己選擇。

(2).Tomcat

在類中輸出System.getProperty("user.dir");顯示的是%Tomcat_Home%/bin

(4).如何讀相對路徑哪？

在Java檔案中getResource或getResourceAsStream均可

例：`getClass().getResourceAsStream(filePath);` // filePath可以是"/filename",這裡的/代表web發布根路徑下WEB-INF/classes

預設使用該方法的路徑是：WEB-INF/classes。已經在Tomcat中測試。

5.讀取檔案時的相對路徑，避免寫入程式碼和絕對路徑的使用。 5.1採用Spring的DI機制獲得檔案，避免寫入程式碼。

 

Java中使用的路徑，分為兩種：絕對路徑和相對路徑。具體而言，又分為四種：

（1）URI形式的絕對資源路徑

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

URL是URI的特例。URL的首碼/協議，必須是Java認識的。URL可以開啟資源，而URI則不行。

URL和URI對象可以互相轉換，使用各自的toURI(),toURL()方法即可！

（2）本地系統的絕對路徑

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

Java.io包中的類，需要使用這種形式的參數。但是，它們一般也提供了URI類型的參數，而URI類型的參數，接受的是URI樣式的String。因此，通過URI轉換，還是可以把URI樣式的絕對路徑用在java.io包中的類中。

（3）相對於classpath的相對路徑

如：相對於 file:/D:/java/eclipse32/workspace/jbpmtest3/bin/這個路徑的相對路徑。其中，bin是本項目的classpath。所有的Java源檔案編譯後的.class檔案複製到這個目錄中。

（4）相對於目前使用者目錄的相對路徑

就是相對於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和當前類的絕對路徑的一些方法。你可能需要使用其中的一些方法來得到你需要的資源的絕對路徑。

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`，提供一個便利方法[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)]這個方法。它能夠接受帶有“../”符號的相對路徑，實現了自由尋找資源的功能。

JAVA檔案中擷取路徑及WEB應用程式擷取路徑方法