Studio 用户指南

工作流分析器是一种静态代码分析器，可确保您的项目符合高质量和可靠性标准。静态代码分析器可在不实际执行项目的情况下检查不一致问题，这与在执行期间介入的动态分析器不同。

工作流分析器使用一组规则来检查与项目执行无关的各种不一致问题。这些规则基于自动化最佳实践，并考虑了变量和参数命名、空序列或工作流、包限制等。 分析器不会在执行或编译时识别错误。

其位于“设计”功能区选项卡中，分别是“分析文件”和“分析项目”按钮。“分析文件”会对“设计器”面板中设为当前焦点的文件执行分析，而“分析项目”则对自动化项目中的所有文件执行分析。

Studio 自带一组内置规则，可通过ST-前缀识别。 UIAutomation.Activities、Excel.Activities、Testing Activities 和 Mail.Activities 也有自己的规则，可通过前缀识别。 在以下表格中查找更多信息：

您还可以创建自定义规则。有关更多信息，请参阅开发者指南中的构建工作流分析器规则。

在 Automation Ops 中创建 Studio 策略时，也可以配置规则。有关更多信息，请参阅 Automation Ops 指南。

每个规则都包含 ID、名称、说明和建议。ID 包含源、类别和编号。例如，变量命名约定具有 ST-NMG-001ID：

每个规则都有一个适用的作用域：

规则包含许多可设置的操作：

请查看“日志记录级别”页面，详细了解 Studio 中的日志记录。

项目或文件的分析基于“项目设置”窗口中的一组规则：

默认情况下，规则按窗口中的代码排列，并先显示已启用的规则。

使用窗口顶部的搜索框，按名称或代码搜索规则。要按作用域和默认操作筛选规则，请单击搜索框右侧的 按钮。

您可以使用规则左侧的复选框启用/禁用规则，也可以使用右侧的下拉列表更改默认操作。

某些规则不需要额外的配置，而其他规则则包含您可以配置的参数，例如不能超过的阈值，或允许或禁止的特定项目的列表。 请注意，当您配置包含文本字段的规则（例如，安全字符串滥用或包限制）时，不应在输入文本时给文本加引号。

对规则的默认值（正则表达式或阈值）作出任何更改后，可以通过右键单击规则，然后选择“重置为默认值”来将值恢复为默认值。

只要触发“工作流分析器”，系统便对文件或项目执行验证。验证选项位于“分析文件”功能区按钮中，分别是“验证文件”和“验证项目”。

此操作检查变量、参数、表达式和导入是否已正确配置。可使用 F8 快捷键触发“验证文件”操作，使用 Shift + F8 触发“验证项目”操作。可随时取消验证。

系统会在“项目”面板中以红点标记包含错误的文件，并在“错误列表”和“输出”面板中显示错误信息。

双击“错误列表”面板中的项目将打开 .xaml 并突出显示引发错误的元素，无论是活动、参数还是变量。

除非所有 .xaml 文件都经过验证，否则无法调试、执行或发布项目。不评估断点条件。

经触发后，“工作流分析器”会使用配置的规则集检查项目或文件，并根据规则操作在“错误列表”面板中记录发现的错误。

在“错误列表”面板中，您可以按“错误”、“警告”和“消息”筛选项目。您可以使用“作用域”下拉菜单，按项目、当前文件或自动化中的特定文件筛选错误。此外，还可按规则 ID 筛选项目。

单击发现的警告或错误，以显示规则建议和每个规则的文档页面链接。

除了违反规则外，“错误列表”面板还显示在执行工作流分析时可能发生的错误。当“工作流分析器”或已配置的规则之一无法运行时，将记录错误，并在描述中详细说明错误原因。

UiPath.Studio.CommandLine.exe 命令行用户界面包含一组参数，用于根据特定规则检查文件或项目，即使在 CI/CD 管道配置中也是如此。

UiPath.Studio.CommandLine.exe 位于安装文件夹中：

默认情况下，安装 Studio 时会启用所有工作流分析器规则，但以下情况除外：

您可以配置规则：

系统会按规则的唯一 ID 对其进行整理，并且会在“工作流分析器设置”中显示这些规则。

例如，在下面的图像中，仅启用了“变量命名约定”规则并接收正则表达式。([A-Z]) 这意味着变量名称必须使用大写。本例禁用了所有其他规则。

以下参数适用于每个规则：

配置完规则后，请访问 UiPath.Studio.CommandLine.exe 命令行用户界面。

以下工作流分析器命令可用：

以下参数可用于工作流分析器命令：

例如，命令 UiPath.Studio.CommandLine.exe analyze-file -p "C:\BlankProcess\Main.xaml" 仅分析项目中的一个文件，即 Main.xaml。该命令的输出返回一个 json 编码的字典，其中包含针对每个违反规则的以下信息：

如要使用放置在自定义位置的 RuleConfig.json 文件，请将位置添加到命令中。以上一个命令为例，要使用位于 C:\CustomFolder\RuleConfig.json 的文件配置规则，请运行命令，如下所示：UiPath.Studio.CommandLine.exe analyze-file -c "C:\CustomFolder\RuleConfig.json" -p "C:\BlankProcess\Main.xaml"。

若要返回命令的退出代码，请在运行后执行 echo %errorlevel%。如果没有包含 ErrorSeverity 错误的消息，则将返回 0 代码。否则，将返回 1。

请注意，有些条目可能与规则无关，而是“工作流分析器”生成的错误。例如，在 .xaml 文件为空的情况下，系统会显示错误。

用作条目前缀的全局唯一标识符 (GUID) 在每次运行时生成，并且仅应用于当前结果。

要配置 Studio，将每个工作流分析的结果导出到项目文件夹，请转到 Studio 后台视图 > 设置 > 设计，然后启用“导出分析器结果”选项。

启用此选项后，每次工作流分析的结果将保存在项目文件夹 \.local\.analysis\ 子文件夹的文件中，该文件命名方式为：分析时间戳后跟 project_analysis_results.json（使用“分析项目”选项时）或 file_analysis_results.json（使用“分析文件”选项时）。

文件中包含有关每个已启用规则的下列信息：

您可以通过在 Studio Backstage 视图 > 设置 > 设计中启用以下选项，来防止执行、发布和推送/检入包含工作流分析器错误的远程存储库项目：

启用“发布前强制使用分析器”时，如果发布成功（Error 操作没有违反规则），工作流分析结果将包含在文件 project_analysis_results.json（位于 \lib\net45\.analysis\）中已发布的 .nupkg 包中。该文件包含有关每个已启用规则的下列信息：