Maven系列之maven-compiler-plugin的使用

背景介绍

1. maven是个项目管理工具，如果我们不告诉它我们的代码要使用什么样的jdk版本编译的话，它就会用maven-compiler-plugin默认的jdk版本来进行处理，这样就容易出现版本不匹配的问题，以至于可能导致编译不通过的问题。
2. 例如代码中要是使用上了jdk1.7的新特性，但是maven在编译的时候使用的是jdk1.6的版本，那这一段代码是完全不可能编译成.class文件的。为了处理这一种情况的出现，在构建maven项目的时候，我习惯性第一步就是配置maven-compiler-plugin插件。
3. 一般情况下jar包都可以使用pom.xml来配置管理，但也有一些时候，我们项目中使用了一个内部jar文件，但是这个文件我们又没有开放到maven库中，我们会将文件当到我们项目WEB-INF/lib中。
   如果我们不对pom.xml进行特殊配置的话，maven打包是不会自动去引用和编译lib中的jar文件的

插件使用

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-compiler-plugin</artifactId>
    <version>3.1</version>
    <configuration>
        <source>1.6</source> <!-- 源代码使用的开发版本 -->
        <target>1.6</target> <!-- 需要生成的目标class文件的编译版本 -->
        <!-- 一般而言，target与source是保持一致的，但是，有时候为了让程序能在其他版本的jdk中运行
        (对于低版本目标jdk，源代码中需要没有使用低版本jdk中不支持的语法)，
        会存在target不同于source的情况 -->
    
        <!-- 这下面的是可选项 -->
        <meminitial>128m</meminitial>
        <maxmem>512m</maxmem>
        <fork>true</fork> <!-- fork is enable,用于明确表示编译版本配置的可用 --> 
        <compilerVersion>1.3</compilerVersion>
        
        <!-- 这个选项用来传递编译器自身不包含但是却支持的参数选项 -->
        <compilerArguments>
            <verbose />
            <!--${path.separator}这个分隔符，在Windows系统下是“;”分号，在Linux下是“:”冒号-->
            <bootclasspath>${java.home}/lib/rt.jar${path.separator}${java.home}/lib/jce.jar</bootclasspath>
            <!--如果想引用不在maven仓库里的东西，只需要加上下面这句话-->
            <extdirs>${project.basedir}/src/main/webapp/WEB-INF/lib</extdirs>
        </compilerArguments>
    </configuration>
</plugin>

不过在3.1版本以后maven-compiler-plugin将compilerArguments定为过时了，建议大家按下面的方法写。
其中表示javac平时用空格隔开的的每一个参数。

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-compiler-plugin</artifactId>
    <version>3.1</version>
    <configuration>
        <source>1.7</source>
        <target>1.7</target>
        <encoding>UTF-8</encoding>
        <compilerArgs> 
            <arg>-verbose</arg>
            <arg>-Xlint:unchecked</arg>
            <arg>-Xlint:deprecation</arg>
            <arg>-bootclasspath</arg>
            <arg>${env.JAVA_HOME}/jre/lib/rt.jar${path.separator}${env.JAVA_HOME}/lib/jce.jar</arg>
            <arg>-extdirs</arg> 
            <arg>${project.basedir}/src/main/webapp/WEB-INF/lib</arg>
        </compilerArgs> 
    </configuration>
</plugin>

注意事项

• ${project.basedir}一定要写，不然会出现“在windows”下可以正常编译，在Linux服务器上就“有可能”出现编译找不到jar包的错误

拓展知识

maven的目录约定

pom.xml所在的目录应为项目的根目录，假设该目录为${proj-dir}，那么Maven有以下假设：

• ${proj-dir}/src/main/java —— 存放项目的.java文件。

• ${proj-dir}/src/main/resources —— 存放项目资源文件，如spring, hibernate配置文件。

• ${proj-dir}/src/test/jave —— 存放所有测试.java文件，如JUnit测试类。

• ${proj-dir}/src/test/resources —— 测试资源文件。

• ${proj-dir}/target —— 项目输出位置。

运行一条mvn clean package命令，Maven会帮你清除target目录，重新建一个空的，编译src/main/java类至target/classes，复制src/main/resources的文件至target/classes，编译src/test/java至target/test-classes，复制src/test/resources的文件至target/test-classes；然后运行所有测试；测试通过后，使用jar命令打包，存储于target目录。Maven做的事情一点也不少，只是都对用户隐蔽起来了，它只要求你遵循它的约定。