Nas funções do Cloud Run, escreve uma função HTTP quando quer invocar uma função através de um pedido HTTP(S). Para permitir a semântica HTTP, use o Function Framework e especifique a assinatura da função HTTP para aceitar argumentos específicos de HTTP.
Implemente funções de controlador HTTP
O exemplo seguinte mostra um ficheiro de origem de função HTTP básico para cada tempo de execução. Consulte a secção Estrutura do diretório de origem para obter informações sobre onde localizar o código-fonte.
Node.js
Módulo ES
import { http } from '@google-cloud/functions-framework';
http('myHttpFunction', (req, res) => {
// Your code here
// Send an HTTP response
res.send('OK');
});
Adicione as seguintes dependências, incluindo "type": "module" no ficheiro
package.json:
{
"dependencies": {
"@google-cloud/functions-framework": "^3.0.0"
},
"type": "module"
}
Módulo CommonJS
const functions = require('@google-cloud/functions-framework');
// Register an HTTP function with the Functions Framework
functions.http('myHttpFunction', (req, res) => {
// Your code here
// Send an HTTP response
res.send('OK');
});
Adicione as seguintes dependências no ficheiro package.json:
{
"dependencies": {
"@google-cloud/functions-framework": "^3.0.0"
}
}
No Node.js, regista uma função de controlador HTTP com o Functions Framework para Node.js. A função do controlador HTTP tem de ser uma função de middleware do Express que aceite os argumentos request e response e envie uma resposta HTTP.
O Cloud Run analisa automaticamente o corpo do pedido com base no cabeçalho Content-Type do pedido através de body-parser, pelo que pode aceder aos objetos req.body e req.rawBody no seu controlador HTTP.
O
ponto de entrada da função
é o nome com o qual o controlador está registado no Functions Framework.
Neste exemplo, o ponto de entrada é myHttpFunction.
Python
import functions_framework
# Register an HTTP function with the Functions Framework
@functions_framework.http
def my_http_function(request):
# Your code here
# Return an HTTP response
return 'OK'
Em Python, regista uma função de controlador HTTP com o Functions Framework for Python. A função do controlador HTTP tem de aceitar um objeto Flask request como argumento e devolver um valor que o Flask possa converter num objeto de resposta HTTP.
O
ponto de entrada da função
é o nome com o qual o controlador está registado no Functions Framework.
Neste exemplo, o ponto de entrada é my_http_function.
Ir
package myhttpfunction
import (
"fmt"
"net/http"
"github.com/GoogleCloudPlatform/functions-framework-go/functions"
)
func init() {
// Register an HTTP function with the Functions Framework
functions.HTTP("MyHTTPFunction", myHTTPFunction)
}
// Function myHTTPFunction is an HTTP handler
func myHTTPFunction(w http.ResponseWriter, r *http.Request) {
// Your code here
// Send an HTTP response
fmt.Fprintln(w, "OK")
}
Em Go, regista uma função de controlador HTTP com o
Functions Framework para Go
na sua função init(). A função do controlador HTTP tem de usar a interface
http.HandlerFunc
padrão para enviar uma resposta HTTP.
O
ponto de entrada da função
é o nome com o qual o controlador está registado no Functions Framework.
Neste exemplo, o ponto de entrada é MyHTTPFunction.
A sua função de controlador HTTP tem de implementar a interface
http.HandlerFunc
padrão. Aceita uma interface http.ResponseWriter que a sua função usa para criar uma resposta ao pedido e um ponteiro para uma estrutura http.Request que contém os detalhes do pedido HTTP de entrada.
Java
package myhttpfunction;
import com.google.cloud.functions.HttpFunction;
import com.google.cloud.functions.HttpRequest;
import com.google.cloud.functions.HttpResponse;
// Define a class that implements the HttpFunction interface
public class MyHttpFunction implements HttpFunction {
// Implement the service() method to handle HTTP requests
@Override
public void service(HttpRequest request, HttpResponse response) throws Exception {
// Your code here
// Send an HTTP response
response.getWriter().write("OK");
}
}
Em Java, usa a
API Java do Functions Framework
para implementar uma classe de controlador HTTP com a interface
HttpFunction. O método service() tem de enviar uma resposta HTTP.
O
ponto de entrada da função
é o nome totalmente qualificado da classe do controlador HTTP, incluindo o nome do pacote. Neste exemplo, o ponto de entrada é myhttpfunction.MyHttpFunction.
O seu método service recebe um objeto HttpRequest que descreve o pedido HTTP de entrada e um objeto HttpResponse que a sua função preenche com uma mensagem de resposta.
.NET
using Google.Cloud.Functions.Framework;
using Microsoft.AspNetCore.Http;
using System.Threading.Tasks;
namespace MyProject
{
// Define a class that implements the IHttpFunction interface
public class MyHttpFunction : IHttpFunction
{
// Implement the HandleAsync() method to handle HTTP requests
public async Task HandleAsync(HttpContext context)
{
// Your code here
// Send an HTTP response
await context.Response.WriteAsync("OK");
}
}
}
Nos runtimes .NET, usa o
Functions Framework para .NET
para implementar uma classe de controlador HTTP com a interface
IHttpFunction. O método HandleAsync() aceita um objeto ASP.NET padrão
HttpContext
como argumento e tem de enviar uma resposta HTTP.
O ponto de entrada da função é o nome totalmente qualificado da classe do controlador HTTP, incluindo o espaço de nomes. Neste exemplo, o ponto de entrada é MyProject.MyHttpFunction.
Ruby
require "functions_framework"
# Register an HTTP function with the Functions Framework
FunctionsFramework.http "my_http_function" do |request|
# Your code here
# Return an HTTP response
"OK"
end
Em Ruby, regista uma função de controlador HTTP com o Functions Framework para Ruby. A sua função de controlador HTTP tem de aceitar um objeto de pedido Rack como argumento e devolver um valor que possa ser usado como resposta HTTP.
O
ponto de entrada da função
é o nome com o qual o controlador está registado no Functions Framework.
Neste exemplo, o ponto de entrada é my_http_function.
PHP
<?php
use Google\CloudFunctions\FunctionsFramework;
use Psr\Http\Message\ServerRequestInterface;
// Register an HTTP function with the Functions Framework
FunctionsFramework::http('myHttpFunction', 'myHttpHandler');
// Define your HTTP handler
function myHttpHandler(ServerRequestInterface $request): string
{
// Your code here
// Return an HTTP response
return 'OK';
}
Em PHP, regista uma função de controlador HTTP com o Functions Framework para PHP.
A sua função de controlador HTTP tem de aceitar um argumento que implemente a interface PSR-7
ServerRequestInterface
e tem de devolver uma resposta HTTP como uma string ou um objeto
que implemente a interface PSR-7
ResponseInterface.
O
ponto de entrada da função
é o nome com o qual o controlador está registado no Functions Framework.
Neste exemplo, o ponto de entrada é myHttpFunction.
Pedidos e respostas HTTP
Quando regista uma função de controlador HTTP com o Functions Framework, o seu controlador HTTP pode inspecionar o método de pedido e realizar diferentes ações com base no método.
Quando configura um fornecedor de eventos para enviar pedidos HTTP para a sua função do Cloud Run, a função envia uma resposta HTTP. Se a função criar tarefas em segundo plano (como com threads, futuros, objetos JavaScript Promise, callbacks ou processos do sistema), tem de terminar ou resolver estas tarefas antes de enviar uma resposta HTTP. As tarefas não terminadas antes de a resposta HTTP ser enviada podem não ser concluídas e podem causar um comportamento indefinido.
Processamento de CORs / compatibilidade com CORS
A partilha de recursos de origem cruzada (CORS) é uma forma de permitir que as aplicações executadas num domínio acedam a recursos de outro domínio. Por exemplo, pode ter de permitir que o seu domínio faça pedidos ao domínio das funções do Cloud Run para aceder à sua função.
Para permitir pedidos de origem cruzada à sua função, defina o cabeçalho
Access-Control-Allow-Origin
conforme adequado na sua resposta HTTP. Para
pedidos de origem cruzada de verificação prévia,
tem de responder ao pedido OPTIONS de verificação prévia com um código de resposta 204
e cabeçalhos adicionais.
Node.js
Python
Ir
Java
.NET
Ruby
PHP
Se o CORS não estiver configurado corretamente, pode ver erros como os seguintes:
XMLHttpRequest cannot load https://YOUR_FUNCTION_URL. No 'Access-Control-Allow-Origin' header is present on the requested resource. Origin 'https://YOUR_DOMAIN' is therefore not allowed access.
Limitações de CORS
Para pedidos de origem cruzada pré-enviados, os pedidos OPTIONS pré-enviados são enviados sem um cabeçalho de autorização, pelo que são rejeitados em todas as funções HTTP que requerem autenticação. Uma vez que os pedidos de pré-voo falham, os pedidos principais também falham. Para contornar esta limitação, use uma das seguintes opções:
- Permita o acesso público da sua função.
- Configure o Identity-Aware Proxy para a sua função, que fornece o cabeçalho de autorização para pedidos OPTIONS de pré-voo enviados para funções do Cloud Run.
- Aloje a sua app Web e o Cloud Run no mesmo domínio para evitar o CORS. Pode fazê-lo integrando o Firebase Hosting com as funções do Cloud Run.