使用 Spring 集成创建一个简单的应用程序的过程

本指南将引导您完成使用 Spring 集成创建一个简单的应用程序的过程，该应用程序从 RSS 源（Spring 博客）检索数据，操作数据，然后将其写入文件。本指南使用传统的 Spring Integration XML 配置。其他指南展示了如何在有和没有JDK 8 Lambda表达式的情况下使用Java配置和DSL。

您将构建什么

您将使用传统的 XML 配置创建具有 Spring 集成的流。

你需要什么

• 约15分钟
• 最喜欢的文本编辑器或 IDE
• JDK 1.8或以后
• 格拉德尔 4+或梅文 3.2+
• 您也可以将代码直接导入到 IDE 中：

• 弹簧工具套件 （STS）
• 智能理念
• VSCode

如何完成本指南

像大多数春天一样入门指南，您可以从头开始并完成每个步骤，也可以绕过您已经熟悉的基本设置步骤。无论哪种方式，您最终都会得到工作代码。

要从头开始，请继续从 Spring 初始化开始.

要跳过基础知识，请执行以下操作：

• 下载​并解压缩本指南的源存储库，或使用吉特:git clone https://github.com/spring-guides/gs-integration.git
• 光盘成gs-integration/initial
• 跳转到定义集成流.

完成后，您可以根据 中的代码检查结果。​​gs-integration/complete​​

从 Spring 初始化开始

你可以使用这个预初始化项目，然后单击生成以下载 ZIP 文件。此项目配置为适合本教程中的示例。

手动初始化项目：

1. 导航到https://start.spring.io.此服务拉入应用程序所需的所有依赖项，并为您完成大部分设置。
2. 选择 Gradle 或 Maven 以及您要使用的语言。本指南假定您选择了 Java。
3. 单击依赖关系，然后选择 Spring 集成。
4. 单击生成。
5. 下载生成的 ZIP 文件，该文件是配置了您选择的 Web 应用程序的存档。

Add to the Build Files

For this example, you need to add two dependencies:

• ​​spring-integration-feed​​
• ​​spring-integration-file​​

The following listing shows the final file:​​pom.xml​​

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>3.0.0</version>
    <relativePath/> <!-- lookup parent from repository -->
  </parent>
  <groupId>com.example</groupId>
  <artifactId>integration-complete</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <name>integration-complete</name>
  <description>Demo project for Spring Boot</description>

  <properties>
    <java.version>17</java.version>
  </properties>

  <dependencies>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-integration</artifactId>
    </dependency>
    <dependency>
      <groupId>org.springframework.integration</groupId>
      <artifactId>spring-integration-feed</artifactId>
    </dependency>
    <dependency>
      <groupId>org.springframework.integration</groupId>
      <artifactId>spring-integration-file</artifactId>
    </dependency>

    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-test</artifactId>
      <scope>test</scope>
    </dependency>
    <dependency>
      <groupId>org.springframework.integration</groupId>
      <artifactId>spring-integration-test</artifactId>
      <scope>test</scope>
    </dependency>
  </dependencies>

  <build>
    <plugins>
      <plugin>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-maven-plugin</artifactId>
      </plugin>
    </plugins>
  </build>

</project>

下面的清单显示了最终文件：​​build.gradle​​

plugins {
  id 'org.springframework.boot' version '3.0.0'
  id 'io.spring.dependency-management' version '1.1.0'
  id 'java'
}

group = 'com.example'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '17'

repositories {
  mavenCentral()
}

dependencies {
  implementation 'org.springframework.boot:spring-boot-starter-integration'
  implementation 'org.springframework.integration:spring-integration-feed'
  implementation 'org.springframework.integration:spring-integration-file'
  testImplementation('org.springframework.boot:spring-boot-starter-test')
  testImplementation 'org.springframework.integration:spring-integration-test'
}

test {
  useJUnitPlatform()
}

定义集成流

对于本指南的示例应用程序，您将定义一个 Spring 集成流程，该流程：

• 在 spring.io 阅读 RSS 源中的博客文章。
• 将它们转换为易于阅读的帖子，包括帖子标题和帖子的 URL。String
• 将其追加到文件的末尾 （）。String/tmp/si/SpringBlog

要定义集成流，您可以使用Spring Integration的XML命名空间中的一些元素创建一个Spring XML配置。具体来说，对于所需的集成流，您可以使用以下 Spring 集成命名空间中的元素：核心、提要和文件。（获得最后两个是我们必须修改 Spring Initializr 提供的构建文件的原因。

以下 XML 配置文件（来自 ）定义了集成流：​​src/main/resources/integration/integration.xml​​

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:int="http://www.springframework.org/schema/integration"
    xmlns:file="http://www.springframework.org/schema/integration/file"
    xmlns:feed="http://www.springframework.org/schema/integration/feed"
    xsi:schemaLocation="http://www.springframework.org/schema/integration/feed https://www.springframework.org/schema/integration/feed/spring-integration-feed.xsd
        http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/integration/file https://www.springframework.org/schema/integration/file/spring-integration-file.xsd
        http://www.springframework.org/schema/integration https://www.springframework.org/schema/integration/spring-integration.xsd">

    <feed:inbound-channel-adapter id="news" url="https://spring.io/blog.atom" auto-startup="${auto.startup:true}">
        <int:poller fixed-rate="5000"/>
    </feed:inbound-channel-adapter>

    <int:transformer
            input-channel="news"
            expression="payload.title + ' @ ' + payload.link + '#{systemProperties['line.separator']}'"
            output-channel="file"/>

    <file:outbound-channel-adapter id="file"
            mode="APPEND"
            charset="UTF-8"
            directory="/tmp/si"
            filename-generator-expression="'${feed.file.name:SpringBlog}'"/>

</beans>

这里有三个集成元素：

• ​​<feed:inbound-channel-adapter>​​：检索帖子的入站适配器，每个轮询一个。如此处的配置，它每五秒轮询一次。帖子被放置在名为 （对应于适配器的 ID） 的通道中。news
• ​​<int:transformer>​​：转换通道中的条目 （），提取条目的标题 （） 和链接 （），并将它们连接成可读的（并添加换行符）。然后发送到名为 的输出通道。com.rometools.rome.feed.synd.SyndEntrynewspayload.titlepayload.linkStringStringfile
• ​​<file:outbound-channel-adapter>​​：将内容从其通道（名为）写入文件的出站通道适配器。具体而言，如此处的配置，它将通道中的任何内容追加到位于 的文件中。filefile/tmp/si/SpringBlog

下图显示了此简单流程：

暂时忽略该属性。稍后在讨论测试时，我们会重新讨论这一点。现在，请注意，默认情况下它是 ，这意味着在应用程序启动时获取帖子。另请注意 中的属性占位符。这意味着默认值是，但可以用属性覆盖。​​auto-startup​​​​true​​​​filename-generator-expression​​​​SpringBlog​​

使应用程序可执行

尽管在较大的应用程序（甚至可能是 Web 应用程序）中配置 Spring 集成流程很常见，但没有理由不能在更简单的独立应用程序中定义它。这就是您接下来要做的：创建一个启动集成流的主类，并声明一些 bean 来支持集成流。您还将应用程序构建到独立的可执行 JAR 文件中。我们使用 Spring Boot 的注释来创建应用程序上下文。由于本指南将 XML 命名空间用于集成流，因此您必须使用注释将其加载到应用程序上下文中。以下清单（来自）显示了应用程序文件：​​@SpringBootApplication​​​​@ImportResource​​​​src/main/java/com/example/integration/IntegrationApplication.java​​

package com.example.integration;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.context.annotation.ImportResource;

@SpringBootApplication
@ImportResource("/integration/integration.xml")
public class IntegrationApplication {
  public static void main(String[] args) throws Exception {
    ConfigurableApplicationContext ctx = new SpringApplication(IntegrationApplication.class).run(args);
    System.out.println("Hit Enter to terminate");
    System.in.read();
    ctx.close();
  }

}

构建可执行的 JAR

您可以使用 Gradle 或 Maven 从命令行运行应用程序。您还可以构建一个包含所有必需依赖项、类和资源的可执行 JAR 文件并运行该文件。通过构建可执行 jar，可以轻松地在整个开发生命周期中跨不同环境等将服务作为应用程序进行交付、版本控制和部署。

如果使用 Gradle，则可以使用 .或者，您可以使用 JAR 文件生成 JAR 文件，然后运行该文件，如下所示：​​./gradlew bootRun​​​​./gradlew build​​

java -jar build/libs/gs-integration-0.1.0.jar

如果使用 Maven，则可以使用 运行应用程序。或者，您可以使用 JAR 文件生成 JAR 文件，然后运行该文件，如下所示：​​./mvnw spring-boot:run​​​​./mvnw clean package​​

java -jar target/gs-integration-0.1.0.jar

运行应用程序

现在，您可以通过运行以下命令从 jar 运行应用程序：

java -jar build/libs/{project_id}-0.1.0.jar

... app starts up ...

应用程序启动后，它将连接到 RSS 源并开始获取博客文章。应用程序通过您定义的集成流程处理这些帖子，最终将帖子信息追加到位于 的文件中。​​/tmp/si/SpringBlog​​

应用程序运行一段时间后，您应该能够查看文件以查看来自少数帖子的数据。在基于 UNIX 的操作系统上，还可以通过运行以下命令来查看写入结果的文件：​​/tmp/si/SpringBlog​​​​tail​​

tail -f /tmp/si/SpringBlog

您应该看到类似于以下示例输出的内容（尽管实际新闻会有所不同）：

Spring Integration Java DSL 1.0 GA Released @ https://spring.io/blog/2014/11/24/spring-integration-java-dsl-1-0-ga-released
This Week in Spring - November 25th, 2014 @ https://spring.io/blog/2014/11/25/this-week-in-spring-november-25th-2014
Spring Integration Java DSL: Line by line tutorial @ https://spring.io/blog/2014/11/25/spring-integration-java-dsl-line-by-line-tutorial
Spring for Apache Hadoop 2.1.0.M2 Released @ https://spring.io/blog/2014/11/14/spring-for-apache-hadoop-2-1-0-m2-released

测试

检查项目，您将看到一个测试用例，位于：​​complete​​​​src/test/java/com/example/integration/FlowTests.java​​

package com.example.integration;

import static org.assertj.core.api.Assertions.assertThat;

import java.io.BufferedReader;
import java.io.File;
import java.io.FileReader;

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.integration.endpoint.SourcePollingChannelAdapter;
import org.springframework.integration.support.MessageBuilder;
import org.springframework.messaging.MessageChannel;

import com.rometools.rome.feed.synd.SyndEntryImpl;

@SpringBootTest({ "auto.startup=false",   // we don't want to start the real feed
          "feed.file.name=Test" })   // use a different file
public class FlowTests {

  @Autowired
  private SourcePollingChannelAdapter newsAdapter;

  @Autowired
  private MessageChannel news;

  @Test
  public void test() throws Exception {
    assertThat(this.newsAdapter.isRunning()).isFalse();
    SyndEntryImpl syndEntry = new SyndEntryImpl();
    syndEntry.setTitle("Test Title");
    syndEntry.setLink("http://characters/frodo");
    File out = new File("/tmp/si/Test");
    out.delete();
    assertThat(out.exists()).isFalse();
    this.news.send(MessageBuilder.withPayload(syndEntry).build());
    assertThat(out.exists()).isTrue();
    BufferedReader br = new BufferedReader(new FileReader(out));
    String line = br.readLine();
    assertThat(line).isEqualTo("Test Title @ http://characters/frodo");
    br.close();
    out.delete();
  }

}

此测试使用 Spring Boot 的测试支持来设置名为 的属性。依靠网络连接进行测试通常不是一个好主意，尤其是在 CI 环境中。相反，我们阻止馈送适配器启动并将 a 注入通道，以便由流的其余部分进行处理。测试还会设置 以便测试写入其他文件。然后它：​​auto.startup​​​​false​​​​SyndEntry​​​​news​​​​feed.file.name​​

• 验证适配器是否已停止。
• 创建测试 。SyndEntry
• 删除测试输出文件（如果存在）。
• 发送消息。
• 验证文件是否存在。
• 读取文件并验证数据是否符合预期。

总结

祝贺！您已经开发了一个简单的应用程序，该应用程序使用 Spring 集成从 spring.io 获取博客文章，处理它们并将它们写入文件。