数据库Schema¶

class QueryBuilder extends \yii\base\Object
{
    // $typeMap用于定义抽象数据类型到DBMS数据类型的映射关系，
    // 具体由各QueryBuilder子类实现。
    public $typeMap = [];

    // 将抽象数据类型转换成合适的DBMS数据类型
    public function getColumnType($type)
    {
        // 映射表中已经有的，直接使用映射的类型
        if (isset($this->typeMap[$type])) {
            return $this->typeMap[$type];

        // 映射表中没有的类型，看看是不是形如 "Schema::TYPE_INT(11) DEFAULT 0" 之类的
        } elseif (preg_match('/^(\w+)\((.+?)\)(.*)$/', $type, $matches)) {
            if (isset($this->typeMap[$matches[1]])) {
                return preg_replace('/\(.+\)/', '(' . $matches[2] . ')', $this->typeMap[$matches[1]]) . $matches[3];
            }

        // 看看是不是形如 "Schema::TYPE_INT NOT NULL" 之类的，
        // 注意这一分支在第二分支之后
        } elseif (preg_match('/^(\w+)\s+/', $type, $matches)) {
            if (isset($this->typeMap[$matches[1]])) {
                return preg_replace('/^\w+/', $this->typeMap[$matches[1]], $type);
            }
        }

        // 实在匹配不上映射表中的类型，那就原封不动返回吧
        return $type;
    }

    // ... ...
}

namespace yii\db\mysql;

class QueryBuilder extends \yii\db\QueryBuilder
{
    public $typeMap = [
        Schema::TYPE_PK => 'int(11) NOT NULL AUTO_INCREMENT PRIMARY KEY',
        Schema::TYPE_BIGPK => 'bigint(20) NOT NULL AUTO_INCREMENT PRIMARY KEY',
        Schema::TYPE_STRING => 'varchar(255)',
        Schema::TYPE_TEXT => 'text',
        Schema::TYPE_SMALLINT => 'smallint(6)',
        Schema::TYPE_INTEGER => 'int(11)',
        Schema::TYPE_BIGINT => 'bigint(20)',
        Schema::TYPE_FLOAT => 'float',
        Schema::TYPE_DECIMAL => 'decimal(10,0)',
        Schema::TYPE_DATETIME => 'datetime',
        Schema::TYPE_TIMESTAMP => 'timestamp',
        Schema::TYPE_TIME => 'time',
        Schema::TYPE_DATE => 'date',
        Schema::TYPE_BINARY => 'blob',
        Schema::TYPE_BOOLEAN => 'tinyint(1)',
        Schema::TYPE_MONEY => 'decimal(19,4)',
    ];
    // ... ...
}

class Schema extends \yii\db\Schema
{
    // 定义从数据库数据类型到16个抽象数据类型间的映射关系
    public $typeMap = [
        'tinyint' => self::TYPE_SMALLINT,
        'bit' => self::TYPE_INTEGER,
        'smallint' => self::TYPE_SMALLINT,
        'mediumint' => self::TYPE_INTEGER,
        'int' => self::TYPE_INTEGER,
        'integer' => self::TYPE_INTEGER,
        'bigint' => self::TYPE_BIGINT,
        'float' => self::TYPE_FLOAT,
        'double' => self::TYPE_FLOAT,
        'real' => self::TYPE_FLOAT,
        'decimal' => self::TYPE_DECIMAL,
        'numeric' => self::TYPE_DECIMAL,
        'tinytext' => self::TYPE_TEXT,
        'mediumtext' => self::TYPE_TEXT,
        'longtext' => self::TYPE_TEXT,
        'longblob' => self::TYPE_BINARY,
        'blob' => self::TYPE_BINARY,
        'text' => self::TYPE_TEXT,
        'varchar' => self::TYPE_STRING,
        'string' => self::TYPE_STRING,
        'char' => self::TYPE_STRING,
        'datetime' => self::TYPE_DATETIME,
        'year' => self::TYPE_DATE,
        'date' => self::TYPE_DATE,
        'time' => self::TYPE_TIME,
        'timestamp' => self::TYPE_TIMESTAMP,
        'enum' => self::TYPE_STRING,
    ];

    // ... ...
}

// $info数组 由 SQL 语句 "SHOW FULL COLUMNS FROM ..." 而来，形式如下：
//      Field: id
//       Type: int(11)
//  Collation: NULL
//       Null: NO
//        Key: PRI
//    Default: NULL
//      Extra: auto_increment
// Privileges: select,insert,update,references
//    Comment:
protected function loadColumnSchema($info)
{
    $column = $this->createColumnSchema();

    // 字段名
    $column->name = $info['Field'];
    // 是否允许为NULL
    $column->allowNull = $info['Null'] === 'YES';
    // 是否是主键
    $column->isPrimaryKey = strpos($info['Key'], 'PRI') !== false;
    // 是否 auto_increment
    $column->autoIncrement = stripos($info['Extra'], 'auto_increment') !== false;
    // 获取字段注释
    $column->comment = $info['Comment'];

    // 重点是这里，获取数据库字段类型，如上面的 int(11)
    $column->dbType = $info['Type'];
    // 是否是 unsigned
    $column->unsigned = stripos($column->dbType, 'unsigned') !== false;

    // 以下将把数据库类型，转换成对应的抽象类型，默认为 TYPE_STRING
    $column->type = self::TYPE_STRING;
    if (preg_match('/^(\w+)(?:\(([^\)]+)\))?/', $column->dbType, $matches)) {

        // 获取 int(11) 的 "int" 部分
        $type = strtolower($matches[1]);
        // 如果映射表里有，那就直接映射成抽象类型
        if (isset($this->typeMap[$type])) {
            $column->type = $this->typeMap[$type];
        }

        // 形如int(11) 的括号中的内容
        if (!empty($matches[2])) {
            // 枚举类型，还需要将所有枚举值写入 $column->enumValues
            if ($type === 'enum') {
                $values = explode(',', $matches[2]);
                foreach ($values as $i => $value) {
                    $values[$i] = trim($value, "'");
                }
                $column->enumValues = $values;

            // 如果不是枚举类型，那么括号中的内容就是精度了，如 decimal(19,4)
            } else {
                $values = explode(',', $matches[2]);
                $column->size = $column->precision = (int) $values[0];
                if (isset($values[1])) {
                    $column->scale = (int) $values[1];
                }

                // bit(1) 类型的，转换成 boolean
                if ($column->size === 1 && $type === 'bit') {
                    $column->type = 'boolean';
                } elseif ($type === 'bit') {
                    // 由于bit最多64位，如果超过 32 位，那么用一个 bigint 足以。
                    if ($column->size > 32) {
                        $column->type = 'bigint';
                    // 如果正好32位，那么用一个 interger 来表示。
                    } elseif ($column->size === 32) {
                        $column->type = 'integer';
                    }
                }
            }
        }
    }

    // 获取PHP数据类型
    $column->phpType = $this->getColumnPhpType($column);

    // 处理默认值
    if (!$column->isPrimaryKey) {
        // timestamp 的话，要实际获取当前时间戳，而不能是字符串 'CURRENT_TIMESTAMP'
        if ($column->type === 'timestamp' && $info['Default'] === 'CURRENT_TIMESTAMP') {
            $column->defaultValue = new Expression('CURRENT_TIMESTAMP');

        // bit 的话，要截取对应的内容，并进行进制转换
        } elseif (isset($type) && $type === 'bit') {
            $column->defaultValue = bindec(trim($info['Default'],'b\''));

        // 其余类型的，直接转换成PHP类型的值
        } else {
            $column->defaultValue = $column->phpTypecast($info['Default']);
        }
    }
    return $column;
}

protected function getColumnPhpType($column)
{
    // 定义从抽象类型到PHP类型的映射
    static $typeMap = [
        'smallint' => 'integer',
        'integer' => 'integer',
        'bigint' => 'integer',
        'boolean' => 'boolean',
        'float' => 'double',
        'binary' => 'resource',
    ];

    // 除了上面的映射关系外，还有几个特殊情况：
    // 1. bigint字段，在64位环境下，且为singed时，使用integer来表示，否则string
    // 2. integer字段，在32位环境下，且为unsinged时，使用string表示，否则integer
    // 3. 映射中不存在的字段类型均使用string
    if (isset($typeMap[$column->type])) {
        if ($column->type === 'bigint') {
            return PHP_INT_SIZE == 8 && !$column->unsigned ? 'integer' : 'string';
        } elseif ($column->type === 'integer') {
            return PHP_INT_SIZE == 4 && $column->unsigned ? 'string' : 'integer';
        } else {
            return $typeMap[$column->type];
        }
    } else {
        return 'string';
    }
}

// 该方法用于把 $value 转换成 php 变量，其中 $value 是PDO从数据库中读取的内容
// 主要参考的是字段的抽象类型 $type 和 PHP类型 $phpType
public function phpTypecast($value)
{
    // 内容为空时，若不是字符串或二进制抽象类型，则是NULL的意思。
    if ($value === '' && $this->type !== Schema::TYPE_TEXT && $this->type !== Schema::TYPE_STRING && $this->type !== Schema::TYPE_BINARY) {
        return null;
    }

    // 内容为null，或者 $value 的类型与PHP类型一致，或者 $value 是一个数据库表达式，
    // 那么可以直接返回
    if ($value === null || gettype($value) === $this->phpType || $value instanceof Expression) {
        return $value;
    }

    // 否则，需要根据PHP类型来完成类型转换
    switch ($this->phpType) {
        case 'resource':
        case 'string':
            return is_resource($value) ? $value : (string) $value;
        case 'integer':
            return (int) $value;
        case 'boolean':
            return (bool) $value;
        case 'double':
            return (double) $value;
    }
    return $value;
}

abstract class Schema extends Object
{
    // 将一个PHP数据类型转换成PDO数据类型
    public function getPdoType($data)
    {
        // 定义一个PHP类型到PDO类型的映射表
        static $typeMap = [
            'boolean' => \PDO::PARAM_BOOL,
            'integer' => \PDO::PARAM_INT,
            'string' => \PDO::PARAM_STR,
            'resource' => \PDO::PARAM_LOB,
            'NULL' => \PDO::PARAM_NULL,
        ];
        $type = gettype($data);

        // 在匹配不上映射表时，采用字符串类型
        return isset($typeMap[$type]) ? $typeMap[$type] : \PDO::PARAM_STR;
    }

    // ... ...
}