soar-PHP - SQL 語句優化器和重寫器的 PHP 擴充套件包、 方便框架中 SQL 語句調優

guanguans發表於2019-07-09
PHPSQL優化套件框架

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

專案連結

框架中使用

  • [x] 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

方法一、執行時初始化配置

<?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);

方法二、配置檔案初始化配置

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);

輸出結果：

score.png

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');

輸出結果：

explain.png

語法檢查

方法呼叫：

$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>
...

參考連結

No practice, no gain in one's wit.
我的 Gitub

相關文章