使用 Best Practices Analyzer using-best-practices-analyzer
使用Best Practices Analyzer的重要注意事项 imp-considerations
请阅读以下章节，以了解运行最佳实践分析器(BPA)时的重要注意事项：
-
BPA报告是使用Adobe Experience Manager (AEM) 模式检测器的输出生成的。 BPA使用的模式检测器版本包含在BPA安装包中。
-
BPA只能由 管理员 用户或 管理员 组中的用户运行。
-
版本6.1及更高版本的AEM实例支持BPA。
note note NOTE 有关在AEM 6.1上安装BPA的特殊要求，请参阅在AEM 6.1上安装。 -
BPA可以在任何环境中运行，但最好在 暂存 环境中运行它。
note note NOTE 为避免对业务关键型实例产生影响，建议您在自定义、配置、内容和用户应用程序方面尽可能接近 生产 环境的 创作 环境中运行BPA。 或者，也可以在克隆的生产“创作”**环境中运行。 -
生成BPA报告内容可能需要相当长的时间，从几分钟到几小时不等。 具体所需的时间长短很大程度上取决于 AEM 存储库内容的大小和性质、AEM 版本以及其他因素。
-
由于生成报告内容可能需要花费大量时间，这些内容将由后台进程生成并保存在缓存中。查看和下载报告的速度应该相对较快，因为该操作会利用内容缓存，直到报告过期或报告被明确刷新为止。在生成报告内容的过程中，您可以关闭浏览器选项卡，稍后在内容保存到缓存中后，再返回查看报告。
可用性 availability
最佳实践分析器可以从软件分发门户以 zip 文件的形式下载。您可以在源Adobe Experience Manager (AEM)实例上通过包管理器安装包。
Source环境连接 source-environment-connectivity
源AEM实例可能正在防火墙后面运行，在该防火墙中，它只能访问已添加到允许列表的特定主机。 要将BPA生成的报告自动成功上传到Cloud Acceleration Manager，需要从运行AEM的实例访问以下端点：
- Azure Blob存储服务：
casstorageprod.blob.core.windows.net
查看Best Practices Analyzer报告 viewing-report
Adobe Experience Manager 6.3.0 和更高版本 aem-later-versions
请参阅此部分，了解如何查看Best Practices Analyzer报告：
-
选择Adobe Experience Manager并导航到工具> 操作 > 最佳实践分析器。
-
单击 生成报告 以执行最佳实践分析器。
-
提供BPA上传密钥，以自动将生成的BPA报告上传到Cloud Acceleration Manager (CAM)。 要获取上传密钥，请导航到CAM中的最佳实践分析
-
提供有效密钥后，生成 按钮将变为活动状态。 单击 生成 以启动报告生成。
-
在BPA生成报告时，您可以在屏幕上看到该工具取得的进展。 它按完成百分比显示进度。 它还会显示分析的项目数以及找到的结果数。
-
生成BPA报告后，它以表格形式显示调查结果的摘要和数量，按调查结果类型和重要性级别进行整理。 要获取有关特定发现结果的更多详细信息，您可以单击与表中发现结果类型对应的数字。
-
您可以通过单击 导出到CSV，选择下载逗号分隔值(CSV)格式的报表。 您还可以通过单击 转到CAM 在CAM中查看报告。 这将带您进入CAM中的最佳实践分析页面。
您可以通过单击 刷新报告，强制BPA清除其缓存并重新生成报告。
- 如果缓存过期，您可以选择在CAM中查看上次生成的报告，方法是单击 在CAM中查看上次生成的报告，或者单击 生成新报告 启动新的报告生成。
在最佳实践分析器报告中使用过滤器 bpa-filters
要筛选出与ACS Commons相关的发现，请执行以下步骤：
-
单击页面左侧的左边栏图标。 这将显示 ACS Commons筛选器。 单击 ACS Commons Filter 以显示交互式复选框，如下图所示。
note note NOTE 仅当BPA检测到使用了ACS Commons时，才会显示左边栏图标。 -
取消选中该框可筛选掉所有与ACS Commons相关的发现。 您应该会在报表中看到 已过滤的发现结果计数，如下图所示。 当以逗号分隔值(CSV)格式导出时，也会将该过滤器应用于报表。
note note NOTE 不应忽略ACS Commons调查结果。 请参阅文档以确定与AEM as a Cloud Service的兼容性。
解读最佳实践分析器报告 cra-report
在AEM实例中运行最佳实践分析器工具时，报告将作为结果显示在工具窗口中。
报告的格式为：
-
报告概述：有关报告本身的信息，包括以下内容：
- 报告时间：生成并首次提供报告内容的时间。
- 过期时间：报告内容缓存过期的时间。
- 生成时间段：报告内容生成过程所花费的时间。
- 发现结果计数：报告中包含的发现结果总数。
-
系统概述：有关运行BPA的AEM系统的信息。
-
发现结果类别：多个部分，每个部分提供同一类别的一个或多个发现结果。每个部分包括：类别名称、子类型、发现结果计数和重要性、摘要、指向类别文档的链接以及单个发现结果信息。
每个发现结果都分配有一个重要性级别，以指示粗略的操作优先级。
请参阅下表，了解重要性级别：
解释最佳实践分析器CSV报告 cra-csv-report
当您从AEM实例单击 CSV 选项时，将从内容缓存生成CSV格式的最佳实践分析器报告，并将该报告返回到您的浏览器。 根据您的浏览器设置，此报表将自动下载为默认名称为results.csv的文件。
如果缓存已过期，则在生成并下载CSV文件之前会重新生成报表。
CSV 格式的报告包括从模式检测器输出生成的信息，这些信息按类别类型、子类型和重要性级别进行排序和组织。其格式适合在 Microsoft Excel 等应用程序中查看和编辑。它旨在以可重复的格式提供所有发现结果信息，在比较不同时间的报告以衡量进度时，这些信息很有用。
CSV 格式的报告包含以下列：
- 代码：类别代码
- 类型：类别名称
- 子类型：类别子类型
- 重要性：重要性级别
- 标识符：发现结果的主要标识符
- 其他：有关发现结果的其他信息
- 消息：为发现结果提供的消息
- 更多信息：可用于访问有关类别的在线帮助的链接
- 上下文：发现结果数据的 JSON 字符串
单个发现结果的列中的值“\N”表示未提供任何数据。
HTTP接口 http-interface
BPA提供了一个HTTP接口，可用作其AEM用户界面的替代方法。 该接口支持 HEAD 和 GET 命令。它可用于生成BPA报告，并以三种格式之一返回报告：JSON、CSV和制表符分隔值(TSV)。
以下URL可用于HTTP访问，其中<host>是安装BPA的服务器的主机名和端口（如果需要）：
http://<host>/apps/best-practices-analyzer/analysis/report.json（对于 JSON 格式）http://<host>/apps/best-practices-analyzer/analysis/report.csv（对于 CSV 格式）http://<host>/apps/best-practices-analyzer/analysis/report.tsv（对于 TSV 格式）
执行HTTP请求 executing-http-request
HTTP 接口可用于多种方法。
一种简单的方法是，在您已经以管理员身份登录 AEM 的同一浏览器中打开一个浏览器选项卡。您可以在该浏览器选项卡中输入 URL，并让浏览器显示或下载结果。
您还可以使用命令行工具，如curl或wget以及任何HTTP客户端应用程序。 如果不将浏览器选项卡用于经过身份验证的会话，则必须在注释中提供管理用户名和密码。
以下是如何实现此操作的示例：curl -u admin:admin 'http://localhost:4502/apps/best-practices-analyzer/analysis/report.csv' > report.csv。
标题和参数 http-headers-and-parameters
此接口使用以下 HTTP 标头：
当不能轻松使用 HTTP 标头时，可以方便地使用以下 HTTP 查询参数：
max-age（数字，可选）：以秒为单位指定缓存刷新生命周期。 此数字必须为 0 或更大。默认的刷新生命周期为86400秒。 如果没有此参数或相应的标头，新的缓存将用于服务24小时的请求，此时必须重新生成缓存。 使用max-age=0将强制清除缓存，并使用新生成的缓存的先前非零刷新生命周期开始重新生成报告。respond-async（布尔值，可选）：指定应异步提供响应。 在缓存失效时使用respond-async=true将导致服务器返回202 Accepted的响应，而无需等待缓存刷新和生成报告。 如果缓存是新的，则此参数不起作用。默认值为false。 如果没有此参数或相应的标头，服务器将同步响应，这可能需要大量时间，并且需要调整HTTP客户端的最大响应时间。may-refresh-cache（布尔值，可选）：指定如果当前缓存为空、已失效或即将失效，服务器可以刷新缓存以响应请求。 如果may-refresh-cache=true或未指定，则服务器可能会启动后台任务，该任务将调用模式检测器并刷新缓存。 如果may-refresh-cache=false，则服务器将不会启动任何刷新任务，否则如果缓存为空或过时（在此情况下报表为空）就会完成这些刷新任务。 此参数不会影响任何已在处理的刷新任务。return-minimal（布尔值，可选）：指定来自服务器的响应应仅包含包含进度指示的状态和采用JSON格式的缓存状态。 如果为return-minimal=true，则响应正文仅限于状态对象。 如果return-minimal=false或未指定，则会提供完整的响应。log-findings（布尔值，可选）：指定服务器在首次生成或刷新缓存时应记录缓存的内容。 缓存中的每个发现结果都记录为JSON字符串。 只有在log-findings=true且请求生成新缓存时，才会进行此日志记录。
当同时存在 HTTP 标头和相应的查询参数时，将优先采用查询参数。
通过 HTTP 接口开始生成报告的简单方法是使用以下命令：curl -u admin:admin 'http://localhost:4502/apps/best-practices-analyzer/analysis/report.json?max-age=0&respond-async=true'。
发出请求后，客户端无需保持活动状态即可生成报告。可以在一个客户端中使用HTTPGET请求启动报告生成操作；生成报告后，可在缓存中使用另一个客户端或AEM用户界面中的BPA工具进行查看。
响应 http-responses
可以使用以下响应值：
200 OK：指示响应包含来自模式检测器的发现结果，这些发现结果在缓存的刷新生命周期内生成。202 Accepted：用于指示缓存已过时。 当respond-async=true和may-refresh-cache=true时，此响应表示正在执行刷新任务。 当may-refresh-cache=false时，此响应仅指示缓存已过时。400 Bad Request：指示请求出错。以“问题详细信息”格式显示的消息（请参阅RFC 7807）提供了更多详细信息。401 Unauthorized：表示请求未获得授权。500 Internal Server Error：指示发生内部服务器错误。以“问题详细信息”格式显示的消息提供了更多详细信息。503 Service Unavailable：指示服务器正忙于其他响应，无法及时为此请求提供服务。仅当发出同步请求时，才可能出现此响应。以“问题详细信息”格式显示的消息提供了更多详细信息。
管理员信息
缓存生命周期调整 cache-adjustment
默认的BPA缓存生命周期为24小时。 在AEM实例和HTTP接口中都有用于刷新报告和重新生成缓存的选项，此默认值可能适用于BPA的大多数使用情况。 如果AEM实例的报告生成时间特别长，则可能需要调整缓存生命周期以最大限度地减少报告的重新生成。
缓存生命周期值作为 maxCacheAge 属性存储在以下存储库节点上：/apps/best-practices-analyzer/content/BestPracticesReport/jcr:content
此属性的值便是缓存生命周期（以秒为单位）。管理员可以使用 CRX/DE Lite 调整缓存生命周期。
在AEM 6.1上安装 installing-on-aem61
BPA利用名为repository-reader-service的系统服务用户帐户来执行模式检测器。 此帐户在 AEM 6.2 和更高版本上可用。在AEM 6.1上，必须在安装BPA 之前 通过执行以下步骤来创建此帐户：