编写 maven 自定义报告插件;如何生成报表的 HTML 正文或"middle"?



我正试图创建一个自定义的maven报告,以便在项目中运行mvn站点目标时生成。我遵循了这里的说明:

http://docs.codehaus.org/display/MAVENUSER/Write+您的+自己的+报告+插件

具体来说,我已经创建了一个实现适当方法的mojo,当我运行mvn站点时,它的"executeReport(…)"方法被调用。我还实现了一个扩展AbstractMavenReportRenderer的类,并用对接收器中方法的一些调用填充了renderBody(…)方法。我的Mojo在其"getRenderer()"方法中返回了该自定义渲染器的一个新实例。

当我运行mvn站点目标时,我的报告显示在报告列表中,它的html文件是用通用maven站点魔术正确生成的(所有菜单和标题以及所有内容都在那里)。但我不知道应该在"executeReport"方法中放入什么,以便按照上面文档中的建议"填充中间部分"。我需要打什么电话才能结束这个循环?

我的Mojo:

@Mojo( name = "message-documentation-report-generator")
public class MessageDocumentationReportMojo extends AbstractMavenReport
{
  /**
   * Directory where reports will go.
   *
   * @parameter expression="${project.reporting.outputDirectory}"
   * @required
   * @readonly
   */
  private String outputDirectory;
  /**
   * @parameter default-value="${project}"
   * @required
   * @readonly
   */
  private MavenProject project;
  @Override
  public String getDescription(Locale arg0)
  {
    return "Message Documentation Information";
  }
  @Override
  public String getName(Locale arg0)
  {
    return "Messages";
  }
  @Override
  public String getOutputName()
  {
    return "messages";
  }
  @Override
  protected void executeReport(Locale arg0) throws MavenReportException
  {
  }
  @Override
  protected String getOutputDirectory()
  {
    return outputDirectory;
  }
  @Override
  protected MavenProject getProject()
  {
    return project;
  }
  @Override
  protected Renderer getSiteRenderer()
  {
    return (Renderer) new MessageReportSiteRenderer(getSink());
  }
}

我的渲染器:

public class MessageReportSiteRenderer extends AbstractMavenReportRenderer
{
  public MessageReportSiteRenderer(Sink sink)
  {
    super(sink);
  }
  @Override
  public String getTitle()
  {
    return "Message Documentation Renderer?";
  }
  @Override
  protected void renderBody()
  {
    sink.head();
    sink.title();
    sink.text("FIDL graph report");
    sink.title_();
    sink.head_();
    sink.body();
    sink.section1();
    sink.sectionTitle1();
    sink.text("FIDL automata index");
    sink.sectionTitle1_();
    sink.lineBreak();
    sink.lineBreak();
    sink.text("List of behavioral elements with link to graphical representation of FIDL automata.");
    sink.lineBreak();
    sink.section1_();
    sink.body_();
    sink.flush();
    sink.close();
  }
}

答案是将renderBody()中的代码放入executeReport(Locale-loc)方法中:

@Override
protected void executeReport(Locale arg0) throws MavenReportException
{
sink.head();
sink.title();
sink.text("FIDL graph report");
sink.title_();
sink.head_();
sink.body();
sink.section1();
sink.sectionTitle1();
sink.text("FIDL automata index");
sink.sectionTitle1_();
sink.lineBreak();
sink.lineBreak();
sink.text("List of behavioral elements with link to graphical representation of FIDL automata.");
sink.lineBreak();
sink.section1_();
sink.body_();
sink.flush();
sink.close();
}

最新更新