soar-php 是一個(gè)基于小米公司開源的 soar 開發(fā)的 PHP 擴(kuò)展包，方便框架中 SQL 語句調(diào)優(yōu)。
項(xiàng)目鏈接
框架中使用
- [x] ThinkPHP
- [ ] Symfony
- [ ] Laravel
- [ ] Lumen
- [ ] Yii2
- [ ] Slim
環(huán)境要求
- PHP >= 5.6
- ext-pdo
- ext-json
安裝
$ composer require guanguans/soar-php --dev
使用
下載 XiaoMi 開源的 SQL 優(yōu)化器 soar蓖议，更多詳細(xì)安裝請(qǐng)參考 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
# 用其他命令或下載器下載均可以
初始化配置虏杰，更多詳細(xì)配置請(qǐng)參考 soar config
方法一、運(yùn)行時(shí)初始化配置
<?php
require_once __DIR__.'/vendor/autoload.php';
use Guanguans\SoarPHP\Soar;
$config = [
// 下載的 soar 的路徑
'-soar-path' => '/Users/yaozm/Documents/wwwroot/soar-php/soar.darwin-amd64',
// 測(cè)試環(huán)境配置
'-test-dsn' => [
'host' => '127.0.0.1',
'port' => '3306',
'dbname' => 'database',
'username' => 'root',
'password' => '123456',
],
// 日志輸出文件
'-log-output' => './soar.log',
// 報(bào)告輸出格式: 默認(rèn) markdown [markdown, html, json]
'-report-type' => 'html',
];
$soar = new Soar($config);
方法二勒虾、配置文件初始化配置
vendor 同級(jí)目錄下新建 .soar.dist 或者 .soar纺阔，內(nèi)容參考 .soar.example，例如：
<?php
return [
// 下載的 soar 的路徑
'-soar-path' => '/Users/yaozm/Documents/wwwroot/soar-php/soar.darwin-amd64',
// 測(cè)試環(huán)境配置
'-test-dsn' => [
'host' => '127.0.0.1',
'port' => '3306',
'dbname' => 'database',
'username' => 'root',
'password' => '123456',
],
// 日志輸出文件
'-log-output' => './soar.log',
// 報(bào)告輸出格式: 默認(rèn) markdown [markdown, html, json]
'-report-type' => 'html',
];
然后初始化
<?php
require_once __DIR__.'/vendor/autoload.php';
use Guanguans\SoarPHP\Soar;
$soar = new Soar();
配置優(yōu)先級(jí)：運(yùn)行時(shí)初始化配置 > .soar > .soar.dist
SQL 評(píng)分
方法調(diào)用：
$sql ="SELECT * FROM `fa_user` `user` LEFT JOIN `fa_user_group` `group` ON `user`.`group_id`=`group`.`id`;";
echo $soar->score($sql);
輸出結(jié)果：
score.png
explain 信息解讀
方法調(diào)用：
$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');
輸出結(jié)果：
explain.png
語法檢查
方法調(diào)用：
$sql = 'selec * from fa_user';
echo $soar->syntaxCheck($sql);
輸出結(jié)果：
At SQL 1 : line 1 column 5 near "selec * from fa_user" (total length 20)
SQL 指紋
方法調(diào)用：
$sql = 'select * from fa_user where id=1';
echo $soar->fingerPrint($sql);
輸出結(jié)果：
select * from fa_user where id = ?
SQL 美化
方法調(diào)用：
$sql = 'select * from fa_user where id=1';
var_dump($soar->pretty($sql));
輸出結(jié)果：
SELECT
*
FROM
fa_user
WHERE
id = 1;
markdown 轉(zhuǎn)化為 html
方法調(diào)用：
echo $soar->md2html("## 這是一個(gè)測(cè)試");
輸出結(jié)果：
...
<h2>這是一個(gè)測(cè)試</h2>
...
soar 幫助
方法調(diào)用：
var_dump($soar->help());
輸出結(jié)果：
···
'Usage of /Users/yaozm/Documents/wwwroot/soar-php/soar:
-allow-charsets string
AllowCharsets (default "utf8,utf8mb4")
-allow-collates string
AllowCollates
-allow-drop-index
AllowDropIndex, 允許輸出刪除重復(fù)索引的建議
-allow-engines string
AllowEngines (default "innodb")
-allow-online-as-test
AllowOnlineAsTest, 允許線上環(huán)境也可以當(dāng)作測(cè)試環(huán)境
-blacklist string
指定 blacklist 配置文件的位置从撼，文件中的 SQL 不會(huì)被評(píng)審州弟。
···
執(zhí)行任意 soar 命令
方法調(diào)用：
$command = "echo '## 這是另一個(gè)測(cè)試' | /Users/yaozm/Documents/wwwroot/soar-php/soar.darwin-amd64 -report-type md2html";
echo $soar->exec($command);
輸出結(jié)果：
...
<h2>這是另一個(gè)測(cè)試</h2>
...
