soar-PHP - SQL 語句優化器和重寫器的 PHP 擴展包、 方便框架應用中 SQL 調優

soar-php 是一個基於小米公司開源的 soar 開發的 PHP 擴展包，方便框架中 SQL 語句調優。

項目連接

• github.com/guanguans/s…
• github.com/guanguans/t…

框架中使用

• ThinkPHP
• Symfony
• Laravel
• Lumen
• Yii2
• Slim

環境要求

• PHP >= 5.6
• ext-pdo
• ext-json

安裝

$ composer require guanguans/soar-php --dev
複製代碼

使用

下載 XiaoMi 開源的 SQL 優化器 soar，更多詳細安裝請參考 soar install

# macOS
$ wget https://github.com/XiaoMi/soar/releases/download/0.11.0/soar.darwin-amd64
# linux
$ wget https://github.com/XiaoMi/soar/releases/download/0.11.0/soar.linux-amd64
# windows
$ wget https://github.com/XiaoMi/soar/releases/download/0.11.0/soar.windows-amd64
# 用其餘命令或下載器下載都可以
複製代碼

初始化配置，更多詳細配置請參考 soar config

方法1、運行時初始化配置

<?php

require_once __DIR__.'/vendor/autoload.php';

use Guanguans\SoarPHP\Soar;

$config = [
    // 下載的 soar 的路徑
    '-soar-path' => '/Users/yaozm/Documents/wwwroot/soar-php/soar.darwin-amd64',
    // 測試環境配置
    '-test-dsn' => [
        'host' => '127.0.0.1',
        'port' => '3306',
        'dbname' => 'database',
        'username' => 'root',
        'password' => '123456',
    ],
    // 日誌輸出文件
    '-log-output' => './soar.log',
    // 報告輸出格式: 默認 markdown [markdown, html, json]
    '-report-type' => 'html',
];
$soar = new Soar($config);
複製代碼

方法2、配置文件初始化配置

vendor 同級目錄下新建 .soar.dist 或者 .soar，內容參考 .soar.example，例如：

<?php
return [
    // 下載的 soar 的路徑
    '-soar-path' => '/Users/yaozm/Documents/wwwroot/soar-php/soar.darwin-amd64',
    // 測試環境配置
    '-test-dsn' => [
        'host' => '127.0.0.1',
        'port' => '3306',
        'dbname' => 'database',
        'username' => 'root',
        'password' => '123456',
    ],
    // 日誌輸出文件
    '-log-output' => './soar.log',
    // 報告輸出格式: 默認 markdown [markdown, html, json]
    '-report-type' => 'html',
];
複製代碼

而後初始化

<?php

require_once __DIR__.'/vendor/autoload.php';

use Guanguans\SoarPHP\Soar;

$soar = new Soar();
複製代碼

配置優先級：運行時初始化配置 > .soar > .soar.dist

SQL 評分

方法調用：

$sql ="SELECT * FROM `fa_user` `user` LEFT JOIN `fa_user_group` `group` ON `user`.`group_id`=`group`.`id`;";
echo $soar->score($sql);
複製代碼

輸出結果：

explain 信息解讀

方法調用：

$sql = "SELECT * FROM `fa_auth_group_access` `aga` LEFT JOIN `fa_auth_group` `ag` ON `aga`.`group_id`=`ag`.`id`;";
// 輸出 html 格式
echo $soar->htmlExplain($sql);
// 輸出 md 格式
echo $soar->mdExplain($sql);
// 輸出 html 格式
echo $soar->explain($sql, 'html');
// 輸出 md 格式
echo $soar->explain($sql, 'md');

複製代碼

輸出結果：

語法檢查

方法調用：

$sql = 'selec * from fa_user';
echo $soar->syntaxCheck($sql);
複製代碼

輸出結果：

At SQL 1 : line 1 column 5 near "selec * from fa_user" (total length 20)
複製代碼

SQL 指紋

方法調用：

$sql = 'select * from fa_user where id=1';
echo $soar->fingerPrint($sql);
複製代碼

輸出結果：

select * from fa_user where id = ?
複製代碼

SQL 美化

方法調用：

$sql = 'select * from fa_user where id=1';
var_dump($soar->pretty($sql));
複製代碼

輸出結果：

SELECT  
  * 
FROM  
  fa_user  
WHERE  
  id  = 1;
複製代碼

markdown 轉化爲 html

方法調用：

echo $soar->md2html("## 這是一個測試");
複製代碼

輸出結果：

...
<h2>這是一個測試</h2>
...
複製代碼

soar 幫助

方法調用：

var_dump($soar->help());
複製代碼

輸出結果：

···
'Usage of /Users/yaozm/Documents/wwwroot/soar-php/soar: -allow-charsets string AllowCharsets (default "utf8,utf8mb4") -allow-collates string AllowCollates -allow-drop-index AllowDropIndex, 容許輸出刪除重複索引的建議 -allow-engines string AllowEngines (default "innodb") -allow-online-as-test AllowOnlineAsTest, 容許線上環境也能夠看成測試環境 -blacklist string 指定 blacklist 配置文件的位置，文件中的 SQL 不會被評審。 ··· 複製代碼

執行任意 soar 命令

方法調用：

$command = "echo '## 這是另外一個測試' | /Users/yaozm/Documents/wwwroot/soar-php/soar.darwin-amd64 -report-type md2html";
echo $soar->exec($command);
複製代碼

輸出結果：

...
<h2>這是另外一個測試</h2>
...
複製代碼

參考連接

• github.com/XiaoMi/soar，XiaoMi