步骤 19: 用 Workflow 进行决策

5.2 version

Maintained

5.2 current

Unmaintained

5.0

用 Workflow 进行决策

用 Workflow 进行决策¶

让模型拥有状态是很常见的。目前评论的状态只由垃圾信息检查器来决定。如果我们要加入更多的决策因素，那该怎么做？

在垃圾信息检查器判别之后，我们可能想要让网站管理员来管理所有评论。这个流程看上去可能是这样的：

当用户提交评论时，我们把它的初始状态设为 submitted；
然后垃圾信息检查器来分析这条评论，把它的状态转为 potential_spam、ham 或 rejected 中的一个；
如果评论不是 rejected 状态，那需要等待管理员根据它的内容质量来决定，是把它切换到 published 还是 rejected。

实现这个逻辑并不复杂，但你可以想到，不断增加类似的规则会大幅提高复杂度。我们可以使用 Symfony 的 Workflow 组件，而不是自己实现它。

1	$ symfony composer req workflow

描述工作流（Workflow）¶

可以在 config/packages/workflow.yaml 文件中描述评论的处理流程：

config/packages/workflow.yaml¶

framework:
    workflows:
        comment:
            type: state_machine
            audit_trail:
                enabled: "%kernel.debug%"
            marking_store:
                type: 'method'
                property: 'state'
            supports:
                - App\Entity\Comment
            initial_marking: submitted
            places:
                - submitted
                - ham
                - potential_spam
                - spam
                - rejected
                - published
            transitions:
                accept:
                    from: submitted
                    to:   ham
                might_be_spam:
                    from: submitted
                    to:   potential_spam
                reject_spam:
                    from: submitted
                    to:   spam
                publish:
                    from: potential_spam
                    to:   published
                reject:
                    from: potential_spam
                    to:   rejected
                publish_ham:
                    from: ham
                    to:   published
                reject_ham:
                    from: ham
                    to:   rejected

为了验证这个流程，可以生成一个示意图：

1	$ symfony console workflow:dump comment \| dot -Tpng -o workflow.png

注解

dot 命令是 Graphviz 工具的一部分。

使用工作流¶

在消息处理器里用工作流来代替当前逻辑：

patch_file¶

--- a/src/MessageHandler/CommentMessageHandler.php
+++ b/src/MessageHandler/CommentMessageHandler.php
@@ -6,19 +6,28 @@ use App\Message\CommentMessage;
 use App\Repository\CommentRepository;
 use App\SpamChecker;
 use Doctrine\ORM\EntityManagerInterface;
+use Psr\Log\LoggerInterface;
 use Symfony\Component\Messenger\Handler\MessageHandlerInterface;
+use Symfony\Component\Messenger\MessageBusInterface;
+use Symfony\Component\Workflow\WorkflowInterface;

 class CommentMessageHandler implements MessageHandlerInterface
 {
     private $spamChecker;
     private $entityManager;
     private $commentRepository;
+    private $bus;
+    private $workflow;
+    private $logger;

-    public function __construct(EntityManagerInterface $entityManager, SpamChecker $spamChecker, CommentRepository $commentRepository)
+    public function __construct(EntityManagerInterface $entityManager, SpamChecker $spamChecker, CommentRepository $commentRepository, MessageBusInterface $bus, WorkflowInterface $commentStateMachine, LoggerInterface $logger = null)
     {
         $this->entityManager = $entityManager;
         $this->spamChecker = $spamChecker;
         $this->commentRepository = $commentRepository;
+        $this->bus = $bus;
+        $this->workflow = $commentStateMachine;
+        $this->logger = $logger;
     }

     public function __invoke(CommentMessage $message)
@@ -28,12 +37,21 @@ class CommentMessageHandler implements MessageHandlerInterface
             return;
         }

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

-        $this->entityManager->flush();
+        if ($this->workflow->can($comment, 'accept')) {
+            $score = $this->spamChecker->getSpamScore($comment, $message->getContext());
+            $transition = 'accept';
+            if (2 === $score) {
+                $transition = 'reject_spam';
+            } elseif (1 === $score) {
+                $transition = 'might_be_spam';
+            }
+            $this->workflow->apply($comment, $transition);
+            $this->entityManager->flush();
+
+            $this->bus->dispatch($message);
+        } elseif ($this->logger) {
+            $this->logger->debug('Dropping comment message', ['comment' => $comment->getId(), 'state' => $comment->getState()]);
+        }
     }
 }

新的逻辑是这样：

如果消息里的评论可以进行名为 accept 的状态迁移，就检查是否为垃圾信息；
根据结果来选择要应用的状态迁移；
调用 apply() 方法来更新评论，它会调用评论的 setState() 方法。
调用 flush() 方法来把更新保存到数据库；
重新派发信息来让工作流再次迁移状态。

因为我们还没有实现管理后台的验证，下次消费信息时，日志中会记录 “Dropping comment message”。

在下一章里我们会实现一个自动验证：

patch_file¶

--- a/src/MessageHandler/CommentMessageHandler.php
+++ b/src/MessageHandler/CommentMessageHandler.php
@@ -50,6 +50,9 @@ class CommentMessageHandler implements MessageHandlerInterface
             $this->entityManager->flush();

             $this->bus->dispatch($message);
+        } elseif ($this->workflow->can($comment, 'publish') || $this->workflow->can($comment, 'publish_ham')) {
+            $this->workflow->apply($comment, $this->workflow->can($comment, 'publish') ? 'publish' : 'publish_ham');
+            $this->entityManager->flush();
         } elseif ($this->logger) {
             $this->logger->debug('Dropping comment message', ['comment' => $comment->getId(), 'state' => $comment->getState()]);
         }

执行 symfony server:log，然后在前端页面添加一个评论，看一下输出的一个个状态迁移。

在依赖注入容器中找到服务¶

当使用依赖注入时，我们通过接口类型提示或者有时使用具体的实现类名，在依赖注入容器中找到对应的服务。但当某个接口有多个实现类时，Symfony 无法猜出你需要的是哪个实现类。我们要明确指出需要哪个服务类。

在前面一节，我们刚刚遇到的 WorkflowInterface 注入，就是这样的一个例子。

当我们在构造函数中注入 WorkflowInterface 接口的任何实例时，Symfony 如何猜测要用哪一个工作流的实现呢？Symfony 使用基于参数名的约定：$commentStateMachine 指向配置里的 comment 工作流（它的类型是 state_machine）。试着换成其它的参数名都会失败。

如果你不记得这个约定了，使用 debug:container 命令。查找所有包含了 “workflow” 关键词的服务：

$ symfony console debug:container workflow

 Select one of the following services to display its information:
  [0] console.command.workflow_dump
  [1] workflow.abstract
  [2] workflow.marking_store.method
  [3] workflow.registry
  [4] workflow.security.expression_language
  [5] workflow.twig_extension
  [6] monolog.logger.workflow
  [7] Symfony\Component\Workflow\Registry
  [8] Symfony\Component\Workflow\WorkflowInterface $commentStateMachine
  [9] Psr\Log\LoggerInterface $workflowLogger
 >

注意选项 8，Symfony\Component\Workflow\WorkflowInterface $commentStateMachine，它告诉你使用 $commentStateMachine 作为参数名有着特殊意义。

注解

正如在之前有一章里看到的那样，我们也可以用 debug:autowiring 命令：

1	$ symfony console debug:autowiring workflow

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