十二、生成项目站点

今天智商下限，犯了个错，惹大佬心烦了，让我在墙角面壁5分钟！！！
大佬，还望网开一面，放小弟一条生路哇，等一下，记完这篇笔记再去面壁T_T

犯错.jpg

今天要讲的是如何通过maven生成项目站点，在maven3中，通过使用maven-site-plugin插件生成项目站点

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-site-plugin</artifactId>
    <version>3.6</version>
</plugin>

直接通过mvn site:site命令就可以在target/site/目录下生成站点，但是其中页面之间的连接还无法连接起来，可以通过site:stage命令生成本机临时站点来解决
site:stage要求:

1. 配置distributeMangement site信息

<distributionManagement>
    <site>
        <id>nexus-site</id>
        <url>dav://localhost:8081/nexus/content/repositories/sites/</url>
    </site>
</distributionManagement>

2. 事先生成站点，运行mvn site:site命令在项目target目录下生成互相不关联的站点页面
3. 转化为本地可访问的站点，运行mvn site:stage -DstagingDirectory=D:\tmp
   到此可以在D:\tmp目录下查看生成的本机站点了，同时各个页面之间的连接也可以正确定位

丰富的项目信息

maven生成的站点其中包含的内容信息，其实是通过maven-project-info-reports-plugin的插件生成的，在maven3中，该插件内置在maven-site-plugin中
该插件会生成：
关于 项目描述
持续集成 项目持续集成服务器信息 需要提供ciManagement
依赖 项目依赖信息，包括传递性依赖、依赖图、依赖许可证以及依赖文件大小、所含类目等
依赖收敛 只针对多模块项目，提供一些依赖健康状况分析，如各个模块中依赖版本是否一致，项目中是否存在SNAPSHOT依赖等
依赖管理 基于项目的依赖管理配置生成报告
问题追踪 项目问题追踪系统信息 需要提供issueManagement
邮件列表 项目邮件列表
插件管理 项目所用插件列表
项目许可证 需要提供licenses
项目概述 包括坐标、名称、描述
项目团队 项目团队信息需要提供developers
源码仓库 需要提供scm
要提供上面提供的几大方面的内容，需要pom做一些配置，下面是一个完整的pom配置信息：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.zheng</groupId>
    <artifactId>account-parent</artifactId>
    <packaging>pom</packaging>
    <version>1.2-SNAPSHOT</version>
    <name>account-web.xml</name>
    <url>http://localhost:8080/account-web</url>
    <description>account-web project</description>

    <!--配置项目发布信息-->
    <scm>
        <connection>scm:git:https://github.com/zl736732419/account-parent.git</connection>
        <developerConnection>scm:git:https://github.com/zl736732419/account-parent.git</developerConnection>
        <!--master分支的浏览器地址，这里需要点击分支master-->
        <url>https://github.com/zl736732419/account-parent/tree/master</url>
        <tag>HEAD</tag>
    </scm>

    <!--持续集成-->
    <ciMangement>
        <system>jenkins</system>
        <url>http://localhost:8080/jenkins</url>
    </ciMangement>

    <!--项目成员-->
    <developers>
        <developer>
            <id>zl</id>
            <name>zhenglian</name>
            <email>736732419@qq.com</email>
            <timezone>8</timezone>
        </developer>
    </developers>

    <!--问题追踪-->
    <issueManagement>
        <system>JIRA</system>
        <url>http://localhost:8081/JIRA</url>
    </issueManagement>

    <licenses>
        <license>
            <name>Apache License, Version2.0</name>
            <url>http://www.apache.org/licenses/LICENSE-2.0</url>
        </license>
    </licenses>
</project>

对于project info 插件提供的几大模块，可以进行自定义，不过一般采用默认的就可以，要进行自定义，需要对maven-project-info-reports-plugin做显示配置

            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-project-info-reports-plugin</artifactId>
                <version>2.9</version>
                <reportSets>
                    <reportSet>
                        <reports>
                            <report>dependencies</report>
                            <report>project-team</report>
                            <report>issue-tracking</report>
                            <report>license</report>
                        </reports>
                    </reportSet>
                </reportSets>
            </plugin>

除了上面的project-info-reports-plugin之外，maven还提供了许多生成报告的插件，与一般的插件不同的是，一般插件需要配置到<project><build><plugins>中，而报告插件则需要配置到<project><reporting><plugins>

其他maven报告插件

javaDocs

坐标依赖方式

<reporting>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <version>2.10.4</version>
        </plugin>
    </plugins>
</reporting>

通过上述配置后，可以在index.html左侧导航栏的project Reports中看到javadocs报告项

javadoc站点.png javadoc站点查看类文档.png
要生成javadoc就要求在编写代码的时候使用javadoc进行注释，如果使用的是idea,可以使用checkstyle、javadoc插件来帮助规范代码编程

source xref

配置方式

<reporting>
    <plugins>
         <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-jxr-plugin</artifactId>
            <version>2.2</version>
            <configuration>
                <aggregate>true</aggregate>
            </configuration>
        </plugin>
    </plugins>
</reporting>

aggregate表示在聚合模块整合所有的源码，我们可以在project reports中看到source xref报告项

source xref.png source xref1.png source xref查看类文档.png

checkstyle文档

配置方式

<reporting>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-checkstyle-plugin</artifactId>
            <version>2.10</version>
            <configuration>
                <configLocation>checkstyle.xml</configLocation>
            </configuration>
        </plugin>
    </plugins>
</reporting>

配置之后生成的site站点中可以在project Reports中查找到checkstyle报告

checkstyle插件页面.png checkstyle查看不规范代码.png

checkstyle是一项代码规范工具，通过它可以对现有的项目代码生成checkstyle报告，用户可以选择使用checkstyle自带的4规则：
config/sun_checks.xml sun定义的默认规范(默认)
config/maven_checks.xml maven社区定义的规范config/turbine_checks.xmlturbine定义的编码规范config/Avalon_checks.xmlavalon定义的编码规范 当然我们还可以指定自定义checkstyle规范，上面的配置<configLocation>checkstyle.xml</configLocation>表示在项目根路径下存在一个checkstyle.xml自定义的checkstyle`规范

checkstyle规范文件结构.png

具体内容为，目前该checkstyle是我工作时使用的规范

<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
        "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
        "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">

<module name="Checker">
    <!--
        If you set the basedir property below, then all reported file
        names will be relative to the specified directory. See
        http://checkstyle.sourceforge.net/5.x/config.html#Checker

        <property name="basedir" value="${basedir}"/>
    -->

    <!-- 检查每个包中是否有java注释文件，默认有package-info.java -->
    <!-- <module name="JavadocPackage"/> -->

    <!-- 检查文件是否以一个空行结束 -->
    <!--<module name="NewlineAtEndOfFile">-->
        <!--<property name="lineSeparator" value="lf"/>-->
        <!--<property name="fileExtensions" value="java, xml, py"/>-->
    <!--</module>-->

    <!-- 检查property文件中是否有相同的key -->
    <module name="Translation"/>

    <!-- 文件长度不超过1500行 -->
    <module name="FileLength">
        <property name="max" value="1500"/>
    </module>

    <!-- 检查文件中是否含有'\t' -->
    <module name="FileTabCharacter"/>

    <!-- 检查文件中的空行. -->
    <module name="RegexpSingleline">
        <property name="format" value="\s+$"/>
        <property name="minimum" value="0"/>
        <property name="maximum" value="0"/>
        <property name="message" value="Line has trailing spaces."/>
    </module>


    <!-- 每个java文件一个语法树 -->
    <module name="TreeWalker">
        <!-- 注释检查 -->
        <!-- 检查方法和构造函数的javadoc -->
        <module name="JavadocMethod">
            <!--<property name="severity" value="warning"/>-->
            <property name="tokens" value="METHOD_DEF"/>
        </module>
        <!-- 检查类和接口的javadoc。默认不检查author和version tags -->
        <module name="JavadocType"/>
        <!-- 检查变量的javadoc -->
        <module name="JavadocVariable"/>
        <!-- 检查javadoc的格式 -->
        <module name="JavadocStyle">
            <property name="checkFirstSentence" value="false"/>
        </module>
        <!-- 检查TODO:注释 -->
        <module name="TodoComment"/>

        <!-- 命名检查 -->
        <!-- 局部的final变量，包括catch中的参数的检查 -->
        <module name="LocalFinalVariableName"/>
        <!-- 局部的非final型的变量，包括catch中的参数的检查 -->
        <module name="LocalVariableName"/>
        <!-- 包名的检查（只允许小写字母），默认^[a-z]+(\.[a-zA-Z_][a-zA-Z_0-9_]*)*$ -->
        <module name="PackageName">
            <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
            <message key="name.invalidPattern" value="包名 ''{0}'' 要符合 ''{1}''格式."/>
        </module>
        <!-- 仅仅是static型的变量（不包括static final型）的检查 -->
        <module name="StaticVariableName"/>
        <!-- Class或Interface名检查，默认^[A-Z][a-zA-Z0-9]*$-->
        <module name="TypeName">
            <property name="severity" value="warning"/>
            <message key="name.invalidPattern" value="名称 ''{0}'' 要符合 ''{1}''格式."/>
        </module>
        <!-- 非static型变量的检查 -->
        <module name="MemberName"/>
        <!-- 方法名的检查 -->
        <module name="MethodName"/>
        <!-- 方法的参数名 -->
        <module name="ParameterName "/>
        <!-- 常量名的检查（只允许大写），默认^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$ -->
        <module name="ConstantName"/>

        <!-- 定义检查 -->
        <!-- 检查数组类型定义的样式 -->
        <module name="ArrayTypeStyle"/>
        <!-- 检查方法名、构造函数、catch块的参数是否是final的 -->
        <!-- <module name="FinalParameters"/> -->
        <!-- 检查long型定义是否有大写的“L” -->
        <module name="UpperEll"/>


        <!-- Checks for Headers                                -->
        <!-- See http://checkstyle.sf.net/config_header.html   -->
        <!-- <module name="Header">                            -->
        <!-- The follow property value demonstrates the ability     -->
        <!-- to have access to ANT properties. In this case it uses -->
        <!-- the ${basedir} property to allow Checkstyle to be run  -->
        <!-- from any directory within a project. See property      -->
        <!-- expansion,                                             -->
        <!-- http://checkstyle.sf.net/config.html#properties        -->
        <!-- <property                                              -->
        <!--     name="headerFile"                                  -->
        <!--     value="${basedir}/java.header"/>                   -->
        <!-- </module> -->

        <!-- Following interprets the header file as regular expressions. -->
        <!-- <module name="RegexpHeader"/>                                -->


        <!-- import检查 避免使用*, Idea修改配置Preference->Editor->Java->Imports Class count to use import with ‘*’ and Names count to use static import with ‘*’ 都改成99 -->
        <module name="AvoidStarImport"/>
        <!-- 检查是否从非法的包中导入了类 -->
        <module name="IllegalImport"/>
        <!-- 检查是否导入了多余的包 -->
        <module name="RedundantImport"/>
        <!-- 没用的import检查，比如：1.没有被用到2.重复的3.import java.lang的4.import 与该类在同一个package的 -->
        <module name="UnusedImports"/>
        <!-- 检查是否导入了指定的非法包。默认情况下，这项检查会拒绝所有的sun.*包，因为直接使用sun.*包的程序肯定不是100%的纯Java程序。-->
        <module name="IllegalImport"/>

        <!-- 长度检查 -->
        <!-- 每行不超过200个字符 -->
        <module name="LineLength">
            <property name="max" value="200"/>
        </module>
        <!-- 方法不超过200行 -->
        <module name="MethodLength">
            <property name="tokens" value="METHOD_DEF"/>
            <property name="max" value="200"/>
        </module>
        <!-- 方法的参数个数不超过20个。 并且不对构造方法进行检查-->
        <module name="ParameterNumber">
            <property name="max" value="20"/>
            <property name="tokens" value="METHOD_DEF"/>
        </module>

        <!-- 空格检查-->
        <!-- 方法名后跟左圆括号"(" -->
        <module name="MethodParamPad"/>
        <!-- 在类型转换时，不允许左圆括号右边有空格，也不允许与右圆括号左边有空格 -->
        <module name="TypecastParenPad"/>
        <!-- Iterator -->
        <!-- <module name="EmptyForIteratorPad"/> -->
        <!-- 检查尖括号 -->
        <!-- <module name="GenericWhitespace"/> -->
        <!-- 检查在某个特定关键字之后应保留空格 -->
        <module name="NoWhitespaceAfter"/>
        <!-- 检查在某个特定关键字之前应保留空格 -->
        <module name="NoWhitespaceBefore"/>
        <!-- 操作符换行策略检查 -->
        <module name="OperatorWrap"/>
        <!-- 圆括号空白 -->
        <module name="ParenPad"/>
        <!-- 检查分隔符是否在空白之后 -->
        <module name="WhitespaceAfter"/>
        <!-- 检查分隔符周围是否有空白 -->
        <module name="WhitespaceAround"/>


        <!-- 修饰符检查 -->
        <!-- 检查修饰符的顺序是否遵照java语言规范，默认public、protected、private、abstract、static、final、transient、volatile、synchronized、native、strictfp -->
        <module name="ModifierOrder"/>
        <!-- 检查接口和annotation中是否有多余修饰符，如接口方法不必使用public -->
        <module name="RedundantModifier"/>


        <!-- 代码块检查 -->
        <!-- 检查是否有嵌套代码块 -->
        <module name="AvoidNestedBlocks"/>
        <!-- 检查是否有空代码块 -->
        <module name="EmptyBlock"/>
        <!-- 检查左大括号位置 -->
        <module name="LeftCurly"/>
        <!-- 检查代码块是否缺失{} -->
        <module name="NeedBraces"/>
        <!-- 检查右大括号位置 -->
        <module name="RightCurly"/>


        <!-- 代码检查 -->
        <!-- 检查是否在同一行初始化 -->
        <!-- <module name="AvoidInlineConditionals"/> -->
        <!-- 检查空的代码段 -->
        <module name="EmptyStatement"/>
        <!-- 检查在重写了equals方法后是否重写了hashCode方法 -->
        <module name="EqualsHashCode"/>
        <!-- 检查局部变量或参数是否隐藏了类中的变量 -->
        <!--<module name="HiddenField">
            <property name="tokens" value="VARIABLE_DEF"/>
        </module>-->
        <!-- 检查是否使用工厂方法实例化 -->
        <module name="IllegalInstantiation"/>
        <!-- 检查子表达式中是否有赋值操作 -->
        <module name="InnerAssignment"/>
        <!-- 检查是否有"魔术"数字 -->
        <module name="MagicNumber">
            <property name="ignoreNumbers" value="-1, 0, 1, 1024"/>
            <property name="ignoreAnnotation" value="true"/>
        </module>
        <!-- 检查switch语句是否有default -->
        <module name="MissingSwitchDefault"/>
        <!-- 检查是否有过度复杂的布尔表达式 -->
        <module name="SimplifyBooleanExpression"/>
        <!-- 检查是否有过于复杂的布尔返回代码段 -->
        <module name="SimplifyBooleanReturn"/>

        <!-- 类设计检查 -->
        <!-- 检查类是否为扩展设计l -->
        <!-- <module name="DesignForExtension"/> -->
        <!-- 检查只有private构造函数的类是否声明为final -->
        <module name="FinalClass"/>
        <!-- 检查工具类是否有public的构造器 -->
        <module name="HideUtilityClassConstructor"/>
        <!-- 检查接口是否仅定义类型 -->
        <module name="InterfaceIsType"/>
        <!-- 检查类成员的可见度 -->
        <module name="VisibilityModifier"/>

        <!-- 代码质量 -->
        <!-- 圈复杂度 不能大于5
        <module name="CyclomaticComplexity">
            <property name="max" value="5"/>
        </module>-->
    </module>

    <!-- 其他检查 -->
    <!-- 文件中使用了System.out.print等-->
    <module name="RegexpSingleline">
        <property name="format" value="System\.out\.print"/>
    </module>
    <!-- 文件中使用了System.exit等-->
    <module name="RegexpSingleline">
        <property name="format" value="System\.exit"/>
    </module>
    <!-- 文件中使用了e.printStackTrace等-->
    <module name="RegexpSingleline">
        <property name="format" value="printStackTrace"/>
    </module>
</module>

pmd

pmd是一款源代码分析工具，它可以寻找出代码中存在的问题、潜在的bug、无用的代码、可优化代码、重复代码以及过于复杂的表达式
配置方式

<reporting>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-pmd-plugin</artifactId>
            <version>3.8</version>
            <configuration>
                <aggregate>true</aggregate>
            </configuration>
        </plugin>
    </plugins>
</reporting>

配置完成后生成的site中，可以在project reports中找到cpd,pmd两个报告
其中
cpd 包含代码拷贝复制粘贴的分析结果,也就是代码重复
pmd 包含了上面提到的情况

pmd分析报告.png cpd复制粘贴分析.png pmd分析结果.png

changelog

changelog能够基于版本控制系统中就近的更变记录生成三份更变报告:
changelog: 基于提交的更变，包括每次提交的日期，文件，作者，注释等
Developer Activity: 基于作者的更变报告，包括作者列表以及每个作者相关的提交次数和涉及的文件数目
file activity 基于文件的更变报告，包括更变的文件列表，以及每个文件的更变次数
想要生成项目更变报告，必须正确配置scm信息

<!--配置项目发布信息-->
    <scm>
        <connection>scm:git:https://github.com/zl736732419/account-parent.git</connection>
        <developerConnection>scm:git:https://github.com/zl736732419/account-parent.git</developerConnection>
        <!--master分支的浏览器地址，这里需要点击分支master-->
        <url>https://github.com/zl736732419/account-parent/tree/master</url>
        <tag>HEAD</tag>
</scm>

<reporting>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-changelog-plugin</artifactId>
            <version>2.3</version>
            <configuration>
                <!--将报告最近60天的更变记录-->
                <type>range</type>
                <range>60</range>
            </configuration>
        </plugin>
    </plugins>
</reporting>

changelog日志.png

cobertura

测试覆盖率报告
配置方式

<reporting>
    <plugins>
        <plugin>
            <groupId>org.codehaus.mojo</groupId>
            <artifactId>cobertura-maven-plugin</artifactId>
            <version>2.7</version>
        </plugin>
    </plugins>
</reporting>

要让cobertura生效，那么必须编写测试用例并且让测试用例能使用src/main/java主项目中的代码，因为测试覆盖率主要是检测主代码中类在测试环境中的运行情况