maven常用插件记录

今天药忘吃喽~ 2022-07-16 20:17 224阅读 0赞

不管你用什么插件，创建项目后pom文件中首先引入以下配置项

首先是默认的编译插件maven-compiler-plugin和打包插件maven-jar-plugin，一般不需要进行配置。

### 1、maven-compiler-plugin ###

1）编译时指定encoding，否则中文通不过，configuration可以只配置encoding

2）执行mvn install时编译报错，因为编译器的版本太老了，通过这个插件修改版本，可以只配置source和target

<plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <version>3.1</version>
        <configuration>
            <source>1.8</source>
            <target>1.8</target>
            <encoding>UTF-8</encoding>
            <compilerArgs>
                <arg>-extdirs</arg>
                <arg>${project.basedir}/src/main/webapp/WEB-INF/lib</arg>
            </compilerArgs>
        </configuration>
    </plugin>

### 2、maven-jar-plugin ###

默认的打包插件，指定主程序的入口，将依赖的jar包一同打出

<plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-jar-plugin</artifactId>
        <configuration>
            <classesDirectory>target/classes/</classesDirectory>
            <archive>
                <manifest>
                    <mainClass>com.alibaba.dubbo.container.Main</mainClass>
                    
                    <useUniqueVersions>false</useUniqueVersions>
                    <addClasspath>true</addClasspath>
                    <classpathPrefix>lib/</classpathPrefix>
                </manifest>
                <manifestEntries>
                    <Class-Path>.</Class-Path>
                </manifestEntries>
            </archive>
        </configuration>
    </plugin>

### 3、maven-dependency-plugin ###

自动拷jar包到target目录，我们实际部署时只有java环境，没有源码和IDE，所以一般使用这个插件把引用的库统一打包到指定目录下，比如lib文件夹。部署war包时，需要将项目依赖的jar包，也打到war包中，这时就会用到该插件

<plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-dependency-plugin</artifactId>
        <executions>
            <execution>
                <id>copy-dependencies</id>
                <phase>package</phase>
                <goals>
                    <goal>copy-dependencies</goal>
                </goals>
                <configuration>
                    <type>jar</type>
                    <includeTypes>jar</includeTypes>
                    <useUniqueVersions>false</useUniqueVersions>
                    <outputDirectory>
                        ${project.build.directory}/lib
                    </outputDirectory>
                </configuration>
            </execution>
        </executions>
    </plugin>

### 4、jetty-maven-plugin ###

mvn jetty:run 启动；Ctrl +C停止服务或者使用mvn jetty:stop

<plugin>
        <groupId>org.eclipse.jetty</groupId>
        <artifactId>jetty-maven-plugin</artifactId>
        <version>9.4.6.v20170531</version>
        <configuration>
            
            <httpConnector>
                <port>8081</port>
                <idleTimeout>60000</idleTimeout>
            </httpConnector>
            
            <reload>manual</reload>
            
            <webApp>
                <contextPath>/</contextPath>
            </webApp>
            
            <requestLog implementation="org.eclipse.jetty.server.NCSARequestLog">
                <filename>target/access-yyyy_mm_dd.log.log</filename>
                <filenameDateFormat>yyyy_MM_dd</filenameDateFormat>
                <logDateFormat>yyyy-MM-dd HH:mm:ss</logDateFormat>
                <logTimeZone>GMT+8:00</logTimeZone>
                <logServer>true</logServer>
                <retainDays>90</retainDays>
                <append>true</append>
                <extended>false</extended>
            </requestLog>
            
            <systemProperties>
                <systemProperty>
                    <name>productionMode</name>
                    <value>false</value>
                </systemProperty>
            </systemProperties>
        </configuration>
    </plugin>

jetty插件需要引入一个依赖插件，否则报错：

<dependency>
    	<groupId>commons-fileupload</groupId>
        <artifactId>commons-fileupload</artifactId>
        <version>1.3.1</version>
    </dependency>

### 5、maven-war-plugin ###

打war包时，配置排除某些web资源文件

<plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-war-plugin</artifactId>
        <version>2.6</version>
        <configuration>
          <webResources>
            <resource>
              <directory>src/main/webapp</directory>
              <excludes>
                <exclude>**/*.jpg</exclude>
              </excludes>
            </resource>
          </webResources>
        </configuration>
    </plugin>

### 6、maven-assembly-plugin ###

支持各种打包文件格式，包括zip、tar.gz等，通过一个打包描述文件如src/main/assembly.xml，来选择具体打包哪些文件集合、依赖、模块、以及本地仓库文件，每个文件的具体打包路径可以自由控制。

[maven-assembly-plugin总结][maven-assembly-plugin]

1) 使用方式如下，首先安装plugin，配置assembly.xml文件

<plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-assembly-plugin</artifactId>
        <version>2.6</version>
        <configuration>
            <descriptors>
                <descriptor>src/main/assembly/assembly.xml</descriptor>
            </descriptors>
        </configuration>
        <executions>
            <execution>
                <id>make-assembly</id>
                <phase>package</phase>
                <goals>
                    <goal>single</goal>
                </goals>
            </execution>
        </executions>
    </plugin>

2) 配置assembly.xml文件

<assembly>
        <id>bin</id>
        <formats>
            <format>zip</format>
        </formats>
        <dependencySets>
            <dependencySet>
                <useProjectArtifact>true</useProjectArtifact>
                <outputDirectory>lib</outputDirectory>
            </dependencySet>
        </dependencySets>
        <fileSets>
            <fileSet>
                <outputDirectory>/</outputDirectory>
                <includes>
                    <include>README.md</include>
                </includes>
            </fileSet>
            <fileSet>
                <directory>src/main/scripts</directory>
                <outputDirectory>/bin</outputDirectory>
                <includes>
                    <include>run.sh</include>
                    <include>run.bat</include>
                </includes>
            </fileSet>
        </fileSets>
    </assembly>

以上代码，执行mvn clean install生成zip包，解压包含两个文件夹：bin、lib以及README.md文件

### 7、mybatisplus-maven-plugin ###

mybatisplus生成代码已经很方便了，最近又发现提供了这个插件，首先引入配置

<plugin>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatisplus-maven-plugin</artifactId>
        <version>1.0</version>
        <configuration>
            
            <outputDir>e:\cache</outputDir>
            
            <fileOverride>true</fileOverride>
            
            <enableCache>true</enableCache>
            
            <author>Yanghu</author>
            
    		<activeRecord>false</activeRecord>
            
            <dataSource>
                <driverName>com.mysql.jdbc.Driver</driverName>
                <url>jdbc:mysql://127.0.0.1:3306/demo?useUnicode=true&useSSL=false</url>
                <username>root</username>
                <password>123456</password>
            </dataSource>
            <strategy>
    			
    			<naming>remove_prefix_and_camel</naming>
    			
    			<tablePrefix>bmd_</tablePrefix>
                
                <idGenType>uuid</idGenType>
                
                
                
                
                    
                    
                
                
                
                    
                
            </strategy>
            <packageInfo>
                
                <parent>com.baomidou</parent>
                
                <service>service</service>
                
                <serviceImpl>service.impl</serviceImpl>
                
                <entity>entity</entity>
                
                <mapper>mapper</mapper>
                
                <xml>mapper.xml</xml>
            </packageInfo>
            <template>
            	
    			
    		</template>
        </configuration>
        <dependencies>
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>${mysql.version}</version>
            </dependency>
        </dependencies>
    </plugin>

执行命令：

mvn com.baomidou:mybatisplus-maven-plugin:1.0:code
    #也可在settings.xml中添加以下配置，然后执行mvn mp:code
    <pluginGroups>
    	<pluginGroup>com.baomidou</pluginGroup>
    </pluginGroups>

美中不足：1、会暴露数据库配置，2、生成的实体不能引入lombok，3、会自动添加一个字段id，生成策略默认为uuid，如果想用自增，需要将这个配置改成auto

### 8、maven-surefire-plugin跳过单元测试 ###

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-surefire-plugin</artifactId>
    <configuration>
    <skip>true</skip>
    </configuration>
    </plugin>

[maven-assembly-plugin]: https://blog.csdn.net/chang_li/article/details/77837220