Google berkomitmen untuk mendorong terwujudnya keadilan ras bagi komunitas Kulit Hitam. Lihat caranya.

Memanggil fungsi dari aplikasi

Dengan SDK klien Cloud Functions for Firebase, Anda dapat memanggil fungsi langsung dari aplikasi Firebase. Untuk memanggil fungsi dari aplikasi Anda dengan cara ini, tulis dan deploy fungsi Callable HTTPS di Cloud Functions, lalu tambahkan logika klien untuk memanggil fungsi dari aplikasi Anda.

Perlu diingat bahwa fungsi callable HTTPS mirip tetapi tidak sama dengan fungsi HTTP. Jika ingin menggunakan fungsi callable HTTPS, Anda harus menggunakan SDK klien untuk platform Anda bersama dengan API backend functions.https (atau menerapkan protokol). Berikut adalah sejumlah perbedaan mendasar antara fungsi callable dan fungsi HTTP:

  • Dengan fungsi callable, token Firebase Authentication, token FCM, dan token App Check, jika tersedia, akan otomatis disertakan dalam permintaan.
  • Pemicu functions.https.onCall akan melakukan deserialisasi isi permintaan dan memvalidasi token autentikasi secara otomatis.

Firebase SDK untuk Cloud Functions v0.9.1 dan yang lebih tinggi memiliki interoperabilitas dengan versi minimum SDK klien Firebase berikut untuk mendukung fungsi Callable HTTPS:

  • Firebase SDK untuk iOS 8.8.0
  • Firebase SDK untuk Android 20.0.1
  • Firebase JavaScript SDK 8.10.0
  • Firebase Modular Web SDK v. 9.0

Jika ingin menambahkan fungsionalitas yang mirip ke aplikasi yang di-build di platform yang tidak didukung, baca Spesifikasi Protokol untuk https.onCall. Panduan ini selebihnya berisi petunjuk tentang cara menulis, men-deploy, dan memanggil fungsi callable HTTPS untuk iOS, Android, web, C++, dan Unity.

Menulis dan men-deploy fungsi callable

Gunakan functions.https.onCall untuk membuat fungsi callable HTTPS. Metode ini mengambil dua parameter: data, dan context yang bersifat opsional:

// Saves a message to the Firebase Realtime Database but sanitizes the text by removing swearwords.
exports.addMessage = functions.https.onCall((data, context) => {
  // ...
});

Untuk fungsi callable yang menyimpan pesan teks ke Realtime Database, misalnya, data dapat berisi teks pesan, sedangkan parameter context mewakili informasi autentikasi pengguna:

// Message text passed from the client.
const text = data.text;
// Authentication / user information is automatically added to the request.
const uid = context.auth.uid;
const name = context.auth.token.name || null;
const picture = context.auth.token.picture || null;
const email = context.auth.token.email || null;

Jarak antara lokasi fungsi callable dan lokasi klien yang melakukan panggilan dapat menghasilkan latensi jaringan. Untuk mengoptimalkan performa, sebaiknya tentukan lokasi fungsi jika bisa diterapkan, dan pastikan untuk menyelaraskan lokasi fungsi callable dengan lokasi yang ditetapkan saat menginisialisasi SDK di sisi klien.

Secara opsional, Anda dapat menambahkan pengesahan App Check untuk membantu melindungi resource backend dari penyalahgunaan, seperti penipuan tagihan atau phishing. Lihat Mengaktifkan penerapan App Check untuk Cloud Functions.

Mengirim kembali hasil

Untuk mengirim data kembali ke klien, tampilkan data yang bisa dienkode JSON. Misalnya, untuk menampilkan hasil operasi penjumlahan:

// returning result.
return {
  firstNumber: firstNumber,
  secondNumber: secondNumber,
  operator: '+',
  operationResult: firstNumber + secondNumber,
};

Untuk menampilkan data setelah operasi asinkron, tampilkan sebuah promise. Data yang ditampilkan oleh promise tersebut akan dikirim kembali ke klien. Misalnya, Anda dapat menampilkan teks bersih yang ditulis oleh fungsi callable ke Realtime Database:

// Saving the new message to the Realtime Database.
const sanitizedMessage = sanitizer.sanitizeText(text); // Sanitize the message.
return admin.database().ref('/messages').push({
  text: sanitizedMessage,
  author: { uid, name, picture, email },
}).then(() => {
  console.log('New Message written');
  // Returning the sanitized message to the client.
  return { text: sanitizedMessage };
})

Menangani error

Untuk memastikan klien mendapatkan detail error yang berguna, tampilkan error dari fungsi callable dengan melempar (atau menunjukkan Promise yang ditolak) sebuah instance functions.https.HttpsError. Error tersebut memiliki atribut code yang dapat berupa salah satu nilai yang tercantum di functions.https.HttpsError. Error tersebut juga memiliki string message, yang secara default berupa string kosong. Error ini juga dapat memiliki kolom details opsional dengan nilai sembarang. Jika error selain HttpsError dilemparkan dari fungsi Anda, klien akan menerima error dengan pesan INTERNAL dan kode internal.

Misalnya, fungsi dapat melempar error pada proses validasi data dan autentikasi dengan pesan error yang akan ditampilkan ke klien yang melakukan panggilan:

// Checking attribute.
if (!(typeof text === 'string') || text.length === 0) {
  // Throwing an HttpsError so that the client gets the error details.
  throw new functions.https.HttpsError('invalid-argument', 'The function must be called with ' +
      'one arguments "text" containing the message text to add.');
}
// Checking that the user is authenticated.
if (!context.auth) {
  // Throwing an HttpsError so that the client gets the error details.
  throw new functions.https.HttpsError('failed-precondition', 'The function must be called ' +
      'while authenticated.');
}

Men-deploy fungsi callable

Setelah Anda menyimpan fungsi callable yang telah selesai di dalam index.js, fungsi tersebut akan di-deploy bersamaan dengan semua fungsi lainnya saat Anda menjalankan firebase deploy. Untuk men-deploy fungsi callable saja, gunakan argumen --only seperti yang ditunjukkan untuk menjalankan deployment sebagian:

$ firebase deploy --only functions:addMessage

Jika mengalami error izin saat men-deploy fungsi, pastikan peran IAM yang sesuai ditetapkan kepada pengguna yang menjalankan perintah deployment.

Menyiapkan lingkungan pengembangan klien

Pastikan Anda memenuhi semua prasyarat, lalu tambahkan dependensi dan library klien yang dibutuhkan ke aplikasi Anda.

iOS

  1. Ikuti petunjuk untuk menambahkan Firebase ke aplikasi iOS Anda.
  2. Tambahkan pod Cloud Functions ke Podfile:
    pod 'Firebase/Functions'
  3. Simpan file, lalu jalankan:
    pod install

Web versi 9

  1. Ikuti petunjuk untuk menambahkan Firebase ke aplikasi Web Anda. Pastikan untuk menjalankan perintah berikut dari terminal Anda:
    npm install firebase@9.1.0 --save
    
  2. Minta Firebase core dan Cloud Functions secara manual:

     import { initializeApp } from 'firebase/app';
     import { getFunctions } from 'firebase/functions';
    
     const app = initializeApp({
         projectId: '### CLOUD FUNCTIONS PROJECT ID ###',
         apiKey: '### FIREBASE API KEY ###',
         authDomain: '### FIREBASE AUTH DOMAIN ###',
       });
     const functions = getFunctions(app);
    

Web versi 8

  1. Ikuti petunjuk untuk menambahkan Firebase ke aplikasi Web Anda.
  2. Tambahkan library klien Cloud Functions dan Firebase core ke aplikasi Anda:
    <script src="https://www.gstatic.com/firebasejs/8.10.0/firebase.js"></script>
    <script src="https://www.gstatic.com/firebasejs/8.10.0/firebase-functions.js"></script>
    

Cloud Functions SDK juga tersedia sebagai paket npm.

  1. Jalankan perintah berikut dari terminal Anda:
    npm install firebase@8.10.0 --save
    
  2. Wajibkan Firebase core dan Cloud Functions secara manual:
    const firebase = require("firebase");
    // Required for side-effects
    require("firebase/functions");
    

Java

  1. Ikuti petunjuk untuk menambahkan Firebase ke aplikasi Android Anda.

  2. Dengan Firebase Android BoM, deklarasikan dependensi untuk library Android Cloud Functions dalam file Gradle modul (level aplikasi), biasanya app/build.gradle.

    dependencies {
        // Import the BoM for the Firebase platform
        implementation platform('com.google.firebase:firebase-bom:28.4.1')
    
        // Declare the dependency for the Cloud Functions library
        // When using the BoM, you don't specify versions in Firebase library dependencies
        implementation 'com.google.firebase:firebase-functions'
    }
    

    Dengan menggunakan Firebase Android BoM, aplikasi Anda akan selalu menggunakan versi library Android Firebase yang kompatibel.

    (Alternatif) Deklarasikan dependensi library Firebase tanpa menggunakan BoM

    Jika memilih untuk tidak menggunakan Firebase BoM, Anda harus menentukan setiap versi library Firebase di baris dependensinya.

    Perhatikan bahwa jika Anda menggunakan beberapa library Firebase di aplikasi Anda, sebaiknya gunakan BoM untuk mengelola versi library, yang memastikan bahwa semua versi kompatibel.

    dependencies {
        // Declare the dependency for the Cloud Functions library
        // When NOT using the BoM, you must specify versions in Firebase library dependencies
        implementation 'com.google.firebase:firebase-functions:20.0.1'
    }
    

Kotlin+KTX

  1. Ikuti petunjuk untuk menambahkan Firebase ke aplikasi Android Anda.

  2. Dengan Firebase Android BoM, deklarasikan dependensi untuk library Android Cloud Functions dalam file Gradle modul (level aplikasi), biasanya app/build.gradle.

    dependencies {
        // Import the BoM for the Firebase platform
        implementation platform('com.google.firebase:firebase-bom:28.4.1')
    
        // Declare the dependency for the Cloud Functions library
        // When using the BoM, you don't specify versions in Firebase library dependencies
        implementation 'com.google.firebase:firebase-functions-ktx'
    }
    

    Dengan menggunakan Firebase Android BoM, aplikasi Anda akan selalu menggunakan versi library Android Firebase yang kompatibel.

    (Alternatif) Deklarasikan dependensi library Firebase tanpa menggunakan BoM

    Jika memilih untuk tidak menggunakan Firebase BoM, Anda harus menentukan setiap versi library Firebase di baris dependensinya.

    Perhatikan bahwa jika Anda menggunakan beberapa library Firebase di aplikasi, sebaiknya gunakan BoM untuk mengelola versi library, yang memastikan bahwa semua versi kompatibel.

    dependencies {
        // Declare the dependency for the Cloud Functions library
        // When NOT using the BoM, you must specify versions in Firebase library dependencies
        implementation 'com.google.firebase:firebase-functions-ktx:20.0.1'
    }
    

C++

Untuk C++ dengan Android:

  1. Ikuti petunjuk untuk menambahkan Firebase ke project C++ Anda.
  2. Tambahkan library firebase_functions ke file CMakeLists.txt Anda.

Untuk C++ dengan iOS:

  1. Ikuti petunjuk untuk menambahkan Firebase ke project C++ Anda.
  2. Tambahkan pod Cloud Functions ke Podfile:
    pod 'Firebase/Functions'
  3. Simpan file, lalu jalankan:
    pod install
  4. Tambahkan framework Cloud Functions dan Firebase core dari Firebase C++ SDK ke project Xcode Anda.
    • firebase.framework
    • firebase_functions.framework

Unity

  1. Ikuti petunjuk untuk menambahkan Firebase ke project Unity Anda.
  2. Tambahkan FirebaseFunctions.unitypackage dari Firebase Unity SDK ke project Unity Anda.

Menginisialisasi SDK klien

Lakukan inisialisasi instance Cloud Functions:

Swift

lazy var functions = Functions.functions()

Objective-C

@property(strong, nonatomic) FIRFunctions *functions;
// ...
self.functions = [FIRFunctions functions];

Web versi 8

firebase.initializeApp({
  apiKey: '### FIREBASE API KEY ###',
  authDomain: '### FIREBASE AUTH DOMAIN ###',
  projectId: '### CLOUD FUNCTIONS PROJECT ID ###'
  databaseURL: 'https://### YOUR DATABASE NAME ###.firebaseio.com',
});

// Initialize Cloud Functions through Firebase
var functions = firebase.functions();

Web versi 9

const app = initializeApp({
  projectId: '### CLOUD FUNCTIONS PROJECT ID ###',
  apiKey: '### FIREBASE API KEY ###',
  authDomain: '### FIREBASE AUTH DOMAIN ###',
});
const functions = getFunctions(app);

Java

private FirebaseFunctions mFunctions;
// ...
mFunctions = FirebaseFunctions.getInstance();

Kotlin+KTX

private lateinit var functions: FirebaseFunctions
// ...
functions = Firebase.functions

C++

firebase::functions::Functions* functions;
// ...
functions = firebase::functions::Functions::GetInstance(app);

Unity

functions = Firebase.Functions.DefaultInstance;

Memanggil fungsi

Swift

functions.httpsCallable("addMessage").call(["text": inputField.text]) { result, error in
  if let error = error as NSError? {
    if error.domain == FunctionsErrorDomain {
      let code = FunctionsErrorCode(rawValue: error.code)
      let message = error.localizedDescription
      let details = error.userInfo[FunctionsErrorDetailsKey]
    }
    // ...
  }
  if let data = result?.data as? [String: Any], let text = data["text"] as? String {
    self.resultField.text = text
  }
}

Objective-C

[[_functions HTTPSCallableWithName:@"addMessage"] callWithObject:@{@"text": _inputField.text}
                                                      completion:^(FIRHTTPSCallableResult * _Nullable result, NSError * _Nullable error) {
  if (error) {
    if (error.domain == FIRFunctionsErrorDomain) {
      FIRFunctionsErrorCode code = error.code;
      NSString *message = error.localizedDescription;
      NSObject *details = error.userInfo[FIRFunctionsErrorDetailsKey];
    }
    // ...
  }
  self->_resultField.text = result.data[@"text"];
}];

Web versi 8

var addMessage = firebase.functions().httpsCallable('addMessage');
addMessage({ text: messageText })
  .then((result) => {
    // Read result of the Cloud Function.
    var sanitizedMessage = result.data.text;
  });

Web versi 9

import { getFunctions, httpsCallable } from "firebase/functions";

const functions = getFunctions();
const addMessage = httpsCallable(functions, 'addMessage');
addMessage({ text: messageText })
  .then((result) => {
    // Read result of the Cloud Function.
    /** @type {any} */
    const data = result.data;
    const sanitizedMessage = data.text;
  });

Java

private Task<String> addMessage(String text) {
    // Create the arguments to the callable function.
    Map<String, Object> data = new HashMap<>();
    data.put("text", text);
    data.put("push", true);

    return mFunctions
            .getHttpsCallable("addMessage")
            .call(data)
            .continueWith(new Continuation<HttpsCallableResult, String>() {
                @Override
                public String then(@NonNull Task<HttpsCallableResult> task) throws Exception {
                    // This continuation runs on either success or failure, but if the task
                    // has failed then getResult() will throw an Exception which will be
                    // propagated down.
                    String result = (String) task.getResult().getData();
                    return result;
                }
            });
}

Kotlin+KTX

private fun addMessage(text: String): Task<String> {
    // Create the arguments to the callable function.
    val data = hashMapOf(
        "text" to text,
        "push" to true
    )

    return functions
            .getHttpsCallable("addMessage")
            .call(data)
            .continueWith { task ->
                // This continuation runs on either success or failure, but if the task
                // has failed then result will throw an Exception which will be
                // propagated down.
                val result = task.result?.data as String
                result
            }
}

C++

firebase::Future<firebase::functions::HttpsCallableResult> AddMessage(
    const std::string& text) {
  // Create the arguments to the callable function.
  firebase::Variant data = firebase::Variant::EmptyMap();
  data.map()["text"] = firebase::Variant(text);
  data.map()["push"] = true;

  // Call the function and add a callback for the result.
  firebase::functions::HttpsCallableReference doSomething =
      functions->GetHttpsCallable("addMessage");
  return doSomething.Call(data);
}

Unity

private Task<string> addMessage(string text) {
  // Create the arguments to the callable function.
  var data = new Dictionary<string, object>();
  data["text"] = text;
  data["push"] = true;

  // Call the function and extract the operation from the result.
  var function = functions.GetHttpsCallable("addMessage");
  return function.CallAsync(data).ContinueWith((task) => {
    return (string) task.Result.Data;
  });
}

Menangani error pada klien

Klien akan menerima error jika server melemparkan error atau promise yang dihasilkan ditolak.

Jika error yang ditampilkan oleh fungsi berjenis function.https.HttpsError, klien akan menerima error code, message, dan details dari error server. Untuk selain jenis tersebut, error akan berisi pesan INTERNAL dan kode INTERNAL. Baca panduan untuk menangani error di fungsi callable Anda.

Swift

if let error = error as NSError? {
  if error.domain == FunctionsErrorDomain {
    let code = FunctionsErrorCode(rawValue: error.code)
    let message = error.localizedDescription
    let details = error.userInfo[FunctionsErrorDetailsKey]
  }
  // ...
}

Objective-C

if (error) {
  if (error.domain == FIRFunctionsErrorDomain) {
    FIRFunctionsErrorCode code = error.code;
    NSString *message = error.localizedDescription;
    NSObject *details = error.userInfo[FIRFunctionsErrorDetailsKey];
  }
  // ...
}

Web versi 8

var addMessage = firebase.functions().httpsCallable('addMessage');
addMessage({ text: messageText })
  .then((result) => {
    // Read result of the Cloud Function.
    var sanitizedMessage = result.data.text;
  })
  .catch((error) => {
    // Getting the Error details.
    var code = error.code;
    var message = error.message;
    var details = error.details;
    // ...
  });

Web versi 9

import { getFunctions, httpsCallable } from "firebase/functions";

const functions = getFunctions();
const addMessage = httpsCallable(functions, 'addMessage');
addMessage({ text: messageText })
  .then((result) => {
    // Read result of the Cloud Function.
    /** @type {any} */
    const data = result.data;
    const sanitizedMessage = data.text;
  })
  .catch((error) => {
    // Getting the Error details.
    const code = error.code;
    const message = error.message;
    const details = error.details;
    // ...
  });

Java

addMessage(inputMessage)
        .addOnCompleteListener(new OnCompleteListener<String>() {
            @Override
            public void onComplete(@NonNull Task<String> task) {
                if (!task.isSuccessful()) {
                    Exception e = task.getException();
                    if (e instanceof FirebaseFunctionsException) {
                        FirebaseFunctionsException ffe = (FirebaseFunctionsException) e;
                        FirebaseFunctionsException.Code code = ffe.getCode();
                        Object details = ffe.getDetails();
                    }

                    // ...
                }

                // ...
            }
        });

Kotlin+KTX

addMessage(inputMessage)
        .addOnCompleteListener(OnCompleteListener { task ->
            if (!task.isSuccessful) {
                val e = task.exception
                if (e is FirebaseFunctionsException) {
                    val code = e.code
                    val details = e.details
                }

                // ...
            }

            // ...
        })

C++

void OnAddMessageCallback(
    const firebase::Future<firebase::functions::HttpsCallableResult>& future) {
  if (future.error() != firebase::functions::kErrorNone) {
    // Function error code, will be kErrorInternal if the failure was not
    // handled properly in the function call.
    auto code = static_cast<firebase::functions::Error>(future.error());

    // Display the error in the UI.
    DisplayError(code, future.error_message());
    return;
  }

  const firebase::functions::HttpsCallableResult *result = future.result();
  firebase::Variant data = result->data();
  // This will assert if the result returned from the function wasn't a string.
  std::string message = data.string_value();
  // Display the result in the UI.
  DisplayResult(message);
}

// ...

// ...
  auto future = AddMessage(message);
  future.OnCompletion(OnAddMessageCallback);
// ...

Unity

 addMessage(text).ContinueWith((task) => {
  if (task.IsFaulted) {
    foreach (var inner in task.Exception.InnerExceptions) {
      if (inner is FunctionsException) {
        var e = (FunctionsException) inner;
        // Function error code, will be INTERNAL if the failure
        // was not handled properly in the function call.
        var code = e.ErrorCode;
        var message = e.ErrorMessage;
      }
    }
  } else {
    string result = task.Result;
  }
});

Sebelum meluncurkan aplikasi, sebaiknya aktifkan App Check untuk membantu memastikan bahwa hanya aplikasi Anda yang dapat mengakses endpoint fungsi callable Anda.