常用MAVEN打包方式总结

最新推荐文章于 2024-05-07 16:08:44 发布

roykingw

最新推荐文章于 2024-05-07 16:08:44 发布

阅读量2.1w

点赞数 11

分类专栏： maven 文章标签： maven plugins

本文链接：https://blog.csdn.net/roykingw/article/details/71486825

版权

maven 专栏收录该内容

0 篇文章 2 订阅

订阅专栏

几种常用的maven打包插件总结：
一、自带插件：
maven自带的核心插件为Build plugins和Reporting plugins。
mvn compile编译源码实际上就利用到了maven-compiler-plugin，其他phase也类似用到了相应的插件
关于maven自带的核心插件见：http://maven.apache.org/plugins/index.html

核心插件 maven-compiler-plugin
参考地址 http://maven.apache.org/plugins/maven-compiler-plugin/
从3.0版本开始，编译工具默认使用的是 javax.tools.JavaCompiler(从JDK 1.6开始) 如果要强制使用javac来进行编译，需要添加参数forceJavacCompilerUse

<plugin> 
  <groupId>org.apache.maven.plugins</groupId>  
  <artifactId>maven-compiler-plugin</artifactId>  
  <version>3.6.1</version>  
  <configuration> 
    <encoding>utf-8</encoding>  
    <source>1.7</source>  
    <!-- 默认1.5 -->  
    <target>1.7</target>  
    <!-- 默认1.5 -->  
    <compilerArgs> 
      <!-- 传递编译参数  -->  
      <arg>-verbose</arg>  
      <arg>-Xlint:all,-options,-path</arg> 
    </compilerArgs>  
    <fork>true</fork>  
    <!-- 配置编译内存参数 -->  
    <meminitial>128m</meminitial>  
    <!-- 初始内存 -->  
    <maxmem>512m</maxmem>  
    <!-- 最大内存 -->  
    <executable>${JAVA_1_4_HOME}/bin/javac</executable>  
    <!-- 指定编译的java库 -->  
    <compilerVersion>1.3</compilerVersion>  
    <!-- 指定编译版本 --> 
  </configuration> 
</plugin>

配置source 和target时，也可以这样配置实际上这是javac指令可以接受的参数

<properties>
    <maven.compiler.source>1.8</maven.compiler.source>
    <maven.compiler.target>1.8</maven.compiler.target>
  </properties>

二、直接打成可执行的jar包。
这种打包方式比较粗暴，将应用的依赖包和程序包打成一个全量包。包会相对较大，但是好处也很明显，不用管依赖包。所以这种方式只适用于比较小的项目，比如搭建微服务这种方式可以适用。

附上关键的服务器执行代码
java -jar dataCleaner.jar 1>/home/credit/app/tracefile 2>/home/credit/app/errorfile &
说明：最后面的& 表明后台执行。
1> 将运行日志输出到tracefile
2> 将错误日志输出到errorfile

具体参数很多，参考官网页面
官网页面 http://maven.apache.org/plugins/maven-assembly-plugin/assembly.html

<plugin>
    <artifactId>maven-assembly-plugin</artifactId>
    <configuration>
      <descriptorRefs>
        <descriptorRef>jar-with-dependencies</descriptorRef>
      </descriptorRefs>
    </configuration>
</plugin>

还一种方式，可以使用spring-boot的打包插件进行打包。一般是跟spring boot一起使用的，但是也可以单独利用出来打成可执行的整包。

<plugin> 
  <groupId>org.springframework.boot</groupId>  
  <artifactId>spring-boot-maven-plugin</artifactId>  
  <version>1.3.5.RELEASE</version>  
  <configuration>
    <mainClass>com.ftoul.dataCleaner.DataCleanServiceProvider</mainClass>  
    <layout>ZIP</layout> 
  </configuration>  
  <executions> 
    <execution> 
      <goals> 
        <goal>repackage</goal> 
      </goals> 
    </execution> 
  </executions> 
</plugin>

补充一下，还有一个shade插件也是比较常用的打fat jar包的方式

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-shade-plugin</artifactId>
  <version>3.0.0</version>
  <executions>
    <execution>
      <phase>package</phase>
      <goals>
        <goal>shade</goal>
      </goals>
      <configuration>
        <transformers>
          <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
            <manifestEntries>
              <Main-Class>org.sonatype.haven.ExodusCli</Main-Class>
              <Build-Number>123</Build-Number>
            </manifestEntries>
          </transformer>
        </transformers>
      </configuration>
    </execution>
  </executions>
</plugin>

三将依赖包与代码包分开打包
这种打包方式更普遍适用。毕竟依赖的jar包在项目发展中变动会相对较小。一般可配合maven-dependency-plugin 和 maven-jar-plugin 两个插件打包。前者负责依赖包，后者负责程序包。

另外，附上服务器可用的执行脚本。

more runapp.sh 
#!/bin/sh
#执行jar包
RUN_LIBS=""
#依赖jar包  
SUPPORT_LIBS=""
RUN_LIB_PATH="$HOME/app/lib"
SUPPORT_LIB_PATH="$HOME/app/support"
#加载程序包
for i in ${RUN_LIB_PATH}/* ; do
   RUN_LIBS=${RUN_LIBS}:$i
done
#加载依赖包
for i in ${SUPPORT_LIB_PATH}/* ; do
   SUPPORT_LIBS=${SUPPORT_LIBS}:$i
done
#整合classpath
CLASSPATH=${RUN_LIBS}:${SUPPORT_LIBS}
export CLASSPATH
#调用java指令执行。-D输入参数 java中可以用 System.getProperties读取。同时指定执行入口类 SpringBootApplication  这是一个典型的Springboot的执行方式。
java  -Xdebug  -Xnoagent -Djava.compiler=NONE -Xrunjdwp:transport=dt_socket,server=y,address=27899,suspend=n -cp $CLASSPATH  -Dspring.profiles.active=prod com.app.SpringBootApplication -D
user.timezone=GMT+08 1>/home/credit/ftoulcloud/bin/tracefile 2>/home/credit/ftoulcloud/bin/errorfile &

echo Start App Success!

assembly官网的其他几个示例使用项目的依赖包进行打包

<build>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-dependency-plugin</artifactId>
      <version>3.0.0</version>
      <executions>
        <execution>
          <id>src-dependencies</id>
          <phase>package</phase>
          <goals>
            <!-- use copy-dependencies instead if you don't want to explode the sources -->
            <goal>unpack-dependencies</goal>
          </goals>
          <configuration>
            <classifier>sources</classifier>
            <failOnMissingClassifierArtifact>false</failOnMissingClassifierArtifact>
            <outputDirectory>${project.build.directory}/sources</outputDirectory>
          </configuration>
        </execution>
      </executions>
    </plugin>
  </plugins>
</build>

将指定的包打入依赖包

<build>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-dependency-plugin</artifactId>
      <version>3.0.0</version>
      <executions>
        <execution>
          <id>copy</id>
          <phase>package</phase>
          <goals>
            <goal>copy</goal>
          </goals>
        </execution>
      </executions>
      <configuration>
        <artifactItems>
          <artifactItem>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>3.8.1</version>
            <type>jar</type>
            <overWrite>false</overWrite>
            <outputDirectory>${project.build.directory}/alternateLocation</outputDirectory>
            <destFileName>optional-new-name.jar</destFileName>
          </artifactItem>
        </artifactItems>
        <outputDirectory>${project.build.directory}/wars</outputDirectory>
        <overWriteReleases>false</overWriteReleases>
        <overWriteSnapshots>true</overWriteSnapshots>
      </configuration>
    </plugin>
  </plugins>
</build>

一个可用的示例

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-dependency-plugin</artifactId>
    <!-- <version>2.10</version> -->
    <executions>
        <execution>
            <id>copy-dependencies</id>
            <phase>package</phase>
            <goals>
                <goal>copy-dependencies</goal>
            </goals>
            <configuration>
                <outputDirectory>export</outputDirectory> <!-- 将依赖包放入export文件夹 -->
                <excludeTransitive>false</excludeTransitive>
                <stripVersion>true</stripVersion>
            </configuration>
        </execution>
    </executions>
</plugin>

四、maven-jar-plugin 将指定的一些文件打包成jar包
这个比较简单。就将指定的文件打成jar包

<plugin> 
  <groupId>org.apache.maven.plugins</groupId>  
  <artifactId>maven-jar-plugin</artifactId>  
  <version>3.0.2</version>  
  <configuration>  <!-- manifest配置信息 主要是可以配置主执行类。有主执行类，可以用java-jar直接执行。没有的话就需要指定执行类 -->
    <archive> 
      <manifest> 
        <addClasspath>true</addClasspath>  
        <classpathPrefix>support/</classpathPrefix>  
        <mainClass>com.myapp.MyAppApplication</mainClass> 
<!-- 可以按上面的方式自己配置，也可以指定MF文件打包。 -->
        <manifestFile>${project.build.outputDirectory}/META-INF/MANIFEST.MF</manifestFile>
      </manifest> 
    </archive>  
  </configuration>
  <executions> 
    <execution> 
      <id>myapp1-jar</id>  
      <phase>package</phase>  
      <goals> 
        <goal>jar</goal> 
      </goals>  
      <configuration> 
        <classifier>myapp</classifier>  
        <includes> 
          <include>com/myapp/**</include>  
          <include>mybatis/**</include>  
          <include>templates/**</include>  
          <include>*.properties</include>  
          <include>dubbo.xml</include> 
        </includes> 
      </configuration> 
    </execution>  
    <execution> 
      <id>myapp2-jar</id>  
      <phase>package</phase>  
      <goals> 
        <goal>jar</goal> 
      </goals>  
      <configuration> 
        <classifier>myapp2</classifier>  
        <includes> 
          <include>com/myapp2/crawler/*</include>  
          <include>com/myapp2/crawler/*</include>  
          <include>com/myapp2/utils/**</include>  
          <include>log4j.properties</include> 
        </includes> 
      </configuration> 
    </execution>  
  </executions> 
</plugin>

五、其他丰富的三方插件
PMD打包插件。 PMD一个很好用的静态代码检查插件， eclipse可以直接安装插件使用
生成PMD报告
http://maven.apache.org/plugins/maven-pmd-plugin/
只能用于3.3.3以后的maven版本

分析JSP页面

<reporting>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-pmd-plugin</artifactId>
      <version>3.8</version>
      <configuration>
        <language>jsp</language>
        <rulesets>
          <ruleset>jsp-basic</ruleset>
        </rulesets>
        <includes>
          <include>**/*.jsp</include>
        </includes>
        <compileSourceRoots>
          <compileSourceRoot>${basedir}/src/main/webapp</compileSourceRoot>
        </compileSourceRoots>
      </configuration>
    </plugin>
  </plugins>
</reporting>

分析JS

<reporting>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-pmd-plugin</artifactId>
      <version>3.8</version>
      <configuration>
        <language>javascript</language>
        <rulesets>
          <ruleset>ecmascript-basic</ruleset>
          <ruleset>ecmascript-braces</ruleset>
          <ruleset>ecmascript-unnecessary</ruleset>
        </rulesets>
        <includes>
          <include>**/*.js</include>
        </includes>
        <compileSourceRoots>
          <compileSourceRoot>${basedir}/src/main/javascript</compileSourceRoot>
        </compileSourceRoots>
      </configuration>
    </plugin>
  </plugins>
</reporting>

代码非法检查

<build>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-pmd-plugin</artifactId>
      <version>3.8</version>
      <executions>
        <execution>
          <goals>
            <goal>check</goal>
            <goal>cpd-check</goal>
          </goals>
        </execution>
      </executions>
    </plugin>
  </plugins>
</build>

制定JDK

<reporting>
  <plugins>
    <plugin>
      <artifactId>maven-pmd-plugin</artifactId>
      <version>3.8</version>
      <configuration>
        <targetJdk>1.6</targetJdk>
      </configuration>
    </plugin>
  </plugins>
</reporting>

删除PMD报告

<reporting>
  <plugins>
    <plugin>
      <artifactId>maven-pmd-plugin</artifactId>
      <version>3.8</version>
      <reportSets>
        <reportSet>
          <reports>
            <report>pmd</report>
            <report>cpd</report>
          </reports>
        </reportSet>
      </reportSets>
    </plugin>
  </plugins>
</reporting>

没事可以经常去官网转转，时不时有些新的打包插件出来。比如PDF插件 GPG签名插件 TOMCAT插件 JETTY插件等。好多好多。用时慢慢去了解。

roykingw

关注

11
点赞
踩
66

收藏

觉得还不错? 一键收藏
打赏
5
评论
常用MAVEN打包方式总结

几种常用的maven打包插件总结：一、自带插件： maven自带的核心插件为Build plugins和Reporting plugins。 mvn compile编译源码实际上就利用到了maven-compiler-plugin，其他phase也类似用到了相应的插件关于maven自带的核心插件见：http://maven.apache.org/plugins/index.html核心插
复制链接

扫一扫