maven日记（十一）：生成项目站点

最新推荐文章于 2024-11-07 00:02:45 发布

最新推荐文章于 2024-11-07 00:02:45 发布 · 184 阅读

文章标签：

#maven

JavaEE 专栏收录该内容

15 篇文章

订阅专栏

本文介绍了如何使用Maven配置站点，包括文档生成、代码规范检查、测试覆盖率分析等功能，并提供了部署站点的方法。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

最简单的站点，首先配置maven3的maven-site-plugin，这个在外层的parent的pom.xml中定义：

<build>
    <pluginManagement>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-site-plugin</artifactId>
                <version>3.2</version>
            </plugin>
        </plugins>
    </pluginManagement>
</build>

注意，可以写在pluginManagement中，然后运行：mvn site即可

>> 项目报告插件：JavaDocs：

<project>
    ...
    <reporting>
        <plugins>
            <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <version>2.8.1</version>
            <configuration>
                <encoding>UTF-8</encoding>
            </configuration>
            </plugin>
        </plugins>
    </reporting>
    ...
</project>

运行：mvn site后就能看到JavaDoc了。

>> 源码插件：Source Xref

如果能随时随地打开浏览器访问项目的最新源代码，那就无敌了。额，maven-jxr-plugin貌似能帮我们完成这个心愿：

<reporting>
    <plugins>
        <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-jxr-plugin</artifactId>
        <version>2.3</version>
        <configuration>
                    <aggregate>true</aggregate>
            <encoding>UTF-8</encoding>
                </configuration>
        </plugin>
    </plugins>
</reporting>

>> 代码规范插件：CheckStyle

CheckStyle用来帮助Java开发人员规范编码，而且可以自定义自己的一套编码规范，通过maven-checkstyle-plugin集成起来：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-checkstyle-plugin</artifactId>
    <version>2.9.1</version>
    <configuration>
        <configLocation>config/sun_checks.xml</configLocation>
        <!--<configLocation>config/maven_checks.xml</configLocation>-->
        <!--<configLocation>config/turbine_checks.xml</configLocation>-->
        <!--<configLocation>config/avalon_checks.xml</configLocation>-->
    </configuration>
</plugin>

默认的就是sun_checks.xml，另外还有三个备选方案，而且用户可以自己定义自己的checks.xml编码规范。

>> 源码分析工具 PMD：

PMD是一款强大的Java源代码分析工具，它能够寻找代码中的问题，包括潜在的bug、无用代码、可优化代码、重复代码以及过于复杂的表达式。

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-pmd-plugin</artifactId>
    <version>2.7.1</version>
    <configuration>
        <rulesets>
        <ruleset>rulesets/basic.xml</ruleset>
        <ruleset>rulesets/unusedcode.xml</ruleset>
        <ruleset>rulesets/importss.xml</ruleset>
        <ruleset>rulesets/braces.xml</ruleset>
        <ruleset>rulesets/naming.xml</ruleset>
        <ruleset>rulesets/strings.xml</ruleset>
        </rulesets>
        <aggregate>true</aggregate>
    </configuration>
</plugin>

>> 版本控制报告：ChangeLog

maven-changelog-plugin能够基于版本控制系统中就近的变更记录生成三分变更报告：

* Change Log：基于提交的变更报告，包括每次提交的日期、文件、作者、注释等

* Developer Activity：基于作者的变更报告，包括作者列表以及每个作者相关的提交次数和涉及文件数目。

* File Activity：基于文件的变更报告，包括变更的文件列表以及每个文件的变更次数。

要想使用ChangeLog插件，必须先定义好SCM信息：

<scm>
    <connection>scm:svn:http://192.168.1.103/app/trunk</connection>
    <developerConnection>scm:svn:https://192.168.1.103/app/trunk</developerConnection>
    <url>http://192.168.1.103/account/trunk</url>
</scm>

有了scm信息，开始配置maven-changelog-plugin了：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-changelog-plugin</artifactId>
    <version>2.2</version>
    <configuration>
                <type>range</type>
                <range>60</range>
            </configuration>
</plugin>

>> 测试覆盖率插件：Cobertura

前面介绍过用Cobertura生成测试覆盖率报告，现在介绍如何将其集成到项目站点中去。

<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>cobertura-maven-plugin</artifactId>
<version>2.5.2</version>
</plugin>

>> 国际化配置：

先确保项目所有的源码，包括pom.xml、site.xml以及apt文档等等都是UTF-8编码

<properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
</properties>

然后配置locales为zh_CN，这个是为了国际化显示用，比如货币、日期、数字等显示成符合zh的格式：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-site-plugin</artifactId>
    <version>3.2</version>
    <configuration>
    <locales>zh_CN</locales>
    </configuration>
</plugin>

>> 部署站点：

maven支持多种协议部署站点，包括FTP、SCP、DAV

<distributionManagement>
    <site>
        <id>app-site</id>
        <url>dav:https://www.springzoo.com/sites/app</url>
    </site>
</distributionManagement>

服务器必须支持WEBDAV，为了确保安全，服务器需要认证，而这个认证就是修改.m2/settings.xml文件：

<settings>
    ...
    <server>
        <id>app-site</id>
        <username>test</username>
        <password>*****</password>
    </server>
</settings>

如果想使用FTP协议部署站点，而且个人推荐这种方法，除了配置正确的部署地址和认证信息外，还要配置额外的扩展组件wagon-ftp：

<build>
    ...
    <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-site-plugin</artifactId>
                <version>3.2</version>
                <configuration>
                    <locales>zh_CN</locales>
                </configuration>
            </plugin>
        </plugins>
        <extensions>
            <extension>
                <groupId>org.apache.maven.wagon</groupId>
                <artifactId>wagon-ftp</artifactId>
                <version>2.3</version>
            </extension>
        </extensions>
</build>
<distributionManagement>
    <site>
        <id>app-site</id>
        <url>ftp://www.springzoo.com/sites/app</url>
    </site>
</distributionManagement>

同样也是要跟上面一样在settings.xml文件中配置FTP登陆的认证信息。

所有配置好以后，只要一句话即可部署整个项目站点了：

# mvn clean site-deploy

本人博客已搬家，新地址为：http://www.pycoding.com/