此版本仍在开发中，尚未被视为稳定版本。对于最新的稳定版本，请使用 spring-cloud-function 4.1.4！spring-doc.cn

Google Cloud 函数

Google Cloud Functions 适配器使 Spring Cloud Functions 应用程序能够在 Google Cloud Functions 无服务器平台上运行。您可以使用开源 Google Functions Framework for Java 在本地运行该函数，也可以在 GCP 上运行该函数。spring-doc.cn

项目依赖关系

首先将依赖项添加到您的项目中。spring-cloud-function-adapter-gcpspring-doc.cn

<dependencies>
	<dependency>
		<groupId>org.springframework.cloud</groupId>
		<artifactId>spring-cloud-function-adapter-gcp</artifactId>
	</dependency>

	...
</dependencies>

此外，添加 which 将构建要部署的函数的 JAR。spring-boot-maven-pluginspring-doc.cn

请注意，我们还将 .这是必需的，因为它会修改插件以正确的 JAR 格式打包您的函数，以便在 Google Cloud Functions 上进行部署。spring-cloud-function-adapter-gcpspring-boot-maven-plugin

<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:runspring-doc.cn

函数 target 应始终设置为 ;这是一个适配器类，用作从 Google Cloud Functions 平台到 Spring Cloud Function 的入口点。org.springframework.cloud.function.adapter.gcp.GcfJarLauncher

<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>

可以在 Spring Cloud Functions GCP 示例中找到工作的完整示例。pom.xmlspring-doc.cn

HTTP 函数

Google Cloud Functions 支持部署 HTTP 函数，这些函数是由 HTTP 请求调用的函数。以下部分介绍了将 Spring Cloud 函数部署为 HTTP 函数的说明。spring-doc.cn

开始

让我们从一个简单的 Spring Cloud Function 示例开始：spring-doc.cn

@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.MFspring-doc.cn

Main-Class: com.example.CloudFunctionMain

然后在本地运行该函数。这是由项目依赖项部分中描述的 Google Cloud Functions 提供的。function-maven-pluginspring-doc.cn

mvn function:run

调用 HTTP 函数：spring-doc.cn

curl http://localhost:8080/ -d "hello"

构建并部署到GCP

首先打包您的应用程序。spring-doc.cn

mvn package

如果您添加了上面定义的自定义插件，您应该会在 directory 中看到生成的 JAR。此 JAR 的格式正确，可以部署到 Google Cloud Functions。spring-boot-maven-plugintarget/deployspring-doc.cn

接下来，确保您已安装 Cloud SDK CLI。spring-doc.cn

在项目基目录中，运行以下命令进行部署。spring-doc.cn

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 函数：spring-doc.cn

curl https://REGION-PROJECT_ID.cloudfunctions.net/function-sample-gcp-http -d "hello"

设置自定义 HTTP statusCode：spring-doc.cn

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-doc.cn

这也允许将函数部署为后台函数。spring-cloud-function-adapter-gcpspring-doc.cn

以下部分介绍了编写 Cloud Pub/Sub 主题后台函数的过程。但是，有许多不同的事件类型可以触发后台函数执行，此处不讨论这些事件类型;这些在后台函数触发器文档中进行了介绍。spring-doc.cn

GCP 入门

让我们从一个简单的 Spring Cloud 函数开始，它将作为 GCF 后台函数运行：spring-doc.cn

@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());
	}
}

此外，使用以下定义在项目中创建类。此类表示在 Pub/Sub 主题事件上传递给函数的 Pub/Sub 事件结构。PubSubMessagespring-doc.cn

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.MFspring-doc.cn

Main-Class: com.example.BackgroundFunctionMain

然后在本地运行该函数。这是由项目依赖项部分中描述的 Google Cloud Functions 提供的。function-maven-pluginspring-doc.cn

mvn function:run

调用 HTTP 函数：spring-doc.cn

curl localhost:8080 -H "Content-Type: application/json" -d '{"data":"hello"}'

通过查看日志来验证是否调用了该函数。spring-doc.cn

部署到 GCP

要将后台函数部署到 GCP，请先打包应用程序。spring-doc.cn

mvn package

接下来，确保您已安装 Cloud SDK CLI。spring-doc.cn

在项目基目录中，运行以下命令进行部署。spring-doc.cn

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 Functions 都会调用该函数。--trigger-topicspring-doc.cn

有关测试和验证后台函数的演练，请参阅运行 GCF 后台函数示例的说明。spring-doc.cn

示例函数

该项目提供了以下示例函数作为参考：spring-doc.cn

function-sample-gcp-http 是一个 HTTP 函数，您可以在本地测试并尝试部署。spring-doc.cn
function-sample-gcp-background 显示了由发布到指定 Pub/Sub 主题的消息触发的后台函数示例。spring-doc.cn