深入探究Java项目中的classpath

深入探究Java项目中的classpath

1. 引言

在Java编程的过程中，经常涉及到对本地资源的读取。比如，SSM框架中，通过Spring框架需要读取其对应的配置文件来实现对SpringBean的实例化。Mybatis框架需要读取配置文件来获取数据库相关的参数。SpringMVC也需要读取配置文件，获得前端控制器的配置参数。

在普通的Java项目中，也需要读取配置文件来提高对程序的维护性。一个常见的资源读取类ResourceBundle，常用来这个类主要用来解决国际化和本地化问题。当程序需要一个特定于语言环境的资源时（如 String），程序可以从适合当前用户语言环境的资源包（大多数情况下也就是.properties文件）中加载它。这样可以编写很大程度上独立于用户语言环境的程序代码，它将资源包中大部分（即便不是全部）特定于语言环境的信息隔离开来。

所有的资源读取情况，都需要涉及到路径的概念。这里面有一个关键的路径，便是classpath。

所谓的classpath，指的是类路径, 不管是SSM框架还是SpringBoot框架下,classpath就是指类路径。也就是java程序编译后后.class文件的所在的路径。

2.Java程序源目录 与 classpath.

众所周知，Java是一种半编译半解释型的语言。由程序员开发的.java程序，需要经过javac编译为.class字节码文件，最后有Java虚拟机将字节码解释为二进制机器码。其过程如下：

由于Java项目最终都需要经过编译为字节码文件。所以，在我们开发过程中的包含.java文件的目录路径，与程序最终的包含.class文件的目录路径是有所不同的。程序最终基于路径读取资源文件，都是在包含.class文件的目录中读取的。为了保证编程过程中路径的正确读取，我们需要了解Java源程序中的的目录结构 与 编译后的目录结构的映射关系。

2.1 Java源程序的目录结构

在常见的Java项目，主要分为普通的Java项目和JavaWeb项目。一般而言，JavaWeb项目较普通的Java项目的目录结构只有少许不同：

对比两者的目录结构如下：

图一 Java项目	图二 JavaWeb项目

从上图可以看出，JavaWeb项目比普通的Java项目多了一个webapp文件夹，该文件夹主要是存放一些前端的页面信息。且两个项目中，带有金黄色标志的的res/resources文件都是用来存放开发环境下的资源文件的。

2.2 本地环境下的Java程序的classpath.

在一个普通的的java项目中，.java格式的源文件最终会被打包为.class格式的文件，经过类加载器的加载，运行在Java虚拟机中。

一个Java程序，会由自动化构建工具对所有的源码进行构建，默认会最终生成一个target目录。 该目录存放项目构建后的文件和目录，jar包，war包和编译后的class文件。一个普通的的Java程序与一个JavaWeb项目编译之后的Target目录结构如下：

图一普通的的Java程序	图二 JavaWeb项目

观察到上图图2中，出现了一些配置文件mybatis.xml等.这些文件对应在源文件src/main/resources下。所以可以推断，resources目录下的文件，最终会被打包至target/classes.

之所以两种项目最后均会生成target目录，是因为idea中，默认将项目模块的编译结果输出到target目录中。打开idea的project structure 设置，可以看到如下页面：

所以，在默认的情况下，Java项目中的classpath路径，就是target/classes.

2.3 Java项目与JavaWeb项目的classpath区别。

一般而言，Java项目主要面向桌面程序的应用，主要是awt、swing这类的编码，不包括JSP等前台页面的代码，大部分是CS架构的工程和一些jar包。JavaWeb项目是BS架构的系统，是网页的编码，像Jsp、Servlet、Struts这类的， JavaWeb项目部署到服务器上，任何用户都可以通过浏览器来访问。两者的classpath的主要区别如下：

• 编译后路径不同。

Java Project和Web Project其实都是Java语言的应用，只是应用场合不同罢了，那么他们的本质区别到底是编译后路径位置不同！在Java项目中，.classpath文件，是在每个项目的目录下存在的。该项目定义了编译后的路径。这个编译后的路径，便是本文中所说的classpath.

下面展示了一个Web项目的.classpath文件，xml代码如下：

1. <?xml version="1.0" encoding="UTF-8"?>
2. <classpath>
3.       <classpathentry kind="src" path="src"/>
4.       <classpathentry kind="src" path="resources"/>
5.       <classpathentry kind="src" path="test"/>
6.       <classpathentry kind="uu" path="org.eclipse.jdt.launching.JRE_CONTAINER"/>
7.       <classpathentry kind="lib" path="lib/servlet-api.jar"/>
8.       <classpathentry kind="lib" path="webapp/WEB-INF/lib/struts2-core-2.1.8.1.jar"/>
9.       ……
10.     <classpathentry kind="output" path="webapp/WEB-INF/classes"/>
11. </classpath>

在xml文档包含一个根元素，就是classpath类路径。子元素是classpathentry，kind属性区别了种类信息。src表示源码，uu是JRE容器的相关信息。lib表示是项目依赖的第三方类库，output表示src编译后的位置。

由于Web项目是要发布到服务器上的，服务器读取的是类文件和页面文件，而不管源文件。在服务器中，是忽略WEB-INF上一级目录的，而直接从WEB-INF目录开始读。所以，最终的运行，跟我们在开发环境中中命名为webapp还是webRoot无关。

3.Java程序开发目录与部署目录的对比。

Java源程序文件最终会被编译到目标文件。而这个目标文件，就是我们说的classpath.如果我们知道了源文件中的什么目录，最终会被编译到classes文件，便可以将需要从classpath中读取的文件信息放置到这些目录之中。

一个Web工程的目录映射图表示如下：

从上图可知，一个Web工程，最终生成的编译结过，以项目名Chicken为根目录，所有的源文件
对应的.class文件，会被放置WEB-INF/classes文件中（由于Web程序是被部署到Web容器中，所以项目的。classes文件必须被放置在WEB-INF/classes中。可通过 Project Structure来设置.class文件的位置）。实际上，源文件中的Resources文件也会被映射到WEB-INF/classes文件。

4.总结

对于web工程，classpath:实际上指的是/WEB-INF/classes目录!

• classpath对应源程序中的src文件夹和resources文件夹。

对于普通Java项目，classpath:实际上指的是/target/classes目录!

• classpath对应源程序中的src文件夹。