【Maven】打包插件使用详解

小咪咪 2023-10-08 23:19 10阅读 0赞

> 本文参照官网：http://maven.apache.org/plugins

#### 一.常用Maven打包插件: ####

> **1.spring-boot-maven-plugin:这个插件是springboot的maven插件,能够将springboot项目打包为可执行的jar/war,[官网文档][Link 1]。  
> 2.maven-assembly-plugin: 这个插件是maven结构定制化的打包,maven中针对打包任务而提供的标准插件,包含了以下几个插件的功能,[官网文档][Link 2]。  
> 3.maven-shade-plugin:这个插件是把整个项目（包含它的依赖）都打包到一个可以执行的jar包中,[官网文档][Link 3]。  
> 4.maven-jar-plugin:这个插件是将指定包目录打成单独的jar包,可以配置需要打包进去的文件,程序的入口类等,[官网文档][Link 4]。  
> 5.maven-resources-plugin:这个插件是用来处理,拷贝resources下的资源文件,[官网文档][Link 5]。  
> 6.maven-compiler-plugin:这个插件是用来编译Java代码,[官网文档][Link 6]。  
> 7.maven-dependency-plugin:这个插件是用来拷贝依赖库,[官网文档][Link 7]。**

#### 二.使用以及说明: ####

1.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>
         	 
             <fork>true</fork> 
             
             <executable>true</executable>
             
             <includeSystemScope>true</includeSystemScope>
         </configuration>
         <executions>
             <execution>
                 <goals>
                 	 
                     <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应用程序集成到集成测试阶段，在此之前启动**

2.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>
       					
       					<phase>package</phase>
       					<goals>
        					
        					<goal>single</goal>
       					</goals>
       				</execution>
      			</executions>
      			<configuration>
       				
       				<descriptor>src/main/assembly/assembly.xml</descriptor>
       				
      			</configuration>
    </plugin>

自定义打包的时候，需要自己写描述符文件，格式为XML:

<assembly>
    	
     	<id>assembly</id>
     	
     	<formats>
     		<format>tar.gz</format>
     	</formats>
     	
     	<includeBaseDirectory>true</includeBaseDirectory>
     	
     	<fileSets>
     		<fileSet>
     			
      			<directory>src/main/bin</directory>
      			
      			<includes>
      				<include>*.sh</include>
      			</includes>
      			<outputDirectory>bin</outputDirectory>
      			
      			<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>
     	
     	<files>
     		<file>
      			<source>target/${
        project.artifactId}-${
        project.version}.jar</source>
      			<outputDirectory>.</outputDirectory>
     		</file>
     	</files>
      	
     	<dependencySets>
     		<dependencySet>
     		
      		<unpack>false</unpack>
      		
      		<scope>runtime</scope>
      		<outputDirectory>lib</outputDirectory>
     		</dependencySet>
     	</dependencySets>
    </assembly>

3.maven-shade-plugin

<plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-shade-plugin</artifactId>
                 <version>2.4.1</version>
                 <executions>
                     <execution>
                     
                         <phase>package</phase>
                         <goals>
                            <goal>shade</goal>
                         </goals>
                         <configuration>
    		              <artifactSet>
    		                <excludes>
    		                
    		                  <exclude>classworlds:classworlds</exclude>
    		                  <exclude>junit:junit</exclude>
    		                </excludes>
    		              </artifactSet>
    		              
    		               <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>
    		               
    		               <minimizeJar>true</minimizeJar>
    		               
    		                <transformers>
    			                <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
    			                  <mainClass>org.sonatype.haven.HavenCli</mainClass>
    			                </transformer>
                  			</transformers>
                  			
                  			<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>

4.maven-jar-plugin

<plugin>
    	<groupId>org.apache.maven.plugins</groupId>
    	<artifactId>maven-jar-plugin</artifactId>
    	<version>2.4</version>
    	<configuration>
    		<archive>
    			
    			<addMavenDescriptor>true</addMavenDescriptor>
    			
    			<manifest>
    				
    				<useUniqueVersions>false</useUniqueVersions>
    				
    				<addClasspath>true</addClasspath>
    				
    				<classpathPrefix>lib/</classpathPrefix>
    				
    				<mainClass>com.ht.pojo.Test</mainClass>
    			</manifest>
    			<manifestEntries>
    				
    				<Class-Path>../config/</Class-Path>
    				
    		<outputDirectory>${
        project.build.directory}/lib</outputDirectory>
    		<includes>
    			
    			
    			<include>**/*.class</include>
    			<include>**/*.properties</include>
    		</includes>
    	</configuration>
    </plugin>

5.maven-resources-plugin

<build>
    			  <resources>
    			       <resource>
    				        
    				        <directory>src/main/resources/</directory>
    				        <includes>
    				          <include>**/*.properties</include>
    				          <include>**/*.xml</include>
    				        </includes>
    					</resource>
    			        <resource>
    		                <directory>src/main/resources</directory>
    		                
    		                <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>
                            
                           
                            <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>

6.maven-compiler-plugin

<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> 
            
    	   <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>

7.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>  
                        	
                            <goal>copy</goal>  
                        </goals>  
                    </execution>  
                    <execution>  
    			        <phase>package</phase>  
    			        <goals>  
    			        	
    			            <goal>unpack</goal>  
    			        </goals>
    			        <configuration>
    		                <type>jar</type>
    		                <includeTypes>jar</includeTypes>
    		                <outputDirectory>
    		                    ${
        project.build.directory}/lib
    		                </outputDirectory>
    		                
    		                <excludeTransitive>false</excludeTransitive>
    		                
    		                <stripVersion>false</stripVersion>
                		</configuration>
           		   </execution>
                </executions>
                
                <configuration>  
        			<excludeGroupIds>org.apache.camel</excludeGroupIds>  
    			</configuration>
    			
    			<configuration>  
    			    <includeArtifactIds>camel-spring</includeArtifactIds>  
    			</configuration>
    </plugin>

[Link 1]: https://docs.spring.io/spring-boot/docs/2.2.1.RELEASE/maven-plugin/
[Link 2]: https://maven.apache.org/plugins/maven-assembly-plugin/
[Link 3]: https://maven.apache.org/plugins/maven-shade-plugin/
[Link 4]: https://maven.apache.org/plugins/maven-jar-plugin/
[Link 5]: https://maven.apache.org/plugins/maven-resources-plugin/
[Link 6]: https://maven.apache.org/plugins/maven-compiler-plugin/
[Link 7]: https://maven.apache.org/plugins/maven-dependency-plugin/