Skip to content

Y
yii2
Commit ff18cff8 by Paul Klimov
Options

Merge pull request #1951 from klimov-paul/mongodb-cache

MongoDB Cache class
parents 54f2b52f 399e7f82
Showing with 339 additions and 0 deletions
extensions/mongodb/Cache.php 0 → 100644
<?php
/**
* @link http://www.yiiframework.com/
* @copyright Copyright (c) 2008 Yii Software LLC
* @license http://www.yiiframework.com/license/
*/
namespace yii\mongodb;
use Yii;
use yii\base\InvalidConfigException;
/**
* Cache implements a cache application component by storing cached data in a MongoDB.
*
* By default, Cache stores session data in a MongoDB collection named 'cache' inside the default database.
* This collection is better to be pre-created with fields 'id' and 'expire' indexed.
* The table name can be changed by setting [[cacheCollection]].
*
* Please refer to [[\yii\caching\Cache]] for common cache operations that are supported by Cache.
*
* The following example shows how you can configure the application to use Cache:
*
* ~~~
* 'cache' => [
* 'class' => 'yii\mongodb\Cache',
* // 'db' => 'mymongodb',
* // 'cacheCollection' => 'my_cache',
* ]
* ~~~
*
* @author Paul Klimov <klimov.paul@gmail.com>
* @since 2.0
*/
class Cache extends \yii\caching\Cache
{
/**
* @var Connection|string the MongoDB connection object or the application component ID of the MongoDB connection.
* After the Cache object is created, if you want to change this property, you should only assign it
* with a MongoDB connection object.
*/
public $db = 'mongodb';
/**
* @var string|array the name of the MongoDB collection that stores the cache data.
* Please refer to [[Connection::getCollection()]] on how to specify this parameter.
* This collection is better to be pre-created with fields 'id' and 'expire' indexed.
*/
public $cacheCollection = 'cache';
/**
* @var integer the probability (parts per million) that garbage collection (GC) should be performed
* when storing a piece of data in the cache. Defaults to 100, meaning 0.01% chance.
* This number should be between 0 and 1000000. A value 0 meaning no GC will be performed at all.
*/
public $gcProbability = 100;
/**
* Initializes the Cache component.
* This method will initialize the [[db]] property to make sure it refers to a valid MongoDB connection.
* @throws InvalidConfigException if [[db]] is invalid.
*/
public function init()
{
parent::init();
if (is_string($this->db)) {
$this->db = Yii::$app->getComponent($this->db);
}
if (!$this->db instanceof Connection) {
throw new InvalidConfigException($this->className() . "::db must be either a MongoDB connection instance or the application component ID of a MongoDB connection.");
}
}
/**
* Retrieves a value from cache with a specified key.
* This method should be implemented by child classes to retrieve the data
* from specific cache storage.
* @param string $key a unique key identifying the cached value
* @return string|boolean the value stored in cache, false if the value is not in the cache or expired.
*/
protected function getValue($key)
{
$query = new Query;
$row = $query->select(['data'])
->from($this->cacheCollection)
->where([
'id' => $key,
'$or' => [
[
'expire' => 0
],
[
'expire' => ['$gt' => time()]
],
],
])
->one($this->db);
if (empty($row)) {
return false;
} else {
return $row['data'];
}
}
/**
* Stores a value identified by a key in cache.
* This method should be implemented by child classes to store the data
* in specific cache storage.
* @param string $key the key identifying the value to be cached
* @param string $value the value to be cached
* @param integer $expire the number of seconds in which the cached value will expire. 0 means never expire.
* @return boolean true if the value is successfully stored into cache, false otherwise
*/
protected function setValue($key, $value, $expire)
{
$result = $this->db->getCollection($this->cacheCollection)
->update(['id' => $key], [
'expire' => $expire > 0 ? $expire + time() : 0,
'data' => $value,
]);
if ($result) {
$this->gc();
return true;
} else {
return $this->addValue($key, $value, $expire);
}
}
/**
* Stores a value identified by a key into cache if the cache does not contain this key.
* This method should be implemented by child classes to store the data
* in specific cache storage.
* @param string $key the key identifying the value to be cached
* @param string $value the value to be cached
* @param integer $expire the number of seconds in which the cached value will expire. 0 means never expire.
* @return boolean true if the value is successfully stored into cache, false otherwise
*/
protected function addValue($key, $value, $expire)
{
$this->gc();
if ($expire > 0) {
$expire += time();
} else {
$expire = 0;
}
try {
$this->db->getCollection($this->cacheCollection)
->insert([
'id' => $key,
'expire' => $expire,
'data' => $value,
]);
return true;
} catch (\Exception $e) {
return false;
}
}
/**
* Deletes a value with the specified key from cache
* This method should be implemented by child classes to delete the data from actual cache storage.
* @param string $key the key of the value to be deleted
* @return boolean if no error happens during deletion
*/
protected function deleteValue($key)
{
$this->db->getCollection($this->cacheCollection)
->remove(['id' => $key]);
return true;
}
/**
* Deletes all values from cache.
* Child classes may implement this method to realize the flush operation.
* @return boolean whether the flush operation was successful.
*/
protected function flushValues()
{
$this->db->getCollection($this->cacheCollection)
->remove();
return true;
}
/**
* Removes the expired data values.
* @param boolean $force whether to enforce the garbage collection regardless of [[gcProbability]].
* Defaults to false, meaning the actual deletion happens with the probability as specified by [[gcProbability]].
*/
public function gc($force = false)
{
if ($force || mt_rand(0, 1000000) < $this->gcProbability) {
$this->db->getCollection($this->cacheCollection)
->remove([
'expire' => [
'$gt' => 0,
'$lt' => time(),
]
]);
}
}
}
\ No newline at end of file
tests/unit/extensions/mongodb/CacheTest.php 0 → 100644
<?php
namespace yiiunit\extensions\mongodb;
use Yii;
use yii\mongodb\Cache;
class CacheTest extends MongoDbTestCase
{
/**
* @var string test cache collection name.
*/
protected static $cacheCollection = '_test_cache';
protected function tearDown()
{
$this->dropCollection(static::$cacheCollection);
parent::tearDown();
}
/**
* Creates test cache instance.
* @return Cache cache instance.
*/
protected function createCache()
{
return Yii::createObject([
'class' => Cache::className(),
'db' => $this->getConnection(),
'cacheCollection' => static::$cacheCollection,
'gcProbability' => 0,
]);
}
// Tests:
public function testSet()
{
$cache = $this->createCache();
$key = 'test_key';
$value = 'test_value';
$this->assertTrue($cache->set($key, $value), 'Unable to set value!');
$this->assertEquals($value, $cache->get($key), 'Unable to set value correctly!');
$newValue = 'test_new_value';
$this->assertTrue($cache->set($key, $newValue), 'Unable to update value!');
$this->assertEquals($newValue, $cache->get($key), 'Unable to update value correctly!');
}
public function testAdd()
{
$cache = $this->createCache();
$key = 'test_key';
$value = 'test_value';
$this->assertTrue($cache->add($key, $value), 'Unable to add value!');
$this->assertEquals($value, $cache->get($key), 'Unable to add value correctly!');
$newValue = 'test_new_value';
$this->assertTrue($cache->add($key, $newValue), 'Unable to re-add value!');
$this->assertEquals($value, $cache->get($key), 'Original value is lost!');
}
/**
* @depends testSet
*/
public function testDelete()
{
$cache = $this->createCache();
$key = 'test_key';
$value = 'test_value';
$cache->set($key, $value);
$this->assertTrue($cache->delete($key), 'Unable to delete key!');
$this->assertEquals(false, $cache->get($key), 'Value is not deleted!');
}
/**
* @depends testSet
*/
public function testFlush()
{
$cache = $this->createCache();
$cache->set('key1', 'value1');
$cache->set('key2', 'value2');
$this->assertTrue($cache->flush(), 'Unable to flush cache!');
$collection = $cache->db->getCollection($cache->cacheCollection);
$rows = $this->findAll($collection);
$this->assertCount(0, $rows, 'Unable to flush records!');
}
/**
* @depends testSet
*/
public function testGc()
{
$cache = $this->createCache();
$cache->set('key1', 'value1');
$cache->set('key2', 'value2');
$collection = $cache->db->getCollection($cache->cacheCollection);
list($row) = $this->findAll($collection);
$collection->update(['_id' => $row['_id']], ['expire' => time() - 10]);
$cache->gc(true);
$rows = $this->findAll($collection);
$this->assertCount(1, $rows, 'Unable to collect garbage!');
}
/**
* @depends testSet
*/
public function testGetExpired()
{
$cache = $this->createCache();
$key = 'test_key';
$value = 'test_value';
$cache->set($key, $value);
$collection = $cache->db->getCollection($cache->cacheCollection);
list($row) = $this->findAll($collection);
$collection->update(['_id' => $row['_id']], ['expire' => time() - 10]);
$this->assertEquals(false, $cache->get($key), 'Expired key value returned!');
}
}
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment