PHP容器--Pimple運行流程淺析

時間 2019-11-19

標籤 php 容器 pimple 運行流程淺析欄目 PHP 简体版

原文原文鏈接

須要具有的知識點

閉包

閉包和匿名函數在PHP5.3.0中引入的。php

閉包是指：建立時封裝周圍狀態的函數。即便閉包所處的環境不存在了，閉包中封裝的狀態依然存在。laravel

理論上，閉包和匿名函數是不一樣的概念。可是PHP將其視做相同概念。
實際上，閉包和匿名函數是假裝成函數的對象。他們是Closure類的實例。git

閉包和字符串、整數同樣，是一等值類型。github

建立閉包：設計模式

<?php
$closure = function ($name) {
    return 'Hello ' . $name;
};
echo $closure('nesfo');//Hello nesfo
var_dump(method_exists($closure, '__invoke'));//true

咱們之因此能調用$closure變量，是由於這個變量的值是一個閉包，並且閉包對象實現了__invoke()魔術方法。只要變量名後有(),PHP就會查找並調用__invoke()方法。數組

一般會把PHP閉包看成函數的回調使用。數據結構

array_map(), preg_replace_callback()方法都會用到回調函數，這是使用閉包的最佳時機！閉包

舉個例子：app

<?php
$numbersPlusOne = array_map(function ($number) {
    return $number + 1;
}, [1, 2, 3]);
print_r($numbersPlusOne);

獲得結果：ide

[2, 3, 4]

在閉包出現以前，只能單首創建具名函數，而後使用名稱引用那個函數。這麼作，代碼執行會稍微慢點，並且把回調的實現和使用場景隔離了。

<?php
function incrementNum ($number) {
    return $number + 1;
}

$numbersPlusOne = array_map('incrementNum', [1, 2, 3]);
print_r($numbersPlusOne);

SPL

ArrayAccess

實現ArrayAccess接口，可使得object像array那樣操做。ArrayAccess接口包含四個必須實現的方法：

interface ArrayAccess {
    //檢查一個偏移位置是否存在 
    public mixed offsetExists ( mixed $offset  );
    
    //獲取一個偏移位置的值 
    public mixed offsetGet( mixed $offset  );
    
    //設置一個偏移位置的值 
    public mixed offsetSet ( mixed $offset  );
    
    //復位一個偏移位置的值 
    public mixed offsetUnset  ( mixed $offset  );
}

SplObjectStorage

SplObjectStorage類實現了以對象爲鍵的映射（map）或對象的集合（若是忽略做爲鍵的對象所對應的數據）這種數據結構。這個類的實例很像一個數組，可是它所存放的對象都是惟一。該類的另外一個特色是，能夠直接從中刪除指定的對象，而不須要遍歷或搜索整個集合。

`::class`語法

由於 ::class 表示是字符串。用 ::class 的好處在於 IDE 裏面能夠直接更名一個 class，而後 IDE 自動處理相關引用。
同時，PHP 執行相關代碼時，是不會先加載相關 class 的。

同理，代碼自動化檢查 inspect 也能夠正確識別 class。

Pimple容器流程淺析

Pimpl是php社區中比較流行的容器。代碼不是不少，詳見https://github.com/silexphp/Pimple/blob/master/src/Pimple/Container.php 。

咱們的應用能夠基於Pimple開發：

namespace EasyWeChat\Foundation;

use Pimple\Container;

class Application extends Container
{
    /**
     * Service Providers.
     *
     * @var array
     */
    protected $providers = [
        ServiceProviders\ServerServiceProvider::class,
        ServiceProviders\UserServiceProvider::class
    ];

    /**
     * Application constructor.
     *
     * @param array $config
     */
    public function __construct($config)
    {
        parent::__construct();

        $this['config'] = function () use ($config) {
            return new Config($config);
        };

        if ($this['config']['debug']) {
            error_reporting(E_ALL);
        }

        $this->registerProviders();
    }

    /**
     * Add a provider.
     *
     * @param string $provider
     *
     * @return Application
     */
    public function addProvider($provider)
    {
        array_push($this->providers, $provider);

        return $this;
    }

    /**
     * Set providers.
     *
     * @param array $providers
     */
    public function setProviders(array $providers)
    {
        $this->providers = [];

        foreach ($providers as $provider) {
            $this->addProvider($provider);
        }
    }

    /**
     * Return all providers.
     *
     * @return array
     */
    public function getProviders()
    {
        return $this->providers;
    }

    /**
     * Magic get access.
     *
     * @param string $id
     *
     * @return mixed
     */
    public function __get($id)
    {
        return $this->offsetGet($id);
    }

    /**
     * Magic set access.
     *
     * @param string $id
     * @param mixed  $value
     */
    public function __set($id, $value)
    {
        $this->offsetSet($id, $value);
    }
}

如何使用咱們的應用：

$app = new Application([]);
$user = $app->user;

以後咱們就可使用$user對象的方法了。咱們發現其實並無$this->user這個屬性，可是能夠直接使用。主要是這兩個方法起的做用：

public function offsetSet($id, $value){}
public function offsetGet($id){}

下面咱們將解釋在執行這兩句代碼，Pimple作了什麼。但在解釋這個以前，咱們先看看容器的一些核心概念。

服務提供者

服務提供者是鏈接容器與具體功能實現類的橋樑。服務提供者須要實現接口ServiceProviderInterface:

namespace Pimple;

/**
 * Pimple service provider interface.
 *
 * @author  Fabien Potencier
 * @author  Dominik Zogg
 */
interface ServiceProviderInterface
{
    /**
     * Registers services on the given container.
     *
     * This method should only be used to configure services and parameters.
     * It should not get services.
     *
     * @param Container $pimple A container instance
     */
    public function register(Container $pimple);
}

全部服務提供者必須實現接口register方法。

咱們的應用裏默認有2個服務提供者：

protected $providers = [
    ServiceProviders\ServerServiceProvider::class,
    ServiceProviders\UserServiceProvider::class
];

以UserServiceProvider爲例，咱們看其代碼實現：

namespace EasyWeChat\Foundation\ServiceProviders;

use EasyWeChat\User\User;
use Pimple\Container;
use Pimple\ServiceProviderInterface;

/**
 * Class UserServiceProvider.
 */
class UserServiceProvider implements ServiceProviderInterface
{
    /**
     * Registers services on the given container.
     *
     * This method should only be used to configure services and parameters.
     * It should not get services.
     *
     * @param Container $pimple A container instance
     */
    public function register(Container $pimple)
    {
        $pimple['user'] = function ($pimple) {
            return new User($pimple['access_token']);
        };
    }
}

咱們看到，該服務提供者的註冊方法會給容器增長屬性user，可是返回的不是對象，而是一個閉包。這個後面我再作講解。

服務註冊

咱們在Application裏構造函數裏使用$this->registerProviders();對全部服務提供者進行了註冊：

private function registerProviders()
{
    foreach ($this->providers as $provider) {
        $this->register(new $provider());
    }
}

仔細看，咱們發現這裏實例化了服務提供者，並調用了容器Pimple的register方法：

public function register(ServiceProviderInterface $provider, array $values = array())
{
    $provider->register($this);

    foreach ($values as $key => $value) {
        $this[$key] = $value;
    }

    return $this;
}

而這裏調用了服務提供者的register方法，也就是咱們在上一節中提到的：註冊方法給容器增長了屬性user，但返回的不是對象，而是一個閉包。

當咱們給容器Pimple添加屬性user的同時，會調用offsetSet($id, $value)方法：給容器Pimple的屬性values、keys分別賦值：

$this->values[$id] = $value;
$this->keys[$id] = true;

到這裏，咱們尚未實例化真正提供實際功能的類EasyWeChat\User\Usr。但已經完成了服務提供者的註冊工做。

當咱們運行到這裏：

$user = $app->user;

會調用offsetGet($id)並進行實例化真正的類：

$raw = $this->values[$id];
$val = $this->values[$id] = $raw($this);
$this->raw[$id] = $raw;

$this->frozen[$id] = true;

return $val;

$raw獲取的是閉包：

$pimple['user'] = function ($pimple) {
    return new User($pimple['access_token']);
};

$raw($this)返回的是實例化的對象User。也就是說只有實際調用纔會去實例化具體的類。後面咱們就能夠經過$this['user']或者$this->user調用User類裏的方法了。

固然，Pimple裏還有不少特性值得咱們去深刻研究，這裏不作過多講解。

參考

一、PHP: 數組式訪問 - Manual http://php.net/manual/zh/class.arrayaccess.php 二、利用 SPL 快速實現 Observer 設計模式 https://www.ibm.com/developerworks/cn/opensource/os-cn-observerspl/ 三、Pimple - A simple PHP Dependency Injection Container https://pimple.sensiolabs.org/ 四、Laravel源碼裏面爲何要用::class語法？ - 知乎 https://www.zhihu.com/question/52656676?from=profile_question_card 五、Laravel 學習筆記 —— 神奇的服務容器 | Laravel China 社區 - 高品質的 Laravel 和 PHP 開發者社區 - Powered by PHPHub https://laravel-china.org/topics/789/laravel-learning-notes-the-magic-of-the-service-container 六、Pimple/README_zh.rst at master · 52fhy/Pimple https://github.com/52fhy/Pimple/blob/master/README_zh.rst