maven总结三: 常用插件


本文为博主原创,转载请注明出处:

目录:

  1. maven-release-plugin

  2. maven-compiler-plugin

  3. maven-assembly-plugin

  4. spring-boot-maven-plugin

  5. maven-resources-plugin

  6. maven-dependency-plugin

1.maven -release-plugin

  提供自动化发布功能,自动升级版本,并将代码提交git服务器


    org.apache.maven.plugins
    maven-release-plugin
    2.5.3
    
        http://git.spt.com/team/supply.git
        http://git.spt.com/team/supply.git
        false
        true
        clean deploy
      
        xxxxx@aikucun.com
        
        xxxx
    

2.maven-compiler-plugin

  指定maven 编译的jdk 版本及编译时的配置。以下为简约配置。通过指定maven 中jdk 编译的版本,可以避免代码工具的jdk 版本变更后,项目编译出现问题


    org.apache.maven.plugins
    maven-compiler-plugin
    3.8.0
    
                            
        1.8 
        1.8 
        UTF-8
        true
        true
        true
    

3.maven-assembly-plugin

   在Maven中,主要有3个插件可以用来打包:  

      • maven-jar-plugin,默认的打包插件,用来打普通的project JAR包;
      • maven-shade-plugin,用来打可执行JAR包,也就是所谓的fat JAR包;
      • maven-assembly-plugin,支持自定义的打包结构,也可以定制依赖项等。

  我们日常使用的以maven-assembly-plugin为最多,因为大数据项目中往往有很多shell脚本、SQL脚本、.properties及.xml配置项等,采用assembly插件可以让输出的结构清晰而标准化。

  示例:

    
        
            
                org.apache.maven.plugins
                maven-assembly-plugin
                ${maven-assembly-plugin.version}
                
                    
                        make-assembly
                        
                        package
                        
                            
                            single
                        
                    
                
                
                    
                    src/main/assembly/assembly.xml
                    
                
            
        
    

  assembly插件的打包方式是通过descriptor(描述符)来定义的。
  Maven预先定义好的描述符有bin,src,project,jar-with-dependencies等。比较常用的是jar-with-dependencies,它是将所有外部依赖JAR都加入生成的JAR包中,比较傻瓜化。
但要真正达到自定义打包的效果,就需要自己写描述符文件,格式为XML。下面是我们的项目中常用的一种配置。


    assembly

    
        tar.gz
    

    true

    
        
            src/main/bin
            
                *.sh
            
            bin
            0755
        
        
            src/main/conf
            conf
        
        
            src/main/sql
            
                *.sql
            
            sql
        
        
            target/classes/
            
                *.properties
                *.xml
                *.txt
            
            conf
        
    

    
        
            target/${project.artifactId}-${project.version}.jar
            .
        
    

    
        
            false
            runtime
            lib
        
    

  id与formats

    formats是assembly插件支持的打包文件格式,有zip、tar、tar.gz、tar.bz2、jar、war。可以同时定义多个format。
    id则是添加到打包文件名的标识符,用来做后缀。
    也就是说,如果按上面的配置,生成的文件就是 a r t i f a c t I d ? {artifactId}-artifactId?{version}-assembly.tar.gz。

  fileSets/fileSet
    用来设置一组文件在打包时的属性。

  directory:源目录的路径。
  includes/excludes:设定包含或排除哪些文件,支持通配符。
  fileMode:指定该目录下的文件属性,采用Unix八进制描述法,默认值是0644。
  outputDirectory:生成目录的路径。

  files/file

    与fileSets大致相同,不过是指定单个文件,并且还可以通过destName属性来设置与源文件不同的名称。
  dependencySets/dependencySet
    用来设置工程依赖文件在打包时的属性。也与fileSets大致相同,不过还有两个特殊的配置:

  unpack:布尔值,false表示将依赖以原来的JAR形式打包,true则表示将依赖解成*.class文件的目录结构打包。
  scope:表示符合哪个作用范围的依赖会被打包进去。compile与provided都不用管,一般是写runtime。

  按照以上配置打包好后,将.tar.gz文件上传到服务器,解压之后就会得到bin、conf、lib等规范化的目录结构,十分方便。

4.spring-boot-maven-plugin

  能够以Maven的方式为应用提供Spring Boot的支持,即为Spring Boot应用提供了执行Maven操作的可能。

   Spring Boot Maven plugin的5个Goals

  • spring-boot:repackage,默认goal。在mvn package之后,再次打包可执行的jar/war,同时保留mvn package生成的jar/war为.origin
  • spring-boot:run,运行Spring Boot应用
  • spring-boot:start,在mvn integration-test阶段,进行Spring Boot应用生命周期的管理
  • spring-boot:stop,在mvn integration-test阶段,进行Spring Boot应用生命周期的管理
  • spring-boot:build-info,生成Actuator使用的构建信息文件build-info.properties

    配置pom.xml文件


        
            
                org.springframework.boot
                spring-boot-maven-plugin
                2.0.1.RELEASE
                
                    
                        
                            repackage
                        
                    
                
            
        
    

   使用该插件打包之后,会生成一个 以 original 的软件包:

                                                                      

5. maven-resources-plugin

    Resources插件负责处理项目资源文件并拷贝到输出目录。Maven将main resources和test resources分开,一般main resources关联main source code,而test resources关联test source code。

   Resources插件目标有三个:

  1. resources:resources,拷贝main resources到main output directory。它绑定了process-resources生命周期阶段,当执行Compiler:compile插件目标前就会执行此阶段。
  2. resources:testResources,拷贝test resources到test output directory。它绑定了process-test-resources生命周期阶段,当执行surefire:test插件目标前就会执行此阶段。
  3. resources:copy-resources,手动拷贝资源到输出目录

  pom 简约配置示例: 


    
        
            maven-resources-plugin
            3.0.2
            
                UTF-8
            
        
    

  可能用到的配置:


    org.apache.maven.plugins
    maven-resources-plugin
    2.6
    
        
        
            copy-resources
            package
            
                copy-resources
            
            
                UTF-8
                
                {project.build.directory}/config
                
                    
                    
                        
                        src/main/resources
                        
                        true
                        
                        
                            **/*.*
                        
                        
                            **/*.json
                        
                    
                
            
        
    

6. maven-dependency-plugin

  用来拷贝项目所有依赖,可能会用到的一些配置如下:


    org.apache.maven.plugins
    maven-dependency-plugin
    
        
            copy-dependencies
            package
            
                copy-dependencies
            
            
                
                ${project.build.directory}/lib
                
                false
                
                false