C# 代码的基本查询¶

学习使用 CodeQL 扩展在 Visual Studio Code 中编写和运行简单的 CodeQL 查询。

有关安装 Visual Studio Code 的 CodeQL 扩展的信息，请参阅“安装 Visual Studio Code 的 CodeQL。”

关于查询¶

我们要运行的查询对代码执行基本搜索，查找在某种意义上是多余的 if 语句，因为它们具有空的 then 分支。例如，如下代码

if (error) { }

查找用于实验的 CodeQL 数据库¶

在开始为 C# 代码编写查询之前，您需要一个 CodeQL 数据库来运行这些查询。最简单的方法是从 GitHub.com 直接下载使用 C# 的存储库的数据库。

在 Visual Studio Code 中，单击左侧边栏中的 **QL** 图标以显示 CodeQL 扩展。
单击 CodeQL 扩展顶部的 **从 GitHub 获取** 或 GitHub 徽标以打开一个输入字段。
将存储库的 URL 复制到字段中，然后按键盘 **Enter** 键。例如，https://github.com/PowerShell/PowerShell.
可选地，如果存储库有多个可用的 CodeQL 数据库，请选择 csharp 以下载从 C# 代码创建的数据库。

有关数据库下载进度的信息显示在 Visual Studio Code 的右下角。下载完成后，数据库将在 CodeQL 扩展的 **数据库** 部分显示带有一个复选标记（请参阅下面的屏幕截图）。

运行快速查询¶

Visual Studio Code 的 CodeQL 扩展将几个 **CodeQL:** 命令添加到命令面板中，包括 **快速查询**，您可以使用它在没有任何设置的情况下运行查询。

从 Visual Studio Code 的命令面板中，选择 **CodeQL: 快速查询**。
片刻之后，将打开一个新选项卡 *quick-query.ql*，准备让您为当前选择的 CodeQL 数据库（此处为 csharp 数据库）编写查询。如果系统提示您将工作区重新加载为多文件夹工作区以允许快速查询，请接受或使用入门工作流创建新的工作区。

在快速查询选项卡中，删除 select ""，并将以下查询粘贴到导入语句 import csharp 下。

from IfStmt ifstmt, BlockStmt block
where ifstmt.getThen() = block and
  block.isEmpty()
select ifstmt, "This 'if' statement is redundant."

将查询保存到其默认位置（工作区下的临时“快速查询”目录，用于 GitHub.vscode-codeql/quick-queries）。

右键单击查询选项卡，然后选择 **CodeQL: 在选定数据库上运行查询**。（或者，从命令面板运行该命令。）

查询将需要几分钟才能返回结果。查询完成后，结果将显示在 CodeQL 查询结果视图中，位于主编辑器视图旁边。

查询结果列在两列中，对应于查询的 select 子句中的表达式。第一列对应于表达式 ifstmt，并链接到项目源代码中出现 ifstmt 的位置。第二列是警报消息。

../../_images/basic-csharp-query-results-1.png

如果找到任何匹配的代码，请单击 ifstmt 列中的链接以打开文件并突出显示匹配的 if 语句。

../../_images/basic-csharp-query-results-2.png

注意

如果您想将实验性查询移动到更永久的位置，则需要移动整个 Quick Queries 目录。该目录是一个 CodeQL 包，具有一个 qlpack.yml 文件，该文件将内容定义为 C# CodeQL 数据库的查询。有关 CodeQL 包的更多信息，请参阅“管理 CodeQL 查询包和库包。”

关于查询结构¶

在初始 import 语句之后，此简单查询包含三个部分，它们的作用与 SQL 查询的 FROM、WHERE 和 SELECT 部分类似。

查询部分	用途	详细信息
`import csharp`	导入 C# 的标准 CodeQL 库。	每个查询都以一个或多个 `import` 语句开头。
`from IfStmt ifstmt, BlockStmt block`	定义查询的变量。声明采用以下形式：`<type> <variable name>`	我们使用一个 `IfStmt` 变量用于 `if` 语句一个 `BlockStmt` 变量用于 then 块
`where ifstmt.getThen() = block and block.isEmpty()`	定义变量的条件。	`ifstmt.getThen() = block` 将两个变量关联起来。该块必须是 `if` 语句的 `then` 分支。 `block.isEmpty()` 指示该块必须为空（即，它不包含任何语句）。
`select ifstmt, "This 'if' statement is redundant."`	定义对每个匹配项报告的内容。 `select` 语句用于查找编码不规范实例的查询，始终采用以下形式：`select <program element>, "<alert message>"`	使用解释问题的字符串报告生成的 `if` 语句。

扩展查询¶

查询编写本质上是一个迭代过程。您编写一个简单的查询，然后在运行它时，您会发现以前没有考虑过的示例，或者改进的机会。

删除误报结果¶

浏览基本查询的结果表明，它可以改进。在结果中，您可能会发现具有 else 分支的 if 语句的示例，其中空的 then 分支确实起作用。例如

if (...)
{
    ...
}
else if (option == "-verbose")
{
    // nothing to do - handled earlier
}
else
{
    error("unrecognized option");
}

在这种情况下，将具有空 then 分支的 if 语句识别为多余的，这是一种误报。对此的一种解决方案是修改查询，以忽略具有 else 分支的 if 语句的空 then 分支。

要排除具有 else 分支的 if 语句

将以下内容添加到 where 子句中

and not exists(ifstmt.getElse())

现在的 where 子句为

where ifstmt.getThen() = block and
  block.isEmpty() and
  not exists(ifstmt.getElse())

重新运行查询。

现在结果更少了，因为不再包含具有 else 分支的 if 语句。

进一步阅读¶

“QL 语言参考”
“CodeQL 工具”