我正在尝试为Maven构建自定义报告插件,以便与mvn site
一起使用。
但是我找不到任何有关如何继续的更新文档。
有关创建插件的官方文档提及扩展org.apache.maven.plugin.AbstractMojo
。但这是关于通常的构建生命周期的“常规”插件。它不适用于site
构建生命周期。
SO上有一个类似的问题(Writing a maven custom report plugin; how do I generate the html body or "middle" of my report?)引用了2015年的一个文档,该文档提到AbstractMavenReport
类而不是AbstractMojo
类,但我找不到它可以在我的项目中的任何地方导入。
我还查看了一些最新报告插件的代码(此处为changes
插件:http://svn.apache.org/viewvc/maven/plugins/tags/maven-changes-plugin-2.12.1/),但我找不到我要找的内容。
报告插件至少没有原型吗?任何人都有这方面的经验吗?
谢谢! - 伯特兰
答案 0 :(得分:1)
多挖一点,我找到了答案: http://maven.apache.org/shared/maven-reporting-impl/index.html
所以,基本上,你需要在 pom.xml 中使用它:
<dependencies>
<dependency>
<groupId>org.apache.maven.reporting</groupId>
<artifactId>maven-reporting-impl</artifactId>
<version>@project.version@</version>
</dependency>
<dependency>
<groupId>org.apache.maven.reporting</groupId>
<artifactId>maven-reporting-api</artifactId>
<version>3.0</version>
</dependency>
<!-- plugin API and plugin-tools -->
<dependency>
<groupId>org.apache.maven</groupId>
<artifactId>maven-plugin-api</artifactId>
<version>3.0.5</version>
</dependency>
<dependency>
<groupId>org.apache.maven.plugin-tools</groupId>
<artifactId>maven-plugin-annotations</artifactId>
<version>3.3</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.apache.maven.shared</groupId>
<artifactId>maven-shared-utils</artifactId>
<version>3.2.0</version>
</dependency>
</dependencies>
然后,您的主要课程必须延长AbstractMavenReport
:
import java.util.Locale;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.reporting.AbstractMavenReport;
import org.apache.maven.reporting.MavenReportException;
/**
* Typical code to copy as a reporting plugin start: choose the goal name, then implement getOutputName(),
* getName( Locale ), getDescription( Locale ) and of course executeReport( Locale ).
*/
@Mojo( name = "custom" )
public class CustomReport
extends AbstractMavenReport
{
public String getOutputName()
{
return "custom-report";
}
public String getName( Locale locale )
{
return "Custom Maven Report";
}
public String getDescription( Locale locale )
{
return "Custom Maven Report Description";
}
@Override
protected void executeReport( Locale locale )
throws MavenReportException
{
// direct report generation using Doxia: compare with CustomReportRenderer to see the benefits of using
// ReportRenderer
getSink().head();
getSink().title();
getSink().text( "Custom Report Title" );
getSink().title_();
getSink().head_();
getSink().body();
getSink().section1();
getSink().sectionTitle1();
getSink().text( "section" );
getSink().sectionTitle1_();
getSink().text( "Custom Maven Report content." );
getSink().section1_();
getSink().body_();
}
}
希望这将有助于Maven Reporting插件的未来开发人员! ; - )