Symfony Doctrineでソフトデリートを実装する方法を完全ガイド！初心者でもわかる削除の仕組み

1. ソフトデリートとは？初心者にも分かりやすいイメージで解説

1. ソフトデリートとは？初心者にも分かりやすいイメージで解説

SymfonyのDoctrine ORMで扱う削除には、大きく2つの方法があります。ひとつは「完全削除」で、データベースから記録そのものを消してしまう方法です。もうひとつが「ソフトデリート」で、削除されたように見せかけながら、本当はデータを残しておく方法です。これはまるで机の引き出しにしまっただけで、他の人からは見えない状態にしておくイメージです。

ソフトデリートを使うと、ユーザーがうっかり削除してしまったデータを後から復元できるメリットがあります。また、削除履歴として残したいときにも便利で、安全性や信頼性を高めたいアプリケーションでよく使われます。SymfonyとDoctrineでは、削除済みかどうかを判定する「削除日」のカラムを用意し、その値が入っている場合は非表示にします。

2. Doctrineでソフトデリートを実装する基本の考え方

2. Doctrineでソフトデリートを実装する基本の考え方

Doctrineでは、ソフトデリートを実現するために「deletedAt」という日付のプロパティをエンティティに追加します。削除操作を行うと、このdeletedAtに日付が入る仕組みにしておきます。初心者の方には「削除された日時をメモしておく」と考えると分かりやすいです。削除されたものは、通常の検索では表示しないようにしておきます。

重要なのは、削除済みかどうかの判断をSQLではなくエンティティの状態として記録しておく点です。データを物理的に消してしまわずに、「使わない状態にするだけ」という役割分担が、ソフトデリートの大きな特徴です。Symfonyで実際の処理を行うときも、削除メソッドを呼ぶのではなく、deletedAtを更新するだけの仕組みに変わります。

3. ソフトデリート対応のエンティティを作成しよう

3. ソフトデリート対応のエンティティを作成しよう

ここではエンティティにdeletedAtを追加し、ソフトデリートを可能にする基本の形を紹介します。初心者の方は「削除されたかどうかを日付で判定する」という部分だけ理解できれば十分です。コードの細かい意味は、ゆっくり覚えていけば大丈夫です。

<?php

namespace App\Entity;

use Doctrine\ORM\Mapping as ORM;

#[ORM\Entity]
class Article
{
    #[ORM\Id]
    #[ORM\GeneratedValue]
    #[ORM\Column]
    private ?int $id = null;

    #[ORM\Column(length: 255)]
    private ?string $title = null;

    #[ORM\Column(type: 'datetime', nullable: true)]
    private ?\DateTime $deletedAt = null;

    public function softDelete(): void
    {
        $this->deletedAt = new \DateTime();
    }

    public function isDeleted(): bool
    {
        return $this->deletedAt !== null;
    }
}

この例では、softDeleteメソッドで削除された日時を記録し、isDeletedメソッドで削除されたかどうかを判定しています。Symfonyで「削除」という操作を行うときは、エンティティマネージャーのremoveを呼ぶのではなく、このsoftDeleteを呼ぶだけにします。これによって、データは残ったまま「削除済み」として扱われるようになります。

4. Repository側で削除済みデータを除外する設計パターン

4. Repository側で削除済みデータを除外する設計パターン

ソフトデリートを導入したあとに重要なのは、「削除済みデータをふつうの一覧に表示しない」ための仕組みです。初心者の方が混乱しやすい部分ですが、Repositoryで検索条件をまとめておくととても整理しやすくなります。Repositoryは、Symfonyでデータベースを操作するときの専用係のような存在です。

<?php

namespace App\Repository;

use App\Entity\Article;
use Doctrine\Bundle\DoctrineBundle\Repository\ServiceEntityRepository;
use Doctrine\Persistence\ManagerRegistry;

class ArticleRepository extends ServiceEntityRepository
{
    public function __construct(ManagerRegistry $registry)
    {
        parent::__construct($registry, Article::class);
    }

    public function findAllActive(): array
    {
        return $this->createQueryBuilder('a')
            ->andWhere('a.deletedAt IS NULL')
            ->orderBy('a.id', 'DESC')
            ->getQuery()
            ->getResult();
    }
}

このfindAllActiveメソッドでは、削除されていないデータだけを取得する条件をRepositoryにまとめています。これにより、コントローラ側で条件を書かなくても、一覧表示では常に削除されていないデータだけが表示されるようになります。まるで、削除済みのデータが見える棚と見えない棚に分かれているようなイメージです。

5. ソフトデリートを使うと便利な理由と注意点

5. ソフトデリートを使うと便利な理由と注意点

ソフトデリートを使うと、削除したデータを後から復元できるため、安全なアプリケーションになります。不正削除や操作ミスにも強くなり、履歴としてデータを残すことができる点もメリットです。また、削除ではなく「非表示」として扱うサービスでは定番の仕組みです。

ただし、注意点として、削除済みデータがデータベースに残り続けるため、長期間の運用ではデータが増えていきます。そのため、完全に不要になったデータを一定期間ごとに削除する仕組みを用意しておくと良いでしょう。初心者の段階ではまず「削除ではなく削除日時を記録する」という考え方を理解しておけば十分です。

SymfonyとDoctrine ORMでソフトデリートを正しく使いこなすと、アプリケーション全体の品質が上がり、安心してデータを管理できるようになります。最初はシンプルなエンティティで試してみて、少しずつ実際のプロジェクトに取り入れていくのがおすすめです。