CakePHP 3多站点动态缓存组隔离实现技术问询

Absolutely, extending CakePHP's cache engine is exactly the right solution for your dynamic multi-site scenario—you don't need to pre-configure dozens of cache instances for every possible site. Here's how to implement this cleanly:

1. 创建自定义缓存引擎 #

First, create a custom cache engine that extends the base engine you're currently using (e.g., File, Redis, Apcu). The core idea is to prefix all cache keys and group identifiers with your current site's unique ID, ensuring isolation between sites.

Create src/Cache/Engine/SiteAwareCacheEngine.php:

<?php
namespace App\Cache\Engine;

use Cake\Cache\Engine\FileEngine; // 替换成你正在用的引擎，比如RedisEngine
use Cake\Core\Configure;

class SiteAwareCacheEngine extends FileEngine
{
    /**
     * 获取当前站点的唯一标识
     * 这里假设你有一个方法能获取当前请求对应的站点ID/标识符
     * 比如从Request对象、Session或者配置中读取
     */
    protected function _getSiteId()
    {
        // 示例：从请求属性中获取站点ID（根据你的实际实现调整）
        $request = \Cake\Routing\Router::getRequest();
        return $request->getAttribute('site_id') ?? 'default';
    }

    /**
     * 重写_key方法，添加站点前缀
     */
    protected function _key($key)
    {
        $siteId = $this->_getSiteId();
        return parent::_key($siteId . '_' . $key);
    }

    /**
     * 重写clearGroup方法，确保只清除当前站点的组缓存
     */
    public function clearGroup($group)
    {
        $siteId = $this->_getSiteId();
        $group = $siteId . '_' . $group;
        return parent::clearGroup($group);
    }

    /**
     * 可选：重写clear方法，支持按站点清除所有缓存
     */
    public function clear($check)
    {
        // 如果需要单独清除当前站点的所有缓存，可以在这里处理
        // 否则调用父类方法会清除整个缓存池（如果不需要的话可以调整）
        return parent::clear($check);
    }
}

2. 配置使用自定义引擎 #

Update your config/app.php (or environment-specific config) to use this custom engine for your cache configurations. For example, if you have a products cache group:

'Cache' => [
    'default' => [
        'className' => 'App\Cache\Engine\SiteAwareCacheEngine',
        'path' => CACHE,
        'url' => env('CACHE_DEFAULT_URL', null),
    ],
    'products' => [
        'className' => 'App\Cache\Engine\SiteAwareCacheEngine',
        'path' => CACHE . 'products' . DS,
        'groups' => ['products'],
        'url' => env('CACHE_PRODUCTS_URL', null),
    ],
],

3. 确保站点标识的正确传递 #

You'll need to make sure your application correctly sets the site identifier on every request. For example, if you're routing based on subdomains or a site parameter, you can add a middleware to inject the site ID into the request attributes:

Create src/Middleware/SiteDetectionMiddleware.php:

<?php
namespace App\Middleware;

use Cake\Http\MiddlewareInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\RequestHandlerInterface;

class SiteDetectionMiddleware implements MiddlewareInterface
{
    public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
    {
        // 根据你的逻辑检测当前站点ID，比如从子域名、路由参数等
        $siteId = $this->_detectSiteFromRequest($request);
        
        // 将站点ID注入请求属性
        $request = $request->withAttribute('site_id', $siteId);
        
        return $handler->handle($request);
    }

    protected function _detectSiteFromRequest(ServerRequestInterface $request)
    {
        // 示例：从子域名获取站点ID
        $host = $request->getUri()->getHost();
        $parts = explode('.', $host);
        if (count($parts) >= 2) {
            return $parts[0];
        }
        
        return 'default';
    }
}

Then register this middleware in src/Application.php:

public function middleware(MiddlewareQueue $middlewareQueue): MiddlewareQueue
{
    $middlewareQueue
        // ...其他中间件
        ->add(new \App\Middleware\SiteDetectionMiddleware());
    
    return $middlewareQueue;
}

4. 使用缓存的方式不变 #

You can continue using CakePHP's cache functions exactly as before—your custom engine will automatically handle the site prefixing behind the scenes:

// 写入站点专属的products缓存
Cache::write('product_123', $productData, 'products');

// 清除当前站点的products缓存组
Cache::clearGroup('products', 'products');

关键注意事项 #

• Engine Compatibility: If you're using a different base engine (like Redis), make sure your custom engine extends that instead of FileEngine. Most core cache engines use the same method signatures for _key() and clearGroup(), so this approach should work universally.
• Site Context Consistency: Ensure the site ID is available in all contexts where cache is used—including CLI commands (if you run cron jobs that interact with cache). For CLI, you might need to pass the site ID as a parameter or read it from a configuration.
• Cache Cleanup: If sites are deleted, you'll want a way to clean up their cached data. You can add a console command that deletes all keys prefixed with the deleted site's ID.

内容的提问来源于stack exchange，提问作者mbryja