Java 路径问题

最新推荐文章于 2022-08-11 07:10:13 发布

fang·up·ad

最新推荐文章于 2022-08-11 07:10:13 发布

阅读量2.5k

点赞数 2

分类专栏： Java 文章标签： java

本文链接：https://blog.csdn.net/qq_22310551/article/details/124009534

版权

Java 专栏收录该内容

8 篇文章 0 订阅

订阅专栏

Java的路径问题，非常难搞。本文讲解Java路径问题。

一、Java路径

Java中使用的路径，分为两种：绝对路径和相对路径。具体而言，又分为四种：

1. URI 形式的绝对路径

示例：file:/D:/java/eclipse32/workspace/jbpmtest3/classes/aaa.b

URL和URI对象可以互相转换，使用各自的toURI()，toURL()方法

URI 语法
scheme:scheme specific part  =>   模式:模式特定部分  
模式特定部分的表示形式取决于所使用的模式。URI当前的常用模式包括：

        data：链接中直接包含经过BASE64编码的数据。

        file：本地磁盘上的文件。

        ftp：FTP服务器。

        http：使用超文本传输协议。

        mailto：电子邮件的地址。

        magnet：可以通过对等网络(端对端P2P，如BitTorrent)下载的资源。

        telnet：基于Telnet的服务的连接。

        urn：统一资源名(Uniform Resource Name)。

URL语法
protocol://userInfo@host:port/path?query#fragment 协议://用户信息@主机名:端口/路径?查询#片段
protocol：URL中的协议(protocol)是相应于URI中的模式(schema)的另一个叫法。URL中，协议部分可以是file、ftp、http、https、magnet、telnet或者其他定制协议字符串(但是不包括urn)。

userInfo：URL中的用户信息(userInfo)是服务器的登录信息，这部分信息是可选的。如果这部分信息存在，一般会包含一个用户名，极少情况下会包含一个口令。实际上URL携带用户信息是不安全的。

port：URL中的端口号(port)是指服务器中应用的运行端口，默认端口为80，此部分信息是可选的(也就如果不指定端口号就使用默认端口80)。

path：URL中的路径(path)用于表示服务器上的一个特定的目录(其实说一个特定的文件也可以)，这个特定的目录不一定是物理目录，也有可能是逻辑目录。这一点很容易说明，一般不可能把服务器上面的目录直接公开让所有人访问，服务器上面跑的一般是Web(Java的话一般是Servlet)应用，路径指向的实际数据来源甚至很大可能是在其他服务器上的MySQL中的查询结果。

query：查询参数(query)一般是一个字符串，它表示URL中向服务器提供的附加参数，一般只使用在http协议的URL中，其中包含了表单数据，来源于用户的输入，表示形式是key1=value1&key2=value2&keyn=valuen。

fragment：片段(fragment)表示远程服务器资源的某个特定的部分。假如服务器资源是一个HTML文档，此片段标识符将制定为该HTML文档的一个锚(Anchor)。如果远程资源是一个XML文档，那么这个片段标识符是一个XPointer。(如果用Markdown写过博客就知道，添加了导航目录之后，片段就是目录将要导航到的目的章节)

URL和URI区别

URI是统一资源标识符，它可以表示任何介质中的资源。而URL是统一资源位置，一般特指因特网中的网络资源位置，使用于Http或者Https协议中。很显然，URI可以表示的范围更大，URI实际上是包含了URL。

2. 本地系统的绝对路径

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

Java.io包中的类，需要使用这种形式的参数；它们一般也接受了URI类型的参数。

3. 相对于classpath的相对路径

D:/java/eclipse32/workspace/jbpmtest3/classes/

相对于这个路径的相对路径。其中，classes是本项目的classpath。所有的Java源文件编译后的.class文件复制到这个目录中。

项目编译后classes文件目录

项目编译后，生成target目录的classes如下。package生成一个包到target/classes、resources目录下文件、文件夹分别生成到target/classes下。

如果src/main/resources 下的文件夹为空，不会生成到target/classes下

4. 相对于当前用户目录的相对路径

就是相对于System.getProperty(“user.dir”)返回的路径。

对于一般项目，这是项目的根路径。对于JavaEE服务器，这可能是服务器的某个路径，具体是哪个路径不确定。

所以，绝对不要使用“相对于当前用户目录的相对路径”。然而：

默认情况下，java.io包中的类总是根据当前用户目录来分析相对路径名。此目录由系统属性user.dir 指定，通常是Java虚拟机的调用目录。

这就是说，在使用java.io包中的类时，最好不要使用相对路径。否则，虽然在J2SE应用程序中可能还算正常，但是到了J2EE程序中，一定会出问题！而且这个路径，在不同的服务器中都是不同的！

SE、EE、ME区别

Java SE（J2SE，Java 2 Platform Standard Edition，标准版）

        Java SE 以前称为 J2SE。它允许开发和部署在桌面、服务器、嵌入式环境和实时环境中使用的 Java 应用程序。Java SE 包含了支持 Java Web 服务开发的类，并为Java EE和Java ME提供基础。

Java EE（J2EE，Java 2 Platform Enterprise Edition，企业版）

        Java EE 以前称为 J2EE。企业版本帮助开发和部署可移植、健壮、可伸缩且安全的服务器端Java 应用程序。Java EE 是在 Java SE 的基础上构建的，它提供 Web 服务、组件模型、管理和通信 API，可以用来实现企业级的面向服务体系结构（service-oriented architecture，SOA）和 Web2.0应用程序。2018年2月，Eclipse 宣布正式将 JavaEE 更名为 JakartaEE

Java ME（J2ME，Java 2 Platform Micro Edition，微型版）

        Java ME 以前称为 J2ME。Java ME 为在移动设备和嵌入式设备（比如手机、PDA、电视机顶盒和打印机）上运行的应用程序提供一个健壮且灵活的环境。Java ME 包括灵活的用户界面、健壮的安全模型、许多内置的网络协议以及对可以动态下载的连网和离线应用程序的丰富支持。基于 Java ME 规范的应用程序只需编写一次，就可以用于许多设备，而且可以利用每个设备的本机功能。

二、相对路径最佳实践

示例基于Spring boot项目。

1. 推荐使用相对于当前classpath的相对路径。

我们在使用相对路径时，应当使用相对于当前classpath的相对路径。

ClassLoader类的getResource(String name)、getResourceAsStream(String name)等方法，就是相对于当前项目的classpath的相对路径来查找资源；读取属性文件常用到的ResourceBundle类的getBundle(String path)也是如此。

2. 得到classpath和当前类的绝对路径的一些方法

下面是一些得到classpath和当前类的绝对路径的一些方法。

（1）得到当前类FileTest.class文件的URI目录。不包括自己文件类名！

String resourcePath = FileTest.class.getResource("").getPath();
输出结果：

file:/E:/yangyang-ba/ETC/receive/target/classes/com/fri/receive/utils/

（2）得到当前的classpath的绝对URI路径。

四种方法
1）FileTest.class.getResource("/").getPath()

2）Thread.currentThread().getContextClassLoader().getResource("") 推荐使用

3）FileTest.class.getClassLoader().getResource("")

4）ClassLoader.getSystemResource("")

输出结果：

file:/E:/yangyang-ba/ETC/receive/target/classes/

（3）获取项目路径

//路径为空
File file = new File("");
// 返回结果：E:\yangyang-ba\ETC\receive
System.out.println(file.getAbsoluteFile());

（4）获取磁盘根目录

 // 获取当前项目所在磁盘的根目录(linux环境没试过)
File fileRoot = new File("/");
// 返回结果：D:\
System.out.println(fileRoot.getAbsoluteFile());

（5）获取`./`路径

// 路径为当前相对目录./时
File fileCurrent = new File("./");
// 返回结果：E:\yangyang-ba\ETC\receive\.
System.out.println(fileCurrent.getAbsoluteFile());

三、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外面的资源。

通用的相对路径解决办法

面对这个问题，我决定编写一个助手类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;

/**
*用来加载类
*classpath下的资源文件，属性文件等。
*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
*/
public static 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());

}

}

总结

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的绝对路径来拼资源的绝对路径！