Eclipse中一个Maven工程的目录结构 (MacOS)

1. 为什么写这篇文章

　　在之前的javaSE开发中，没有很关注Eclipse工程目录下的环境，总是看见一个src就点进去新建一个包再写一个class。以后的日子中也没有机会注意到一个工程到底是怎么组织的这种问题，更不要说自己试试怎么控制了。

　　但是最近在学习Maven的时候知道了它对工程的目录结构有要求，也就是所谓的“惯例优于配置”。有一个被绝大多数人认可的java工程的目录结构被确定下来。这样统一了市面上各种复杂配置的工程。于是我便重新开始查资料，看看别人到底如何安排一个优秀的工程框架的。

　　同时，我也分析了Eclipse会给一个项目生成什么配置文件，其中的内容和意义又是什么.这样能心里面大致有个数，本地的什么文件是干什么的，怎么来的。

2. 一个简单的J2SE工程目录结构

　　首先，Mac中，一个默认的Eclipse工程的目录结构：

• MyProject:工程的名字
• src：一个源文件文件夹
• com.jd.MyProject：一个包。一般是倒写的域名保证其独一无二性。
• Main.java:一个java文件。

看上去就这么多？其实不是的，在我的mac环境下，一般时候Eclipse左边的目录是Package Explorer，也是是如上图显示的内容。但是其实可以用另外一个显示其真正的目录，也就是包含一些隐藏文件。叫Navigator(事实上Package Explorer默认隐藏Linux系统下的以.开头的隐藏文件，所以看不见，而Navigator默认打开)。显示效果如下：

3. 为什么Eclipse能认出来这些？

　　那么除了这些之外，其实还有值得探究的部分：

• 为什么Eclipse能识别出这个一个Maven工程？
• Eclipse怎么识别Source Folder？

　　这些问题可以提出很多，其实本质上都是：Eclipse是一个集成开发环境，而Maven是一种项目管理及自动构建工具（*），Eclipse没有责任去“识别”Maven。这句话乍一听感觉和直觉不相符合：明明新建工程的时候选择新建一个Maven工程，Eclipse就知道这是一个Maven工程啊？明明导入一个Maven工程，Eclipse就能正确识别打开啊?

　　其实是Eclipse帮我们做了很多。所以问题的答案是：Eclipse是通过配置文件来“认知”一个工程的。而这些配置文件，都是一些隐藏文件。你新建一个Maven工程，其实是按照模板写好了这些配置文件，所以Eclipse才能读出来这个工程的相关信息。

（一）我们先看一个普通的J2SE工程的配置文件的内容和其效果，工程如下：

1，.settings文件夹下的那个文件：org.eclipse.jdt.core.prefs。里面的内容是：

 eclipse.preferences.version=1
 org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode=enabled
 org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.8
 org.eclipse.jdt.core.compiler.codegen.unusedLocal=preserve
 org.eclipse.jdt.core.compiler.compliance=1.8
 org.eclipse.jdt.core.compiler.debug.lineNumber=generate
 org.eclipse.jdt.core.compiler.debug.localVariable=generate
 org.eclipse.jdt.core.compiler.debug.sourceFile=generate
 org.eclipse.jdt.core.compiler.problem.assertIdentifier=error
 org.eclipse.jdt.core.compiler.problem.enumIdentifier=error
 org.eclipse.jdt.core.compiler.source=1.8

很明显，是明确jdk的，还有一些编译器的参数的配置。

2，.classpath。这个隐藏文件的内容是：

 <?xml version="1.0" encoding="UTF-8"?>
 <classpath>
     <classpathentry kind="src" path="src" />
     <classpathentry kind="con"
         path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.8" />
     <classpathentry kind="output" path="bin" />
 </classpath>

这个比较重要，因为这个文件直接控制了一个工程的目录结构。kind属性为src，表示这个文件夹是放源码的文件夹，物理位置在/src。也就是我们看到的那个文件夹。

kind属性为con，也就是config，里面控制的是这个工程的JVM，JDK，等等信息，一把来说我们不需要的修改。kind属性为output，说明了编译后产生的class文件放在物理地址：/bin里面。

看到这个文件的配置，我们就知道前面为什么工程的目录安排是那样的了，换句话说，正是这个文件的配置，工程才体现那样的目录。再进一步说，如果你在这个文件里面按照你的想法配置，那么你保存之后，项目的目录结构会自动变成你安排的那样。

3，.project。内容如下：

 <?xml version="1.0" encoding="UTF-8"?>
 <projectDescription>
     <name>MyProject</name>
     <comment></comment>
     <projects>
     </projects>
     <buildSpec>
         <buildCommand>
             <name>org.eclipse.jdt.core.javabuilder</name>
             <arguments>
             </arguments>
         </buildCommand>
     </buildSpec>
     <natures>
         <nature>org.eclipse.jdt.core.javanature</nature>
     </natures>
 </projectDescription>

也是一些关于编译的配置文件，下面讲Maven还会讲到。

以上是一个普通java工程的所有文件和其目录结构，可以看到在我之前编写代码时没仔细注意的地方，一些配置文件对工程的结构做出了约束。

（二）接下来是一个Maven工程。

在Package Explorer里面看到的目录结构是：

几个不同点：　　

　　1. Source Folder不是一个简单的src，而是src/main/java

因为Maven是一种强约束的工程类型。它对工程的文件命名和格式要求比较严格。其好处是指定了规范，方便代码的移植和理解。上文中的src/main/java是个什么呢？其实是一个路径，打开其物理地址会发现，是一个src文件夹包含了一个main文件夹，再包含了java文件夹。这样的层次的文件路径一共有4个，如下：

• src/main/java  :这个目录下储存主要的java代码
• src/main/resources  :储存主要的资源文件。比如spring的xml配置文件和log4j的properties文件。
• src/test/java  :储存测试用的类，比如JUNIT的测试一般就放在这个目录下面
• src/test/resources  :储存测试用的资源文件

　　当然，这4个不是都必须有。前两个一般都有，后两个可能没有（不需要测试）。

　　与之类似的，如果一个包的名字是com.jd.MyProject，那么它在硬盘上的目录结构就是com/jd/MyProject。

　　2.  有一个target文件夹

很简单，就是源码编译后生成的class文件放的地方(如果是一个WEB应用，还有别的信息也在编译打包之后放在target里面)。具体放的时候也会根据是工程代码还是测试代码区分放置class文件。

　　3. 一个pom.xml。这个文件可以说是一个Maven工程最重要的文件了，因为这个是Maven的基础配置文件，和程序员打交道最多的也在这个文件里面，包括配置依赖关系等等。

根据上文描述，我们都知道了Eclispe里面的.开头的隐藏文件真正配置了工程的目录结构等等。那么这个Maven工程的配置文件里面写的是什么呢？

1，.settings：是Maven工程的一些配置，比如JDK版本和文件编码格式（UTF-8），比如父工程和子Module的依赖关系。

2，.classpath，这个文件内容变化了：

 <?xml version="1.0" encoding="UTF-8"?>
 <classpath>
     <classpathentry kind="src" output="target/classes" path="src/main/java">
         <attributes>
             <attribute name="optional" value="true" />
             <attribute name="maven.pomderived" value="true" />
         </attributes>
     </classpathentry>
     <classpathentry kind="src" output="target/test-classes"
         path="src/test/java">
         <attributes>
             <attribute name="optional" value="true" />
             <attribute name="maven.pomderived" value="true" />
         </attributes>
     </classpathentry>
     <classpathentry kind="con"
         path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/J2SE-1.5">
         <attributes>
             <attribute name="maven.pomderived" value="true" />
         </attributes>
     </classpathentry>
     <classpathentry kind="con"
         path="org.eclipse.m2e.MAVEN2_CLASSPATH_CONTAINER">
         <attributes>
             <attribute name="maven.pomderived" value="true" />
         </attributes>
     </classpathentry>
     <classpathentry kind="output" path="target/classes" />
 </classpath>

之前我们知道了一个Maven工程目录结构什么样子，这里就可以看出来为什么这个样子。正是这个文件的配置，让工程在Eclipse里面体现出来了与之前不一样的目录结构。具体一点就是它重新规定了各种文件（源码，配置，输出）在工程中存放的目录。事实上，你在Eclipse里面做工程目录的修改的核心都是修改这文件，从而体现你的修改。

3，.project.xml

这个文件可以说是很重要的，因为一开始我思考的问题是：怎么样把一个普通的JavaSE工程变成一个Maven工程的答案就在这里。我一点点修改，终于发现了最关键的一点，也就在这个文件里面。文件内容如下：

 <?xml version="1.0" encoding="UTF-8"?>
 <projectDescription>
     <name>MavenDemo</name>
     <comment></comment>
     <projects>
     </projects>
     <buildSpec>
         <buildCommand>
             <name>org.eclipse.jdt.core.javabuilder</name>
             <arguments>
             </arguments>
         </buildCommand>
         <buildCommand>
             <name>org.eclipse.m2e.core.maven2Builder</name>
             <arguments>
             </arguments>
         </buildCommand>
     </buildSpec>
     <natures>
         <nature>org.eclipse.jdt.core.javanature</nature>
         <nature>org.eclipse.m2e.core.maven2Nature</nature>
     </natures>
 </projectDescription>

可以看到多了两行。一个在buildCommand标签里面，一个在natures标签里面。如果你在一个普通的JavaSE工程里面加入了

 <nature>org.eclipse.m2e.core.maven2Nature</nature>

可以看到Eclipse就会在工程图标上加上一个M，认定其是一个Maven工程。删除这句话再保存，前面多出来的那句话也会自动删除。说明这句话正是确定这个工程“特性”的关键。

这个特性本身不重要，重要的是终于明白了，看上去很简单的东西，别人究竟是怎么实现的。在平常觉得理所当然的操作-->结果的背后，也许就体现了别人设计的智慧。比如这里：通过文件记录工程的目录结构。

以上就是Maven和普通工程的一些工程结构上的区别，以及造成这些区别的原因。