API 使用报告

API 使用报告描述从一组捆绑软件到另一组捆绑软件的一组引用。 可使用 API 使用 Ant 任务生成报告。 已提供用于在外部工具对话框中配置并生成报告的用户界面。 要创建新的使用扫描配置,只需要双击 API 使用报告配置类型。

“API 使用报告”选项卡

API 使用报告选项卡允许您配置分析。

以下示例显示用于在 3.4 安装中抽取对 Eclipse 捆绑软件的所有引用的配置。

“API 使用报告”选项卡


选项

描述

缺省值

分析 可选择希望分析的内容,它们可以是 API 基线、目标定义或捆绑软件目录的对象。还可选择仅对现有报告生成 HTML。只能选择一个选项(每个选项允许您对其进行配置)。即,如果您选择分析 API 基线,那么您可访问“API 基线”首选项页面来编辑现有基线。 API 基线
分析 > API 基线 可从组合框中选择要分析的任何 API 基线 缺省基线或空白
分析 > 基线... 允许访问 API 基线首选项页面来配置要分析的基线。  
分析 > 目标定义 可从组合框中选择要分析的任何目标定义 活动目标定义或为空
分析 > 目标 允许访问目标平台首选项页面以配置要分析的目标定义。  
分析 > 目录 可输入包含捆绑软件的目录的绝对路径。 空
分析 > 浏览... 允许您进行浏览以查找要分析的捆绑软件的文件夹。  
分析 > 针对现有用法扫描生成 HTML 报告 允许您为现有扫描创建报告并且不必再次执行分析。  
搜索 > 引用 允许您指定要查看其引用的捆绑软件的名称(或匹配 RegEx)。考虑以下示例:org\.eclipse.*。在此示例中,我们表示希望见到以名称 org.eclipse. 开头的任何捆绑软件的所有引用。 空
搜索 > API 引用 允许您扫描 API 引用。 unchecked
搜索 > 内部引用 允许您扫描内部引用。 已选中
搜索 > 非法 API 使用 允许您扫描非法 API 使用(即,使用受限 API 成员)。 unchecked
搜索 > 捆绑软件匹配 允许您指定希望从中扫描引用的捆绑软件的名称(或匹配 RegEx),即搜索范围。 考虑以下示例:.*。在此示例中,我们表示希望搜索名称与任何字符序列相匹配的所有捆绑软件。 可通过将此字段留为空白实现相同效果。 空
报告 > 报告类型 允许您在两种 HTML 报告格式之间进行选择。如果选择了所引用的捆绑软件报告(生产者),那么报告将列示其中包含已搜索的捆绑软件中所引用的类型的所有捆绑软件。如果选择了引用捆绑软件报告(使用者),那么将对报告进行组织以显示搜索范围中包含引用的所有捆绑软件。

切换报告类型时,请检查引用对象和捆绑软件匹配正则表达式是否具有正确的值。 在一个设置中使用通配符表达式时(例如,.*),切换到另一种报告类型时通常会要求将通配符移至另一个设置以获取最有用的报告。

所引用的捆绑软件报告(生产者)
报告 > 报告输出位置 允许您指定应放置所有已生成报告的绝对路径。 空
报告 > 浏览... 允许您选择要输出任何报告的位置。  
报告 > 报告新结果之前清除报告目录 允许您在扫描报告任何结果之前清除现有 XML 报告位置。应注意的是,此选项将完全除去指定的报告目录(如果它存在),并且所有子目录也会以递归方式除去。 unchecked
报告 > 创建 HTML 报告 将所有 XML 输出转换为格式化 HTML 并将其放在 <report location>\html 中 unchecked
报告 > 清除 HTML 报告位置 允许您在创建新报告之前清除现有 HTML 位置。应注意的是,此选项将完全除去指定的 HTML 目录(如果它存在),并且所有子目录也会以递归方式除去。仅当您选择上面提到的创建 HTML 报告选项时,才会启用此选项。 unchecked
报告 > 搜索完成时打开报告 分析完成时打开 HTML 报告。仅当您选择上面提到的创建 HTML 报告选项时,才会启用此选项。 unchecked
报告 > 描述 允许您输入报告的人类可读描述。 空

“模式”选项卡

模式选项卡允许您创建各种正则表达式模式以控制用法分析。 当前受支持的三种模式如下:

  1. 归档模式 - 允许您指定分析期间应忽略的嵌套归档。
  2. 包模式 - 允许您指定应充当 API 或内部项而不必更新捆绑软件清单的包。
  3. 报告转换模式 - 允许您创建包名正则表达式以过滤报告的引用。所有已报告引用使用其标准包名进行过滤。

“模式”选项卡


选项

描述

缺省值

添加... 允许您添加新模式。此按钮将启动模式向导。  
编辑 允许您编辑当前选择的模式。一次只能编辑一个模式。  
除去 允许您除去所选模式。一次可以除去多个模式。  

相关任务

与 API 基线进行比较
设置基线

相关参考

API 基线首选项
“API 使用模式”向导