9.3创建email集成流

9.3创建email集成流

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

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

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

@Data
@ConfigurationProperties(prefix="tacocloud.email")
@Component
public class EmailProperties {
    private String username;
    private String password;
    private String host;
    private String mailbox;
    private long pollRate = 30000;

    public String getImapUrl() {
        return String.format("imaps://%s:%s@%s/%s",
             this.username, this.password, this.host, this.mailbox);
    }
}

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

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

tacocloud:
  email:
    host: imap.tacocloud.com
    mailbox: INBOX
    username: taco-in-flow
    password: 1L0v3T4c0s
    poll-rate: 10000

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

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

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

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

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

程序清单9.5定义一个集成流接收电子邮件并将它们作为订单提交

package tacos.email;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.integration.dsl.IntegrationFlow;
import org.springframework.integration.dsl.IntegrationFlows;
import org.springframework.integration.dsl.Pollers;

@Configuration
public class TacoOrderEmailIntegrationConfig {

    @Bean
    public IntegrationFlow tacoOrderEmailFlow(
        EmailProperties emailProps,
        EmailToOrderTransformer emailToOrderTransformer,
        OrderSubmitMessageHandler orderSubmitHandler) {

        return IntegrationFlows
            .from(
              Mail.imapInboundAdapter(emailProps.getImapUrl()),
              e -> e.poller(
                  Pollers.fixedDelay(emailProps.getPollRate())))
            .transform(emailToOrderTransformer)
            .handle(orderSubmitHandler)
            .get();
    }
}

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

  • IMAP电子邮件入站信道适配器 —— 根据EmailPropertiesgetImapUrl()方法返回的IMP URL来创建通道适配器,根据pollRate属性来设定轮询延时。进来的电子邮件被移交到它连接到转换器的通道。

  • 一种将电子邮件转换为订单对象的转换器 —— 在EmailToOrderTransformer中实现的转换器,其被注入到tacoOrderEmailFlow()方法中。从转换中所产生的订单通过另外一个通道扇出到最终组件中。

  • *处理程序(作为出站通道适配器)—— 处理程序接收一个订单对象,并将其提交到Taco CloudREST API

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

<dependency>
    <groupId>org.springframework.integration</groupId>
    <artifactId>spring-integration-file</artifactId>
</dependency>

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

程序清单9.6使用集成转换器将到来的邮件转换为taco订单

@Component
public class EmailToOrderTransformer extends AbstractMailMessageTransformer<Order> {
    @Override
    protected AbstractIntegrationMessageBuilder<Order>
        doTransform(Message mailMessage) throws Exception {
        Order tacoOrder = processPayload(mailMessage);
        return MessageBuilder.withPayload(tacoOrder);
    }
    ...
}

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

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

package tacos.email;
import java.util.ArrayList;
import java.util.List;
import lombok.Data;

@Data
public class Order {
    private final String email;
    private List<Taco> tacos = new ArrayList<>();

    public void addTaco(Taco taco) {
        this.tacos.add(taco);
    }
}

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

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

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

程序清单9.7通过消息处理器传输订单到Taco Cloud API

package tacos.email;
import java.util.Map;
import org.springframework.integration.handler.GenericHandler;
import org.springframework.stereotype.Component;
import org.springframework.web.client.RestTemplate;

@Component
public class OrderSubmitMessageHandler
             implements GenericHandler<Order> {
    private RestTemplate rest;
    private ApiProperties apiProps;

    public OrderSubmitMessageHandler(
        ApiProperties apiProps, RestTemplate rest) {
        this.apiProps = apiProps;
        this.rest = rest;
    }

    @Override
    public Object handle(Order order, Map<String, Object> headers) {
        rest.postForObject(apiProps.getUrl(), order, String.class);
        return null;
    }
}

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

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

@Data
@ConfigurationProperties(prefix="tacocloud.api")
@Component
public class ApiProperties {
    private String url;
}

application.ymlTaco Cloud APIURL可能会像这样被配置:

tacocloud:
  api:
    url: http://api.tacocloud.com

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

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

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

spring:
  main:
    web-application-type: none

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

上一页
下一页