9.3 创建 Email 集成流

Taco Cloud 应该能让它的用户通过 email 提交他们的 taco 设计和放置订单。你在报纸上通过发送传单和放置外卖广告，邀请大家通过电子邮件发送 taco 订单。这样做很成功！不幸的是，它有点太过于”成功”了。有这么多的电子邮件中，你必须雇用临时工做一些，无非就是阅读完所有的信件，并提交订单的详细信息到订购系统来的工作。

在本节中，将实现一个集成信息流，用于轮询 Taco Cloud 收件箱中的 taco 订单电子邮件，并解析邮件订单的详细信息，然后提交订单到 Taco Cloud 进行处理。总之，你将从邮箱端点模块中使用入站通道适配器，用于把 Taco Cloud 收件箱中的邮件提取到集成中。

下一步，在集成信息流中，电子邮件将被解析为订单对象，接着被扇出到另外一个向 Taco Cloud 的 REST API 提交订单的处理器中，在那里，它们将如同其他订单一样被处理。首先，让我们定义一个简单的配置属性的类，来捕获如何处理 Taco Cloud 电子邮件的细节：

  1. @Data
  2. @ConfigurationProperties(prefix="tacocloud.email")
  3. @Component
  4. public class EmailProperties {
  5.     private String username;
  6.     private String password;
  7.     private String host;
  8.     private String mailbox;
  9.     private long pollRate = 30000;
  11.     public String getImapUrl() {
  12.         return String.format("imaps://%s:%s@%s/%s",
  13.              this.username, this.password, this.host, this.mailbox);
  14.     }
  15. }

正如你所看到的，EmailProperties 使用 get() 方法来产生一个 IMAP URL。流就使用这个 URL 连接到 Taco Cloud 的电子邮件服务器，然后轮询电子邮件。所捕获的属性中包括，用户名、密码、IMAP服务器的主机名、轮询的邮箱和该邮箱被轮询频率（默认为 30 秒轮询一次）。

该 EmailProperties 类是在类的级别使用了 @ConfigurationProperties 注解，注解中 prefix 被设置为 tacocloud.email。这意味着，可以在 application.yml 配置文件中详细配置 email 的信息：

  1. tacocloud:
  2.   email:
  3.     host: imap.tacocloud.com
  4.     mailbox: INBOX
  5.     username: taco-in-flow
  6.     password: 1L0v3T4c0s
  7.     poll-rate: 10000

现在让我们使用 EmailProperties 去配置集成流。

定义这个流程时有两种选择：

  • 定义在 Taco Cloud 应用程序本身里面 — 在流结束的位置，服务激活器将调用定义了的存储库来创建 taco 订单。
  • 定义在一个单独的应用程序中 — 在流结束的位置，服务激活器将发送 POST 请求到 Taco Cloud API 来提交 taco 订单。

无论选择那种服务激活器的实现，对流本身没有什么影响。但是，因为你会需要一些类型来代表的 tao、order 和 ingredient，这些需要与你在 Taco Cloud 应用程序中定义的那些有一些不一样。因此在一个单独的应用程序中集成信息流，可以避免与现有的域类型混淆进行。

还可以选择使用 XML 配置、Java 配置或 Java DSL 来定义流。我比较喜欢 Java DSL 的优雅，哈哈，这就是你会用到的。随意啦，你如果对一点点额外的挑战有兴趣，可以使用其他配置风格来书写这个流。现在，让我们来看看在 Java DSL 配置下的 taco 订单电子邮件流。

{% code title=”程序清单 9.5 定义一个集成流接收电子邮件并将它们作为订单提交” %}

  1. package tacos.email;
  2. import org.springframework.context.annotation.Bean;
  3. import org.springframework.context.annotation.Configuration;
  4. import org.springframework.integration.dsl.IntegrationFlow;
  5. import org.springframework.integration.dsl.IntegrationFlows;
  6. import org.springframework.integration.dsl.Pollers;
  7. ​
  8. @Configuration
  9. public class TacoOrderEmailIntegrationConfig {
  11.     @Bean
  12.     public IntegrationFlow tacoOrderEmailFlow(
  13.         EmailProperties emailProps,
  14.         EmailToOrderTransformer emailToOrderTransformer,
  15.         OrderSubmitMessageHandler orderSubmitHandler) {
  17.         return IntegrationFlows
  18.             .from(
  19.               Mail.imapInboundAdapter(emailProps.getImapUrl()),
  20.               e -> e.poller(
  21.                   Pollers.fixedDelay(emailProps.getPollRate())))
  22.             .transform(emailToOrderTransformer)
  23.             .handle(orderSubmitHandler)
  24.             .get();
  25.     }
  26. }

{% endcode %}

taco 订单电子邮件流（在 tacoOrderEmailFlow() 方法中的定义）是由三个不同的部分组成：

  • IMAP 电子邮件入站信道适配器 —— 根据 EmailProperties 的 getImapUrl() 方法返回的 IMP URL 来创建通道适配器，根据 pollRate属性来设定轮询延时。进来的电子邮件被移交到它连接到转换器的通道。
  • 一种将电子邮件转换为订单对象的转换器 —— 在 EmailToOrderTransformer 中实现的转换器，其被注入到 tacoOrderEmailFlow() 方法中。从转换中所产生的订单通过另外一个通道扇出到最终组件中。
  • *处理程序（作为出站通道适配器）—— 处理程序接收一个订单对象，并将其提交到 Taco Cloud 的 REST API。

可以通过将 Email 端点模块作为项目构建的依赖项，就可以对 Mail.imapInboundAdapter() 进行调用。Maven 的依赖关系如下所示：

  1. <dependency>
  2.     <groupId>org.springframework.integration</groupId>
  3.     <artifactId>spring-integration-file</artifactId>
  4. </dependency>

EmailToOrderTransformer 这个类，通过继承 AbstractMailMessageTransformer 的方式，实现了 Spring Integration 中的 Transformer 接口，如程序清单 9.6 所示。

{% code title=”程序清单 9.6 使用集成转换器将到来的邮件转换为 taco 订单” %}

  1. @Component
  2. public class EmailToOrderTransformer extends AbstractMailMessageTransformer<Order> {
  3.     @Override
  4.     protected AbstractIntegrationMessageBuilder<Order>
  5.         doTransform(Message mailMessage) throws Exception {
  6.         Order tacoOrder = processPayload(mailMessage);
  7.         return MessageBuilder.withPayload(tacoOrder);
  8.     }
  9.     ...
  10. }

{% endcode %}

AbstractMailMessageTransformer 是处理其有效载荷为电子邮件消息的基类，其着重于，从到来的消息中将邮件信息提取到，通过 doTransform() 方法传入的 Message 对象中。

在 doTransform() 方法中，把 Message 传递到名 processPayload() 的 private 方法中，在其中将电子邮件解析为 Order 对象。这里的 Order 对象与 Taco Cloud 主应用程序中的 Order 对象虽然有些相似，但是还是不同的，它稍微简单一些：

  1. package tacos.email;
  2. import java.util.ArrayList;
  3. import java.util.List;
  4. import lombok.Data;
  5. ​
  6. @Data
  7. public class Order {
  8.     private final String email;
  9.     private List<Taco> tacos = new ArrayList<>();
  11.     public void addTaco(Taco taco) {
  12.         this.tacos.add(taco);
  13.     }
  14. }

与用于在客户的整个交付和账单信息不同，这个 Order 类只携带了客户的电子邮件。

将电子邮件解析为 taco 订单是一个有意义的事情。事实上，即使是一个简单的实现，都会涉及到几十行代码。而这几十行的代码对 Spring Integration 和如何实现转换器的讨论是没有更多的帮助的。因此，为了节省空间，准备放下对 processPayload() 方法的详细实现。

该 EmailToOrderTransformer 做的最后一件事就是返回包含 Order 对象有效载荷的 MessageBuilder。由 MessageBuilder 产生的消息，被发送到集成信息流的最后一个部分：消息处理器，推送订单到 Taco Cloud API。OrderSubmitMessageHandler，如下所示，实现了 Spring Integration 的 GenericHandler 接口，用于处理携带 Order 有效载荷的消息。

{% code title=”程序清单 9.7 通过消息处理器传输订单到 Taco Cloud API” %}

  1. package tacos.email;
  2. import java.util.Map;
  3. import org.springframework.integration.handler.GenericHandler;
  4. import org.springframework.stereotype.Component;
  5. import org.springframework.web.client.RestTemplate;
  6. ​
  7. @Component
  8. public class OrderSubmitMessageHandler
  9.              implements GenericHandler<Order> {
  10.     private RestTemplate rest;
  11.     private ApiProperties apiProps;
  13.     public OrderSubmitMessageHandler(
  14.         ApiProperties apiProps, RestTemplate rest) {
  15.         this.apiProps = apiProps;
  16.         this.rest = rest;
  17.     }
  19.     @Override
  20.     public Object handle(Order order, Map<String, Object> headers) {
  21.         rest.postForObject(apiProps.getUrl(), order, String.class);
  22.         return null;
  23.     }
  24. }

{% endcode %}

为了满足 GenericHandler 接口的要求，OrderSubmitMessageHandler 重写 handle() 方法。这个方法接收传入 Order 对象，并使用注入的 RestTemplate 通过 POST 请求中注入 ApiProperties 对象捕获的 URL 提交订单。最后，handler() 方法返回 null 以指示流处理结束。

ApiProperties 是为了避免在调用 postForObject() 方法时对 URL 进行硬编码。这是一个配置属性文件，看起来像这样：

  1. @Data
  2. @ConfigurationProperties(prefix="tacocloud.api")
  3. @Component
  4. public class ApiProperties {
  5.     private String url;
  6. }

在 application.yml，Taco Cloud API 的 URL 可能会像这样被配置：

  1. tacocloud:
  2.   api:
  3.     url: http://api.tacocloud.com

为了使 RestTemplate 在项目中可用，它被注入到 OrderSubmitMessageHandler 中，需要将 Spring Boot web starter 中添加到项目构建中：

  1. <dependency>
  2.     <groupId>org.springframework.boot</groupId>
  3.     <artifactId>spring-boot-starter-web</artifactId>
  4. </dependency>

这使得 RestTemplate 在 classpath 中可用，这也触发了 Spring MVC 的自动配置。作为一个独立的 Spring Integration 流，应用程序并不需要 Spring MVC，或是嵌入的Tomcat。因此，你应该在 application.yml 中禁用 Spring MVC 的自动配置：

  1. spring:
  2.   main:
  3.     web-application-type: none

spring.main.web-application-type 属性可以被设置为 servlet、reactive 或是 none，当 Spring MVC 在 classpath 中时，自动配置将这个值设置为 servlet。但是这里需要将其重写为 none，这样 Spring MVC 和 Tomcat 就不会自动配置了。（我们将在 11 章讨论将其作为一个响应式 web 应用程序的意义）。