如何在Yii2中使用MySQL的optimizer hints优化器提示功能

Yii2 原生没有内置支持设置 MySQL optimizer hints 的方法，你可以通过以下两种方案实现需求：

方案1：直接使用原生SQL执行 #

你可以直接拼接带hint的SQL语句，通过Yii提供的DAO层执行，适合逻辑比较简单的查询场景：

// 示例：执行带NO_RANGE_OPTIMIZATION提示的查询
$rows = Yii::$app->db->createCommand("SELECT /*+ NO_RANGE_OPTIMIZATION(t3 PRIMARY, f2_idx) */ f1 FROM t3 WHERE f1 > 30 AND f1 < 33")
    ->queryAll();

// 带参数的查询也支持正常绑定
$rows = Yii::$app->db->createCommand("SELECT /*+ BKA(t1) NO_BKA(t2) */ * FROM t1 INNER JOIN t2 WHERE t1.id = :id")
    ->bindValue(':id', 10)
    ->queryAll();

方案2：自定义QueryBuilder支持链式调用hint #

如果要保持Yii查询构造器的链式调用风格，可以自定义MySQL查询构造器类，预留hint插入位：

1. 首先继承原生MySQL QueryBuilder，重写SQL语句构造逻辑：

<?php
namespace app\components;

use yii\db\mysql\QueryBuilder as BaseQueryBuilder;

class QueryBuilder extends BaseQueryBuilder
{
    public function build($query, $params = [])
    {
        $sql = parent::build($query, $params);
        // 读取Query对象上自定义的optimizerHint属性
        if (property_exists($query, 'optimizerHint') && !empty($query->optimizerHint)) {
            // 匹配开头的SQL操作关键字插入hint，支持SELECT/INSERT/UPDATE/DELETE等场景
            return preg_replace('/^(SELECT|INSERT|UPDATE|DELETE)/i', '$1 /*+ ' . $query->optimizerHint . ' */', $sql);
        }
        return $sql;
    }
}

2. 在应用配置中替换数据库组件的queryBuilder实现：

return [
    'components' => [
        'db' => [
            'class' => \yii\db\Connection::class,
            'dsn' => 'mysql:host=localhost;dbname=你的库名',
            'username' => '数据库账号',
            'password' => '数据库密码',
            // 指定使用自定义的QueryBuilder
            'queryBuilder' => \app\components\QueryBuilder::class,
        ],
    ],
];

3. 自定义Query类增加hint设置方法，也可以对应扩展ActiveQuery适配AR查询场景：

<?php
namespace app\components;

use yii\db\Query as BaseQuery;

class Query extends BaseQuery
{
    // 存储optimizer hint的自定义属性
    public $optimizerHint;

    // 链式设置hint的方法
    public function optimizerHint($hint)
    {
        $this->optimizerHint = $hint;
        return $this;
    }
}

4. 使用示例：

$rows = (new \app\components\Query())
    ->select('*')
    ->from('t1')
    ->where(['>', 'id', 10])
    ->optimizerHint('NO_ICP(t1)') // 直接设置需要的optimizer hint
    ->all();

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