本指南将引导您完成在程序的不同部分或不同程序之间交换消息的过程,使用弹簧集成通道适配器和谷歌云发布/订阅作为底层消息交换机制。
您将构建的内容
一个弹簧启动向自身发送消息并处理这些消息的 Web 应用程序。
你需要什么
- 约15分钟
- 最喜欢的文本编辑器或 IDE
- JDK 1.8或以后
- 格拉德尔 4+或梅文 3.2+
- 您也可以将代码直接导入到 IDE 中:
- 弹簧工具套件 (STS)
- 智能理念
- VSCode
- 启用了计费和发布/订阅功能的 Google Cloud Platform 项目
- 谷歌云软件开发工具包
如何完成本指南
像大多数春天一样入门指南,您可以从头开始并完成每个步骤,也可以绕过您已经熟悉的基本设置步骤。无论哪种方式,您最终都会得到工作代码。
要从头开始,请继续使用 Gradle 构建.
要跳过基础知识,请执行以下操作:
- 下载并解压缩本指南的源存储库,或使用吉特:
git clone https://github.com/spring-guides/gs-messaging-gcp-pubsub.git
- 光盘成
gs-messaging-gcp-pubsub/initial
- 跳转到添加所需的依赖项.
完成后,您可以根据 中的代码检查结果。gs-messaging-gcp-pubsub/complete
使用 Gradle 构建
使用 Maven 构建
使用 IDE 进行构建
添加所需的依赖项
如果您使用的是 Maven,请将以下内容添加到您的文件中:pom.xml
<dependencies>
...
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-gcp-starter-pubsub</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.integration</groupId>
<artifactId>spring-integration-core</artifactId>
</dependency>
...
</dependencies>
或者,如果您使用的是 Gradle:
dependencies {
...
compile("org.springframework.cloud:spring-cloud-gcp-starter-pubsub:1.2.5.RELEASE")
compile("org.springframework.integration:spring-integration-core")
...
}
如果您使用的是 Maven,强烈建议您使用 Spring Cloud GCP 物料清单来控制依赖项的版本:
<properties>
...
<spring-cloud-gcp.version>1.2.5.RELEASE</spring-cloud-gcp.version>
...
</properties>
<dependencyManagement>
<dependencies>
...
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-gcp-dependencies</artifactId>
<version>${spring-cloud-gcp.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
...
</dependencies>
</dependencyManagement>
设置 Google Cloud 发布/订阅环境
您需要一个主题和一个订阅才能从 Google Cloud Pub/Sub 发送和接收消息。您可以在谷歌云控制台或者,以编程方式使用类。PubSubAdmin
在本练习中,创建一个名为“testTopic”的主题和一个名为“testSubscription”的主题的订阅。
创建应用程序文件
您需要一个类来包含通道适配器和消息传递配置。创建一个带有 @SpringBootApplication 标头的 PubSubApplication 类,就像 Spring Boot 应用程序的典型情况一样。
src/main/java/hello/PubSubApplication.java
@SpringBootApplication
public class PubSubApplication {
public static void main(String[] args) throws IOException {
SpringApplication.run(PubSubApplication.class, args);
}
}
此外,由于您正在构建 Web 应用程序,因此请创建一个 WebAppController 类以在控制器和配置逻辑之间分离。
src/main/java/hello/WebAppController.java
@RestController
public class WebAppController {
}
我们仍然缺少两个用于 HTML 和属性的文件。
src/main/resources/static/index.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Spring Integration GCP sample</title>
</head>
<body>
<div name="formDiv">
<form action="/publishMessage" method="post">
Publish message: <input type="text" name="message" /> <input type="submit" value="Publish!"/>
</form>
</div>
</body>
</html>
src/main/resources/application.properties
#spring.cloud.gcp.project-id=[YOUR_GCP_PROJECT_ID_HERE]
#spring.cloud.gcp.credentials.location=file:[LOCAL_FS_CREDENTIALS_PATH]
Spring Cloud GCP 核心启动启动器可以自动配置这两个属性并使它们可选。属性文件中的属性始终优先于 Spring 引导配置。Spring Cloud GCP Core Boot 启动器与 Spring Cloud GCP Pub/Sub Boot 启动器捆绑在一起。
GCP 项目 ID 是从环境变量自动配置的,其中GOOGLE_CLOUD_PROJECT
其他几个来源.OAuth2 凭据是从GOOGLE_APPLICATION_CREDENTIALS环境变量。如果谷歌云软件开发工具包已安装,可以通过在应用程序的同一进程或父进程中运行命令来轻松配置此环境变量。gcloud auth application-default login
创建入站通道适配器
入站通道适配器侦听来自 Google Cloud 发布/订阅的消息,并将其发送到应用程序中的 Spring 通道。
实例化入站通道适配器需要一个实例和现有订阅的名称。 是 Spring 订阅 Google Cloud Pub/Sub 主题的抽象。Spring Cloud GCP 发布/订阅启动器提供了一个自动配置的实例,您可以简单地将其作为方法参数注入。PubSubTemplate
PubSubTemplate
PubSubTemplate
src/main/java/hello/PubSubApplication.java
@Bean
public PubSubInboundChannelAdapter messageChannelAdapter(
@Qualifier("pubsubInputChannel") MessageChannel inputChannel,
PubSubTemplate pubSubTemplate) {
PubSubInboundChannelAdapter adapter =
new PubSubInboundChannelAdapter(pubSubTemplate, "testSubscription");
adapter.setOutputChannel(inputChannel);
adapter.setAckMode(AckMode.MANUAL);
return adapter;
}
默认情况下,适配器中的消息确认模式设置为自动。此行为可能会被覆盖,如示例中所示。
实例化通道适配器后,必须配置适配器将收到的消息发送到的输出通道。
src/main/java/hello/PubSubApplication.java
@Bean
public MessageChannel pubsubInputChannel() {
return new DirectChannel();
}
附加到入站通道的是用于处理传入消息的服务激活器。
src/main/java/hello/PubSubApplication.java
@Bean
@ServiceActivator(inputChannel = "pubsubInputChannel")
public MessageHandler messageReceiver() {
return message -> {
LOGGER.info("Message arrived! Payload: " + new String((byte[]) message.getPayload()));
BasicAcknowledgeablePubsubMessage originalMessage =
message.getHeaders().get(GcpPubSubHeaders.ORIGINAL_MESSAGE, BasicAcknowledgeablePubsubMessage.class);
originalMessage.ack();
};
}
输入通道名称(例如,)必须与输入通道方法名称匹配。每当新消息到达该通道时,它都会由返回的 .ServiceActivator
"pubsubInputChannel"
MessageHandler
在此示例中,只需记录消息正文并确认消息即可处理消息。在手动确认中,使用对象确认消息,该对象附加到标头,可以使用密钥提取。BasicAcknowledgeablePubsubMessage
Message
GcpPubSubHeaders.ORIGINAL_MESSAGE
创建出站通道适配器
出站通道适配器侦听来自 Spring 通道的新消息,并将其发布到 Google Cloud 发布/订阅主题。
实例化出站通道适配器需要现有主题的 和名称。 是 Spring 将消息发布到 Google Cloud Pub/Sub 主题的抽象。Spring Cloud GCP 发布/订阅启动器提供了一个自动配置的实例。PubSubTemplate
PubSubTemplate
PubSubTemplate
src/main/java/hello/PubSubApplication.java
@Bean
@ServiceActivator(inputChannel = "pubsubOutputChannel")
public MessageHandler messageSender(PubSubTemplate pubsubTemplate) {
return new PubSubMessageHandler(pubsubTemplate, "testTopic");
}
您可以使用 将消息写入频道并将其发布到 Google Cloud Pub/Sub。MessageGateway
src/main/java/hello/PubSubApplication.java
@MessagingGateway(defaultRequestChannel = "pubsubOutputChannel")
public interface PubsubOutboundGateway {
void sendToPubsub(String text);
}
通过此代码,Spring 自动生成一个对象,然后可以将其自动连接到应用程序中的私有字段中。
src/main/java/hello/WebAppController.java
@Autowired
private PubsubOutboundGateway messagingGateway;
添加控制器逻辑
向控制器添加逻辑,以便写入 Spring 通道:
src/main/java/hello/WebAppController.java
package hello;
import hello.PubSubApplication.PubsubOutboundGateway;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.servlet.view.RedirectView;
@RestController
public class WebAppController {
// tag::autowireGateway[]
@Autowired
private PubsubOutboundGateway messagingGateway;
// end::autowireGateway[]
@PostMapping("/publishMessage")
public RedirectView publishMessage(@RequestParam("message") String message) {
messagingGateway.sendToPubsub(message);
return new RedirectView("/");
}
}
认证
应用程序必须通过GOOGLE_APPLICATION_CREDENTIALS环境变量或属性进行身份验证。spring.cloud.gcp.credentials.location
如果您有谷歌云软件开发工具包已安装后,您可以使用该命令使用您的用户帐户登录。gcloud auth application-default login
或者,您可以从谷歌云控制台并将文件中的属性指向它。spring.cloud.gcp.credentials.location
application.properties
作为一个泉水资源,也可以从文件系统以外的地方获取,如 URL、类路径等。spring.cloud.gcp.credentials.location
使应用程序可执行
尽管可以将此服务打包为传统的服务战争文件,下面演示的更简单的方法将创建一个独立的应用程序。您可以将所有内容打包到由 Java 方法驱动的单个可执行 JAR 文件中。此外,您还可以使用 Spring 的支持来嵌入main()
雄猫servlet 容器作为 HTTP 运行时,而不是部署到外部实例。
@SpringBootApplication
是一个方便的注释,它添加了以下所有内容:
-
@Configuration
:将类标记为应用程序上下文的 Bean 定义源。 -
@EnableAutoConfiguration
:告诉 Spring 引导根据类路径设置、其他 bean 和各种属性设置开始添加 bean。例如,如果 在类路径上,则此注释会将应用程序标记为 Web 应用程序并激活关键行为,例如设置 .spring-webmvc
DispatcherServlet
-
@ComponentScan
:告诉 Spring 在包中查找其他组件、配置和服务,让它找到控制器。hello
该方法使用 Spring Boot 的方法启动应用程序。您是否注意到没有一行 XML?也没有文件。此 Web 应用程序是 100% 纯 Java,您无需处理配置任何管道或基础结构。main()
SpringApplication.run()
web.xml
构建可执行的 JAR
您可以使用 Gradle 或 Maven 从命令行运行应用程序。您还可以构建一个包含所有必需依赖项、类和资源的可执行 JAR 文件并运行该文件。通过构建可执行 jar,可以轻松地在整个开发生命周期中跨不同环境等将服务作为应用程序进行交付、版本控制和部署。
如果使用 Gradle,则可以使用 .或者,您可以使用 JAR 文件生成 JAR 文件,然后运行该文件,如下所示:./gradlew bootRun
./gradlew build
java -jar build/libs/gs-messaging-gcp-pubsub-0.1.0.jar
如果使用 Maven,则可以使用 运行应用程序。或者,您可以使用 JAR 文件生成 JAR 文件,然后运行该文件,如下所示:./mvnw spring-boot:run
./mvnw clean package
java -jar target/gs-messaging-gcp-pubsub-0.1.0.jar
此处描述的步骤将创建一个可运行的 JAR。你也可以构建经典 WAR 文件. |
将显示日志记录输出。该服务应在几秒钟内启动并运行。
测试应用程序
现在应用程序正在运行,您可以对其进行测试。打开http://localhost:8080,在输入文本框中键入一条消息,按“发布!”按钮,然后验证该消息是否已正确记录在过程终端窗口中。
总结
祝贺!您刚刚开发了一个 Spring 应用程序,该应用程序使用 Spring 集成 GCP 发布/订阅通道适配器交换消息!
标签:Google,java,Sub,Spring,应用程序,gcp,Pub,main,Cloud From: https://blog.51cto.com/u_15326439/5968596