步骤 18: 使用异步

5.0 version
Maintained

使用异步

在处理表单提交时来检查垃圾信息会造成一些问题。如果 Akismet 的 API 变得很慢,我们的网站对用户的响应也会很慢。但更糟的是,如果调用 Akismet 的 API 超时了,或者 API 不可用,那我们可能会丢失评论。

理想情况是,你应该存储提交的数据,但先不发布它,并且立刻返回一个应答。检查垃圾信息可以之后进行。

对评论进行标记

我们要为评论引入 state 信息,它可以取以下值之一:submittedspampublished

state 属性加入 Comment 类:

1
$ symfony console make:entity Comment

创建一个数据库结构迁移:

1
$ symfony console make:migration

修改这个迁移,让已有评论的状态默认设为 published

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

     public function down(Schema $schema) : void

更新数据库结构:

1
$ symfony console doctrine:migrations:migrate

我们也要确保 state 的默认值设为 submitted

patch_file
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
--- a/src/Entity/Comment.php
+++ b/src/Entity/Comment.php
@@ -49,9 +49,9 @@ class Comment
     private $photoFilename;

     /**
-     * @ORM\Column(type="string", length=255)
+     * @ORM\Column(type="string", length=255, options={"default": "submitted"})
      */
-    private $state;
+    private $state = 'submitted';

     public function __toString(): string
     {

更新 EasyAdmin 的配置,这样我们可以看到评论的状态:

patch_file
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
--- a/config/packages/easy_admin.yaml
+++ b/config/packages/easy_admin.yaml
@@ -18,6 +18,7 @@ easy_admin:
                     - author
                     - { property: 'email', type: 'email' }
                     - { property: 'photoFilename', type: 'image', 'base_path': "/uploads/photos", label: 'Photo' }
+                    - state
                     - { property: 'createdAt', type: 'datetime' }
                 sort: ['createdAt', 'ASC']
                 filters: ['conference']
@@ -26,5 +27,6 @@ easy_admin:
                     - { property: 'conference' }
                     - { property: 'createdAt', type: datetime, type_options: { attr: { readonly: true } } }
                     - 'author'
+                    - { property: 'state' }
                     - { property: 'email', type: 'email' }
                     - text

别忘了也要更新测试,就是在 fixture 里设置 state

patch_file
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
--- a/src/DataFixtures/AppFixtures.php
+++ b/src/DataFixtures/AppFixtures.php
@@ -37,8 +37,16 @@ class AppFixtures extends Fixture
         $comment1->setAuthor('Fabien');
         $comment1->setEmail('[email protected]');
         $comment1->setText('This was a great conference.');
+        $comment1->setState('published');
         $manager->persist($comment1);

+        $comment2 = new Comment();
+        $comment2->setConference($amsterdam);
+        $comment2->setAuthor('Lucas');
+        $comment2->setEmail('[email protected]');
+        $comment2->setText('I think this one is going to be moderated.');
+        $manager->persist($comment2);
+
         $admin = new Admin();
         $admin->setRoles(['ROLE_ADMIN']);
         $admin->setUsername('admin');

在控制器的测试里,模拟验证:

patch_file
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
--- a/tests/Controller/ConferenceControllerTest.php
+++ b/tests/Controller/ConferenceControllerTest.php
@@ -2,6 +2,8 @@

 namespace App\Tests\Controller;

+use App\Repository\CommentRepository;
+use Doctrine\ORM\EntityManagerInterface;
 use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;

 class ConferenceControllerTest extends WebTestCase
@@ -22,11 +24,17 @@ class ConferenceControllerTest extends WebTestCase
         $client->submitForm('Submit', [
             'comment_form[author]' => 'Fabien',
             'comment_form[text]' => 'Some feedback from an automated functional test',
-            'comment_form[email]' => '[email protected]',
+            'comment_form[email]' => $email = '[email protected]',
             'comment_form[photo]' => dirname(__DIR__, 2).'/public/images/under-construction.gif',
         ]);
         $this->assertResponseRedirects();
+
+        // simulate comment validation
+        $comment = self::$container->get(CommentRepository::class)->findOneByEmail($email);
+        $comment->setState('published');
+        self::$container->get(EntityManagerInterface::class)->flush();
+
         $client->followRedirect();
         $this->assertSelectorExists('div:contains("There are 2 comments")');
     }

在 PHPUnit 测试中,你可以用 self::$container->get() 获取容器里的任何服务;你也可以用它访问非公共服务。

理解 Messenger

在 Symfony 中由 Messenger 组件来管理异步代码:

1
$ symfony composer req messenger

当需要异步执行一些逻辑时,发送一个 消息消息总线。总线会在一个 队列 中存储消息,并且立即返回,这样执行流程就能尽快恢复。

一个 消费者 程序会在后台持续运行,它会读取队列里的消息,并且执行相关逻辑。消费者程序可以和 web 应用程序运行在同一个服务器上,也可以运行在另一个服务器上。

它和 HTTP 请求的处理方式很像,只是它不会返回应答。

编写一个消息处理器

一个消息是一个仅包含数据的类,它不含任何逻辑。它会被持久化,然后保存在队列中,所以它只包含“简单”的可序列化数据。

创建 CommentMessage 类:

src/Message/CommentMessage.php
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
namespace App\Message;

class CommentMessage
{
    private $id;
    private $context;

    public function __construct(int $id, array $context = [])
    {
        $this->id = $id;
        $this->context = $context;
    }

    public function getId(): int
    {
        return $this->id;
    }

    public function getContext(): array
    {
        return $this->context;
    }
}

在 Messenger 的世界里,我们没有控制器,但有消息处理器。

在新的 App\MessageHandler 命名空间下创建 CommentMessageHandler 类,它知道如何处理 CommentMessage 类的消息:

src/MessageHandler/CommentMessageHandler.php
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
namespace App\MessageHandler;

use App\Message\CommentMessage;
use App\Repository\CommentRepository;
use App\SpamChecker;
use Doctrine\ORM\EntityManagerInterface;
use Symfony\Component\Messenger\Handler\MessageHandlerInterface;

class CommentMessageHandler implements MessageHandlerInterface
{
    private $spamChecker;
    private $entityManager;
    private $commentRepository;

    public function __construct(EntityManagerInterface $entityManager, SpamChecker $spamChecker, CommentRepository $commentRepository)
    {
        $this->entityManager = $entityManager;
        $this->spamChecker = $spamChecker;
        $this->commentRepository = $commentRepository;
    }

    public function __invoke(CommentMessage $message)
    {
        $comment = $this->commentRepository->find($message->getId());
        if (!$comment) {
            return;
        }

        if (2 === $this->spamChecker->getSpamScore($comment, $message->getContext())) {
            $comment->setState('spam');
        } else {
            $comment->setState('published');
        }

        $this->entityManager->flush();
    }
}

MessageHandlerInterface 是一个 标记 接口。它帮助 Symfony 自动注册和自动配置该类为一个消息处理器。根据惯例,处理逻辑放在名为 __invoke() 的方法中。该方法中的 CommentMessage 类型提示告诉 Messenger 它要处理的类是哪一个。

更新控制器来使用新的系统:

patch_file
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
--- a/src/Controller/ConferenceController.php
+++ b/src/Controller/ConferenceController.php
@@ -5,14 +5,15 @@ namespace App\Controller;
 use App\Entity\Comment;
 use App\Entity\Conference;
 use App\Form\CommentFormType;
+use App\Message\CommentMessage;
 use App\Repository\CommentRepository;
 use App\Repository\ConferenceRepository;
-use App\SpamChecker;
 use Doctrine\ORM\EntityManagerInterface;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\HttpFoundation\File\Exception\FileException;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Messenger\MessageBusInterface;
 use Symfony\Component\Routing\Annotation\Route;
 use Twig\Environment;

@@ -20,11 +21,13 @@ class ConferenceController extends AbstractController
 {
     private $twig;
     private $entityManager;
+    private $bus;

-    public function __construct(Environment $twig, EntityManagerInterface $entityManager)
+    public function __construct(Environment $twig, EntityManagerInterface $entityManager, MessageBusInterface $bus)
     {
         $this->twig = $twig;
         $this->entityManager = $entityManager;
+        $this->bus = $bus;
     }

     /**
@@ -40,7 +43,7 @@ class ConferenceController extends AbstractController
     /**
      * @Route("/conference/{slug}", name="conference")
      */
-    public function show(Request $request, Conference $conference, CommentRepository $commentRepository, SpamChecker $spamChecker, string $photoDir)
+    public function show(Request $request, Conference $conference, CommentRepository $commentRepository, string $photoDir)
     {
         $comment = new Comment();
         $form = $this->createForm(CommentFormType::class, $comment);
@@ -59,6 +62,7 @@ class ConferenceController extends AbstractController
             }

             $this->entityManager->persist($comment);
+            $this->entityManager->flush();

             $context = [
                 'user_ip' => $request->getClientIp(),
@@ -66,11 +70,8 @@ class ConferenceController extends AbstractController
                 'referrer' => $request->headers->get('referer'),
                 'permalink' => $request->getUri(),
             ];
-            if (2 === $spamChecker->getSpamScore($comment, $context)) {
-                throw new \RuntimeException('Blatant spam, go away!');
-            }

-            $this->entityManager->flush();
+            $this->bus->dispatch(new CommentMessage($comment->getId(), $context));

             return $this->redirectToRoute('conference', ['slug' => $conference->getSlug()]);
         }

我们现在分发一个消息到总线上,而不是依赖于垃圾信息检查器。然后消息处理器会决定怎么处理消息。

这达到了一些意想不到的效果。我们把控制器和垃圾信息检查器进行了解耦,把逻辑移到了消息处理器这个新的类中。这是一个使用总线的完美案例。测试一下代码,它能通过。所有的执行仍然是同步的,但代码大概已经变得“更好”了。

限制展示的评论

更新评论的展示逻辑,让未发布的评论不出现在前端:

patch_file
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
--- a/src/Repository/CommentRepository.php
+++ b/src/Repository/CommentRepository.php
@@ -25,7 +25,9 @@ class CommentRepository extends ServiceEntityRepository
     {
         return $this->createQueryBuilder('c')
             ->andWhere('c.conference = :conference')
+            ->andWhere('c.state = :state')
             ->setParameter('conference', $conference)
+            ->setParameter('state', 'published')
             ->orderBy('c.createdAt', 'DESC')
             ->setMaxResults($limit)
             ->setFirstResult($offset)

真正走向异步

默认情况下,消息处理器都是同步调用。为了使用异步方式,你需要在 config/packages/messenger.yaml 配置文件中为每个消息处理器显式地配置要用到的队列:

patch_file
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
--- a/config/packages/messenger.yaml
+++ b/config/packages/messenger.yaml
@@ -5,10 +5,10 @@ framework:

         transports:
             # https://symfony.com/doc/current/messenger.html#transport-configuration
-            # async: '%env(MESSENGER_TRANSPORT_DSN)%'
+            async: '%env(RABBITMQ_DSN)%'
             # failed: 'doctrine://default?queue_name=failed'
             # sync: 'sync://'

         routing:
             # Route your messages to the transports
-            # 'App\Message\YourMessage': async
+            App\Message\CommentMessage: async

配置告诉总线把 App\Message\CommentMessage 类的实例发送到 async 队列,这个队列用一个 DSN 定义,它的值储存在 RABBITMQ_DSN 环境变量中。

在 Docker 服务中加入 RabbitMQ

如你才猜测的那样,我们会使用 RabbitMQ:

patch_file
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
--- a/docker-compose.yaml
+++ b/docker-compose.yaml
@@ -12,3 +12,7 @@ services:
     redis:
         image: redis:5-alpine
         ports: [6379]
+
+    rabbitmq:
+        image: rabbitmq:3.7-management
+        ports: [5672, 15672]

重启 Docker 服务

为了强制让 Docker Compose 加上 RabbitMQ 容器,停止容器,然后重新启动:

1
2
$ docker-compose stop
$ docker-compose up -d
1
$ sleep 10

用消费者程序处理消息

如果你试着提交一个新评论,垃圾检查器不再被调用。在 getSpamScore() 方法中加上一行 error_log() 调用来进行验证。新方案是,消息会在 RabbitMQ 中等待,直到有消费者进程来处理。

你可以想象得到,Symfony 自带了一个消费者命令。现在来运行它:

1
$ symfony console messenger:consume async -vv

它会立刻处理掉那个表单提交后分发的消息:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
 [OK] Consuming messages from transports "async".

 // The worker will automatically exit once it has received a stop signal via the messenger:stop-workers command.

 // Quit the worker with CONTROL-C.

11:30:20 INFO      [messenger] Received message App\Message\CommentMessage ["message" => App\Message\CommentMessage^ { …},"class" => "App\Message\CommentMessage"]
11:30:20 INFO      [http_client] Request: "POST https://80cea32be1f6.rest.akismet.com/1.1/comment-check"
11:30:20 INFO      [http_client] Response: "200 https://80cea32be1f6.rest.akismet.com/1.1/comment-check"
11:30:20 INFO      [messenger] Message App\Message\CommentMessage handled by App\MessageHandler\CommentMessageHandler::__invoke ["message" => App\Message\CommentMessage^ { …},"class" => "App\Message\CommentMessage","handler" => "App\MessageHandler\CommentMessageHandler::__invoke"]
11:30:20 INFO      [messenger] App\Message\CommentMessage was handled successfully (acknowledging to transport). ["message" => App\Message\CommentMessage^ { …},"class" => "App\Message\CommentMessage"]

日志会记录消息的处理,但你可以用 -vv 选项在终端获得即时反馈。你甚至应该可以在日志中发现调用 Akismet API 的记录。

Ctrl+C 可以停止消费者程序。

探索 RabbitMQ 的 web 管理界面

如果你想要查看 RabbitMQ 中的队列和消息,打开它的 web 管理界面:

1
$ symfony open:local:rabbitmq

或者从 web 调试工具栏上也能打开:

使用 guest/guest 这组账号密码来登入 RabbitMQ 的管理界面:

在后台运行 worker 进程

我们想要在不打开很多终端的情况下就可以让消费者程序持续运行,而不是每次提交一个评论时打开它,提交完后再立刻关闭它。

symfony 命令在执行 run 命令时,可以通过守护进程选项(-d)来管理这种后台运行的命令或工作进程。

再执行一次消费者程序,但在后台程序中发送消息:

1
$ symfony run -d --watch=config,src,templates,vendor symfony console messenger:consume async

--watch 选项告诉Symfony,每当 config/src/templates/vendor/ 这些目录下有文件系统的改动时,这个命令必须重启。

注解

不要使用 -vv 选项,否则你会在执行 server:log 时信息会重复(日志信息和控制台信息)。

如果消费者程序因为一些原因停止运行了(内存限制,程序错误等待),它会被自动重启。如果运行消费者程序失败得太频繁,symfony 命令就会放弃运行。

日志通过 symfony server:log 流式输出,它会整合所有来自 PHP、web 服务器和应用程序的其它日志:

1
$ symfony server:log

server:status 命令来列出当前项目所管理的全部后台 worker 进程:

1
2
3
4
$ symfony server:status

Web server listening on https://127.0.0.1:8000
  Command symfony console messenger:consume async running with PID 15774 (watching config/, src/, templates/)

要停止一个 worker 进程,需要停止 web 服务器,或者根据 server:status 命令显示的进程 ID 杀死对应进程:

1
$ kill 15774

对失败的消息进行重试

如果处理消息时 Akismet 下线了怎么办?提交评论的人不会受影响,但这个消息丢失了,垃圾信息检查也没有做。

Messenger 针对处理消息时抛出异常有一个重试机制。让我们来对它进行配置:

patch_file
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
--- a/config/packages/messenger.yaml
+++ b/config/packages/messenger.yaml
@@ -5,10 +5,17 @@ framework:

         transports:
             # https://symfony.com/doc/current/messenger.html#transport-configuration
-            async: '%env(RABBITMQ_DSN)%'
-            # failed: 'doctrine://default?queue_name=failed'
+            async:
+                dsn: '%env(RABBITMQ_DSN)%'
+                retry_strategy:
+                    max_retries: 3
+                    multiplier: 2
+
+            failed: 'doctrine://default?queue_name=failed'
             # sync: 'sync://'

+        failure_transport: failed
+
         routing:
             # Route your messages to the transports
             App\Message\CommentMessage: async

当处理消息时出现了问题,消费者程序会在放弃前重试 3 次。放弃后它不会丢掉消息,而是把它放在一个持久化存储中,即使用了 Doctrine 数据库的 failed 队列中。

查看处理失败的消息,用以下命令来重试处理:

1
2
3
$ symfony console messenger:failed:show

$ symfony console messenger:failed:retry

部署 RabbitMQ

在服务列表中添加 RabbitMQ,它就被加到生产服务器上了。

patch_file
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
--- a/.symfony/services.yaml
+++ b/.symfony/services.yaml
@@ -5,3 +5,8 @@ db:

 rediscache:
     type: redis:5.0
+
+queue:
+    type: rabbitmq:3.7
+    disk: 1024
+    size: S

在 web 容器的主配置文件也引用它,并激活 PHP 的 amqp 扩展:

patch_file
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
--- a/.symfony.cloud.yaml
+++ b/.symfony.cloud.yaml
@@ -4,6 +4,7 @@ type: php:7.4

 runtime:
     extensions:
+        - amqp
         - pdo_pgsql
         - apcu
         - mbstring
@@ -22,6 +23,7 @@ variables:
 relationships:
     database: "db:postgresql"
     redis: "rediscache:redis"
+    rabbitmq: "queue:rabbitmq"

 web:
     locations:

当项目里的 RabbitMQ 服务安装好以后,你要先打开隧道才能访问它的 web 管理界面:

1
2
3
4
5
$ symfony tunnel:open
$ symfony open:remote:rabbitmq

# when done
$ symfony tunnel:close

在 SymfonyCloud 上运行 worker 进程

我们需要持续运行 messenger:consume 来处理来自 RabbitMQ 的消息。在 SymfonyCloud 上,这是 worker 进程 的角色:

patch_file
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
--- a/.symfony.cloud.yaml
+++ b/.symfony.cloud.yaml
@@ -46,3 +46,12 @@ hooks:
         set -x -e

         (>&2 symfony-deploy)
+
+workers:
+    messages:
+        commands:
+            start: |
+                set -x -e
+
+                (>&2 symfony-deploy)
+                php bin/console messenger:consume async -vv --time-limit=3600 --memory-limit=128M

就像本地 symfony 命令一样,SymfonyCloud 会管理重启和日志。

用这个命令来查看 worker 进程中的日志:

1
$ symfony logs --worker=messages all

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