步骤 13: 管理 Doctrine 对象的生命周期

当新增一条评论时，createdAt 这个字段最好可以自动设为当前的日期和时间。

Doctrine 在对象的生命周期中（在新行被插入到数据库之前、在对应行被更新之后……），有不同的方式来操作对象以及对象的属性。

定义生命周期的回调方法

当要执行的行为无需任何服务对象，而且只是针对一种实体类时，可以在该实体类里定义一个回调方法：

patch_file

  1. --- a/src/Entity/Comment.php
  2. +++ b/src/Entity/Comment.php
  3. @@ -7,6 +7,7 @@ use Doctrine\ORM\Mapping as ORM;
  5.  /**
  6.   * @ORM\Entity(repositoryClass=CommentRepository::class)
  7. + * @ORM\HasLifecycleCallbacks()
  8.   */
  9.  class Comment
  10.  {
  11. @@ -106,6 +107,14 @@ class Comment
  12.          return $this;
  13.      }
  15. +    /**
  16. +     * @ORM\PrePersist
  17. +     */
  18. +    public function setCreatedAtValue()
  19. +    {
  20. +        $this->createdAt = new \DateTime();
  21. +    }
  22. +
  23.      public function getConference(): ?Conference
  24.      {
  25.          return $this->conference;

对象的数据被第一次存储在数据库时会触发 @ORM\PrePersist 事件。当触发时，setCreatedAtValue() 方法会被调用，当前的日期和时间就会用来设置 createdAt 属性的值。

为会议添加 slug

会议页面的 URL 对会议缺乏描述性：/conference/1。更重要的是，这些 URL 依赖于一个实现细节（数据库表的主键被泄露了）。

用类似 /conference/paris-2020 这样的 URL 来代替怎么样？那看上去好得多。paris-2020 就是我们所谓的会议 slug。

为会议增加一个 slug 属性（一个不能取值 null 的 255 长度的字符串）：

  1. $ symfony console make:entity Conference

添加一个数据库结构迁移文件，用来增加一个新的列：

  1. $ symfony console make:migration

执行这个新的结构迁移：

  1. $ symfony console doctrine:migrations:migrate

得到一个错误？这是预料之中的。为什么呢？因为我们要求这个 slug 不能是 null 值，但是当结构迁移执行时，数据库中已有的会议行会为 slug 设置一个 null 值。让我们通过调整一下该迁移文件来修复这个错误。

patch_file

  1. --- a/migrations/Version00000000000000.php
  2. +++ b/migrations/Version00000000000000.php
  3. @@ -20,7 +20,9 @@ final class Version20200714152808 extends AbstractMigration
  4.      public function up(Schema $schema) : void
  5.      {
  6.          // this up() migration is auto-generated, please modify it to your needs
  7. -        $this->addSql('ALTER TABLE conference ADD slug VARCHAR(255) NOT NULL');
  8. +        $this->addSql('ALTER TABLE conference ADD slug VARCHAR(255)');
  9. +        $this->addSql("UPDATE conference SET slug=CONCAT(LOWER(city), '-', year)");
  10. +        $this->addSql('ALTER TABLE conference ALTER COLUMN slug SET NOT NULL');
  11.      }
  13.      public function down(Schema $schema) : void

这里的技巧是先增加这个 slug 列并且允许它取值为 null，然后再把行里的 slug 设置成一个非 null 值，最后把这个列设置回不能取 null 值。

注解

对于真实项目，在 SQL 中使用 CONCAT(LOWER(city), '-', year) 可能还不足以解决问题。在这种情况下，我们需要一个 真正 的 Slugger。

数据库结构迁移现在应该可以顺利执行了：

  1. $ symfony console doctrine:migrations:migrate

因为应用程序马上会使用 slug 来查找每个会议，我们来调整下会议的实体类，确保 slug 的值在数据库中是唯一的：

patch_file

  1. --- a/src/Entity/Conference.php
  2. +++ b/src/Entity/Conference.php
  3. @@ -6,9 +6,11 @@ use App\Repository\ConferenceRepository;
  4.  use Doctrine\Common\Collections\ArrayCollection;
  5.  use Doctrine\Common\Collections\Collection;
  6.  use Doctrine\ORM\Mapping as ORM;
  7. +use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
  9.  /**
  10.   * @ORM\Entity(repositoryClass=ConferenceRepository::class)
  11. + * @UniqueEntity("slug")
  12.   */
  13.  class Conference
  14.  {
  15. @@ -40,7 +42,7 @@ class Conference
  16.      private $comments;
  18.      /**
  19. -     * @ORM\Column(type="string", length=255)
  20. +     * @ORM\Column(type="string", length=255, unique=true)
  21.       */
  22.      private $slug;

因为我们使用了验证器来确保 slug 的唯一性，我们需要增加 Symfony 的 Validator 组件：

  1. $ symfony composer req validator

正如你所料，我们需要执行一次数据库结构迁移：

  1. $ symfony console make:migration
  1. $ symfony console doctrine:migrations:migrate

生成 slug

生成一个可读性良好的 slug，并将它用于 URL（任何非 ASCII 字符都会被编码），这是个有挑战的工作，尤其是对于英语之外的语言。比如你该如何把 é 转换成 e 呢？

不必重新发明轮子，让我们来用 Symfony 的 String 组件，它使字符串操作变得很容易，而且它也提供了一个 slugger：

  1. $ symfony composer req string

在 Conference 类里增加一个 computeSlug() 方法，它会根据会议数据计算出 slug 的值：

patch_file

  1. --- a/src/Entity/Conference.php
  2. +++ b/src/Entity/Conference.php
  3. @@ -7,6 +7,7 @@ use Doctrine\Common\Collections\ArrayCollection;
  4.  use Doctrine\Common\Collections\Collection;
  5.  use Doctrine\ORM\Mapping as ORM;
  6.  use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
  7. +use Symfony\Component\String\Slugger\SluggerInterface;
  9.  /**
  10.   * @ORM\Entity(repositoryClass=ConferenceRepository::class)
  11. @@ -61,6 +62,13 @@ class Conference
  12.          return $this->id;
  13.      }
  15. +    public function computeSlug(SluggerInterface $slugger)
  16. +    {
  17. +        if (!$this->slug || '-' === $this->slug) {
  18. +            $this->slug = (string) $slugger->slug((string) $this)->lower();
  19. +        }
  20. +    }
  21. +
  22.      public function getCity(): ?string
  23.      {
  24.          return $this->city;

只有当前 slug 为空或者是设为了 - 这个特殊值的时候，computeSlug() 方法才会计算 slug 值。为什么我们要用 - 这个特殊值呢？因为在后台新增一个会议时，slug 是必填的。所以我们需要一个非空值，它告诉应用程序，我们要自动生成 slug。

定义一个复杂的生命周期回调方法

和 createdAt 一样，slug 应该被自动设置。当会议被更新时，computeSlug() 方法要被自动调用。

但是这个方法依赖于 SluggerInterface 接口的一个实现，所以我们无法像之前那样增加一个 prePersist 事件（我们无法注入 slugger）。

转而创建一个 Doctrine 里针对实体的监听器：

src/EntityListener/ConferenceEntityListener.php

  1. namespace App\EntityListener;
  3. use App\Entity\Conference;
  4. use Doctrine\ORM\Event\LifecycleEventArgs;
  5. use Symfony\Component\String\Slugger\SluggerInterface;
  7. class ConferenceEntityListener
  8. {
  9.     private $slugger;
  11.     public function __construct(SluggerInterface $slugger)
  12.     {
  13.         $this->slugger = $slugger;
  14.     }
  16.     public function prePersist(Conference $conference, LifecycleEventArgs $event)
  17.     {
  18.         $conference->computeSlug($this->slugger);
  19.     }
  21.     public function preUpdate(Conference $conference, LifecycleEventArgs $event)
  22.     {
  23.         $conference->computeSlug($this->slugger);
  24.     }
  25. }

注意到当新建或更新一个会议时，slug 也会更新（新建时调用 prePersist() 方法，更新时调用 preUpdate() 方法）。

在服务容器中配置服务

到目前为止，我们还没有谈到 Symfony 中一个重要的组成部分，就是 依赖注入容器，它负责管理各个 服务：在需要的时候创建和注入服务。

一个 服务 是一个提供某项功能的“全局”对象（比如一个 mailer 、一个 logger 、一个 slugger 等等），而不是一个 数据对象 （比如 Doctrine 实体的实例）。

你极少需要去直接操作容器，因为在你需要服务的时候，它会自动注入服务对象：例如，当你在控制器方法里对参数进行类型提示时，容器会注入对应类型的服务对象。

如果在前面的步骤里，你想要知道事件的监听器是如何注册的，那么现在你有答案了：那就是容器。当某个类实现了一个特定的接口，容器就会知道应该以某种方式注册这个类。

不过很可惜，自动化并非总是可以实现，尤其在一些第三方包中。我们刚才写的这个针对实体的监听器就是一个例子。由于它没有实现任何接口，也没有继承自一个容器的“已知类”，所以 Symfony 的服务容器并不能自动管理它。

我们需要在容器中部分地声明这个监听器。容器仍然可以猜测出依赖关联，所以不用把它写出来，但我们需要手工添加一些“标签”来把这个监听器注册到 Doctrine 的事件分发器：

patch_file

  1. --- a/config/services.yaml
  2. +++ b/config/services.yaml
  3. @@ -29,3 +29,7 @@ services:
  5.      # add more service definitions when explicit configuration is needed
  6.      # please note that last definitions always *replace* previous ones
  7. +    App\EntityListener\ConferenceEntityListener:
  8. +        tags:
  9. +            - { name: 'doctrine.orm.entity_listener', event: 'prePersist', entity: 'App\Entity\Conference'}
  10. +            - { name: 'doctrine.orm.entity_listener', event: 'preUpdate', entity: 'App\Entity\Conference'}

注解

不要把 Doctrine 的事件监听器和 Symfony 的事件监听器混淆起来。尽管它们看上去很相似，但它们用的底层代码架构是不一样的。

在应用中使用 slug

试着在后台里添加更多会议，并且更新一个现有会议的城市或年份；除非你使用特殊的 - 值，否则 slug 不会更新。

最后一个改动，就是更新控制器和模板，让它们在路由中使用会议的 slug 来代替 id。

patch_file

  1. --- a/src/Controller/ConferenceController.php
  2. +++ b/src/Controller/ConferenceController.php
  3. @@ -28,7 +28,7 @@ class ConferenceController extends AbstractController
  4.          ]));
  5.      }
  7. -    #[Route('/conference/{id}', name: 'conference')]
  8. +    #[Route('/conference/{slug}', name: 'conference')]
  9.      public function show(Request $request, Conference $conference, CommentRepository $commentRepository): Response
  10.      {
  11.          $offset = max(0, $request->query->getInt('offset', 0));
  12. --- a/templates/base.html.twig
  13. +++ b/templates/base.html.twig
  14. @@ -12,7 +12,7 @@
  15.              <h1><a href="{{ path('homepage') }}">Guestbook</a></h1>
  16.              <ul>
  17.              {% for conference in conferences %}
  18. -                <li><a href="{{ path('conference', { id: conference.id }) }}">{{ conference }}</a></li>
  19. +                <li><a href="{{ path('conference', { slug: conference.slug }) }}">{{ conference }}</a></li>
  20.              {% endfor %}
  21.              </ul>
  22.              <hr />
  23. --- a/templates/conference/index.html.twig
  24. +++ b/templates/conference/index.html.twig
  25. @@ -8,7 +8,7 @@
  26.      {% for conference in conferences %}
  27.          <h4>{{ conference }}</h4>
  28.          <p>
  29. -            <a href="{{ path('conference', { id: conference.id }) }}">View</a>
  30. +            <a href="{{ path('conference', { slug: conference.slug }) }}">View</a>
  31.          </p>
  32.      {% endfor %}
  33.  {% endblock %}
  34. --- a/templates/conference/show.html.twig
  35. +++ b/templates/conference/show.html.twig
  36. @@ -22,10 +22,10 @@
  37.          {% endfor %}
  39.          {% if previous >= 0 %}
  40. -            <a href="{{ path('conference', { id: conference.id, offset: previous }) }}">Previous</a>
  41. +            <a href="{{ path('conference', { slug: conference.slug, offset: previous }) }}">Previous</a>
  42.          {% endif %}
  43.          {% if next < comments|length %}
  44. -            <a href="{{ path('conference', { id: conference.id, offset: next }) }}">Next</a>
  45. +            <a href="{{ path('conference', { slug: conference.slug, offset: next }) }}">Next</a>
  46.          {% endif %}
  47.      {% else %}
  48.          <div>No comments have been posted yet for this conference.</div>

现在会议页面应该可以使用它的 slug 来打开：

步骤 13: 管理 Doctrine 对象的生命周期 - 图1

深入学习

This work, including the code samples, is licensed under a Creative Commons BY-NC-SA 4.0 license.