maven2站点的定制和发布.docx
- 文档编号:7225605
- 上传时间:2023-01-22
- 格式:DOCX
- 页数:16
- 大小:22.04KB
maven2站点的定制和发布.docx
《maven2站点的定制和发布.docx》由会员分享,可在线阅读,更多相关《maven2站点的定制和发布.docx(16页珍藏版)》请在冰豆网上搜索。
maven2站点的定制和发布
<!
--原创作品,转载请注明出处!
-->
mvnsite功能强大,特别是在生成的项目站点中可以添加很多测试报告及文档。
一般需要解决3个问题:
1、如何定制站点的内容和样式?
2、mvnsite生成的文件分布在各子模块目录下,如何统一管理?
3、如何将报告发布成站点,以便于项目组其它成员通过浏览器能够方便的查看?
--------------------------------------------------------------------------------------------------
站点定制:
一、如果不做任何配置,执行mvnsite命令生成默认样式的站点,主要包括以下内容:
1、子模块列表Modules;
2、文档列表ProjectDocumentation,主要有两大块:
项目信息ProjectInformation、项目报告ProjectReports;
3、项目信息ProjectInformation,默认包括项目相关概要信息、持续集成、依赖、插件、配置库等报告,详见官网(Apache>Maven>Plugins>MavenProjectInfoReportsPlugin):
http:
//maven.apache.org/plugins/maven-project-info-reports-plugin/
4、项目报告ProjectReports,取决与pom.xml文件中
二、如果想要增加站点内容,或者减少项目信息报告,则需要建立site.xml文件,修改项目pom文件
1、在项目根目录下(与根pom同级)新建src\site目录,其下新建site.xml文件;
2、site.xml的标准格式和校验文件可以参见官网(Apache>Maven>Plugins>MavenSitePlugin>ConfiguringtheSiteDescriptor):
http:
//maven.apache.org/plugins/maven-site-plugin/examples/sitedescriptor.html
3、编写site.xml,参考官网;
4、一个例子:
xmlversion="1.0"encoding="ISO-8859-1"?
>
//maven.apache.org/DECORATION/1.0.0"xmlns: xsi="http: //www.w3.org/2001/XMLSchema-instance"xsi: schemaLocation="http: //maven.apache.org/DECORATION/1.0.0http: //maven.apache.org/xsd/decoration-1.0.0.xsd"> -- //maven.apache.org/images/apache-maven-project.png //maven.apache.org/ //maven.apache.org/images/maven-small.gif -->
--
-->
5、以上例子中,parent、modules、reports为保留字,生成的站点将包含以下内容:
模块名(默认与各级pom文件中的
6、需要注意的是,无需配置ProjectInfoReportsPlugin即默认包含所有ProjectInformation报告,如果想要去掉其中某些报告,需要在pom文件中对ProjectInfoReportsPlugin进行配置:
--
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.
四、集成Checkstyle、 Cobertura、Surefire、Findbugs
Checkstyle:
Reportoncodingstyleconventions.
CoberturaTestCoverage:
CoberturaTestCoverageReport.
SurefireReport:
Reportonthetestresultsoftheproject.
FindBugsReport:
GeneratesasourcecodereportwiththeFindBugsLibrary.
在超级pom文件的build pluginManagement和build plugins以及reporting部分增加以上插件(详见《CheckStyle、cobertura、Findbugs与Maven2的集成》)。
...
--TodefinethepluginversioninyourparentPOM-->
...
--TousetheplugingoalsinyourPOMorparentPOM-->
...
...
--TousethereportgoalsinyourPOMorparentPOM-->
...
...
五、全局聚合报告
当项目有多个子模块时,生成的站点需要到各级子目录下面才能看到。
如果想要生成一个整体情况的报告,则需要使用dashboard插件来生成全局报告。
官网:
http:
//mojo.codehaus.org/dashboard-maven-plugin/usage.html
1、在项目pom文件build pluginManagement和build plugins以及reporting部分配置dashboard插件
...
--TodefinethepluginversioninyourparentPOM-->
...
--TousetheplugingoalsinyourPOMorparentPOM-->
...
...
--TousethereportgoalsinyourPOMorparentPOM-->
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- maven2 站点 定制 发布