README

一个用于格式化SQL语句的轻量级PHP类。

它可以在语法高亮的基础上自动缩进并添加换行。

历史

我发现自己经常需要调试自动生成的SQL语句，并希望有一种简单的方法可以输出格式化的HTML，而无需包含庞大的库或复制粘贴到在线格式化工具中。

最初我打算从PhpMyAdmin中提取格式化代码，但那需要10,000+行代码，并使用了全局变量。

我看到其他人也有同样的问题，并以Stack Overflow用户losif的答案为起点。 http://stackoverflow.com/a/3924147

用法

SqlFormatter类有一个静态方法'format'，它接受一个SQL字符串
作为输入，并返回一个包含在pre标签内的格式化HTML块。

示例用法

<?php
require_once('SqlFormatter.php');

$query = "SELECT count(*),`Column1`,`Testing`, `Testing Three` FROM `Table1`
    WHERE Column1 = 'testing' AND ( (`Column2` = `Column3` OR Column4 >= NOW()) )
    GROUP BY Column1 ORDER BY Column3 DESC LIMIT 5,10";

echo SqlFormatter::format($query);

输出

仅格式化

如果您不需要语法高亮，只想添加缩进和换行，请将第二个参数传递为false。

这适用于输出到错误日志或其他非HTML格式。

<?php
echo SqlFormatter::format($query, false);

输出

仅语法高亮

有一个名为'highlight'的独立方法，它保留所有原始空白并仅添加语法高亮。

这对于已经很好地格式化的SQL来说很有用，只需稍微容易阅读。

<?php
echo SqlFormatter::highlight($query);

输出

压缩查询

compress方法删除所有注释并压缩空白。

这适用于可以轻松复制粘贴到命令行的查询。

-- This is a comment
    SELECT
    /* This is another comment
    On more than one line */
    Id #This is one final comment
    as temp, DateCreated as Created FROM MyTable;

echo SqlFormatter::compress($query)

输出

SELECT Id as temp, DateCreated as Created FROM MyTable;

删除注释

如果您想保留所有原始空白格式并仅删除注释，可以使用removeComments方法而不是compress。

-- This is a comment
    SELECT
    /* This is another comment
    On more than one line */
    Id #This is one final comment
    as temp, DateCreated as Created FROM MyTable;

<?php
echo SqlFormatter::removeComments($query);

输出

    SELECT
    
    Id 
    as temp, DateCreated as Created FROM MyTable;

将SQL字符串拆分为查询

另一个与格式化无关的功能是能够将SQL字符串拆分为多个查询。

例如

DROP TABLE IF EXISTS MyTable;
CREATE TABLE MyTable ( id int );
INSERT INTO MyTable	(id)
	VALUES
	(1),(2),(3),(4);
SELECT * FROM MyTable;

<?php
$queries = SqlFormatter::splitQuery($sql);

结果

1. DROP TABLE IF EXISTS MyTable;
2. CREATE TABLE MyTable ( id int );
3. INSERT INTO MyTable (id) VALUES (1),(2),(3),(4);
4. SELECT * FROM MyTable;

为什么不使用正则表达式？

为什么不直接使用explode(';', $sql)或正则表达式？

以下示例SQL和其他类似SQL是不可能通过正则表达式正确拆分的，无论多么复杂。

SELECT ";"; SELECT ";\"; a;";
SELECT ";
    abc";
SELECT a,b #comment;
FROM test;

SqlFormatter将字符串分解为标记，而不是使用正则表达式，并且可以正确生成

1. SELECT ";";
2. SELECT ";\"; a;";
3. SELECT "; abc";
4. SELECT a,b #comment; FROM test;

请注意，splitQuery方法在以下情况下仍然会失败

• 可以使用DELIMITER命令将分隔符从默认的分号';'更改为其他符号。
• CREATE PROCEDURE命令在其中间包含一个分号';'。
• USE命令不以分号';'结束。