如何在Yii2的ActiveRecord查询中注入SQL提示？

要实现像Model::find()->withComment('query id')这样的链式调用，给ActiveRecord生成的SQL添加前置注释，可以通过扩展ActiveQuery类来实现，具体步骤如下：

1. 自定义带注释功能的ActiveQuery类 #

创建一个继承自yii\db\ActiveQuery的子类，添加存储注释的属性和withComment方法，并重写prepare方法来修改最终生成的SQL：

namespace app\db;

use yii\db\ActiveQuery;

class CommentActiveQuery extends ActiveQuery
{
    private $comment;

    // 设置查询注释的链式方法
    public function withComment(string $comment)
    {
        $this->comment = $comment;
        return $this;
    }

    // 重写prepare方法，在SQL前插入注释
    public function prepare($builder)
    {
        $sql = parent::prepare($builder);
        
        if (!empty($this->comment)) {
            // 转义注释中的*/，避免破坏SQL结构
            $escapedComment = str_replace('*/', '*\/', $this->comment);
            $sql = "/* {$escapedComment} */ {$sql}";
        }
        
        return $sql;
    }
}

2. 在Model中使用自定义Query类 #

在需要支持注释功能的Model类里，重写find方法，返回自定义的CommentActiveQuery实例：

namespace app\models;

use app\db\CommentActiveQuery;
use yii\db\ActiveRecord;

class YourModel extends ActiveRecord
{
    public static function find()
    {
        return new CommentActiveQuery(get_called_class());
    }
}

3. 调用示例 #

现在就可以通过链式调用添加查询注释了：

// 生成的SQL会是 /* query id */ SELECT * FROM your_model ...
$models = YourModel::find()->withComment('query id')->all();

注意事项 #

• 必须转义注释内容中的*/，否则会提前闭合注释块，导致SQL语法错误。
• 如果需要全局所有Model都支持该功能，可以修改项目的BaseActiveRecord类，让所有Model继承它，无需逐个重写find方法。

内容的提问来源于stack exchange，提问作者user2531657