כתיבה של פונקציות Cloud Run

Node.js

מבנה הספרייה הבסיסי של פונקציות Node.js הוא כדלקמן:

.
├── index.js
└── package.json

כברירת מחדל, Cloud Run מנסה לטעון קוד מקור מקובץ בשם index.js בספריית הבסיס של הפונקציה. כדי לציין קובץ מקור ראשי אחר, משתמשים בשדה main בקובץ package.json.

קובץ package.json צריך לכלול גם את Functions Framework for Node.js כתלות:

{
  "main": "index.js",
  "dependencies": {
    "@google-cloud/functions-framework": "^3.0.0"
  },
  "type": "module"
}

הקוד בקובץ הראשי צריך להגדיר את נקודת הכניסה של הפונקציה, ויכול לייבא קוד אחר ומודולים של Node.js. בנוסף, בקובץ הראשי אפשר להגדיר כמה נקודות כניסה לפונקציות שאפשר לפרוס בנפרד.

פרטים נוספים זמינים במאמרים סקירה כללית של סביבת זמן הריצה של Node.js וFunctions Framework for Node.js.

Python

מבנה הספריות הבסיסי של פונקציות Python הוא כדלקמן:

.
├── main.py
└── requirements.txt

‫Cloud Run טוען קוד מקור מקובץ בשם main.py שנמצא בספרייה הבסיסית של הפונקציה. צריך לתת לקובץ הראשי את השם main.py.

קובץ requirements.txt צריך לכלול את Functions Framework for Python כתלות:

functions-framework==3.*

הקוד בקובץ main.py צריך להגדיר את נקודת הכניסה של הפונקציה, ויכול לייבא קוד אחר ותלות חיצונית כרגיל. קובץ main.py יכול להגדיר גם כמה נקודות כניסה לפונקציות שאפשר לפרוס בנפרד.

פרטים נוספים זמינים במאמר סקירה כללית של זמן הריצה של Python ובמאמר Functions Framework for Python.

המשך

המבנה הבסיסי של ספרייה לפונקציות Go הוא כדלקמן:

.
├── myfunction.go
└── go.mod

הפונקציה צריכה להיות בחבילת Go בשורש הפרויקט. לחבילה ולקובצי המקור שלה יכול להיות כל שם, אבל הפונקציה לא יכולה להיות ב-package main. אם אתם צריכים חבילה של main, למשל לבדיקות מקומיות, אתם יכולים ליצור אותה בספריית משנה:

.
├── myfunction.go
├── go.mod
└── cmd/
  └── main.go

קובץ ה-go.mod צריך לכלול את Functions Framework for Go כתלות:

module example.com/my-module

require (
  github.com/GoogleCloudPlatform/functions-framework-go v1.5.2
)

הקוד בחבילת הבסיס צריך להגדיר את נקודת הכניסה של הפונקציה, ויכול לייבא קוד אחר מחבילות משנה ומקובצי תלות כרגיל. החבילה יכולה גם להגדיר כמה נקודות כניסה לפונקציות שאפשר לפרוס בנפרד.

פרטים נוספים זמינים במאמרים בנושא סקירה כללית של זמן הריצה של Go וFunctions Framework for Go.

Java

מבנה הספריות הבסיסי של פונקציות Java הוא כדלקמן:

.
├── pom.xml
└── src/
  └── main/
      └── java/
          └── MyFunction.java

קבצי המקור של Java צריכים להיות בתיקייה src/main/java/, והשם שלהם יכול להיות כל שם. אם קובצי המקור מגדירים חבילה, מוסיפים עוד תיקייה מתחת ל-src/main/java עם שם החבילה:

.
├── pom.xml
└── src/
  └── main/
      └── java/
          └── mypackage/
              └── MyFunction.java

מומלץ למקם את הבדיקות המשויכות בספריית משנה src/test/java/.

קובץ ה-pom.xml צריך לכלול את Functions Framework for Java כתלות:

...
    <dependency>
      <groupId>com.google.cloud.functions</groupId>
      <artifactId>functions-framework-api</artifactId>
      <version>1.0.4</version>
    </dependency>
...

הקוד בקובצי המקור צריך להגדיר את נקודת הכניסה של הפונקציה, ואפשר לייבא קוד אחר ותלות חיצונית כרגיל. בקבצי המקור אפשר גם להגדיר כמה נקודות כניסה של פונקציות שאפשר לפרוס בנפרד.

פרטים נוספים זמינים במאמרים בנושא סקירה כללית של Java runtime ו-Functions Framework for Java.

‎.NET

מבנה הספריות הבסיסי של פונקציות ‎ .NET הוא כדלקמן:

.
├── MyFunction.cs
└── MyProject.csproj

אתם יכולים לבנות את הפרויקטים כמו כל קוד מקור אחר של ‎ .NET. קובצי המקור יכולים להיות בכל שם.

קובץ הפרויקט צריך לכלול את Functions Framework for .NET כתלות:

...
    <PackageReference Include="Google.Cloud.Functions.Hosting" Version="1.0.0" />
...

הקוד בקובצי המקור צריך להגדיר את נקודת הכניסה של הפונקציה, ואפשר לייבא קוד אחר ותלות חיצונית כרגיל. בקבצי המקור אפשר גם להגדיר כמה נקודות כניסה של פונקציות שאפשר לפרוס בנפרד.

פרטים נוספים זמינים במאמר סקירה כללית של זמן הריצה של ‎.NET ובמאמר Functions Framework for .NET.

Ruby

מבנה הספריות הבסיסי של פונקציות Ruby הוא כדלקמן:

.
├── app.rb
├── Gemfile
└── Gemfile.lock

‫Cloud Run טוען קוד מקור מקובץ בשם app.rb שנמצא בספרייה הבסיסית של הפונקציה. הקובץ הראשי צריך להיקרא app.rb.

קובץ ה-Gemfile צריך לכלול את Functions Framework for Ruby כתלות:

source "https://rubygems.org"
gem "functions_framework", "~> 1.0"

הקוד בקובץ app.rb צריך להגדיר את נקודת הכניסה של הפונקציה, ויכול לייבא קוד אחר ותלות חיצונית כרגיל. קובץ app.rb יכול להגדיר גם כמה נקודות כניסה לפונקציות שאפשר לפרוס בנפרד.

פרטים נוספים זמינים במאמר סקירה כללית של זמן הריצה של Ruby ובמאמר בנושא Functions Framework for Ruby.

PHP

מבנה הספריות הבסיסי של פונקציות PHP הוא כדלקמן:

.
├── index.php
└── composer.json

‫Cloud Run טוען קוד מקור מקובץ בשם index.php שנמצא בספרייה הבסיסית של הפונקציה. צריך לתת לקובץ הראשי את השם index.php.

קובץ composer.json צריך לכלול את Functions Framework for PHP כתלות:

{
  "require": {
    "google/cloud-functions-framework": "^1.1"
  }
}

הקוד בקובץ index.php צריך להגדיר את נקודת הכניסה של הפונקציה, ויכול לייבא קוד אחר ותלות חיצונית כרגיל. קובץ index.php יכול להגדיר גם כמה נקודות כניסה לפונקציות שאפשר לפרוס בנפרד.

פרטים נוספים זמינים במאמר סקירה כללית של זמן הריצה של PHP ובמאמר בנושא Functions Framework for PHP.

Node.js

import { http } from '@google-cloud/functions-framework';
// Register an HTTP function with the Functions Framework that executes
// when you make an HTTP request to the deployed function's endpoint.
http('helloGET', (req, res) => {
  res.send('Hello World!');
});

{
  "name": "nodejs-docs-samples-functions-hello-world-get",
  "version": "0.0.1",
  "private": true,
  "license": "Apache-2.0",
  "author": "Google Inc.",
  "repository": {
    "type": "git",
    "url": "https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git"
  },
  "engines": {
    "node": ">=16.0.0"
  },
  "scripts": {
    "test": "c8 mocha -p -j 2 test/*.test.js --timeout=6000 --exit"
  },
  "dependencies": {
    "@google-cloud/functions-framework": "^3.1.0"
  },
  "devDependencies": {
    "c8": "^10.0.0",
    "gaxios": "^6.0.0",
    "mocha": "^10.0.0",
    "wait-port": "^1.0.4"
  }
}

  const functions = require('@google-cloud/functions-framework');

  // Register an HTTP function with the Functions Framework
  functions.http('helloGET', (req, res) => {
    // Your code here

    // Send an HTTP response
    res.send('OK');
  });

  {
    "dependencies": {
      "@google-cloud/functions-framework": "^3.0.0"
    }
  }

ב-Node.js, רושמים פונקציית handler של HTTP באמצעות Functions Framework ל-Node.js. פונקציית ה-handler של HTTP חייבת להיות פונקציית תווכה של Express שמקבלת את הארגומנטים request ו-response ושולחת תגובת HTTP.

‫Cloud Run מנתח באופן אוטומטי את גוף הבקשה על סמך הכותרת Content-Type של הבקשה באמצעות body-parser, כך שאתם יכולים לגשת לאובייקטים req.body ו-req.rawBody ב-HTTP handler.

נקודת הכניסה של הפונקציה היא השם שבו רשום ה-handler ב-Functions Framework. בדוגמה הזו, נקודת הכניסה היא helloGET.

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'

ב-Python, רושמים פונקציית handler של HTTP באמצעות Functions Framework for Python. פונקציית הטיפול ב-HTTP צריכה לקבל אובייקט Flask request כארגומנט ולהחזיר ערך ש-Flask יכול להמיר לאובייקט תגובת HTTP.

נקודת הכניסה של הפונקציה היא השם שבו רשום ה-handler ב-Functions Framework. בדוגמה הזו, נקודת הכניסה היא my_http_function.

המשך

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")
}

ב-Go, רושמים פונקציה לטיפול ב-HTTP באמצעות Functions Framework for Go בפונקציה init(). פונקציית ה-handler של HTTP צריכה להשתמש בממשק http.HandlerFunc הרגיל כדי לשלוח תגובת HTTP.

נקודת הכניסה של הפונקציה היא השם שבו רשום ה-handler ב-Functions Framework. בדוגמה הזו, נקודת הכניסה היא MyHTTPFunction.

פונקציית ה-handler של HTTP חייבת להטמיע את הממשק הרגיל http.HandlerFunc. היא מקבלת ממשק http.ResponseWriter שהפונקציה שלכם משתמשת בו כדי ליצור תשובה לבקשה, ומצביע למבנה http.Request שמכיל את הפרטים של בקשת ה-HTTP הנכנסת.

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");
  }
}

ב-Java, משתמשים ב-Functions Framework Java API כדי להטמיע מחלקה של handler ל-HTTP עם הממשק HttpFunction. השיטה service() חייבת לשלוח תגובת HTTP.

נקודת הכניסה של הפונקציה היא השם המלא של מחלקת ה-handler של ה-HTTP, כולל שם החבילה. בדוגמה הזו, נקודת הכניסה היא myhttpfunction.MyHttpFunction.

השיטה service מקבלת אובייקט HttpRequest שמתאר את בקשת ה-HTTP הנכנסת, ואובייקט HttpResponse שהפונקציה מאכלסת בהודעת תגובה.

‎.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");
        }
    }
}

בזמני ריצה של .NET, משתמשים ב-Functions Framework for .NET כדי להטמיע מחלקה של handler ל-HTTP עם הממשק IHttpFunction. השיטה HandleAsync() מקבלת אובייקט HttpContext סטנדרטי של ASP.NET כארגומנט, והיא חייבת לשלוח תגובת HTTP.

נקודת הכניסה של הפונקציה היא השם המלא של מחלקת ה-handler של HTTP, כולל מרחב השמות. בדוגמה הזו, נקודת הכניסה היא 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

ב-Ruby, רושמים פונקציה לטיפול ב-HTTP באמצעות Functions Framework for Ruby. פונקציית ה-handler של HTTP חייבת לקבל אובייקט Rack request כארגומנט ולהחזיר ערך שאפשר להשתמש בו כתגובת HTTP.

נקודת הכניסה של הפונקציה היא השם שבו רשום ה-handler ב-Functions Framework. בדוגמה הזו, נקודת הכניסה היא 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';
}

ב-PHP, רושמים פונקציית handler של HTTP באמצעות Functions Framework for PHP. פונקציית הטיפול ב-HTTP חייבת לקבל ארגומנט שמיישם את הממשק PSR-7 ServerRequestInterface ולחזיר תגובת HTTP כמחרוזת או כאובייקט שמיישם את הממשק PSR-7 ResponseInterface.

נקודת הכניסה של הפונקציה היא השם שבו רשום ה-handler ב-Functions Framework. בדוגמה הזו, נקודת הכניסה היא myHttpFunction.

Node.js

const functions = require('@google-cloud/functions-framework');

/**
 * HTTP function that supports CORS requests.
 *
 * @param {Object} req Cloud Function request context.
 * @param {Object} res Cloud Function response context.
 */
functions.http('corsEnabledFunction', (req, res) => {
  // Set CORS headers for preflight requests
  // Allows GETs from any origin with the Content-Type header
  // and caches preflight response for 3600s

  res.set('Access-Control-Allow-Origin', '*');

  if (req.method === 'OPTIONS') {
    // Send response to OPTIONS requests
    res.set('Access-Control-Allow-Methods', 'GET');
    res.set('Access-Control-Allow-Headers', 'Content-Type');
    res.set('Access-Control-Max-Age', '3600');
    res.status(204).send('');
  } else {
    res.send('Hello World!');
  }
});

Python

import functions_framework

@functions_framework.http
def cors_enabled_function(request):
    # For more information about CORS and CORS preflight requests, see:
    # https://developer.mozilla.org/en-US/docs/Glossary/Preflight_request

    # Set CORS headers for the preflight request
    if request.method == "OPTIONS":
        # Allows GET requests from any origin with the Content-Type
        # header and caches preflight response for an 3600s
        headers = {
            "Access-Control-Allow-Origin": "*",
            "Access-Control-Allow-Methods":