Laravel 的緩存源碼解析

SwordFly 發(fā)布于2019-07-01 12:46 / 1541人閱讀

摘要：年月日前言支持多種緩存系統(tǒng)并提供了統(tǒng)一的接口默認支持的存儲驅(qū)動包括如下默認使用數(shù)組測試用關(guān)系型數(shù)據(jù)庫默認的緩存配置文件在參考鏈接使用直接使用為我們提供的支持的大部分方法其他使用方法請參照官方翻譯中文文檔源碼中常用

Last-Modified: 2019年5月10日14:17:34

前言

Laravel 支持多種緩存系統(tǒng), 并提供了統(tǒng)一的api接口.

(Laravel 5.5)默認支持的存儲驅(qū)動包括如下:

file (默認使用)

apc

array (數(shù)組, 測試用)

database (關(guān)系型數(shù)據(jù)庫)

memcached

redis

默認的緩存配置文件在 config/cache.php

參考鏈接:

https://learnku.com/docs/lara...

https://www.jianshu.com/p/46a...

使用

直接使用Laravel為我們提供的Facade

use IlluminateSupportFacadesCache;
$cache = Cache::get("key");

支持的大部分方法:

Cache::put("key", "value", $minutes);
Cache::add("key", "value", $minutes);
Cache::forever("key", "value");
Cache::remember("key", $minutes, function(){ return "value" });
Cache::rememberForever("key", function(){ return "value" });
Cache::forget("key");
Cache::has("key");
Cache::get("key");
Cache::get("key", "default");
Cache::get("key", function(){ return "default"; });
Cache::tags("my-tag")->put("key","value", $minutes);
Cache::tags("my-tag")->has("key");
Cache::tags("my-tag")->get("key");
Cache::tags("my-tag")->forget("key");
Cache::tags("my-tag")->flush();
Cache::increment("key");
Cache::increment("key", $amount);
Cache::decrement("key");
Cache::decrement("key", $amount);
Cache::tags("group")->put("key", $value);
Cache::tags("group")->get("key");
Cache::tags("group")->flush();

其他使用方法請參照官方翻譯(中文)文檔: https://learnku.com/docs/lara...

源碼

Laravel 中常用 Cache Facade 來操作緩存, 對應的實際類是 IlluminateCacheCacheManager 緩存管理類(工廠).

Cache::xxx()

我們通過 CacheManager 類獲取持有不同存儲驅(qū)動的 IlluminateCacheRepository 類

CacheManager::store($name = null)

Repository 倉庫類代理了實現(xiàn)存儲驅(qū)動接口 IlluminateContractsCacheStore 的類實例.

Cache Facade

首先從 Cache Facade 開始分析, 先看一下其源碼:


在配置文件 configapp.php 中定義了 Cache 服務提供者
//...
"providers" => [
        // ......
        IlluminateCacheCacheServiceProvider::class,
        // ......
    ],
//...
IlluminateCacheCacheServiceProvider 源文件:
app->singleton("cache", function ($app) {
            return new CacheManager($app);
        });

        $this->app->singleton("cache.store", function ($app) {
            return $app["cache"]->driver();
        });

        $this->app->singleton("memcached.connector", function () {
            return new MemcachedConnector;
        });
    }
    
    // ......
}
通過上面源碼可知, Cache Facade 關(guān)聯(lián)的項是 IlluminateCacheCacheManager, 也就是我們通過 Cache Facade 實際調(diào)用的是 CacheManager實例的方法.
CacheManager

CacheManager 實現(xiàn)了 IlluminateContractsCacheFactory 接口(↑), 即實現(xiàn)了一個簡單工廠, 傳入存儲驅(qū)動名, 返回對應的驅(qū)動實例.
CacheManager實現(xiàn)的簡單工廠接口方法:
getDefaultDriver();

        return $this->stores[$name] = $this->get($name);
    }
    
    /**
     * Get the default cache driver name.
     *
     * @return string
     */
    public function getDefaultDriver()
    {
        return $this->app["config"]["cache.default"];
    }

    /**
     * Attempt to get the store from the local cache.
     *
     * @param  string  $name
     * @return IlluminateContractsCacheRepository
     */
    protected function get($name)
    {
        return $this->stores[$name] ?? $this->resolve($name);
    }

    /**
     * Resolve the given store.
     *
     * @param  string  $name
     * @return IlluminateContractsCacheRepository
     *
     * @throws InvalidArgumentException
     */
    protected function resolve($name)
    {
        $config = $this->getConfig($name);

        if (is_null($config)) {
            throw new InvalidArgumentException("Cache store [{$name}] is not defined.");
        }

        if (isset($this->customCreators[$config["driver"]])) {
            return $this->callCustomCreator($config);
        } else {
            $driverMethod = "create".ucfirst($config["driver"])."Driver";

            if (method_exists($this, $driverMethod)) {
                return $this->{$driverMethod}($config);
            } else {
                throw new InvalidArgumentException("Driver [{$config["driver"]}] is not supported.");
            }
        }
    }
    
    /**
     * Dynamically call the default driver instance.
     *
     * @param  string  $method
     * @param  array   $parameters
     * @return mixed
     */
    public function __call($method, $parameters)
    {
        return $this->store()->$method(...$parameters);
    }
}
可以看到 CacheManager 提供了會話級別的實例緩存, 當解析驅(qū)動名時, 它會按如下順序解析:

自定義驅(qū)動: 查看是否有通過 CacheManager::extend(...)自定義的驅(qū)動
Laravel提供的驅(qū)動: 查看是否存在 CacheManager::createXxxDriver(...)方法

這些方法返回的實例必須是實現(xiàn)了 IlluminateContractsCacheRepository 接口
本質(zhì)上, CacheManager  就是一個提供了會話級別緩存的 Repository 實例工廠, 同時它提供了一個 __call 魔術(shù)方法, 以便快速調(diào)用默認緩存驅(qū)動.
$value = Cache::store("file")->get("foo");

// 通過 _call, 調(diào)用默認緩存驅(qū)動的 get 方法
$value = Cache::get("key");
Repository
IlluminateContractsCacheRepository 接口

Repository 是一個符合 PSR-16: Common Interface for Caching Libraries 規(guī)范的緩存?zhèn)}庫類, 其在Laravel相應的實現(xiàn)類: IlluminateCacheRepository
IlluminateCacheRepository 部分代碼如下:
store = $store;
    }

    public function has($key)
    {
        return ! is_null($this->get($key));
    }

    public function get($key, $default = null)
    {
        if (is_array($key)) {
            return $this->many($key);
        }

        $value = $this->store->get($this->itemKey($key));

        // If we could not find the cache value, we will fire the missed event and get
        // the default value for this cache value. This default could be a callback
        // so we will execute the value function which will resolve it if needed.
        if (is_null($value)) {
            $this->event(new CacheMissed($key));

            $value = value($default);
        } else {
            $this->event(new CacheHit($key, $value));
        }

        return $value;
    }

    public function pull($key, $default = null)
    {
        return tap($this->get($key, $default), function ($value) use ($key) {
            $this->forget($key);
        });
    }
    
    protected function event($event)
    {
        if (isset($this->events)) {
            $this->events->dispatch($event);
        }
    }

    /**
     * Set the event dispatcher instance.
     *
     * @param  IlluminateContractsEventsDispatcher  $events
     * @return void
     */
    public function setEventDispatcher(Dispatcher $events)
    {
        $this->events = $events;
    }

    public function __call($method, $parameters)
    {
        if (static::hasMacro($method)) {
            return $this->macroCall($method, $parameters);
        }

        return $this->store->$method(...$parameters);
    }
    
    public function __clone()
    {
        $this->store = clone $this->store;
    }
}

從源碼可以看出, IlluminateCacheRepository 實現(xiàn)了代理模式, 具體的實現(xiàn)是交由 IlluminateContractsCacheStore 來處理, Repository 主要作用是

提供一些便捷操作(可以理解為語法糖)
Event 事件觸發(fā), 包括緩存命中/未命中、寫入/刪除鍵值

Store
IlluminateContractsCache 緩存驅(qū)動是實際處理緩存如何寫入/讀取/刪除的類, 接口內(nèi)容如下:

具體的實現(xiàn)類有:

ApcStore
ArrayStore
NullStore
DatabaseStore
FileStore
MemcachedStore
RedisStore