链接检查：链接检查

注意：这个目标应该用作 Maven 报告。

全名：

org.apache.maven.plugins:maven-linkcheck-plugin:1.0.1:linkcheck

说明：

生成Linkcheck报告。

属性：

  • 需要执行 Maven 2.0 项目。
  • 自版本：1.0.

必需参数

姓名 类型 自从 描述
http方法 String 1.0 要使用的 HTTP 方法。当前支持的是“GET”和“HEAD”。
HTTP 获取
HTTP GET 方法在RFC2616的第 9.3 节中定义： GET 方法意味着检索由 Request-URI 标识的任何信息（以实体的形式）。
HTTP 头
HTTP HEAD 方法在RFC2616的第 9.4 节中定义： HEAD 方法与 GET 相同，只是服务器不得在响应中返回消息体。

默认值为：head。
链接检查缓存 File 1.0 Linkcheck 缓存文件的位置。
默认值为：${project.build.directory}/linkcheck/linkcheck.cache。
链接检查输出 File 1.0 Linkcheck 报告文件的位置。
默认值为：${project.build.directory}/linkcheck/linkcheck.xml。
离线 boolean 1.0 无论我们是否离线。
默认值为：${settings.offline}。
输出目录 File 1.0 报告输出目录。

可选参数

姓名 类型 自从 描述
基本网址 String 1.0 用于站点中的绝对链接（例如 /index.html）的基本 URL。
默认值为：${project.url}。
编码 String 1.0 Linkcheck 读取源文件时使用的文件编码。如果project.build.sourceEncoding未设置该属性，则使用平台默认编码。
默认值为：${project.build.sourceEncoding}。
排除的HttpStatusErrors int[] 1.0 要忽略的 HTTP 错误列表，例如404.
排除HttpStatusWarnings int[] 1.0 要忽略的 HTTP 警告列表，例如301.
排除链接 String[] 1.0 要排除的链接列表。
注意：**/dummy/*excludedLink 允许使用类似的模式。
排除页面 String[] 1.0 要排除的网站页面列表。默认情况下， linkcheck.html将排除此报告，即 。
注意：excludedPage 不允许使用任何模式，只能使用特定的文件名。
强制站点 boolean 1.0 true强制站点生成，false 否则。使用此参数可确保已正确生成所有文档。
默认值为：true。
httpClient参数 Properties 1.0 获取链接时要使用的额外 HttpClient 参数。例如： 
<httpClientParameters>
 <property>
  <name>http.protocol.max-redirects</name>
  <value>10</value>
 </property>
</httpClientParameters>
请参阅HttpClient 首选项页面
httpFollow重定向 boolean 1.0 如果在线，HTTP 方法应自动遵循 HTTP 重定向，否则为false 。
默认值为：true。
跳过 boolean 1.0 true跳过报告执行，false 否则。目的是防止 forceSite启用时无限调用。
默认值为：false。
暂停 int 1.0 设置获取链接时使用的超时时间。零值表示不使用超时。
默认值为：2000。

参数详情

基本网址：

用于站点中的绝对链接（例如 /index.html）的基本 URL。
  • 类型：java.lang.String
  • 自：1.0
  • 必需：No
  • 表达式：${linkcheck.baseURL}
  • 默认：${project.url}

编码：

Linkcheck 读取源文件时使用的文件编码。如果project.build.sourceEncoding未设置该属性，则使用平台默认编码。
  • 类型：java.lang.String
  • 自：1.0
  • 必需：No
  • 表达式：${encoding}
  • 默认：${project.build.sourceEncoding}

排除的HttpStatusErrors：

要忽略的 HTTP 错误列表，例如404.
  • 类型：int[]
  • 自：1.0
  • 必需：No

排除HttpStatusWarnings：

要忽略的 HTTP 警告列表，例如301.
  • 类型：int[]
  • 自：1.0
  • 必需：No

排除链接：

要排除的链接列表。
注意：**/dummy/*excludedLink 允许使用类似的模式。
  • 类型：java.lang.String[]
  • 自：1.0
  • 必需：No

排除页面：

要排除的网站页面列表。默认情况下， linkcheck.html将排除此报告，即 。
注意：excludedPage 不允许使用任何模式，只能使用特定的文件名。
  • 类型：java.lang.String[]
  • 自：1.0
  • 必需：No

强制站点：

true强制站点生成，false 否则。使用此参数可确保已正确生成所有文档。
  • 类型：boolean
  • 自：1.0
  • 必需：No
  • 表达式：${linkcheck.forceSite}
  • 默认：true

httpClient参数：

获取链接时要使用的额外 HttpClient 参数。例如： 
<httpClientParameters>
 <property>
  <name>http.protocol.max-redirects</name>
  <value>10</value>
 </property>
</httpClientParameters>
请参阅HttpClient 首选项页面
  • 类型：java.util.Properties
  • 自：1.0
  • 必需：No
  • 表达式：${httpClientParameters}

httpFollowRedirect：

如果在线，HTTP 方法应自动遵循 HTTP 重定向，否则为false 。
  • 类型：boolean
  • 自：1.0
  • 必需：No
  • 默认：true

http方法：

要使用的 HTTP 方法。当前支持的是“GET”和“HEAD”。
HTTP 获取
HTTP GET 方法在RFC2616的第 9.3 节中定义： GET 方法意味着检索由 Request-URI 标识的任何信息（以实体的形式）。
HTTP 头
HTTP HEAD 方法在RFC2616的第 9.4 节中定义： HEAD 方法与 GET 相同，只是服务器不得在响应中返回消息体。
  • 类型：java.lang.String
  • 自：1.0
  • 必需：Yes
  • 默认：head

链接检查缓存：

Linkcheck 缓存文件的位置。
  • 类型：java.io.File
  • 自：1.0
  • 必需：Yes
  • 默认：${project.build.directory}/linkcheck/linkcheck.cache

链接检查输出：

Linkcheck 报告文件的位置。
  • 类型：java.io.File
  • 自：1.0
  • 必需：Yes
  • 默认：${project.build.directory}/linkcheck/linkcheck.xml

离线：

无论我们是否离线。
  • 类型：boolean
  • 自：1.0
  • 必需：Yes
  • 表达式：${linkcheck.offline}
  • 默认：${settings.offline}

输出目录：

报告输出目录。
  • 类型：java.io.File
  • 自：1.0
  • 必需：Yes
  • 表达式：${project.reporting.outputDirectory}

跳过：

true跳过报告执行，false 否则。目的是防止 forceSite启用时无限调用。
  • 类型：boolean
  • 自：1.0
  • 必需：No
  • 表达式：${linkcheck.skip}
  • 默认：false

超时：

设置获取链接时使用的超时时间。零值表示不使用超时。
  • 类型：int
  • 自：1.0
  • 必需：No
  • 表达式：${timeout}
  • 默认：2000