maven2站点的定制和发布Word格式文档下载.docx

maven2站点的定制和发布Word格式文档下载.docx

《maven2站点的定制和发布Word格式文档下载.docx》由会员分享，可在线阅读，更多相关《maven2站点的定制和发布Word格式文档下载.docx（16页珍藏版）》请在冰豆网上搜索。

http:

//maven.apache.org/plugins/maven-project-info-reports-plugin/

4、项目报告ProjectReports，取决与pom.xml文件中<

reporting>

部分的配置，可集成checkstyle、cobertura、Findbugs等报告；

二、如果想要增加站点内容，或者减少项目信息报告，则需要建立site.xml文件，修改项目pom文件

1、在项目根目录下（与根pom同级）新建src\site目录，其下新建site.xml文件；

2、site.xml的标准格式和校验文件可以参见官网（Apache>

MavenSitePlugin>

ConfiguringtheSiteDescriptor）：

//maven.apache.org/plugins/maven-site-plugin/examples/sitedescriptor.html

3、编写site.xml，参考官网；

4、一个例子：

?

xmlversion="

1.0"

encoding="

ISO-8859-1"

>

projectxmlns="

//maven.apache.org/DECORATION/1.0.0"

xmlns:

xsi="

//www.w3.org/2001/XMLSchema-instance"

xsi:

schemaLocation="

//maven.apache.org/DECORATION/1.0.0http:

//maven.apache.org/xsd/decoration-1.0.0.xsd"

!

--<

bannerLeft>

<

name>

TEST<

/name>

src>

//maven.apache.org/images/apache-maven-project.png<

/src>

href>

//maven.apache.org/<

/href>

/bannerLeft>

bannerRight>

//maven.apache.org/images/maven-small.gif<

/bannerRight>

body>

links>

itemname="

Up"

href="

../dashboard-report.html"

/>

Home"

/links>

menuref="

parent"

-- 

menuname="

Overview"

Introduction"

index.html"

ProjectSummary"

project-summary.html"

/>

PluginManagement"

plugin-management.html"

ProjectPlugins"

plugins.html"

SourceRepository"

source-repository.html"

/menu>

modules"

reports"

/body>

/project>

5、以上例子中，parent、modules、reports为保留字，生成的站点将包含以下内容：

模块名（默认与各级pom文件中的<

对应）、上级模块链接（parent，方便返回上级目录）、子模块列表链接（modules）、文档列表（reports，包括ProjectInformation和ProjectReports）、返回上级目录和返回首页的链接；

6、需要注意的是，无需配置ProjectInfoReportsPlugin即默认包含所有ProjectInformation报告，如果想要去掉其中某些报告，需要在pom文件中对ProjectInfoReportsPlugin进行配置：

plugins>

plugin>

groupId>

org.apache.maven.plugins<

/groupId>

artifactId>

maven-project-info-reports-plugin<

/artifactId>

version>

2.1.2<

/version>

reportSets>

reportSet>

reports>

report>

index<

/report>

summary<

project-team<

mailing-list<

cim<

issue-tracking<

license<

scm<

/reports>

/reportSet>

/reportSets>

/plugin>

/plugins>

/reporting>

7、一般情况下，index页面需要生成，以免进入子模块时找不到链接。

三、javadoc报告和jxr代码链接

在build 

pluginManagement和build 

plugins以及reporting部分增加javadoc插件，如果pom文件中已经配置，则只需作相应修改。

charset、encoding、docencoding配置用于解决生成的javadoc文件中文乱码问题；

aggregate配置为true则javadoc报告会集中显示所有子模块的javadoc。

在reporting部分增加JXR插件。

TheJXRpluginproducesacross-referenceoftheproject'

ssources.Thegeneratedreportsmakeiteasierfortheusertoreferenceorfindspecificlinesofcode.ItisalsohandywhenusedwiththePMDplugin（andcheckstyleplugin）forreferencingerrorsfoundinthecode.

maven-javadoc-plugin<

2.4<

configuration>

aggregate>

true<

/aggregate>

charset>

UTF-8<

/charset>

encoding>

/encoding>

docencoding>

/docencoding>

/configuration>

maven-jxr-plugin<

四、集成Checkstyle、 

Cobertura、Surefire、Findbugs

Checkstyle：

Reportoncodingstyleconventions.

CoberturaTestCoverage：

CoberturaTestCoverageReport.

SurefireReport：

Reportonthetestresultsoftheproject.

FindBugsReport：

GeneratesasourcecodereportwiththeFindBugsLibrary.

在超级pom文件的build 

plugins以及reporting部分增加以上插件（详见《CheckStyle、cobertura、Findbugs与Maven2的集成》）。

project>

...

build>

--TodefinethepluginversioninyourparentPOM-->

pluginManagement>

maven-checkstyle-plugin<

2.3<

org.codehaus.mojo<

findbugs-maven-plugin<

2.0.1<

maven-surefire-report-plugin<

2.5<

cobertura-maven-plugin<

/pluginManagement>

--TousetheplugingoalsinyourPOMorparentPOM-->

...

/build>

--TousethereportgoalsinyourPOMorparentPOM-->

configLocation>

Loong_Checks.xml<

/configLocation>

xmlOutput>

/xmlOutput>

effort>

Max<

/effort>

五、全局聚合报告

当项目有多个子模块时，生成的站点需要到各级子目录下面才能看到。

如果想要生成一个整体情况的报告，则需要使用dashboard插件来生成全局报告。

官网：

//mojo.codehaus.org/dashboard-maven-plugin/usage.html

1、在项目pom文件build 

plugins以及reporting部分配置dashboard插件

dashboard-maven-plugin<

1.0.0-beta-1<