# Maven 的其它插件

# 1. tomcat8 插件

TIP

可能因为某些特殊原因,你需要使用 tomcat8-maven-plugin ,而不是 tomcat7 插件 。

你能在 mvnrepository 上查到 tomcat8-maven-plugin 插件的信息网址 (opens new window)。但是,人家有也明确说了,这个包并不在中央仓库中,而是在另一个(非中央)仓库里。

Note: this artifact is located at ICM repository (http://maven.icm.edu.pl/artifactory/repo/)

因此,maven 无法从中央仓库下载到 tomcat 8 的 maven 插件,因为中央仓库根本就没有。阿里的镜像服务器中自然也没有。

如果,你要使用 tomcat8-maven-plugin 插件,你需要额外地、明确地告诉它对于中央仓库中没有的包,要去哪里下载。这就需要在 pom.xml 配置文件中进行配置。

依赖声明整体结构(其它无关元素略。另外,pluginRepositories 习惯性在 build 的后面)

project 
├── dependencies
├── build
└── pluginRepositories
    ├── pluginRepository
    ├── pluginRepository
    ├── ...
    └── pluginRepository

主要包含如下元素:

<pluginRepositories>
    <pluginRepository>
        <id>alfresco</id>
        <url>https://artifacts.alfresco.com/nexus/content/repositories/public/</url>
        <snapshots>
           <enabled>false</enabled>
        </snapshots>
        <releases>
            <enabled>true</enabled>
        </releases>
    </pluginRepository>
</pluginRepositories>

考虑到境外仓库的网络问题,最好还是直接从老师(或同事)的本地仓库中将他们下好的 tomcat8 插件拷贝过来(更省事一些)


在通过 tomcat8-maven-plugin 运行项目时,可能会遇到一些问题:

  • 问题一:

    Caused by: java.io.FileNotFoundException: C:\Program%20Files\JetBrains\IntelliJ%20IDEA%202020.2.3\plugins\maven\lib\maven3\lib\javax.inject-1.jar (系统找不到指定的路径。)
    

    这是因为 IDEA 所使用的内置的 maven 的路径名中有空格(上述的 %20)对 tomcat8-maven-plugin 造成了干扰(对 tomcat7-maven-plugin 没影响)

    因此,你需要将 IDEA 所使用的 maven 从内置的 maven 配置为外部的 maven,而且这个 maven 的路径中不能有空格。

  • 问题二:

    使用 tomcat8:run 时,有可能会出现莫名其妙的 500 错误。所以你要使用的是 tomcat8:run-war 命令。

# 2. mybatis-generator 插件

就我个人而言,如果项目中使用到了 mybatis 框架,那么 mybatis-generator 插件就是我的必备插件。

mybatis-generator-maven-plugin 是 mybatis 官方提供的用于在 maven 中直接使用 mybatis-generator 。

<!-- 它位于 <plugins>...</plugins> 中 -->
<plugin> <!-- mybatis.generator 插件 begin -->
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-maven-plugin</artifactId>
    <version>1.4.0</version> <!-- 不要低于 1.3.7 版本 -->
    <dependencies>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.22</version>
        </dependency>
        <dependency>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-core</artifactId>
            <version>1.4.0</version> <!-- 不要低于 1.3.7 版本 -->
        </dependency>
        </dependencies>
        <configuration>
            <verbose>true</verbose> <!-- 允许移动生成的文件 -->
            <overwrite>true</overwrite> <!-- 是否覆盖 -->
            <!-- 自动生成的配置 -->
            <configurationFile>src/main/resources/mybatis/mybatis-generator-config.xml</configurationFile>
    </configuration>
</plugin> <!-- mybatis.generator 插件 end -->

上述的配置中的要素的作用显而易见:

  • 插件依赖于数据库驱动包和 mybatis-generator-core 来连接到数据库,并进行反向生成功能。
  • 插件需要你提供一个配置文件来告诉它反向生成过程中的一些具体细节。

# 3. dockerfile 插件

dockerfile-maven-plugin 是 spotify 公司新提供的、用以替代 docker-maven-plugin 的插件,它同样是用于在 maven 中将当前项目打成一个 docker image 。 相较于 docker-maven-plugin 而言,dockerfile-maven-plugin 更简洁、方便。

<plugin>
    <groupId>com.spotify</groupId>
    <artifactId>dockerfile-maven-plugin</artifactId>
    <version>1.4.13</version>
    <configuration>
        <repository>${project.artifactId}</repository>
        <tag>${project.version}</tag>
        <buildArgs>
            <JAR_FILE>${project.build.finalName}.jar</JAR_FILE>
        </buildArgs>
    </configuration>
</plugin>

dockerfile-maven-plugin 插件会要求在项目的根目录下,也就是 pom.xml 文件的平级目录下存在一个 Dockerfile 文件,它会去用这个 Dockerfile 文件生成 docker image 。

FROM openjdk:8-jre-alpine
EXPOSE 8080
ARG JAR_FILE
ADD target/${JAR_FILE} app.jar
ENTRYPOINT ["java", "-jar", "/app.jar"]

# 4. Apache Maven Checkstyle Plugin

Apache 基金会的 maven checkstyle 插件能帮程序员检测代码中不符合规范的地方,大大方便程序开发。

checkstyle 默认使用 sun 公司的编程规范来检查代码规范。如果你像自定义校验规则,你需要提供一个 checkstyle.xml 配置文件,在配置文件中按 checkstyle 的规则启用或关闭某个规则。

不过随着《阿里巴巴 Java 开发手册》的流行,阿里巴巴推出了类似的 maven 插件 p3c-pmd,因此,checkstyle 慢慢被 p3c-pmd 取代了。

# 5. p3c-pmd 插件

P3C-PMD 插件基于 PMD 实现了《阿里巴巴 Java 开发手册》中涉及的 48 条规则。

<!-- 在 <plugins>...</plugins> 里面 -->
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-pmd-plugin</artifactId>
    <version>3.13.0</version>
    <configuration>
        <rulesets>
            <ruleset>rulesets/java/ali-naming.xml</ruleset>
            <!--
            <ruleset>rulesets/java/ali-comment.xml</ruleset>
            <ruleset>rulesets/java/ali-concurrent.xml</ruleset>
            <ruleset>rulesets/java/ali-constant.xml</ruleset>
            <ruleset>rulesets/java/ali-exception.xml</ruleset>
            <ruleset>rulesets/java/ali-flowcontrol.xml</ruleset>
            <ruleset>rulesets/java/ali-oop.xml</ruleset>
            <ruleset>rulesets/java/ali-orm.xml</ruleset>
            <ruleset>rulesets/java/ali-other.xml</ruleset>
            <ruleset>rulesets/java/ali-set.xml</ruleset>
            -->
        </rulesets>
        <printFailingErrors>true</printFailingErrors>
    </configuration>
    <executions>
        <execution>
            <id>validate</id>
            <phase>validate</phase>
            <goals>
                <goal>check</goal>
            </goals>
        </execution>
    </executions>
    <dependencies>
        <!-- 需要使用阿里的一些 xml 文件,因此需要这里增加 p3c 的依赖 -->
        <dependency>
            <groupId>com.alibaba.p3c</groupId>
            <artifactId>p3c-pmd</artifactId>
            <version>2.1.0</version>
        </dependency>
    </dependencies>
</plugin>