本文主要是介绍SpringBoot 2 基于 SpringIntegration 获取 RSS Feed(Spring Blog)帖子信息,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!
开篇词
该指南将引导你使用 Spring Integration 创建一个简单的应用,该应用将从 RSS Feed(Spring Blog)中检索数据,处理数据,然后将其写入文件。该指南使用传统的 Spring Integration XML 配置。其他指南展示了如何在带和不带 JDK 8 Lambda 表达式的情况下使用 Java Configuration 和 DSL。
你将创建的应用
我们将使用传统的 XML 配置通过 Spring Integration 创建一个流。
你将需要的工具
- 大概 15 分钟左右;
- 你最喜欢的文本编辑器或集成开发环境(IDE)
- JDK 1.8 或更高版本;
- Gradle 4+ 或 Maven 3.2+
- 你还可以将代码直接导入到 IDE 中:
- Spring Too Suite (STS)
- IntelliJ IDEA
如何完成这个指南
像大多数的 Spring 入门指南一样,你可以从头开始并完成每个步骤,也可以绕过你已经熟悉的基本设置步骤。如论哪种方式,你最终都有可以工作的代码。
- 要从头开始,移步至从 Spring Initializr 开始;
- 要跳过基础,执行以下操作:
- 下载并解压缩该指南将用到的源代码,或借助 Git 来对其进行克隆操作:
git clone https://github.com/spring-guides/gs-integration.git
- 切换至
gs-integration/initial
目录; - 跳转至该指南的定义集成流。
- 下载并解压缩该指南将用到的源代码,或借助 Git 来对其进行克隆操作:
待一切就绪后,可以检查一下 gs-integration/complete
目录中的代码。
从 Spring Initializr 开始
对于所有的 Spring 应用来说,你应该从 Spring Initializr 开始。Initializr 提供了一种快速的方法来提取应用程序所需的依赖,并为你完成许多设置。该示例仅需要 Spring Integration 依赖。下图显示了此示例项目的 Initializr 设置:
上图显示了选择 Maven 作为构建工具的 Initializr。你也可以使用 Gradle。它还将
com.example
和integration
的值分别显示为 Group 和 Artifact。在本示例的其余部分,将用到这些值。
以下清单显示了选择 Maven 时创建的 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.2.0.RELEASE</version><relativePath/> <!-- lookup parent from repository --></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><exclusions><exclusion><groupId>org.junit.vintage</groupId><artifactId>junit-vintage-engine</artifactId></exclusion></exclusions></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 时创建的 build.gradle
文件:
plugins {id 'org.springframework.boot' version '2.2.0.RELEASE'id 'io.spring.dependency-management' version '1.0.8.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') {exclude group: 'org.junit.vintage', module: 'junit-vintage-engine'}testImplementation 'org.springframework.integration:spring-integration-test'
}test {useJUnitPlatform()
}
添加至构建文件
该示例需要添加两个依赖:
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.2.0.RELEASE</version><relativePath/> <!-- lookup parent from repository --></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><exclusions><exclusion><groupId>org.junit.vintage</groupId><artifactId>junit-vintage-engine</artifactId></exclusion></exclusions></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 '2.2.0.RELEASE'id 'io.spring.dependency-management' version '1.0.8.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') {exclude group: 'org.junit.vintage', module: 'junit-vintage-engine'}testImplementation 'org.springframework.integration:spring-integration-test'
}test {useJUnitPlatform()
}
定义集成流
对于该指南的示例应用,我们将定义一个 Spring Integration 流:
- 从 spring.io 的 RSS feed 中阅读博客文章;
- 将它们转换为易于阅读的
String
,该字符串由帖子标题和帖子的 URL 所组成; - 将该
String
附加到文件(/tmp/si/SpringBlog
)的末尾。
要定义集成流,我们可以创建一个 Spring XML 配置,其中包含 Spring Integration 的 XML 命名空间中的一些元素。具体来说,对于所需的集成流,我们可以使用来自以下 Spring Integration 命名空间的元素:core、feed 以及 file。(获得最后两个是我们不得不修改 Spring Initialize 提供的构建文件的原因。)
以下 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.xsdhttp://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsdhttp://www.springframework.org/schema/integration/file https://www.springframework.org/schema/integration/file/spring-integration-file.xsdhttp://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:transformerinput-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>
:将news
频道中的条目(com.rometools.rome.feed.synd.SyndEntry
)进行转换,提取条目的标题(payload.title
)和链接(payload.link
),然后将它们串联成可读的String
(并添加换行符)。然后将String
发送至名为file
的输出通道;<file:outbound-channel-adapter>
:一个出站通道适配器,它将内容从其通道(命名file
)写入文件。具体来说,如该处配置,它将file
通道中的所有内容附加至/tmp/si/SpringBlog
文件中。
下图显示了该简单流:
先忽略 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
来运行应用。或通过借助 ./gradlew build
来构建 JAR 文件,然后运行 JAR 文件,如下所示:
java -jar build/libs/gs-integration-0.1.0.jar
由官网提供的以上这条命令的执行结果与我本地的不一样,我需要这样才能运行:
java -jar build/libs/integration-0.0.1-SNAPSHOT.jar
。
如果使用 Maven,则可以借助 ./mvnw spring-boot:run
来运行该用。或可以借助 ./mvnw clean package
来构建 JAR 文件,然后运行 JAR 文件,如下所示:
java -jar target/gs-integration-0.1.0.jar
由官网提供的以上这条命令的执行结果与我本地的不一样,我需要这样才能运行:
java -jar target/integration-0.0.1-SNAPSHOT.jar
。
我们还可以构建一个经典的 WAR 文件。
运行应用之后
应用启动之后,它将连接至 RSS feed,并开始获取博客文章。应用通过我们定义的集成流来处理这些帖子,最终将帖子信息追加至 /tmp/si/SpringBlog
文件中。
在应用运行了一段时间之后,我们应该能够在 /tmp/si/SpringBlog
上查看文件,以查看少量文章中的数据。在基于 *nix 的操作系统上,我们还可以通过运行以下命令来从 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
测试
检查整个项目,我们将在 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 {@Autowiredprivate SourcePollingChannelAdapter newsAdapter;@Autowiredprivate MessageChannel news;@Testpublic 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 中获取博客文章,对其进行处理并将其写入文件。
参见
以下指南也可能会有所帮助:
- 使用 Spring Boot 构建应用(尽请期待~)
想看指南的其他内容?请访问该指南的所属专栏:《Spring 官方指南》
这篇关于SpringBoot 2 基于 SpringIntegration 获取 RSS Feed(Spring Blog)帖子信息的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!