前言

今天逛 github 时，发现了这款对 SQL 进行优化和改写的自动化工具 sora 。感觉挺不错的，就下载学习了一下。这个工具支持的功能比较多，可以作为我们日常开发中的一款辅助工具，现在我就把它推荐给你们～～～

github传送门： https://github.com/XiaoMi/soar

背景

在我们日常开发中，优化SQL总是我们日常开发任务之一。例行 SQL 优化，不仅可以提升程序性能，还能够降低线上故障的概率。

目前常用的 SQL 优化方式包括但不限于：业务层优化、SQL逻辑优化、索引优化等。其中索引优化通常通过调整索引或新增索引从而达到 SQL 优化的目的。索引优化往往可以在短时间内产生非常巨大的效果。如果能够将索引优化转化成工具化、标准化的流程，减少人工介入的工作量，无疑会大大提高我们的工作效率。

SOAR(SQL Optimizer And Rewriter) 是一个对 SQL 进行优化和改写的自动化工具。 由小米人工智能与云平台的数据库团队开发与维护。

与业内其他优秀产品对比如下：

从上图可以看出，支持的功能丰富，其功能特点如下：

• 跨平台支持（支持 Linux, Mac 环境，Windows 环境理论上也支持，不过未全面测试）

• 目前只支持 MySQL 语法族协议的 SQL 优化

• 支持基于启发式算法的语句优化

• 支持复杂查询的多列索引优化（UPDATE, INSERT, DELETE, SELECT）

• 支持 EXPLAIN 信息丰富解读

• 支持 SQL 指纹、压缩和美化

• 支持同一张表多条 ALTER 请求合并

• 支持自定义规则的 SQL 改写

就介绍这么多吧，既然是SQL优化工具，光说是没有用的，我们还是先用起来看看效果吧。

安装

这里有两种安装方式，如下：

• 
  

1. 下载二进制安装包

$ wget https://github.com/XiaoMi/soar/releases/download/0.11.0/soar.linux-amd64 -O soar
chmod a+x soar

这里建议直接下载最新版，要不会有 bug 。

下载好的二进制文件添加到环境变量中即可(不会的谷歌一下吧，这里就不讲了)。

测试一下：

$ echo 'select * from user' | soar.darwin-amd64(根据你自己的二进制文件名来输入)# Query: AC4262B5AF150CB5★ ★ ★ ☆ ☆ 75分

```sqlSELECT
  *FROM
  USER
```## 最外层 SELECT 未指定 WHERE 条件* **Item:**  CLA.001* **Severity:**  L4

* **Content:**  SELECT 语句没有 WHERE 子句，可能检查比预期更多的行(全表扫描)。对于 SELECT COUNT(\*) 类型的请求如果不要求精度，建议使用 SHOW TABLE STATUS 或 EXPLAIN 替代。## 不建议使用 SELECT * 类型查询* **Item:**  COL.001* **Severity:**  L1

* **Content:**  当表结构变更时，使用 \* 通配符选择所有列将导致查询的含义和行为会发生更改，可能导致查询返回更多的数据。

• 
  

1. 源码安装

依赖环境：

1. Go 1.10+2. git

高级依赖（仅面向开发人员）

• mysql 客户端版本需要与容器中MySQL版本相同，避免出现由于认证原因导致无法连接问题

• docker MySQL Server测试容器管理

• govendor Go包管理

• retool 依赖外部代码质量静态检查工具二进制文件管理

生成二进制文件：

go get -d github.com/XiaoMi/soarcd ${GOPATH}/src/github.com/XiaoMi/soar && make

生成的二进制文件与上面一样，直接放入环境变量即可，这里我没有尝试，靠你们自己踩坑了呦～～～

简单使用

0. 前置准备

准备一个 table ，如下：

CREATE TABLE `users` (  `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,  
`username` varchar(64) NOT NULL DEFAULT '',  `nickname` varchar(255) DEFAULT '',  
`password` varchar(256) NOT NULL DEFAULT '',  `salt` varchar(48) NOT NULL DEFAULT '',  
`avatar` varchar(128) DEFAULT NULL,  `uptime` datetime DEFAULT NULL,
  PRIMARY KEY (`id`),  UNIQUE KEY `username` (`username`)
) ENGINE=InnoDB AUTO_INCREMENT=11 DEFAULT CHARSET=utf8mb4

1. 直接输入sql语句(不运行)

$ echo "select * from users" | soar.darwin-amd64
$ # Query: 30AFCB1E1344BEBD★ ★ ★ ☆ ☆ 75分

```sqlSELECT
  *FROM
  users
```## 最外层 SELECT 未指定 WHERE 条件* **Item:**  CLA.001* **Severity:**  L4

* **Content:**  SELECT 语句没有 WHERE 子句，可能检查比预期更多的行(全表扫描)。对于 SELECT COUNT(\*) 类型的请求如果不要求精度，建议使用 SHOW TABLE STATUS 或 EXPLAIN 替代。## 不建议使用 SELECT * 类型查询* **Item:**  COL.001* **Severity:**  L1

* **Content:**  当表结构变更时，使用 \* 通配符选择所有列将导致查询的含义和行为会发生更改，可能导致查询返回更多的数据。

现在是完全根据SQL语句进行分析的，因为没有连接到 mysql 。可以看到，给出的报告也很详细，但是只是空壳子，仅凭 SQL 语句给出的分析并不是准确的，所以我们开始接下来的应用。

2. 连接 mysql 生成 EXPLAIN 分析报告

我们可以在配置文件中配置好 mysql 相关的配置，操作如下：

vi soar.yaml
# yaml format config file
online-dsn:
    addr:     127.0.0.1:3306
    schema:   asong
    user:     root
    password: root1997
    disable:  false

test-dsn:
    addr:     127.0.0.1:3306
    schema:   asong
    user:     root
    password: root1997
    disable:  false

配置好了，我们来实践一下子吧：

$ echo "SELECT id,username,nickname,password,salt,avatar,uptime FROM users WHERE username = 'asong1111'" | soar.darwin-amd64 -test-dsn="root:root1997@127.0.0.1:3306/asong" -allow-online-as-test -log-output=soar.log
$ # Query: D12A420193AD1674★ ★ ★ ★ ★ 100分

```sqlSELECT
  id, username, nickname, PASSWORD, salt, avatar, uptimeFROM
  usersWHERE
  username  = 'asong1111'```##  Explain信息| id | select\_type | table | partitions | type | possible_keys | key | key\_len | ref | rows | filtered | scalability | Extra |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1  | SIMPLE | *users* | NULL | const | username | username | 258 | const | 1 | ☠️ **100.00%** | ☠️ **O(n)** | NULL |### Explain信息解读#### SelectType信息解读* **SIMPLE**: 简单SELECT(不使用UNION或子查询等).#### Type信息解读* **const**: const用于使用常数值比较PRIMARY KEY时, 当查询的表仅有一行时, 使用system. 例:SELECT * FROM tbl WHERE col = 1.

这回结果中多了EXPLAIN信息分析报告。这对于刚开始入门的小伙伴们是友好的，因为我们对 Explain 解析的字段并不熟悉，有了它我们可以完美的分析 SQL 中的问题，是不是很棒。

3. 语法检查

soar 工具不仅仅可以进行 sql 语句分析，还可以进行对 sql 语法进行检查，找出其中的问题，来看个例子：

$ echo "selec * from users" | soar.darwin-amd64 -only-syntax-check
At SQL 1 : line 1 column 5 near "selec * from users" (total length 18)

这里 select 关键字少了一个 t ，运行该指令帮助我们一下就定位了问题，当我们的 sql 语句很长时，就可以使用该指令来辅助我们检查 SQL 语句是否正确。

4. SQL美化

我们日常开发时，经常会看其他人写的代码，因为水平不一样，所以有些 SQL 语句会写的很乱，所以这个工具就派上用场了，我们可以把我们的 SQL 语句变得漂亮一些，更容易我们理解哦。

$ echo "SELECT id,username,nickname,password,salt,avatar,uptime FROM users WHERE username = 'asong1111'" | soar.darwin-amd64 -report-type=pretty

SELECT
  id, username, nickname, PASSWORD, salt, avatar, uptime
FROM
  users
WHERE
  username  = 'asong1111';

这样看起来是不是更直观了呢～～。

结尾

因为我也才是刚使用这个工具，更多的玩法我还没有发现，以后补充。更多玩法可以自己研究一下，github传送门： https://github.com/XiaoMi/soar 。官方文档其实很粗糙，更多方法解锁还要靠自己研究，毕竟源码已经给我们了，对于学习 go 也有一定帮助，当作一个小项目慢慢优化岂不是更好呢～～。