构建一个 OOP SQL 查询生成器

PHP 7实现了一种称为上下文相关的词法分析器。这意味着，如果上下文允许，通常保留的词可以被使用，因此，当构建面向对象的 SQL 构建器时，我们可以使用名为 and, or, not 等方法。

如何做…

1.我们定义了一个 Application/Database/Finder 类。在这个类中，我们定义了与我们最喜欢的SQL操作相匹配的方法。

  1. namespace Application\Database;
  2. class Finder
  3. {
  4.   public static $sql      = '';
  5.   public static $instance = NULL;
  6.   public static $prefix   = '';
  7.   public static $where    = array();
  8.   public static $control  = ['', ''];
  10.     // $a == name of table
  11.     // $cols = column names
  12.     public static function select($a, $cols = NULL)
  13.     {
  14.       self::$instance  = new Finder();
  15.       if ($cols) {
  16.            self::$prefix = 'SELECT ' . $cols . ' FROM ' . $a;
  17.       } else {
  18.         self::$prefix = 'SELECT * FROM ' . $a;
  19.       }
  20.       return self::$instance;
  21.     }
  23.     public static function where($a = NULL)
  24.     {
  25.         self::$where[0] = ' WHERE ' . $a;
  26.         return self::$instance;
  27.     }
  29.     public static function like($a, $b)
  30.     {
  31.         self::$where[] = trim($a . ' LIKE ' . $b);
  32.         return self::$instance;
  33.     }
  35.     public static function and($a = NULL)
  36.     {
  37.         self::$where[] = trim('AND ' . $a);
  38.         return self::$instance;
  39.     }
  41.     public static function or($a = NULL)
  42.     {
  43.         self::$where[] = trim('OR ' . $a);
  44.         return self::$instance;
  45.     }
  47.     public static function in(array $a)
  48.     {
  49.         self::$where[] = 'IN ( ' . implode(',', $a) . ' )';
  50.         return self::$instance;
  51.     }
  53.     public static function not($a = NULL)
  54.     {
  55.         self::$where[] = trim('NOT ' . $a);
  56.         return self::$instance;
  57.     }
  59.     public static function limit($limit)
  60.     {
  61.         self::$control[0] = 'LIMIT ' . $limit;
  62.         return self::$instance;
  63.     }
  65.     public static function offset($offset)
  66.     {
  67.         self::$control[1] = 'OFFSET ' . $offset;
  68.         return self::$instance;
  69.     }
  71.   public static function getSql()
  72.   {
  73.     self::$sql = self::$prefix
  74.        . implode(' ', self::$where)
  75.                . ' '
  76.                . self::$control[0]
  77.                . ' '
  78.                . self::$control[1];
  79.     preg_replace('/  /', ' ', self::$sql);
  80.     return trim(self::$sql);
  81.   }
  82. }

2.每个用于生成SQL片段的函数都会返回相同的属性，即 $instance。这使得我们可以使用一个流畅的接口来表示代码，比如这样。

  1. $sql = Finder::select('project')->where('priority > 9') ... etc.

如何运行…

将前面定义的代码复制到 Application/Database 文件夹下的Finder.php文件中。然后您可以创建一个chap_05_oop_query_builder.php调用程序，它初始化了在第一章建立基础中定义的自动加载器。然后你可以运行Finder::select()来生成一个对象，从这个对象中可以呈现SQL字符串。

  1. <?php
  2. require __DIR__ . '/../Application/Autoload/Loader.php';
  3. Application\Autoload\Loader::init(__DIR__ . '/..');
  4. use Application\Database\Finder;
  6. $sql = Finder::select('project')
  7.   ->where()
  8.   ->like('name', '%secret%')
  9.   ->and('priority > 9')
  10.   ->or('code')->in(['4', '5', '7'])
  11.   ->and()->not('created_at')
  12.   ->limit(10)
  13.   ->offset(20);
  15. echo Finder::getSql();

这是预编码的结果：

构建一个 OOP SQL 查询生成器 - 图1

参考

有关上下文相关词法分析器的更多信息，请参见本文：

https://wiki.php.net/rfc/context_sensitive_lexer