maven-site-plugin笔记——2.3到3.0之间的变化

最新推荐文章于 2022-08-30 15:57:54 发布

原创最新推荐文章于 2022-08-30 15:57:54 发布 · 5k 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#maven #plugins #image #google #html #工作

Maven 专栏收录该内容

3 篇文章

订阅专栏

本文介绍了maven-site-plugin从2.3到3.0版本的变化，特别是新版本不再接受<reporting>节点下的插件配置。解决方法是将报告插件配置转换为新的形式，并说明了在3.0版本中，maven-site-plugin如何查找插件的顺序。通过这些改动，可以成功生成project-reports.html文件，但要找回index.html则需进一步了解maven-site-plugin的内部工作原理。

刚才正在配置一个项目的报告输出，在配置pom的时候按照maven2的做法在<reporting>节点下加上了pmd、checkstyle等plugin

<reporting>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-checkstyle-plugin</artifactId>
      <version>${checkstyle.plugin.version}</version>
    </plugin>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-pmd-plugin</artifactId>
      <version>${pmd.plugin.version}</version>
    </plugin>
</reporting>

却发现在target/site目录下除了image及css文件夹之外，一个html也没有，而且预期的报告也没有生成，我就纳闷了

几经Google后，终于查到，原来maven-site-plugin在3.0版本采用了一种全新的配置形式，导致不能接受<reporting>节点下声明的报告插件，这一点在其官方网站上有介绍：http://maven.apache.org/plugins/maven-site-plugin/maven-3.html#Configuration_formats

解决办法就是，将<reporting>内的plugin声明，转换为如下形式：

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-site-plugin</artifactId>
  <version>3.0</version>
  <configuration>
    <reportPlugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-checkstyle-plugin</artifactId>
      </plugin>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-pmd-plugin</artifactId>
      </plugin>
    </reportPlugins>
  </configuration>
</plugin>

注意，这里的plugin声明已经成为了maven-site-plugin中的一个configuration项，已不再享有原来plugin那种继承规则，在可视化编辑器内也再没有语法提示。

还有一点就是，在3.0版本中，在maven-site-plugin内声明的插件是可以忽略version的，maven-site-plugin会按照如下顺序查找：