|
对于最新的稳定版本，请使用 spring-cloud-function 4.3.0！ |
谷歌云函数
Google Cloud Functions 适配器使 Spring Cloud Function 应用程序能够在 Google Cloud Functions 无服务器平台上运行。 您可以使用开源 Google Functions Framework for Java 或在 GCP 上本地运行该函数。
项目依赖项
首先添加spring-cloud-function-adapter-gcp依赖项目。
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-function-adapter-gcp</artifactId>
</dependency>
...
</dependencies>此外，将spring-boot-maven-plugin这将构建要部署的函数的 JAR。
请注意，我们还引用了spring-cloud-function-adapter-gcp作为spring-boot-maven-plugin.这是必要的，因为它会修改插件，以将函数打包为正确的 JAR 格式，以便在 Google Cloud Functions 上部署。 |
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<outputDirectory>target/deploy</outputDirectory>
</configuration>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-function-adapter-gcp</artifactId>
</dependency>
</dependencies>
</plugin>最后，添加作为 Google Functions Framework for Java 的一部分提供的 Maven 插件。
这允许您通过mvn function:run.
函数目标应始终设置为org.springframework.cloud.function.adapter.gcp.GcfJarLauncher;这是一个适配器类，充当从 Google Cloud Functions 平台进入 Spring Cloud Function 的入口点。 |
<plugin>
<groupId>com.google.cloud.functions</groupId>
<artifactId>function-maven-plugin</artifactId>
<version>0.9.1</version>
<configuration>
<functionTarget>org.springframework.cloud.function.adapter.gcp.GcfJarLauncher</functionTarget>
<port>8080</port>
</configuration>
</plugin>工作的完整示例pom.xml可以在 Spring Cloud Functions GCP 示例中找到。
HTTP 函数
Google Cloud Functions 支持部署 HTTP 函数，即由 HTTP 请求调用的函数。以下部分描述了将 Spring Cloud 函数部署为 HTTP 函数的说明。
开始
让我们从一个简单的 Spring Cloud 函数示例开始：
@SpringBootApplication
public class CloudFunctionMain {
public static void main(String[] args) {
SpringApplication.run(CloudFunctionMain.class, args);
}
@Bean
public Function<String, String> uppercase() {
return value -> value.toUpperCase();
}
}在resources/META-INF/MANIFEST.MF.
Main-Class: com.example.CloudFunctionMain然后在本地运行该函数。
这是由 Google Cloud Functions 提供的function-maven-plugin在项目依赖项部分中描述。
mvn function:run
调用 HTTP 函数：
curl http://localhost:8080/ -d "hello"
构建并部署到 GCP
首先打包您的应用程序。
mvn package
如果您添加了自定义spring-boot-maven-plugin插件，您应该在target/deploy目录。
此 JAR 的格式正确，可部署到 Google Cloud Functions。
接下来，确保您已安装 Cloud SDK CLI。
在项目基目录中，运行以下命令进行部署。
gcloud functions deploy function-sample-gcp-http \ --entry-point org.springframework.cloud.function.adapter.gcp.GcfJarLauncher \ --runtime java11 \ --trigger-http \ --source target/deploy \ --memory 512MB
调用 HTTP 函数：
curl https://REGION-PROJECT_ID.cloudfunctions.net/function-sample-gcp-http -d "hello"
设置自定义 HTTP statusCode：
Functions can specify a custom HTTP response code by setting the `FunctionInvoker.HTTP_STATUS_CODE` header.
@Bean
public Function<String, Message<String>> function() {
String payload = "hello";
Message<String> message = MessageBuilder.withPayload(payload).setHeader(FunctionInvoker.HTTP_STATUS_CODE, 404).build();
return input -> message;
};后台函数
Google Cloud Functions 还支持部署后台函数，这些函数是间接调用以响应事件（例如 Cloud Pub/Sub 主题上的消息、Cloud Storage 存储分区中的更改或 Firebase 事件）。
这spring-cloud-function-adapter-gcp也允许将函数部署为后台函数。
以下部分介绍了编写 Cloud Pub/Sub 主题后台函数的过程。 但是，有许多不同的事件类型可以触发后台函数的执行，这里不讨论;这些在后台函数触发器文档中进行了描述。
GCP 入门
让我们从一个简单的 Spring Cloud 函数开始，它将作为 GCF 后台函数运行：
@SpringBootApplication
public class BackgroundFunctionMain {
public static void main(String[] args) {
SpringApplication.run(BackgroundFunctionMain.class, args);
}
@Bean
public Consumer<PubSubMessage> pubSubFunction() {
return message -> System.out.println("The Pub/Sub message data: " + message.getData());
}
}此外，创建PubSubMessage类，并具有以下定义。此类表示 Pub/Sub 事件结构，该结构在 Pub/Sub 主题事件上传递给您的函数。
public class PubSubMessage {
private String data;
private Map<String, String> attributes;
private String messageId;
private String publishTime;
public String getData() {
return data;
}
public void setData(String data) {
this.data = data;
}
public Map<String, String> getAttributes() {
return attributes;
}
public void setAttributes(Map<String, String> attributes) {
this.attributes = attributes;
}
public String getMessageId() {
return messageId;
}
public void setMessageId(String messageId) {
this.messageId = messageId;
}
public String getPublishTime() {
return publishTime;
}
public void setPublishTime(String publishTime) {
this.publishTime = publishTime;
}
}在resources/META-INF/MANIFEST.MF.
Main-Class: com.example.BackgroundFunctionMain然后在本地运行该函数。
这是由 Google Cloud Functions 提供的function-maven-plugin在项目依赖项部分中描述。
mvn function:run
调用 HTTP 函数：
curl localhost:8080 -H "Content-Type: application/json" -d '{"data":"hello"}'
通过查看日志来验证是否调用了该函数。
部署到 GCP
为了将后台函数部署到 GCP，请先打包您的应用程序。
mvn package
如果您添加了自定义spring-boot-maven-plugin插件，您应该在target/deploy目录。
此 JAR 的格式正确，可部署到 Google Cloud Functions。
接下来，确保您已安装 Cloud SDK CLI。
在项目基目录中，运行以下命令进行部署。
gcloud functions deploy function-sample-gcp-background \ --entry-point org.springframework.cloud.function.adapter.gcp.GcfJarLauncher \ --runtime java11 \ --trigger-topic my-functions-topic \ --source target/deploy \ --memory 512MB
现在，每次将消息发布到指定的主题时，Google Cloud Function 都会调用该函数--trigger-topic.
有关测试和验证后台函数的演练，请参阅运行 GCF 后台函数示例的说明。
示例函数
项目提供以下示例函数作为参考：
-
function-sample-gcp-http 是一个 HTTP 函数，您可以在本地测试并尝试部署。
-
function-sample-gcp-background 显示了由发布到指定 Pub/Sub 主题的消息触发的后台函数示例。