链接检查:链接检查

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

全名:

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

说明:

生成链接检查报告。

属性:

  • 需要执行一个 Maven 项目。
  • 自版本:1.0。

必需参数

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

默认值为:head。
链接检查缓存 文件 1.0 Linkcheck 缓存文件的位置。
默认值为:${project.build.directory}/linkcheck/linkcheck.cache。
链接检查输出 文件 1.0 Linkcheck 报告文件的位置。
默认值为:${project.build.directory}/linkcheck/linkcheck.xml。
离线 布尔值 1.0 无论我们是否离线。
默认值为:${settings.offline}。
用户属性是:linkcheck.offline。

可选参数

姓名 类型 自从 描述
基本网址 细绳 1.0 用于站点中绝对链接(例如 /index.html)的基本 URL。
默认值为:${project.url}。
用户属性是:linkcheck.baseURL。
编码 细绳 1.0 Linkcheck 读取源文件时使用的文件编码。如果未设置属性project.build.sourceEncoding,则使用平台默认编码。
默认值为:${project.build.sourceEncoding}。
用户属性是:编码。
排除的HttpStatusErrors 整数[] 1.0 要忽略的 HTTP 错误列表,例如404。
排除HttpStatusWarnings 整数[] 1.0 要忽略的 HTTP 警告列表,例如301。
排除链接 细绳[] 1.0 要排除的链接列表。
注意:excludeLink允许使用**/dummy/*之类的模式。
排除页面 细绳[] 1.0 要排除的页面列表。
注意:
  • 此报告(即linkcheck.html)始终被排除在外。
  • 可能包含 Ant 风格的通配符和双通配符,例如 apidocs/**等。

强制站点 布尔值 1.0 true强制站点生成, 否则为false 。使用此参数可确保已正确生成所有文档。
默认值为:true。
用户属性是:linkcheck.forceSite。
httpClient参数 特性 1.0 获取链接时要使用的额外 HttpClient 参数。例如:
<httpClientParameters>
 <property>
  <name>http.protocol.max-redirects</name>
  <value>10</value>
 </property>
</httpClientParameters>
请参阅HttpClient 首选项页面
用户属性是:httpClientParameters。
httpFollow重定向 布尔值 1.0 如果在线,HTTP 方法应自动遵循 HTTP 重定向,否则为false 。
默认值为:true。
跳过 布尔值 1.0 true跳过报告执行, 否则为false 。目的是在启用forceSite时防止无限调用 。
默认值为:false。
用户属性是:linkcheck.skip。
暂停 整数 1.0 设置获取链接时使用的超时时间。零值表示不使用超时。
默认值为:2000。
用户属性是:超时。

参数详情

基本网址:

用于站点中绝对链接(例如 /index.html)的基本 URL。
  • 类型:java.lang.String
  • 从: 1.0
  • 要求:否
  • 用户属性:linkcheck.baseURL
  • 默认值:${project.url}

编码:

Linkcheck 读取源文件时使用的文件编码。如果未设置属性project.build.sourceEncoding,则使用平台默认编码。
  • 类型:java.lang.String
  • 从: 1.0
  • 要求:否
  • 用户属性:编码
  • 默认值:${project.build.sourceEncoding}

排除的HttpStatusErrors:

要忽略的 HTTP 错误列表,例如404。
  • 类型:java.lang.Integer[]
  • 从: 1.0
  • 要求:否

排除HttpStatusWarnings:

要忽略的 HTTP 警告列表,例如301。
  • 类型:java.lang.Integer[]
  • 从: 1.0
  • 要求:否

排除链接:

要排除的链接列表。
注意:excludeLink允许使用**/dummy/*之类的模式。
  • 类型:java.lang.String[]
  • 从: 1.0
  • 要求:否

排除页面:

要排除的页面列表。
注意:
  • 此报告(即linkcheck.html)始终被排除在外。
  • 可能包含 Ant 风格的通配符和双通配符,例如 apidocs/**等。
  • 类型:java.lang.String[]
  • 从: 1.0
  • 要求:否

强制站点:

true强制站点生成, 否则为false 。使用此参数可确保已正确生成所有文档。
  • 类型:布尔值
  • 从: 1.0
  • 要求:否
  • 用户属性:linkcheck.forceSite
  • 默认值:真

httpClient参数:

获取链接时要使用的额外 HttpClient 参数。例如:
<httpClientParameters>
 <property>
  <name>http.protocol.max-redirects</name>
  <value>10</value>
 </property>
</httpClientParameters>
请参阅HttpClient 首选项页面
  • 类型:java.util.Properties
  • 从: 1.0
  • 要求:否
  • 用户属性:httpClientParameters

httpFollowRedirect:

如果在线,HTTP 方法应自动遵循 HTTP 重定向,否则为false 。
  • 类型:布尔值
  • 从: 1.0
  • 要求:否
  • 默认值:真

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
  • 要求:是
  • 默认:头

链接检查缓存:

Linkcheck 缓存文件的位置。
  • 类型:java.io.File
  • 从: 1.0
  • 要求:是
  • 默认值:${project.build.directory}/linkcheck/linkcheck.cache

链接检查输出:

Linkcheck 报告文件的位置。
  • 类型:java.io.File
  • 从: 1.0
  • 要求:是
  • 默认值:${project.build.directory}/linkcheck/linkcheck.xml

离线:

无论我们是否离线。
  • 类型:布尔值
  • 从: 1.0
  • 要求:是
  • 用户属性:linkcheck.offline
  • 默认值:${settings.offline}

跳过:

true跳过报告执行, 否则为false 。目的是在启用forceSite时防止无限调用 。
  • 类型:布尔值
  • 从: 1.0
  • 要求:否
  • 用户属性:linkcheck.skip
  • 默认值:假

超时:

设置获取链接时使用的超时时间。零值表示不使用超时。
  • 类型:整数
  • 从: 1.0
  • 要求:否
  • 用户属性:超时
  • 默认值:2000