本文参照官网:http://maven.apache.org/plugins
一.常用Maven打包插件:
1.spring-boot-maven-plugin:这个插件是springboot的maven插件,能够将springboot项目打包为可执行的jar/war,官网文档。
2.maven-assembly-plugin: 这个插件是maven结构定制化的打包,maven中针对打包任务而提供的标准插件,包含了以下几个插件的功能,官网文档。
3.maven-shade-plugin:这个插件是把整个项目(包含它的依赖)都打包到一个可以执行的jar包中,官网文档。
4.maven-jar-plugin:这个插件是将指定包目录打成单独的jar包,可以配置需要打包进去的文件,程序的入口类等,官网文档。
5.maven-resources-plugin:这个插件是用来处理,拷贝resources下的资源文件,官网文档。
6.maven-compiler-plugin:这个插件是用来编译Java代码,官网文档。
7.maven-dependency-plugin:这个插件是用来拷贝依赖库,官网文档。
二.使用以及说明:
spring-boot-maven-plugin
// An highlighted block<plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> <version>2.1.1.RELEASE</version> <configuration> <!-- 配置使devtools生效 --> <fork>true</fork> <!-- 配置为 true,打包出来的 jar/war 就是可执行的,可以配置为linux的service启动,如果使用 jar -xf 等解压命令,将此配置改为false--> <executable>true</executable> <!-- 配置在使用第三方的jar包作为依赖,打包时,指定maven把scope为system的依赖同样打到jar包中去,需要配合dependency的<scope>system</scope>和<systemPath>${project.basedir}/libs/xxx-api-sdk-1.1.0.jar</systemPath>使用--> <includeSystemScope>true</includeSystemScope> </configuration> <executions> <execution> <goals> <!-- 配置在 mvn package 执行之后,再次打包生成可执行的 jar包。repackage生成jar包的名称与 mvn package 生成的原始 jar/war包名称相同,而原始 jar包被重命名为 *.origin。这样生成的*.jar可直接运行,但不能被其他项目模块依赖。这是因为repackage将项目的class都放在了jar包 BOOT-INF/classes 文件夹中,导致其他模块不能加载jar包中的 class。--> <goal>repackage</goal> </goals> </execution> </executions> </plugin>
spring-boot-maven-plugin提供的goals
mvn spring-boot:build-info:生成项目的构建信息文件
mvn spring-boot:help:展示spring-boot-maven-plugin的帮助信息
mvn spring-boot:repackage :可生成可执行的jar包或war包。插件的核心goal。
mvn spring-boot:run:运行 Spring Boot 应用
mvn spring-boot:start:将SpringBoot应用程序集成到集成测试阶段,在此之前启动
mvn spring-boot:stop:将SpringBoot应用程序集成到集成测试阶段,在此之前启动
maven-assembly-plugin
<plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-assembly-plugin</artifactId> <version>2.4<version> <executions> <execution> <id>make-assembly</id> <!-- 配置绑定到package生命周期 --> <phase>package</phase> <goals> <!-- 配置只运行一次 --> <goal>single</goal> </goals> </execution> </executions> <configuration> <!-- 配置描述符文件 --> <descriptor>src/main/assembly/assembly.xml</descriptor> <!-- 配置可以使用Maven预配置的描述符 <descriptorRefs> <descriptorRef>jar-with-dependencies</descriptorRef> </descriptorRefs> --> </configuration></plugin>
自定义打包的时候,需要自己写描述符文件,格式为XML:
<assembly><!--配置添加到打包文件名的标识符,用来做后缀--> <id>assembly</id> <!--配置打包文件格式,有zip、tar、tar.gz、tar.bz2、jar、war--> <formats> <format>tar.gz</format> </formats> <!----> <includeBaseDirectory>true</includeBaseDirectory> <!-- 配置一组文件在打包时的属性。--> <fileSets> <fileSet> <!-- 配置源目录的路径。--> <directory>src/main/bin</directory> <!-- 配置包含或排除哪些文件,支持通配符--> <includes> <include>*.sh</include> </includes> <outputDirectory>bin</outputDirectory> <!-- 配置该目录下的文件属性,采用Unix八进制描述法,默认值是0644--> <fileMode>0755</fileMode> </fileSet> <fileSet> <directory>src/main/conf</directory> <!-- 配置生成目录的路径。--> <outputDirectory>conf</outputDirectory> </fileSet> <fileSet> <directory>src/main/sql</directory> <includes> <include>*.sql</include> </includes> <outputDirectory>sql</outputDirectory> </fileSet> <fileSet> <directory>target/classes/</directory> <includes> <include>*.properties</include> <include>*.xml</include> <include>*.txt</include> </includes> <outputDirectory>conf</outputDirectory> </fileSet> </fileSets> <!-- 配置和fileSets大致相同,不过是指定单个文件,并且还可以通过destName属性来设置与源文件不同的名称。--> <files> <file> <source>target/${project.artifactId}-${project.version}.jar</source> <outputDirectory>.</outputDirectory> </file> </files> <!-- 配置工程依赖文件在打包时的属性--> <dependencySets> <dependencySet> <!--配置布尔值,false表示将依赖以原来的JAR形式打包,true则表示将依赖解成*.class文件的目录结构打包。--> <unpack>false</unpack> <!--配置符合哪个作用范围的依赖会被打包进去。compile与provided都不用管,一般是写runtime。 按照以上配置打包好后,将.tar.gz文件上传到服务器,解压之后就会得到bin、conf、lib等规范化的目录结构--> <scope>runtime</scope> <outputDirectory>lib</outputDirectory> </dependencySet> </dependencySets></assembly>
maven-shade-plugin
<plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-shade-plugin</artifactId> <version>2.4.1</version> <executions> <execution> <!--配置goal-shade绑定到phase-package 上 会在 target 文件生成一个以 -shaded.jar 为后缀的 jar 包--> <phase>package</phase> <goals> <goal>shade</goal> </goals> <configuration> <artifactSet> <excludes> <!--配置该工程依赖的部分 Jar 包 include/exclude 掉。--> <exclude>classworlds:classworlds</exclude> <exclude>junit:junit</exclude> </excludes> </artifactSet> <!--配置依赖的某个 Jar 包内部的类或者资源 include/exclude 掉。--> <filters> <filter> <artifact>junit:junit</artifact> <includes> <include>junit/framework/</include> <include>org/junit/</include> </includes> <excludes> <exclude>org/junit/experimental/</exclude> <exclude>org/junit/runners/</exclude> </excludes> </filter> </filters> <!--配置将所有不使用的类全部排除掉,将 jar 最小化--> <minimizeJar>true</minimizeJar> <!--配置 MainClass 创建一个可执行 Jar 包。--> <transformers> <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer"> <mainClass>org.sonatype.haven.HavenCli</mainClass> </transformer> </transformers> <!-- 配置解决jar或类的多版本冲突 在打包的时候把类重命名--> <relocations> <relocation> <pattern>org.codehaus.plexus.util</pattern> <shadedPattern>org.shaded.plexus.util</shadedPattern> <excludes> <exclude>org.codehaus.plexus.util.xml.Xpp3Dom</exclude> <exclude>org.codehaus.plexus.util.xml.pull.*</exclude> </excludes> </relocation> </relocations> </configuration> </execution> </executions></plugin>
maven-jar-plugin
<plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-jar-plugin</artifactId><version>2.4</version><configuration><archive><!-- 配置生成的jar中,包含pom.xml和pom.properties这两个文件 --><addMavenDescriptor>true</addMavenDescriptor><!-- 生成MANIFEST.MF的设置 --><manifest><!--配置引用的包maven库多个包带时间戳的和不带时间戳的无法对应的错误 --><useUniqueVersions>false</useUniqueVersions><!-- 配置依赖包添加路径, 这些路径会写在MANIFEST文件的Class-Path下 --><addClasspath>true</addClasspath><!-- 配置jar所依赖的jar包添加classPath的时候的前缀,如果这个jar本身和依赖包在同一级目录,则不需要添加 --><classpathPrefix>lib/</classpathPrefix><!-- 配置jar启动入口类 --><mainClass>com.ht.pojo.Test</mainClass></manifest><manifestEntries><!-- 配置Class-Path下添加配置文件的路径 --><Class-Path>../config/</Class-Path><!-- 配项目依赖本地的资源,打包的时候并不想把这些资源文件打进包里面,需要指定资源文件的路径</manifestEntries></archive><!-- 配置jar包的位置 --><outputDirectory>${project.build.directory}/lib</outputDirectory><includes><!-- 配置打包class文件和config目录下面的 properties文件 --><!-- 配置可能需要一些其他文件,这边可以配置,包括剔除的文件等等 --><include>***.properties</include></includes></configuration></plugin>
maven-resources-plugin
<build> <resources> <resource> <!--配置从此目录下读取全部以.properties和.xml开头的文件--> <directory>src/main/resources/</directory> <includes> <include>***.xml</include> </includes></resource> <resource> <directory>src/main/resources</directory> <!--配置过滤上面指定属性文件中的占位符,占位符是${变量名称}这样的形式,maven会自动读取includes配置文件,然后解析其中的占位符,使用上面pom文件中定义的属性进行替换--> <filtering>true</filtering> <includes> <include>*.yml</include> </includes> <!--配置排除某些--> <excludes> <exclude>file</exclude> </excludes> </resource> </resources> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-resources-plugin</artifactId> <version>3.2.0</version> <executions> <execution> <id>copy-resources</id> <!-- here the phase you need --> <!-- 配置作用周期--> <phase>validate</phase> <goals><goal>copy-resources</goal> </goals> <configuration> <outputDirectory>${basedir}/target/extraresources</outputDirectory> <resources> <resource> <directory>src/non-packaged-resources</directory> <filtering>true</filtering> </resource> </resources> </configuration> </execution> </executions></plugin> </plugins></build>
maven-compiler-plugin
<plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-compiler-plugin</artifactId> <version>3.1</version> <configuration> <!-- 配置指定的 JDK 版本将 java 文件编译为 class 文件(针对编译运行环境) --> <source>1.6</source> <!-- 配置指定的 JDK 版本对源代码进行编译(针对编译运行环境) --> <target>1.6</target> <!-- 配置程序能在其他版本的jdk中运行(对于低版本目标jdk,源代码中需要没有使用低版本jdk中不支持的语法),会存在target不同于source的情况 --> <compilerArgs> <!--配置javac平时用空格隔开的的每一个参数--> <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>
maven-dependency-plugin
<plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-dependency-plugin</artifactId> <version>2.8</version> <executions> <execution> <phase>package</phase> <goals> <!--配置copy操作可以用来将某个maven artifact(s)拷贝到某个目录下--> <goal>copy</goal> </goals> </execution> <execution> <phase>package</phase> <goals> <!--配置unpack操作可以用来将某个maven artifact(s)拷贝到某个目录下--> <goal>unpack</goal> </goals> <configuration> <type>jar</type> <includeTypes>jar</includeTypes> <outputDirectory> ${project.build.directory}/lib </outputDirectory> <!-- 配置是否排除间接依赖 默认false 不排除 --> <excludeTransitive>false</excludeTransitive> <!-- 配置是否消除依赖jar包后缀的版本信息 默认是false 不取消版本信息--> <stripVersion>false</stripVersion> </configuration> </execution> </executions> <!--配置排除所有camel的依赖--> <configuration> <excludeGroupIds>org.apache.camel</excludeGroupIds> </configuration><!--配置排除除camel-spring外的所有其他依赖--><configuration> <includeArtifactIds>camel-spring</includeArtifactIds> </configuration></plugin>
来源地址:https://blog.csdn.net/z_xiao_qiang/article/details/129902148