如何从零构建无数据库的Symfony自定义Repository？

1. 核心实现思路 #

完全可以复刻Doctrine的Repository/Entity模式，不需要依赖数据库或Doctrine ORM：

• 实体类：就是普通PHP类，仅封装业务对象的属性和核心逻辑（比如目录实体、邮件实体），不需要继承任何框架类，只需要保证属性封装和必要的getter/setter。
• 仓库类：作为数据访问层，封装对文件系统、邮箱、XML等存储介质的CRUD操作，所有实体的读取、创建、更新、删除逻辑都集中在这里，和Doctrine Repository的职责完全一致。

2. 必须将仓库注册为Symfony服务 #

肯定需要注册，原因有三个：

• 利用Symfony的依赖注入（DI）：可以在控制器、其他服务中直接通过类型提示注入仓库，不用手动new，避免硬编码依赖。
• 统一管理配置：比如文件系统根目录、邮箱账号这类配置，可以通过参数注入到仓库，方便不同环境切换。
• 复用容器特性：Symfony会自动管理仓库的实例（默认单例），还能利用容器的标签、编译优化等功能。

3. 仓库的注册与实现步骤 #

步骤1：编写实体类 #

以文件系统目录实体为例：

// src/Entity/DirectoryEntity.php
namespace App\Entity;

class DirectoryEntity
{
    private string $name;
    private string $fullPath;
    private \DateTimeInterface $createdAt;

    public function __construct(string $name, string $fullPath, \DateTimeInterface $createdAt)
    {
        $this->name = $name;
        $this->fullPath = $fullPath;
        $this->createdAt = $createdAt;
    }

    // 仅暴露必要的 getter 方法
    public function getName(): string { return $this->name; }
    public function getFullPath(): string { return $this->fullPath; }
    public function getCreatedAt(): \DateTimeInterface { return $this->createdAt; }
}

步骤2：编写仓库类 #

封装文件系统的目录操作，通过DI注入依赖（比如Symfony的Filesystem组件）：

// src/Repository/DirectoryRepository.php
namespace App\Repository;

use App\Entity\DirectoryEntity;
use Symfony\Component\Filesystem\Filesystem;

class DirectoryRepository
{
    private string $rootStorageDir;
    private Filesystem $filesystem;

    // 通过DI注入存储根目录和Filesystem服务
    public function __construct(string $rootStorageDir, Filesystem $filesystem)
    {
        $this->rootStorageDir = $rootStorageDir;
        $this->filesystem = $filesystem;
    }

    // 获取所有子目录实体
    public function findAll(): array
    {
        if (!is_dir($this->rootStorageDir)) {
            return [];
        }

        $entities = [];
        foreach (scandir($this->rootStorageDir) as $dirName) {
            if ($dirName === '.' || $dirName === '..') continue;
            $fullPath = $this->rootStorageDir . '/' . $dirName;
            if (is_dir($fullPath)) {
                $createdAt = (new \DateTime())->setTimestamp(filectime($fullPath));
                $entities[] = new DirectoryEntity($dirName, $fullPath, $createdAt);
            }
        }
        return $entities;
    }

    // 根据名称查找单个目录实体
    public function find(string $dirName): ?DirectoryEntity
    {
        $fullPath = $this->rootStorageDir . '/' . $dirName;
        if (!is_dir($fullPath)) {
            return null;
        }
        $createdAt = (new \DateTime())->setTimestamp(filectime($fullPath));
        return new DirectoryEntity($dirName, $fullPath, $createdAt);
    }

    // 创建新目录实体（同步创建物理目录）
    public function create(string $dirName): DirectoryEntity
    {
        $fullPath = $this->rootStorageDir . '/' . $dirName;
        $this->filesystem->mkdir($fullPath);
        return new DirectoryEntity($dirName, $fullPath, new \DateTime());
    }
}

步骤3：注册仓库服务 #

Symfony 4+默认开启自动配置，只要仓库类放在src/Repository目录下，会自动注册为服务（服务ID为类的全限定名）。如果需要注入自定义参数，可手动在config/services.yaml中配置：

# config/services.yaml
services:
    App\Repository\DirectoryRepository:
        arguments:
            $rootStorageDir: '%kernel.project_dir%/var/storage/directories'
        autowire: true
        autoconfigure: true

步骤4：在控制器中使用 #

通过类型提示直接注入仓库：

// src/Controller/DirectoryController.php
namespace App\Controller;

use App\Repository\DirectoryRepository;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\Response;

class DirectoryController extends AbstractController
{
    public function list(DirectoryRepository $repo): Response
    {
        $directories = $repo->findAll();
        return $this->render('directory/list.html.twig', [
            'directories' => $directories
        ]);
    }
}

4. 是否需要继承/实现框架类或接口？ #

不需要强制继承，但推荐实现自定义通用接口：

• 自定义一个RepositoryInterface，定义通用的CRUD方法（findAll、find、create等），让所有仓库类实现它。这样后续替换存储介质（比如从文件系统换成XML）时，只需要替换仓库实现类，上层代码无需修改。
• 不需要继承Symfony或Doctrine的类，除非你想兼容Doctrine的仓库接口（比如Doctrine\Persistence\ObjectRepository），但完全没必要，自定义接口更灵活。

示例通用接口：

// src/Repository/RepositoryInterface.php
namespace App\Repository;

interface RepositoryInterface
{
    public function findAll(): array;
    public function find(string $id): ?object;
    public function create(object $entity): object;
    public function update(object $entity): object;
    public function delete(object $entity): void;
}

5. 其他场景扩展示例（XML存储） #

如果是XML文件存储实体，仓库类可复用Symfony的Serializer组件：

// src/Repository/XmlEntityRepository.php
namespace App\Repository;

use App\Entity\XmlEntity;
use Symfony\Component\Serializer\SerializerInterface;

class XmlEntityRepository implements RepositoryInterface
{
    private string $xmlFilePath;
    private SerializerInterface $serializer;

    public function __construct(string $xmlFilePath, SerializerInterface $serializer)
    {
        $this->xmlFilePath = $xmlFilePath;
        $this->serializer = $serializer;
    }

    public function findAll(): array
    {
        if (!file_exists($this->xmlFilePath)) {
            return [];
        }
        $xmlContent = file_get_contents($this->xmlFilePath);
        return $this->serializer->deserialize($xmlContent, XmlEntity::class . '[]', 'xml');
    }

    // 其他CRUD方法省略...
}

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