专栏首页IT码农Laravel5.3之Query Builder源码解析(上)

Laravel5.3之Query Builder源码解析(上)

说明:本文主要学习Laravel Database模块的Query Builder源码。实际上,Laravel通过Schema Builder来设计数据库,通过Query Builder来CURD数据库。Query Builder并不复杂或神秘,只是在PDO扩展的基础上又开放封闭的包装了一层,提供了fluent api,使得书写的代码也很简洁流畅。在看下Query Builder源码之前,先大概探索下illuminate/database package的目录结构。

开发环境: Laravel5.3 + PHP7

Folder/File

Description

Capsule

Capsule文件夹下只有一个Manager类,主要实现了容器实例化,DatabaseManager和ConnectionFactory的实例化

Connectors

里面包含了四种DB的链接器:MySQLConnector,PostgresConnector,SQLiteConnector,SqlServerConnector,是主要的组件之一,用来CRUD时链接对应的DB

Console

该文件内包含migration和seed的命令,如php artisan db:seed, php artisan migrate

Eloquent

该文件夹内包含的就是Eloquent的主要实现类,如重点的Model类,Builder类,Relations子文件夹内包含的表的关系类。是核心的组件,也是类最多的文件夹

Events

装载事件类的文件夹

Migrations

实际执行migrate相关命令的类

Query

Query Builder的代码主要在这个文件夹,主要的类是Builder类,还包括Grammars和Processors两大类别,根据四个不同的DB分门别类

Schema

是设计database的主要参与类,主要的类是Builder类和Blueprint类,还有Grammars类别,根据四个不同的DB分门别类

Connection class

数据库链接类,封装了PDO,是重要的类

DatabaseManager class

在DatabaseServiceProvider注册为'db',通常会通过该manager来'向下走'到对应的数据库实现类,是重要的类

Seeder class

主要负责seed命令时的操作

数据库连接的实例化

Query Builder主要在Query文件夹下,以一行简单又经常使用的代码为例来学习下内部实现的原理吧:

Route::get('/query_builder', function() {
    // Query Builder
    return DB::table('users')->where('id', '=', 1)->get();
});

// Illuminate/Support/Facades/DB
class DB extends Facade
{
    /**
     * Get the registered name of the component.
     *
     * @return string
     */
    protected static function getFacadeAccessor()
    {
        return 'db';
    }
}

在DatabaseServiceProvider已经注册了名为'db'的服务即DatabaseManager对象,则实际上魔术调用DatabaseManager中的table()方法,看下__call()魔术方法源码:

    // $method = 'table', $parameters = 'users'
    public function __call($method, $parameters)
    {
        return $this->connection()->$method(...$parameters);
    }

所以重点是connection()方法,该方法返回的是Connection对象,看下connection()方法源码:

public function connection($name = null)
    {
        // $name = 'mysql', $type = null
        list($name, $type) = $this->parseConnectionName($name);

        // 首次在$connections[]中没有'mysql' => $mysql_connection,所以需要根据配置创建对应DB连接
        if (! isset($this->connections[$name])) {
            // 重点是makeConnection()创建了mysql连接实例
            $connection = $this->makeConnection($name);
            
            // 由于$type是null,不是'write'或'read',所以实际上啥也没做
            $this->setPdoForType($connection, $type);

            // 得到连接实例$connection后,还需要对该实例做准备工作,如绑定事件,设置connector
            $this->connections[$name] = $this->prepare($connection);
        }

        return $this->connections[$name];
    }
    
    protected function parseConnectionName($name)
    {
        $name = $name ?: $this->getDefaultConnection();
        // 检查是否以::read, ::write结尾
        return Str::endsWith($name, ['::read', '::write'])
                            ? explode('::', $name, 2) : [$name, null];
    }
    
    public function getDefaultConnection()
    {
        // laravel默认是mysql,这里假定是常用的mysql连接
        return $this->app['config']['database.default'];
    }

通过上面源码知道重点是makeConnection($name)方法,该方法根据传入的mysql名称,来实例化出一个Connection对象,重点看下makeConnection()源码:

    protected function makeConnection($name)
    {
        // 从config/database.php中获取'connections.mysql'的配置
        $config = $this->getConfig($name);

        // 如果已经自定义了连接,如在AppServiceProvider的boot()中又使用DatabaseManager::extend()方法自定义了一个'mysql'连接实例,
        // 那就用该实例,这里假设没有自定义
        if (isset($this->extensions[$name])) {
            return call_user_func($this->extensions[$name], $config, $name);
        }

        // $driver = 'mysql'
        $driver = $config['driver'];

        if (isset($this->extensions[$driver])) {
            return call_user_func($this->extensions[$driver], $config, $name);
        }
        
        // 通过ConnectionFactory类工厂模式获取Mysql的连接类    
        return $this->factory->make($config, $name);
    }

实际上最后还是通过\Illuminate\Database\Connectors\ConnectionFactory来解析出对应的connection,这里使用了工厂模式,看下该工厂类的make()方法源码:

    public function make(array $config, $name = null)
    {
        $config = $this->parseConfig($config, $name);

        if (isset($config['read'])) {
            return $this->createReadWriteConnection($config);
        }

        return $this->createSingleConnection($config);
    }
    
    protected function createSingleConnection(array $config)
    {
        // $pdo是个闭包
        $pdo = $this->createPdoResolver($config);

        return $this->createConnection(
            // $config['driver'] = 'mysql', $config['database'] = 'homestead'(数据库名称)
            $config['driver'], $pdo, $config['database'], $config['prefix'], $config
        );
    }
    
    protected function createPdoResolver(array $config)
    {
        return function () use ($config) {
            return $this->createConnector($config)->connect($config);
        };
    }

深入代码发现,最后是通过该工厂类的createConnection()方法来造出的一个Connection对象,createConnection()源码就是常见的傻瓜式的工厂构造函数:

    protected function createConnection($driver, $connection, $database, $prefix = '', array $config = [])
    {
        // 容器中已经绑定了'db.connection.mysql'服务就解析出该服务,这里是没有注册的
        if ($this->container->bound($key = "db.connection.{$driver}")) {
            return $this->container->make($key, [$connection, $database, $prefix, $config]);
        }

        // $driver = 'mysql'
        switch ($driver) {
            case 'mysql':
                return new MySqlConnection($connection, $database, $prefix, $config);
            case 'pgsql':
                return new PostgresConnection($connection, $database, $prefix, $config);
            case 'sqlite':
                return new SQLiteConnection($connection, $database, $prefix, $config);
            case 'sqlsrv':
                return new SqlServerConnection($connection, $database, $prefix, $config);
        }

        throw new InvalidArgumentException("Unsupported driver [$driver]");
    }

总之,通过以上一步步分析就拿到了Connection这个对象了,DatabaseManager中的__call()方法中最后执行的是(new MysqlConnection(*))->table('users')->where('id', 1)->get()

OK, 这里注意下MySqlConnection的构造参数$connection是个闭包,该闭包的值是ConnectionFactory::createPdoResolver()的返回值,看下闭包里的操作:

    protected function createPdoResolver(array $config)
    {
        return function () use ($config) {
            return $this->createConnector($config)->connect($config);
        };
    }
    
    public function createConnector(array $config)
    {
        if (! isset($config['driver'])) {
            throw new InvalidArgumentException('A driver must be specified.');
        }

        if ($this->container->bound($key = "db.connector.{$config['driver']}")) {
            return $this->container->make($key);
        }

        switch ($config['driver']) {
            case 'mysql':
                return new MySqlConnector;
            case 'pgsql':
                return new PostgresConnector;
            case 'sqlite':
                return new SQLiteConnector;
            case 'sqlsrv':
                return new SqlServerConnector;
        }

        throw new InvalidArgumentException("Unsupported driver [{$config['driver']}]");
    }

很简单就能知道该闭包一旦执行时,实际上执行的行为类似于(new MySqlConnector)->connect($config)

这里,就已经得到了链接器实例MySqlConnection了,该connection中还装着一个(new MySqlConnector)->connect($config),下文在其使用时再聊下其具体连接逻辑。

总结:第一步数据库连接实例化已经走完了,已经拿到了连接实例MySqlConnection,下一步将学习下connect()连接器是如何连接数据库的,和如何编译执行SQL语句得到user_id为1的结果值。到时见。

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • Laravel5.2之Filesystem源码解析(上)

    说明:本文主要学习Laravel的Filesystem模块的源码逻辑,把自己的一点点研究心得分享出来,希望对别人有所帮助。总的来说,Filesystem模块的源...

    botkenni
  • Yii2 源码分析 - 入口文件执行流程

    以 yii 2.0.14 高级版的 frontend 为例,从 frontend/web/index.php 开始

    botkenni
  • react中常规删除功能

    // let message = ( <div><p > 商机删除后列表将不可见此商机, 请谨慎操作! </p> </div>);

    botkenni
  • Laravel 5.5 为响应请求提供的可响应接口

    Laravel 5.5 的路由中增加了一种新的返回类型:可相应接口(Responsable)。该接口允许对象在从控制器或者闭包路由中返回时自动被转化为标准的 H...

    小李刀刀
  • 【答疑解惑第三讲】硬件设计应该从那本书入手?

    疑惑一 学习过程中如何避免只听不练? 没必要专门的找练习去做,一般教材的后面都有课后题,做的前提是做这章节在理论都理解的差不多了,就在电脑上用编译器独立的完成,...

    程序员互动联盟
  • Java——this关键字(调用本类属性、调用本类方法、表示当前对象)

    this是一个非常灵活的关键字,不会明确表示一个固定概念,比如int,它就是表示一个整型。

    Winter_world
  • 一波三折:DBA需要头脑冷清思路清晰解决故障以幸存

    杨廷琨(yangtingkun) 云和恩墨 CTO 高级咨询顾问,Oracle ACE总监,ITPUB Oracle数据库管理版版主 这是一则生产环境的真实维护...

    数据和云
  • 如何合理构造一个Uploader工具类(设计到实现)

    本文将带你基于ES6的面向对象,脱离框架使用原生JS,从设计到代码实现一个Uploader基础类,再到实际投入使用。通过本文,你可以了解到一般情况下根据需求是如...

    coder_koala
  • 算法提高 12-1三角形

    问题描述   为二维空间中的点设计一个结构体,在此基础上为三角形设计一个结构体。分别设计独立的函数计算三角形的周长、面积、中心和重心。输入三个点,输出这三个...

    AI那点小事
  • 用大白话告诉你小白都能看懂的Hadoop架构原理

    Hadoop 是目前大数据领域最主流的一套技术体系,包含了多种技术,例如 HDFS(分布式文件系统),YARN(分布式资源调度系统),MapReduce(分布式...

    良月柒

扫码关注云+社区

领取腾讯云代金券