Semmle QL 设计模式解析：构建可扩展且精确的代码分析模型

Semmle QL 设计模式解析：构建可扩展且精确的代码分析模型

codeql 项目地址: https://gitcode.com/gh_mirrors/ql/ql

引言

在静态代码分析领域，Semmle QL 作为一种强大的查询语言，为开发者提供了深入分析代码结构的能力。本文将重点介绍 Semmle QL 中的核心设计模式，特别是 ::Range 模式，帮助开发者构建既灵活又精确的代码分析模型。

::Range 模式：扩展性与精确性的平衡

模式概述

::Range 模式是 Semmle QL 中一种巧妙的设计范式，它解决了类设计中扩展性（允许用户添加新类型）与精确性（允许子类覆盖父类行为）之间的矛盾。这种模式通过分离类的定义与实现范围，为代码分析提供了更大的灵活性。

传统设计的问题

在传统设计中，我们通常会面临两种选择：

1. 抽象类方案：

   abstract class MySpecialExpr extends Expr {
     abstract int memberPredicate();
   }
   

   这种方案允许用户扩展新类型，但无法统一覆盖所有子类的行为。

2. 非抽象类方案：

   class MySpecialExpr extends Expr {
     int memberPredicate() { ... }
   }
   

   这种方案允许行为覆盖，但限制了类型的扩展性。

::Range 模式的实现

::Range 模式通过模块化设计解决了上述问题：

class MySpecialExpr extends Expr instanceof MySpecialExpr::Range {
  int memberPredicate() { result = super.memberPredicate() }
}

module MySpecialExpr {
  abstract class Range extends Expr {
    abstract int memberPredicate();
  }
}

这种结构提供了两个扩展点：

• 模型扩展：通过继承 MySpecialExpr::Range 来添加新类型
• 行为精炼：通过继承 MySpecialExpr 来覆盖现有行为

实际应用示例

以 Python 库中的 Escaping 类为例，该模型用于分析各种字符转义函数：

class Escaping extends Expr instanceof Escaping::Range {
  string getKind() { result = super.getKind() }
}

module Escaping {
  abstract class Range extends Expr {
    abstract string getKind();
  }
}

• 库开发者可以继承 Escaping::Range 来添加新的转义函数类型
• 分析人员可以继承 Escaping 来创建特定类型的转义函数集合（如 HtmlEscaping）

类导入的最佳实践

子类导入一致性

在 Semmle QL 中，导入新文件可能会改变标准库的行为，因为：

1. 可能引入新的抽象类子类型
2. 可能建立新的多重继承关系
3. 可能覆盖现有谓词

因此，最佳实践是确保在导入基类时，尽可能包含其所有子类，以保持分析结果的一致性。

抽象类的开放与封闭设计

在类设计中，我们需要明确区分两种抽象类：

1. 开放联合（Open Union）：

   • 明确设计为扩展点
   • ::Range 模式中的 Range 类就是典型例子
   • 鼓励用户通过继承添加新类型

2. 封闭联合（Closed Union）：

   • 不期望用户添加新类型
   • 传统上可能错误地使用抽象类实现
   • 现代设计应采用非抽象类方案

反模式示例

/** 反模式：使用抽象类表示封闭联合 */
abstract class BinaryExpr extends Expr {
  Expr getLhs() { result = this.getChild(0) }
  Expr getRight() { result = this.getChild(1) }
}

正确实现方式

对于封闭联合，推荐以下方案：

1. 使用 dbscheme 类型：

   @binary_expr = @plus_expr | @minus_expr | ...
   class BinaryExpr extends Expr, @binary_expr { ... }
   

2. 使用类型别名：

   class RawBinaryExpr = @plus_expr | @minus_expr | ...
   class BinaryExpr extends Expr, RawBinaryExpr { ... }
   

3. 使用特征谓词：

   class BinaryExpr extends Expr {
     BinaryExpr() { 
       this instanceof PlusExpr or 
       this instanceof MinusExpr or ...
     }
   }
   

结论

Semmle QL 的设计模式为代码分析提供了强大的建模能力。::Range 模式通过巧妙的类结构设计，解决了扩展性与精确性的矛盾；而合理的类导入策略和抽象类设计原则，则确保了分析模型的稳定性和可预测性。掌握这些设计模式，将帮助开发者构建更加健壮和灵活的代码分析解决方案。

codeql 项目地址: https://gitcode.com/gh_mirrors/ql/ql