背景
maven 作为Java 开发者必备的项目管理和构建工具,已经深深的影响了一代 Javaer.? 本文主要记录一些你可能用过但是不那么常用,但是关键时刻可能又非常有用的plugin.以备需要的时候查看.只列举插件的一些常用配置;
编译
maven-compiler-plugin
用于便于 Java 项目mvn compile就是使用它.不多说.
<plugin>
<artifactId>maven-compiler-pluginartifactId>
<version>3.8.0version>
<configuration>
<source>${java.version}source>
<target>${java.version}target>
<encoding>UTF-8encoding>
configuration>
plugin>
复制代码maven-source-plugin
<plugin>
<groupId>org.apache.maven.pluginsgroupId>
<artifactId>maven-source-pluginartifactId>
<version>3.0.1version>
<executions>
<execution>
<id>attach-sourcesid>
<phase>nonephase>
<goals>
<goal>jargoal>
goals>
execution>
executions>
plugin>
复制代码可执行 Jar 包和重命名Package
maven-shade-plugin
maven-shade-plugin主要提供了 rename 包名,将依赖包放进一个 jar 中,简直是一个万能的插件,使用,根据实际经验,这个插件在提供防止和其他包有冲突的 sdk 的时候特别有用.
- filters: 只选择 jar 包中需要的包名或者 exclude 不需要的包名
- artifactSet :选择哪些 jar 包放入最终的 jar 包中
- relocations:重命名包名路径,也可以选择 includes 和 excludes
- Transformers :合并器的选择,就是公共的资源文件应该如何合并.
<plugin>
<groupId>org.apache.maven.pluginsgroupId>
<artifactId>maven-shade-pluginartifactId>
<version>3.0.0version>
<executions>
<execution>
<phase>packagephase>
<goals>
<goal>shadegoal>
goals>
<configuration>
<shadedArtifactAttached>falseshadedArtifactAttached> <createDependencyReducedPom>truecreateDependencyReducedPom>
<createSourcesJar>truecreateSourcesJar>
<shadeSourcesContent>trueshadeSourcesContent>
<filters>
<filter>
<artifact>io.jaegertracing:jaeger-thriftartifact>
<includes>
<include>jaeger/org/apache/**include>
<include>io/jaegertracing/**include>
includes>
filter>
<filter>
<artifact>ch.qos.logback:logback-classicartifact>
<excludes>
<exclude>META-INF/services/**exclude>
excludes>
filter>
filters>
<artifactSet>
<excludes>
<exclude>net.bytebuddy:byte-buddy:jar:exclude>
excludes>
artifactSet>
<relocations>
<relocation>
<pattern>com.squareuppattern>
<shadedPattern>${shade.package}.com.squareupshadedPattern>
relocation>
relocations>
<transformers>
<transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
<manifestEntries>
<Premain-Class>${premain.class}Premain-Class>
manifestEntries>
transformer>
transformers>
configuration>
execution>
executions>
plugin>
复制代码maven-jar-plugin
<plugin>
<groupId>org.apache.maven.pluginsgroupId>
<artifactId>maven-jar-pluginartifactId>
<version>3.1.0version>
<configuration>
<archive>
<manifest>
<addClasspath>trueaddClasspath>
<mainClass>com.test.fastjar.fatjartest.FatJarTestApplicationmainClass>
manifest>
archive>
configuration>
plugin>
复制代码maven-assembly-plugin
此插件主要在打包上线过程中使用,但是也可以用来构建可执行的 jar 包.
<plugin>
<groupId>org.apache.maven.pluginsgroupId>
<artifactId>maven-assembly-pluginartifactId>
<version>3.1.0version>
<configuration>
<descriptorRefs>
<descriptorRef>jar-with-dependenciesdescriptorRef>
descriptorRefs>
<archive>
<manifest>
<mainClass>com.test.fastjar.fatjartest.FatJarTestApplicationmainClass>
manifest>
archive>
configuration>
<executions>
<execution>
<id>assemble-allid>
<phase>packagephase>
<goals>
<goal>singlegoal>
goals>
execution>
executions>
plugin>
复制代码发布
maven-release-plugin
规范化 项目的构建发布,自动修改POM版本,自动打 tag,特别有用.
常用命令:- 准备发布:
mvn release:prepare - 执行发布:
mvn release:perform -Darguments="-Dmaven.deploy.skip=true"(如果不想推送 jar 包到仓库中)
<plugin>
<groupId>org.apache.maven.pluginsgroupId>
<artifactId>maven-release-pluginartifactId>
<version>2.5.3version>
<configuration>
<tagNameFormat>@{project.version}tagNameFormat>
<autoVersionSubmodules>trueautoVersionSubmodules>
configuration>
plugin>
复制代码打包
主要目的是将所需要的资源都压缩成一个 tar或者zip包,便于上线发布.
<plugin>
<groupId>org.apache.maven.pluginsgroupId>
<artifactId>maven-assembly-pluginartifactId>
<version>3.0.0version>
<configuration>
<appendAssemblyId>falseappendAssemblyId>
<filters>
<filter>src/assembly/filter.propertiesfilter>
filters>
<descriptors>
<descriptor>src/assembly/assembly.xmldescriptor>
descriptors>
configuration>
<executions>
<execution>
<id>make-assemblyid>
<phase>packagephase>
<goals>
<goal>singlegoal>
goals>
execution>
executions>
plugin>
复制代码重点在于src/assembly/assembly.xml如何配置,如下是将一个单独的 jar 包打包上线.
- assembly 过程中也可以 filter 资源文件.
<assembly
xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2 http://maven.apache.org/xsd/assembly-1.1.2.xsd">
<id>binid>
<formats>
<format>tar.gzformat>
formats>
<includeBaseDirectory>falseincludeBaseDirectory>
<fileSets>
<fileSet>
<directory>src/bin/${profileActive}directory>
<outputDirectory>${project.artifactId}/binoutputDirectory>
<fileMode>0755fileMode>
fileSet>
fileSets>
<files>
<file>
<source>target/${project.artifactId}-${project.version}.jarsource>
<outputDirectory>${project.artifactId}/outputDirectory>
file>
files>
assembly>
复制代码命令执行
maven-antrun-plugin
执行 ant 命令
<plugin>
<groupId>org.apache.maven.pluginsgroupId>
<artifactId>maven-antrun-pluginartifactId>
<version>1.8version>
<executions>
<execution>
<id>unpackid>
<phase>packagephase>
<configuration>
<target>
<echo message="unjar" />
<unzip src="${project.build.directory}/${artifactId}-${version}.jar" dest="${project.build.directory}/unpacked/" />
target>
configuration>
<goals>
<goal>rungoal>
goals>
execution>
<execution>
<id>copyid>
<phase>packagephase>
<goals>
<goal>rungoal>
goals>
<configuration>
<target>
<copy file="${project.build.directory}/${project.artifactId}-${project.version}.jar" tofile="../agent.jar" overwrite="true" />
<copy file="${project.build.directory}/classes/version" tofile="../version" overwrite="true" />
target>
configuration>
execution>
executions>
plugin>
复制代码代码生成
mybatis-generator-plugin
<plugin>
<groupId>org.mybatis.generatorgroupId>
<artifactId>mybatis-generator-maven-pluginartifactId>
<version>1.3.7version>
<dependencies>
<dependency>
<groupId>mysqlgroupId>
<artifactId>mysql-connector-javaartifactId>
<version>5.1.41version>
dependency>
<dependency>
<groupId>com.itfswgroupId>
<artifactId>mybatis-generator-pluginartifactId>
<version>1.2.15version>
dependency>
dependencies>
<configuration>
<configurationFile>generatorConfig.xmlconfigurationFile>
<overwrite>trueoverwrite>
<verbose>trueverbose>
configuration>
plugin>
复制代码generatorConfig.xml
xml version="1.0" encoding="UTF-8" ?>
<generatorConfiguration>
<context id="symphony">
<property name="autoDelimitKeywords" value="true"/>
<property name="beginningDelimiter" value="`"/>
<property name="endingDelimiter" value="`"/>
<plugin type="com.itfsw.mybatis.generator.plugins.SelectOneByExamplePlugin"/>
<plugin type="com.itfsw.mybatis.generator.plugins.LimitPlugin"/>
<plugin type="com.itfsw.mybatis.generator.plugins.ModelBuilderPlugin"/>
<plugin type="com.itfsw.mybatis.generator.plugins.ExampleEnhancedPlugin"/>
<plugin type="com.itfsw.mybatis.generator.plugins.BatchInsertPlugin"/>
<plugin type="com.itfsw.mybatis.generator.plugins.ModelColumnPlugin"/>
<plugin type="com.itfsw.mybatis.generator.plugins.SelectSelectivePlugin"/>
<commentGenerator>
<property name="suppressAllComments" value="false"/>
<property name="suppressDate" value="true"/>
commentGenerator>
<jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://192.168.8.1:5711/xxx?useSSL=false"
userId="xxx" password="xxx"/>
<javaModelGenerator targetPackage="com.xxx.model"
targetProject="src/main/java"/>
<sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources" />
<javaClientGenerator targetPackage="com.xxx.dao"
targetProject="src/main/java" type="XMLMAPPER"/>
<table tableName="app_deploy">
<generatedKey column="id" sqlStatement="JDBC" identity="true"/>
table>
context>
generatorConfiguration>
复制代码protobuf-maven-plugin
用于根据.proto 文件生成 protobuf 文件
<extensions>
<extension>
<groupId>kr.motd.mavengroupId>
<artifactId>os-maven-pluginartifactId>
<version>1.5.0.Finalversion>
extension>
extensions>
<plugin>
<groupId>org.xolstice.maven.pluginsgroupId>
<artifactId>protobuf-maven-pluginartifactId>
<executions>
<execution>
<id>Generate Java from protocol buffersid>
<phase>generate-sourcesphase>
<goals>
<goal>compilegoal>
<goal>compile-customgoal>
goals>
<configuration>
<checkStaleness>truecheckStaleness>
<pluginArtifact>io.grpc:protoc-gen-grpc-java:1.18.0:exe:${os.detected.classifier}pluginArtifact>
<pluginId>grpc-javapluginId>
<protoSourceRoot>${project.build.directory}/generated-sources/_protoprotoSourceRoot>
<protocArtifact>com.google.protobuf:protoc:3.6.1:exe:${os.detected.classifier}protocArtifact>
configuration>
execution>
executions>
plugin>
复制代码SCM
maven-scm-plugin
从远程仓库获取源码,用于项目.
<plugin>
<artifactId>maven-scm-pluginartifactId>
<executions>
<execution>
<id>Checkout Helm Protocol Buffers source codeid>
<phase>generate-sourcesphase>
<goals>
<goal>checkoutgoal>
goals>
<configuration>
<checkoutDirectory>${project.build.directory}/generated-sources/helmcheckoutDirectory>
<connectionUrl>scm:git:https://github.com/kubernetes/helm.gitconnectionUrl>
<includes>_proto/hapi/**includes>
<scmVersion>v2.12.3scmVersion>
<scmVersionType>tagscmVersionType>
configuration>
execution>
executions>
plugin>
复制代码总结
如上只是一些本人总结的有用的插件,仅供参考.