下面,通过实例来介绍如何配置maven,来产生项目站点。
首先创建相关的site
mvn archetype:create \
-DarchetypeGroupId=org.apache.maven.archetypes \
-DarchetypeArtifactId=maven-archetype-site \
-DgroupId=com.mycompany.app \
-DartifactId=my-app-site
你会看到如下的目录:
my-app-site
|-- pom.xml
`-- src
`-- site
|-- apt
| |-- format.apt
| `-- index.apt
|-- fml
| `-- faq.fml
|-- fr
| |-- apt
| | |-- format.apt
| | `-- index.apt
| |-- fml
| | `-- faq.fml
| `-- xdoc
| `-- xdoc.xml
|-- xdoc
| `-- xdoc.xml
|-- site.xml
`-- site_fr.xml
当然也可以不用通过此来生成站点,直接在原有的src目录中增加site目录就行。当然,为了简化操作,一般先生成相应的site目录,然后拷贝到相应的src目录中。
修改pom文件
增加以下内容
xml 代码
- <distributionManagement>
- <site>
- <id>websiteid>
- <url>scp://webhost.company.com/www/websiteurl>
- site>
- distributionManagement>
- <build>
- <plugins>
- <plugin>
- <artifactId>maven-site-pluginartifactId>
- <configuration>
- <locales>zh_CNlocales>
- <outputEncoding>GBKoutputEncoding>
- configuration>
- plugin>
- plugins>
- build>
在site 目录下,最重要的就是site.xml文件了
site.xml描述了主要的site布局,例子如下:
xml 代码
- xml version="1.0" encoding="ISO-8859-1"?>
- <project name="Maven">
- <bannerLeft>
- <name>Mavenname>
- <src>http://maven.apache.org/images/apache-maven-project.pngsrc>
- <href>http://maven.apache.org/href>
- bannerLeft>
- <bannerRight>
- <src>http://maven.apache.org/images/maven-small.gifsrc>
- bannerRight>
- <body>
- <links>
- <item name="Apache" href="http://www.apache.org/" />
- <item name="Maven 1.0" href="http://maven.apache.org/"/>
- <item name="Maven 2" href="http://maven.apache.org/maven2/"/>
- links>
- <menu name="Maven 2.0">
- <item name="Introduction" href="index.html"/>
- <item name="Download" href="download.html"/>
- <item name="Release Notes" href="release-notes.html" />
- <item name="General Information" href="about.html"/>
- <item name="For Maven 1.0 Users" href="maven1.html"/>
- <item name="Road Map" href="roadmap.html" />
- menu>
- <menu ref="reports" />
- ...
- body>
- project>
配置站点文件
maven 支持以下的文档:
xdoc格式,使用简单的xml格式
apt格式,like wiki格式的纯文本
fml格式, faq格式
docBook
一般采用apt文件,默认的apt都是iso-8859-1的,如果需要支持中文,需要使用native2ascii命令来转换。
报表:
站点主要的配置,目前不错的报表插件,包括javadoc,pmd,checkstyle,Surefire test,source xref,tag list等。
下面详细介绍这些报表:
javadoc,对于团队内部来说,javadoc是比较重要的,当然前提是能好好的写javadoc。
配置如下:在reporting中增加如下的插件
xml 代码
- <plugin>
- <groupId>org.apache.maven.pluginsgroupId>
- <artifactId>maven-javadoc-pluginartifactId>
- <configuration>
- <links>
- <link>http://java.sun.com/j2se/1.4.2/docs/apilink>
- <link>http://plexus.codehaus.org/ref/1.0-alpha-9/apidocslink>
- links>
- <aggregate>trueaggregate>
- configuration>
- plugin>
pmd,一个不错的代码检查工具。
xml 代码
- <plugin>
- <groupId>org.apache.maven.pluginsgroupId>
- <artifactId>maven-pmd-pluginartifactId>
- <configuration>
- <rulesets>
- <ruleset>/rulesets/basic.xmlruleset>
- <ruleset>/rulesets/imports.xmlruleset>
- <ruleset>/rulesets/unusedcode.xmlruleset>
- <ruleset>/rulesets/finalizers.xmlruleset>
- <ruleset>/rulesets/controversial.xmlruleset>
- <ruleset>/rulesets/strings.xmlruleset>
- <ruleset>/rulesets/strictexception.xmlruleset>
- <ruleset>/rulesets/optimizations.xmlruleset>
- <ruleset>/rulesets/naming.xmlruleset>
- rulesets>
- <linkXref>truelinkXref>
- <sourceEncoding>GBKsourceEncoding>
- <minimumTokens>100minimumTokens>
- <targetJdk>1.5targetJdk>
- configuration>
- plugin>
checkstyle,主要的代码格式工具,和pmd相比,更注重代码的格式。
xml 代码
- <plugin>
- <groupId>org.apache.maven.pluginsgroupId>
- <artifactId>maven-checkstyle-pluginartifactId>
- <configuration>
- <configLocation>sun_checks.xmlconfigLocation>
- configuration>
- plugin>
Surefire test,单元测试结果报表
xml 代码
- <plugin>
- <groupId>org.apache.maven.pluginsgroupId>
- <artifactId>maven-surefire-report-pluginartifactId>
- plugin>
source xref,在网站上直接察看java源代码
xml 代码
- <plugin>
- <groupId>org.apache.maven.pluginsgroupId>
- <artifactId>maven-jxr-pluginartifactId>
- plugin>
tag list,用于查找在代码中预定义的标签,如todo
xml 代码
- <plugin>
- <groupId>org.codehaus.mojogroupId>
- <artifactId>taglist-maven-pluginartifactId>
- <configuration>
- <tags>
- <tag>TODOtag>
- <tag>@todotag>
- <tag>FIXMEtag>
- tags>
- configuration>
- plugin>
基本的站点已经成型了,下面就是生成了。
执行mvn site 生成目录,或者直接执行 mvn site-deploy 发布站点