|
利用classpath的絕對(duì)路徑，定位所有資源
這個(gè)便利方法的實(shí)現(xiàn)原理，就是“利用classpath的絕對(duì)路徑，定位所有資源”。
ClassLoader類(lèi)的getResource("")方法能夠得到當(dāng)前classpath的絕對(duì)路徑，這是所有Java程序都擁有的能力，具有最大的適應(yīng)性！
而目前的JDK提供的ClassLoader類(lèi)的getResource(String 相對(duì)路徑)方法，只能接受一般的相對(duì)路徑。這樣，使用ClassLoader類(lèi)的getResource(String 相對(duì)路徑)方法就只能定位到classpath下的資源。
如果，它能夠接受“../”這樣的參數(shù)，允許我們用相對(duì)路徑來(lái)定位classpath外面的資源，那么我們就可以定位位置的資源！
當(dāng)然，我無(wú)法修改ClassLoader類(lèi)的這個(gè)方法，于是，我編寫(xiě)了一個(gè)助手類(lèi)ClassLoaderUtil類(lèi)，提供了[public static URL getExtendResource(String relativePath)]這個(gè)方法。它能夠接受帶有“../”符號(hào)的相對(duì)路徑，實(shí)現(xiàn)了自由尋找資源的功能。
通過(guò)相對(duì)classpath路徑實(shí)現(xiàn)自由尋找資源的助手類(lèi)的源代碼：
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
*用來(lái)加載類(lèi)，classpath下的資源文件，屬性文件等。
*getExtendResource(StringrelativePath)方法，
*可以使用../符號(hào)來(lái)加載classpath外部的資源。
*/
publicclass ClassLoaderUtil {
privatestatic Log log=LogFactory.getLog(ClassLoaderUtil.class);
/**
*Thread.currentThread().getContextClassLoader().getResource("")
*/
/**
*加載Java類(lèi)。 使用全限定類(lèi)名
*@paramclassName
*@return
*/
publicstatic Class loadClass(String className) {
try {
return getClassLoader().loadClass(className);
} catch (ClassNotFoundException e) {
thrownew RuntimeException("class not found '"+className+"'", e);
}
}
/**
*得到類(lèi)加載器
*@return
*/
publicstatic ClassLoader getClassLoader() {
return ClassLoaderUtil.class.getClassLoader();
}
/**
*提供相對(duì)于classpath的資源路徑，返回文件的輸入流
*@paramrelativePath必須傳遞資源的相對(duì)路徑。
*@是相對(duì)于classpath的路徑。
*@如果需要查找classpath外部的資源，需要使用../來(lái)查找
*@return 文件輸入流
*@throwsIOException
*@throwsMalformedURLException
*/
publicstatic InputStream getStream(String relativePath)
throws MalformedURLException, IOException {
if(!relativePath.contains("../")){
return getClassLoader().getResourceAsStream(relativePath);
}else{
return ClassLoaderUtil.getStreamByExtendResource(relativePath);
}
}
/**
*
*@paramurl
*@return
*@throwsIOException
*/
publicstatic InputStream getStream(URL url) throws IOException{
if(url!=null){
return url.openStream();
}else{
returnnull;
}
}
/**
*
*@paramrelativePath必須傳遞資源的相對(duì)路徑。是相對(duì)于classpath的路徑。
*@如果需要查找classpath外部的資源，需要使用../來(lái)查找
*@return
*@throwsMalformedURLException
*@throwsIOException
*/
publicstatic InputStream getStreamByExtendResource(String relativePath)
throws MalformedURLException, IOException{
return ClassLoaderUtil.getStream(
ClassLoaderUtil.getExtendResource(relativePath));
}
/**
*提供相對(duì)于classpath的資源路徑，返回屬性對(duì)象，它是一個(gè)散列表
*@paramresource
*@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的絕對(duì)路徑。
*URL形式的
*@return
*/
publicstatic String getAbsolutePathOfClassLoaderClassPath(){
ClassLoaderUtil.log.info(
ClassLoaderUtil.getClassLoader().getResource("").toString());
return ClassLoaderUtil.getClassLoader().getResource("").toString();
}
/**
*
*@paramrelativePath 必須傳遞資源的相對(duì)路徑。是相對(duì)于classpath的路徑。
*@如果需要查找classpath外部的資源，需要使用../來(lái)查找
*@return資源的絕對(duì)URL
*@throwsMalformedURLException
*/
publicstatic 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(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("絕對(duì)路徑："+resourceAbsolutePath) ;
URL resourceAbsoluteURL=new URL(resourceAbsolutePath);
return resourceAbsoluteURL;
}
/**
*
*@paramsource
*@paramdest
*@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;
}
/**
*
*@paramsource
*@paramdest
*@paramnum
*@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;
}
/**
*
*@paramresource
*@return
*/
publicstatic URL getResource(String resource){
ClassLoaderUtil.log.info("傳入的相對(duì)于classpath的路徑："+resource) ;
return ClassLoaderUtil.getClassLoader().getResource(resource);
}
/**
*@paramargs
*@throwsMalformedURLException
*/
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類(lèi)的public static URL getExtendResource(String relativePath)，雖然很簡(jiǎn)單，但是確實(shí)可以解決大問(wèn)題。
不過(guò)這個(gè)方法還是比較簡(jiǎn)陋的。我還想在未來(lái)有空時(shí)，進(jìn)一步增強(qiáng)它的能力。比如，增加Ant風(fēng)格的匹配符。用**代表多個(gè)目錄，*代表多個(gè)字符，？代表一個(gè)字符。達(dá)到Spring那樣的能力，一次返回多個(gè)資源的URL，進(jìn)一步方便大家開(kāi)發(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類(lèi)的public static URL getExtendResource(String relativePath)方法已經(jīng)能夠使用相對(duì)于classpath的相對(duì)路徑定位所有位置的資源。
4.絕對(duì)不要使用硬編碼的絕對(duì)路徑。因?yàn)椋覀兺耆梢允褂肅lassLoader類(lèi)的getResource("")方法得到當(dāng)前classpath的絕對(duì)路徑。
使用硬編碼的絕對(duì)路徑是完全沒(méi)有必要的！它一定會(huì)讓你死的很難看！程序?qū)o(wú)法移植！
如果你一定要指定一個(gè)絕對(duì)路徑，那么使用配置文件，也比硬編碼要好得多！
當(dāng)然，我還是推薦你使用程序得到classpath的絕對(duì)路徑來(lái)拼資源的絕對(duì)路徑！
|