|
前言 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，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)]这个方法。它能够接受带有“../”符号的相对路径，实现了自由寻找资源的功能。 通过相对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 *nov29,2006 10:34:34am *用来加载类，ｃｌａｓｓｐａｔｈ下的资源文件，属性文件等。 *getextendresource(stringrelativepath)方法，可以使用../符号来加载classpath外部的资源。 */ publicclass classloaderutil { privatestatic log log=logfactory.getlog(classloaderutil.class); /** *thread.currentthread().getcontextclassloader().getresource("") */ /** *加载java类。 使用全限定类名 *@paramclassname *@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的资源路径，返回文件的输入流 *@paramrelativepath必须传递资源的相对路径。是相对于classpath的路径。如果需要查找classpath外部的资源，需要使用../来查找 *@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必须传递资源的相对路径。是相对于classpath的路径。如果需要查找classpath外部的资源，需要使用../来查找 *@return *@throwsmalformedurlexception *@throwsioexception */ publicstatic inputstream getstreambyextendresource(string relativepath) throws malformedurlexception, ioexception{ return classloaderutil.getstream(classloaderutil.getextendresource(relativepath)); } /** *提供相对于classpath的资源路径，返回属性对象，它是一个散列表 *@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的绝对路径。 *url形式的 *@return */ publicstatic string getabsolutepathofclassloaderclasspath(){ classloaderutil.log.info(classloaderutil.getclassloader().getresource("").tostring()); return classloaderutil.getclassloader().getresource("").tostring(); }
/** * *@paramrelativepath 必须传递资源的相对路径。是相对于classpath的路径。如果需要查找classpath外部的资源，需要使用../来查找 *@return资源的绝对url *@throwsmalformedurlexception */ 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; } /** * *@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("传入的相对于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类的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的绝对路径来拼资源的绝对路径！
|
