hi-man/localcache

provides a cache with local and remote cache

v0.0.9 2020-11-28 01:44 UTC

Requires

• php: >=7.0.0
• ext-redis: >=4.0.0
• ext-yac: >=2.0.0
• psr/simple-cache: ^1.0

Requires (Dev)

• phpunit/phpunit: ^7.5

MIT

• Tinggong

README

now, let's back to our classroom, professor is talking about the architecture of cpu, just like the software your are creating，Redis is the L2 cache, and Yac is the L1 cache for your software, and LocalCache is the cache manager of Redis and Yac.

so, if your redis server is busying, and your data does not change frequently, LocalCache is the right man you are finding.

If I have seen further, it is by standing on the shoulders of giants.

thanks to phpredis and yac

• Feature
• Usage
• Requirement
• Install
• testing
• Classes
  • CachePoolService
    • initCacheInstance
    • getCacheInstance
    • setCacheValue
    • getCacheValue
    • deleteByKey
  • CacheService
    • getConfigByConnection
    • logException
    • setCacheValue
    • getCacheValue
    • deleteByKey
  • LocalCache
    • Construct
    • select
    • get
    • set
    • delete / unlink
    • expire
    • clear
    • hDel / hGetAll / hMSet / hMGet / hSet / hGet
    • setLocalCacheTimeout
    • getLocalCacheTimeout

Feature

• a redis client with retry mechanism
• reduce redis requests by caching data in memory
• support redis connection pool
• more graceful exception handler
• disable cache on demands

Usage

1. extend class CacheService (recommend)
2. use static funcitons in CachePoolService
3. use LocalCache class directly

Requirement

• PHP 7.0+
• phpredis
• yac

Install

composer require 'hi-man/localcache'

testing

composer test

Classes

CachePoolService

pool of LocalCache, can be called statically

initCacheInstance

initialize LocalCache

getCacheInstance

get instance of LocalCache by connection name

setCacheValue

set cache value

getCacheValue

get cache value

deleteByKey

delete from cache by key

CacheService

abstract class to use CachePoolService more productive

getConfigByConnection

MUST implemented get redis configuration by connection identifier

logException

MUST implemented exception handler

setCacheValue

wrapper of CachePoolService::setCacheValue

getCacheValue

wrapper of CachePoolService::getCacheValue

deleteByKey

wrapper of CachePoolService::deleteByKey

LocalCache

provide a local cache between application and redis server

Construct

$lc = new LocalCache(
  '127.0.01' /* redis host */,
  'Yac prefix' /* yac prefix, empty prefix will disable yac, default value is empty, max length is 20 */,
  6379 /* redis port, default value is 6379 */,
  3 /* redis connection timeout, in seconds, default value is 3 */,
  500000 /* redis retry interval, in microseconds, default value is 500000 */,
  3 /* redis read timeout, default value is 3 */,
  3 /* max retry, default value is 3 */,
  0 /* redis reserved, default value is 0 */
);

select

the same as redis command select, but not really issue a command request.

$lc->select(0 /* redis database index */);

get

the same as redis command get, use yac cache value first, then issue a command request if cache is missing.

$lc->get(
  'key' /* redis item key */,
  'default value' /* default value if the key does not exists */
);

set

the same as redis command set, reset yac cache value

$lc->set(
    'key',      /* redis item key */
    'value',    /* value to store */
    3           /* ttl */
    'default value' /* default value if the key does not exists */
);

delete / unlink

the same as redis command delete or unlink, also delete yac cache

$lc->delete(
    'key',      /* redis item key */
);

$lc->unlink(
    'key',      /* redis item key */
);

expire

the same as redis command expire, also reset yac cache expire time

$lc->expire('key' /* redis item key */, 3 /* expire time in seconds */);

clear

the same as redis command flushdb, but flush all yac cache

$lc->clear();

hDel / hGetAll / hMSet / hMGet / hSet / hGet

the same as redis command

setLocalCacheTimeout

set yac cache timeout, set the right value for your scenario. cache invalidation is a big concept to deal with.

$lc->setLocalCacheTimeout(
    'key',      /* redis item key */
    'value',    /* value to store */
    3           /* ttl */
    'default value' /* default value if the key does not exists */
);

getLocalCacheTimeout

get yac cache timeout

$lc->getLocalCacheTimeout();