maven2 建立统一的管理站点

阅读更多
    使用maven2的另外一个好处,就是有了统一的入口,用于察看项目的进展情况。这主要包括了项目的介绍,成员介绍,以及相关的项目的文档,当然也包括项目的所有进展报表。
    下面,通过实例来介绍如何配置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 代码
 
  1.   
  2.            <distributionManagement>  
  3.                  <site>  
  4.                    <id>websiteid>  
  5.                    <url>scp://webhost.company.com/www/websiteurl>  
  6.               site>  
  7.            distributionManagement>  
  8.            <build>  
  9.               <plugins>  
  10.              
  11.               <plugin>  
  12.                  <artifactId>maven-site-pluginartifactId>  
  13.                 <configuration>  
  14.                     <locales>zh_CNlocales>  
  15.                     <outputEncoding>GBKoutputEncoding>  
  16.                     configuration>  
  17.                   plugin>  
  18.              plugins>  
  19.           build>  

在site 目录下,最重要的就是site.xml文件了
site.xml描述了主要的site布局,例子如下:
xml 代码
 
  1. xml version="1.0" encoding="ISO-8859-1"?>  
  2. <project name="Maven">  
  3.     
  4.   <bannerLeft>  
  5.     <name>Mavenname>  
  6.     <src>http://maven.apache.org/images/apache-maven-project.pngsrc>  
  7.     <href>http://maven.apache.org/href>  
  8.   bannerLeft>  
  9.     
  10.   <bannerRight>  
  11.     <src>http://maven.apache.org/images/maven-small.gifsrc>  
  12.   bannerRight>  
  13.   <body>  
  14.       
  15.     <links>  
  16.       <item name="Apache" href="http://www.apache.org/" />  
  17.       <item name="Maven 1.0" href="http://maven.apache.org/"/>  
  18.       <item name="Maven 2" href="http://maven.apache.org/maven2/"/>  
  19.     links>  
  20.      
  21.     <menu name="Maven 2.0">  
  22.       <item name="Introduction" href="index.html"/>  
  23.       <item name="Download" href="download.html"/>  
  24.       <item name="Release Notes" href="release-notes.html" />  
  25.       <item name="General Information" href="about.html"/>  
  26.       <item name="For Maven 1.0 Users" href="maven1.html"/>  
  27.       <item name="Road Map" href="roadmap.html" />  
  28.     menu>  
  29.     <menu ref="reports" />  
  30.     ...  
  31.   body>  
  32. 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 代码
 
  1. <plugin>  
  2.         <groupId>org.apache.maven.pluginsgroupId>  
  3.         <artifactId>maven-javadoc-pluginartifactId>  
  4.         <configuration>  
  5.           <links>  
  6.             <link>http://java.sun.com/j2se/1.4.2/docs/apilink>  
  7.             <link>http://plexus.codehaus.org/ref/1.0-alpha-9/apidocslink>  
  8.           links>  
  9.           <aggregate>trueaggregate>  
  10.         configuration>  
  11.       plugin>  

pmd,一个不错的代码检查工具。
    
xml 代码
 
  1. <plugin>  
  2.         <groupId>org.apache.maven.pluginsgroupId>  
  3.         <artifactId>maven-pmd-pluginartifactId>  
  4.         <configuration>  
  5.           <rulesets>  
  6.             <ruleset>/rulesets/basic.xmlruleset>  
  7.             <ruleset>/rulesets/imports.xmlruleset>  
  8.             <ruleset>/rulesets/unusedcode.xmlruleset>  
  9.             <ruleset>/rulesets/finalizers.xmlruleset>  
  10.             <ruleset>/rulesets/controversial.xmlruleset>  
  11.             <ruleset>/rulesets/strings.xmlruleset>  
  12.             <ruleset>/rulesets/strictexception.xmlruleset>  
  13.             <ruleset>/rulesets/optimizations.xmlruleset>  
  14.             <ruleset>/rulesets/naming.xmlruleset>  
  15.           rulesets>  
  16.           <linkXref>truelinkXref>  
  17.           <sourceEncoding>GBKsourceEncoding>  
  18.           <minimumTokens>100minimumTokens>  
  19.             
  20.           <targetJdk>1.5targetJdk>  
  21.         configuration>  
  22.       plugin>  


checkstyle,主要的代码格式工具,和pmd相比,更注重代码的格式。
     
xml 代码
 
  1. <plugin>  
  2.         <groupId>org.apache.maven.pluginsgroupId>  
  3.         <artifactId>maven-checkstyle-pluginartifactId>  
  4.         <configuration>  
  5.           <configLocation>sun_checks.xmlconfigLocation>  
  6.         configuration>  
  7.       plugin>  


Surefire test,单元测试结果报表
  
xml 代码
 
  1. <plugin>  
  2.      <groupId>org.apache.maven.pluginsgroupId>  
  3.      <artifactId>maven-surefire-report-pluginartifactId>  
  4.    plugin>  


source xref,在网站上直接察看java源代码

    
xml 代码
 
  1. <plugin>  
  2.         <groupId>org.apache.maven.pluginsgroupId>  
  3.         <artifactId>maven-jxr-pluginartifactId>  
  4.       plugin>  

tag list,用于查找在代码中预定义的标签,如todo
    
xml 代码
 
  1. <plugin>  
  2.         <groupId>org.codehaus.mojogroupId>  
  3.         <artifactId>taglist-maven-pluginartifactId>  
  4.         <configuration>  
  5.           <tags>  
  6.             <tag>TODOtag>  
  7.             <tag>@todotag>  
  8.             <tag>FIXMEtag>  
  9.           tags>  
  10.         configuration>  
  11.       plugin>  


基本的站点已经成型了,下面就是生成了。
执行mvn site 生成目录,或者直接执行 mvn site-deploy 发布站点

你可能感兴趣的:(配置管理,项目管理,maven,XML,Apache)