使用Spring Integration · springboot官方文檔中文版

# 整合資料本指南將引導您完成使用Spring Integration創建一個簡單應用程序的過程，該應用程序將從RSS Feed（Spring Blog）中檢索數據，處理數據，然后將其寫入文件。本指南使用傳統的Spring Integration XML配置。其他指南顯示了如何在帶有和不帶有JDK 8 Lambda表達式的情況下使用Java Configuration和DSL。 ## 你會建立什么您將使用傳統的XML配置通過Spring Integration創建一個流程。 ## 你需要什么 * 約15分鐘 * 最喜歡的文本編輯器或IDE * [JDK 1.8](http://www.oracle.com/technetwork/java/javase/downloads/index.html) 或更高版本 * [Gradle 4+](http://www.gradle.org/downloads) 或 [Maven 3.2+](https://maven.apache.org/download.cgi) * 您還可以將代碼直接導入到IDE中： * [彈簧工具套件（STS）](https://spring.io/guides/gs/sts) * [IntelliJ IDEA](https://spring.io/guides/gs/intellij-idea/) ## 如何完成本指南像大多數Spring 一樣 [入門指南](https://spring.io/guides) ，您可以從頭開始并完成每個步驟，也可以繞過您已經熟悉的基本設置步驟。無論哪種方式，您最終都可以使用代碼。要 **從頭開始** ，請繼續進行“ [從Spring Initializr開始”](https://spring.io/guides/gs/integration/#scratch) 。要 **跳過基礎知識** ，請執行以下操作： * [下載](https://github.com/spring-guides/gs-integration/archive/master.zip) 并解壓縮本指南的源存儲庫，或使用對其進行克隆 [Git](https://spring.io/understanding/Git) ： `git clone [https://github.com/spring-guides/gs-integration.git](https://github.com/spring-guides/gs-integration.git)` * 光盤進入 `gs-integration/initial` * 繼續 [定義集成流程](https://spring.io/guides/gs/integration/#initial) 。 **完成后** ，您可以根據中的代碼檢查結果 `gs-integration/complete`. ## 從Spring Initializr開始如果您使用Maven，請訪問 [Spring Initializr](https://start.spring.io/#!type=maven-project&language=java&platformVersion=2.4.3.RELEASE&packaging=jar&jvmVersion=11&groupId=com.example&artifactId=integration&name=integration&description=Demo%20project%20for%20Spring%20Boot&packageName=com.example.integration&dependencies=integration) 以生成具有所需依賴項的新項目（Spring Integration）。以下清單顯示了 `pom.xml` 選擇Maven時創建的文件： ~~~ <?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>2.4.3</version> <relativePath/>  </parent> <groupId>com.example</groupId> <artifactId>integration</artifactId> <version>0.0.1-SNAPSHOT</version> <name>integration</name> <description>Demo project for Spring Boot</description> <properties> <java.version>1.8</java.version> </properties> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-integration</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> ~~~ 如果您使用Gradle，請訪問 [Spring Initializr](https://start.spring.io/#!type=gradle-project&language=java&platformVersion=2.4.3.RELEASE&packaging=jar&jvmVersion=11&groupId=com.example&artifactId=integration&name=integration&description=Demo%20project%20for%20Spring%20Boot&packageName=com.example.integration&dependencies=integration) 以生成具有所需依賴項的新項目（Spring Integration）。以下清單顯示了 `build.gradle` 選擇Gradle時創建的文件： ~~~ plugins { id 'org.springframework.boot' version '2.4.3' id 'io.spring.dependency-management' version '1.0.11.RELEASE' id 'java' } group = 'com.example' version = '0.0.1-SNAPSHOT' sourceCompatibility = '1.8' repositories { mavenCentral() } dependencies { implementation 'org.springframework.boot:spring-boot-starter-integration' testImplementation('org.springframework.boot:spring-boot-starter-test') testImplementation 'org.springframework.integration:spring-integration-test' } test { useJUnitPlatform() } ~~~ ### 手動初始化（可選）如果要手動初始化項目而不是使用前面顯示的鏈接，請按照以下步驟操作： 1. 導航到 [https://start.spring.io](https://start.spring.io) 。該服務提取應用程序所需的所有依賴關系，并為您完成大部分設置。 2. 選擇Gradle或Maven以及您要使用的語言。本指南假定您選擇了Java。 3. 單擊 **Dependencies，** 然后選擇 **Spring Integration** 。 4. 點擊 **生成** 。 5. 下載生成的ZIP文件，該文件是使用您的選擇配置的Web應用程序的存檔。如果您的IDE集成了Spring Initializr，則可以從IDE中完成此過程。 ## 添加到構建文件對于此示例，您需要添加兩個依賴項： * `spring-integration-feed` * `spring-integration-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>2.4.3</version> <relativePath/>  </parent> <groupId>com.example</groupId> <artifactId>integration</artifactId> <version>0.0.1-SNAPSHOT</version> <name>integration</name> <description>Demo project for Spring Boot</description> <properties> <java.version>1.8</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> ~~~ The following listing shows the final `build.gradle` file: ~~~ plugins { id 'org.springframework.boot' version '2.4.3' id 'io.spring.dependency-management' version '1.0.11.RELEASE' id 'java' } group = 'com.example' version = '0.0.1-SNAPSHOT' sourceCompatibility = '1.8' 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 Integration流程，該流程： * 從spring.io的RSS feed中閱讀博客文章。 * 將它們轉換為易于閱讀的 `String` 由帖子標題和帖子的網址組成。 * 追加 `String` 到文件末尾（ `/tmp/si/SpringBlog`). 要定義集成流程，您可以使用Spring Integration的XML名稱空間中的一些元素來創建Spring XML配置。具體來說，對于所需的集成流程，您可以使用這些Spring Integration名稱空間中的元素：核心，提要和文件。（獲得最后兩個是為什么我們必須修改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>`：檢索入站適配器的入站適配器，每個輪詢一個。按照此處的配置，它每五秒鐘輪詢一次。帖子被放置在名為的頻道中 `news` （對應于適配器的ID）。 * `<int:transformer>`：轉換條目（ `com.rometools.rome.feed.synd.SyndEntry`）在里面 `news` 頻道，提取條目的標題（ `payload.title`）并鏈接（ `payload.link`）并將它們連接成可讀的 `String`（并添加換行符）。這 `String` 然后發送到名為 `file`. * `<file:outbound-channel-adapter>`：一個出站通道適配器，它從其通道寫入內容（名為 `file`）到文件。具體來說，如此處配置的那樣，它會將任何內容附加到 `file` 引導至位于的文件 `/tmp/si/SpringBlog`. 下圖顯示了此簡單流程： ![讀取RSS feed條目的流](https://raw.githubusercontent.com/spring-guides/gs-integration/master/images/blogToFile.png) 忽略 `auto-startup`現在的屬性。我們稍后在討論測試時會重新討論。現在，請注意，默認情況下， `true`，這意味著在應用程序啟動時提取帖子。還要注意屬性占位符在 `filename-generator-expression`。這意味著默認值為 `SpringBlog` 但可以用屬性覆蓋。 ## 使應用程序可執行盡管通常在較大的應用程序（甚至是Web應用程序）中配置Spring Integration流，但沒有理由不能在更簡單的獨立應用程序中定義它。接下來，您將要做的是：創建一個開始集成流程的主類，該主類聲明了少數支持集成流程的bean。您還將把應用程序構建到一個獨立的可執行JAR文件中。我們使用Spring Boot的 `@SpringBootApplication`注釋以創建應用程序上下文。由于本指南將XML名稱空間用于集成流程，因此您必須使用 `@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，則可以通過使用以下命令運行該應用程序 `./gradlew bootRun`。或者，您可以通過使用以下命令構建JAR文件： `./gradlew build` 然后運行JAR文件，如下所示： ~~~ java -jar build/libs/gs-integration-0.1.0.jar ~~~ 如果您使用Maven，則可以通過使用以下命令運行該應用程序 `./mvnw spring-boot:run`。或者，您可以使用以下命令構建JAR文件： `./mvnw clean package` 然后運行JAR文件，如下所示： ~~~ java -jar target/gs-integration-0.1.0.jar ~~~ 此處描述的步驟將創建可運行的JAR。您還可以構建經典的WAR文件。 ## 運行應用程序現在，您可以通過運行以下命令從jar運行應用程序： ~~~ java -jar build/libs/{project_id}-0.1.0.jar ... app starts up ... ~~~ 應用程序啟動后，它將連接到RSS feed并開始獲取博客文章。應用程序通過您定義的集成流程處理這些帖子，最終將帖子信息附加到位于以下位置的文件中： `/tmp/si/SpringBlog`. 應用程序運行了一段時間后，您應該可以在以下位置查看文件： `/tmp/si/SpringBlog`查看少量帖子中的數據。在基于UNIX的操作系統上，您還可以 `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的測試支持來設置名為 `auto.startup` 到 `false`。依靠網絡連接進行測試通常不是一個好主意，尤其是在CI環境中。相反，我們阻止Feed適配器啟動，并注入一個 `SyndEntry` 進入 `news`其余流程處理的通道。該測試還設置了 `feed.file.name`以便測試寫入另一個文件。然后： * 驗證適配器已停止。 * 創建一個測試 `SyndEntry`. * 刪除測試輸出文件（如果存在）。 * 發送消息。 * 驗證文件是否存在。 * 讀取文件并驗證數據是否符合預期。 ## 概括恭喜你！您已經開發了一個簡單的應用程序，該應用程序使用Spring Integration從spring.io中獲取博客文章，對其進行處理并將其寫入文件。