深入探讨Maven打包：打造精致的Zip包

开发运维 2024-03-26 LOVEHL^ˇ^ 手机阅读
Scan me!

在部署Spring Boot生产项目时，首先需要使用Maven将其打包成一个JAR文件或者包含JAR文件的ZIP文件。随后，通过堡垒机将打包好的文件上传至服务器进行部署，或构建成Docker镜像进行发布。在这一过程中，我们需要将项目中的配置文件或静态资源放置在JAR包之外，这样在修改配置文件或静态资源时就无需重新打包。为了构建ZIP文件，我们使用了Maven Assembly Plugin插件，该插件用于创建项目分发包，通过一个XML描述文件定义打包内容。本文将详细介绍这一流程。

maven-assembly-plugin简介

maven-assembly-plugin 是一个 Maven 插件，用于创建项目分发包。该插件可以帮助将项目的构建输出、依赖库等资源打包成一个归档文件，如 JAR、ZIP、TAR 等，方便项目的部署和发布。

以下是 maven-assembly-plugin 的一些主要特点和用途：

  • 灵活的配置：通过配置插件，可以定义不同的打包方式和内容，满足各种项目的需求。可以选择包含依赖库、特定文件、目录结构等。
  • 多种打包格式：支持生成不同格式的归档文件，如 JAR 包含所有依赖、ZIP 压缩文件、TAR 文件等，可以根据实际情况选择合适的打包格式。
  • 自定义描述符：除了预定义的描述符外，还可以编写自定义描述符文件，以更精细的方式控制打包过程，定义需要包含的文件、目录结构等。
  • 插件执行阶段：通常在 Maven 构建的某个阶段（如 package 阶段）触发执行，生成所需的分发包。
  • 简化部署流程：打包成归档文件后，可以方便地进行部署和发布，简化了项目的交付流程。

maven-assembly-plugin 配置

让我们来看一下 Maven Assembly Plugin 的配置文件 package.xml，这个文件定义了项目打包的内容和形式。在这个 XML 文件中，我们定义了项目打包的格式为 zip 和 dir，同时指定了一些文件和目录的打包规则。

package.xml

 
 
 
 package
 
  zip
    dir
 
 false
    
        
            lib
            runtime
            
                ${groupId}:${artifactId}
            
        
    
 
  
  
   bin/
   ./
            
                *.sh
            
   0755
   unix
  
  
  
   src/main/resources
   ./
  
  
  
   ${project.build.directory}
   ./
   
    *.jar

在 package.xml 中，我们还可以定义需要打包的依赖库、启动脚本文件、静态资源文件以及启动 jar 文件等内容。也可以在通过来排除一些我们不需要的资源， 通过这个 XML 文件，我们可以灵活地配置项目打包的内容和结构。

Maven Build 配置

在项目的POM文件中，我们还需要引入maven-assembly-plugin插件，并指定其配置文件。由于我们需要将配置文件和静态资源放置在JAR包之外，因此在打包过程中需要排除这些文件。Maven的配置示例如下：

 
  
  src/main/java
  
   
    ${project.basedir}/src/main/resources
    true
    
     *
    
   
   
    ${project.basedir}/src/main/resources
    true
   
  
  
   
    org.apache.maven.plugins
    maven-resources-plugin
    3.1.0
    
     UTF-8
     
      xls
      xlsx
      csv
     
    
   
   
    org.apache.maven.plugins
    maven-jar-plugin
    3.1.0
    
     
      
      
       cn.xj.snowflake.SnowflakeApplication
       true
       lib/
       ${project.artifactId}-${project.version}
      
     
     
      config/**
      mapper/**
      mybatis/**
      static/**
      templates/**
      i18n/**
      lib/**
      vm/**
      *.txt
      *.xml
      *.properties
      *.yml
      *.properties
     
    
   
   
    org.apache.maven.plugins
    maven-dependency-plugin
    
     
      copy
      compile
      
       copy-dependencies
      
      
       ${project.build.directory}/lib
       false
       false
       true
       compile
      
     
    
   
   
    maven-assembly-plugin
    
     false
     
      conf/package.xml
     
    
    
     
      make-assembly
      package
      
       single

在 Maven Build 的配置中，我们引入了 maven-resources-plugin、maven-jar-plugin、maven-dependency-plugin 和 maven-assembly-plugin 这几个插件，并对它们进行了相应的配置。

总结

当我们执行 mvn package 命令进行打包时，Maven 会按照配置文件 package.xml 和插件的配置来生成最终的分发包。Maven Assembly Plugin 会根据配置文件定义的规则将项目的相关文件、依赖库等内容打包成指定的格式，并完成最终的分发包构建。

通过以上的配置和打包过程，我们可以很方便地使用 Maven 来管理项目的打包和发布，而不需要手动进行复杂的文件拷贝和整理工作。