Ikuti semua informasi yang diumumkan di Firebase Summit, dan pelajari bagaimana Firebase dapat membantu Anda mempercepat pengembangan aplikasi dan menjalankan aplikasi dengan percaya diri. Pelajari Lebih Lanjut

Panggil fungsi dari aplikasi Anda

Tetap teratur dengan koleksi Simpan dan kategorikan konten berdasarkan preferensi Anda.

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

Penting untuk diingat bahwa fungsi callable HTTPS serupa tetapi tidak identik dengan fungsi HTTP. Untuk menggunakan fungsi callable HTTPS, Anda harus menggunakan SDK klien untuk platform Anda bersama dengan API backend functions.https (atau mengimplementasikan protokol). Callables memiliki perbedaan utama dari fungsi HTTP:

  • Dengan callable, token Firebase Authentication, token FCM, dan token App Check, jika tersedia, otomatis disertakan dalam permintaan.
  • Pemicu functions.https.onCall secara otomatis membatalkan serialisasi badan permintaan dan memvalidasi token autentikasi.

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

  • Firebase SDK untuk platform Apple 10.3.0
  • Firebase SDK untuk Android 20.2.1
  • Firebase JavaScript SDK 8.10.1
  • Firebase Modular Web SDK v.9.0

Jika Anda ingin menambahkan fungsionalitas serupa ke aplikasi yang dibangun di atas platform yang tidak didukung, lihat Spesifikasi Protokol untuk https.onCall . Bagian selanjutnya dari panduan ini memberikan petunjuk tentang cara menulis, menerapkan, dan memanggil fungsi HTTPS yang dapat dipanggil untuk platform Apple, Android, web, C++, dan Unity.

Tulis dan gunakan fungsi callable

Gunakan functions.https.onCall untuk membuat fungsi HTTPS yang dapat dipanggil. Metode ini membutuhkan dua parameter: data , dan opsional context :

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

Untuk fungsi yang dapat dipanggil 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 yang dapat dipanggil dan lokasi klien pemanggil dapat membuat latensi jaringan. Untuk mengoptimalkan performa, pertimbangkan untuk menentukan lokasi fungsi jika berlaku, dan pastikan untuk menyelaraskan lokasi callable dengan kumpulan lokasi saat Anda menginisialisasi SDK di sisi klien.

Secara opsional, Anda dapat melampirkan pengesahan App Check untuk membantu melindungi sumber daya backend Anda dari penyalahgunaan, seperti penipuan penagihan atau phishing. Lihat Mengaktifkan penerapan App Check untuk Cloud Functions .

Mengirim kembali hasilnya

Untuk mengirim data kembali ke klien, kembalikan data yang dapat dikodekan JSON. Misalnya, untuk mengembalikan hasil operasi penjumlahan:

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

Untuk mengembalikan data setelah operasi asinkron, kembalikan janji. Data yang dikembalikan oleh janji dikirim kembali ke klien. Misalnya, Anda dapat mengembalikan 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 kesalahan

Untuk memastikan klien mendapatkan detail error yang berguna, kembalikan error dari callable dengan melempar (atau mengembalikan Promise yang ditolak dengan) instance dari functions.https.HttpsError . Error tersebut memiliki atribut code yang dapat berupa salah satu nilai yang tercantum di functions.https.HttpsError . Kesalahan juga memiliki string message , yang defaultnya adalah string kosong. Mereka juga dapat memiliki bidang details opsional dengan nilai arbitrer. Jika kesalahan selain HttpsError dilemparkan dari fungsi Anda, klien Anda akan menerima kesalahan dengan pesan INTERNAL dan kode internal .

Misalnya, sebuah fungsi dapat melontarkan kesalahan validasi dan autentikasi data dengan pesan kesalahan untuk kembali ke klien pemanggil:

// 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.');
}

Terapkan fungsi yang dapat dipanggil

Setelah Anda menyimpan fungsi callable yang telah selesai di dalam index.js , fungsi tersebut akan diterapkan bersama dengan semua fungsi lainnya saat Anda menjalankan firebase deploy . Untuk menerapkan callable saja, gunakan argumen --only seperti yang ditunjukkan untuk melakukan penerapan parsial :

firebase deploy --only functions:addMessage

Jika Anda mengalami kesalahan izin saat menerapkan fungsi, pastikan peran IAM yang sesuai telah ditetapkan ke pengguna yang menjalankan perintah penerapan.

Siapkan lingkungan pengembangan klien Anda

Pastikan Anda memenuhi semua prasyarat, lalu tambahkan dependensi dan pustaka klien yang diperlukan ke aplikasi Anda.

iOS+

Ikuti petunjuk untuk menambahkan Firebase ke aplikasi Apple Anda .

Gunakan Swift Package Manager untuk menginstal dan mengelola dependensi Firebase.

  1. Di Xcode, dengan proyek aplikasi Anda terbuka, arahkan ke File > Add Packages .
  2. Saat diminta, tambahkan repositori SDK platform Apple Firebase:
  3.   https://github.com/firebase/firebase-ios-sdk
  4. Pilih library Cloud Functions.
  5. Setelah selesai, Xcode akan secara otomatis mulai menyelesaikan dan mengunduh dependensi Anda di latar belakang.

Web version 9

  1. Ikuti petunjuk untuk menambahkan Firebase ke aplikasi Web Anda . Pastikan untuk menjalankan perintah berikut dari terminal Anda:
    npm install firebase@9.15.0 --save
    
  2. Membutuhkan inti Firebase 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 version 8

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

Cloud Functions SDK juga tersedia sebagai paket npm.

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

Java

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

  2. Dalam file Gradle modul (level aplikasi) Anda (biasanya <project>/<app-module>/build.gradle ), tambahkan dependensi untuk library Android Cloud Functions. Kami merekomendasikan penggunaan Firebase Android BoM untuk mengontrol pembuatan versi library.

    dependencies {
        // Import the BoM for the Firebase platform
        implementation platform('com.google.firebase:firebase-bom:31.1.0')
    
        // Add 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 pustaka Android Firebase yang kompatibel.

    (Alternatif) Tambahkan dependensi library Firebase tanpa menggunakan BoM

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

    Perhatikan bahwa jika Anda menggunakan beberapa pustaka Firebase di aplikasi Anda, kami sangat menyarankan penggunaan BoM untuk mengelola versi pustaka, yang memastikan bahwa semua versi kompatibel.

    dependencies {
        // Add 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.2.1'
    }
    

Kotlin+KTX

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

  2. Dalam file Gradle modul (level aplikasi) Anda (biasanya <project>/<app-module>/build.gradle ), tambahkan dependensi untuk library Android Cloud Functions. Kami merekomendasikan penggunaan Firebase Android BoM untuk mengontrol pembuatan versi library.

    dependencies {
        // Import the BoM for the Firebase platform
        implementation platform('com.google.firebase:firebase-bom:31.1.0')
    
        // Add 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 pustaka Android Firebase yang kompatibel.

    (Alternatif) Tambahkan dependensi library Firebase tanpa menggunakan BoM

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

    Perhatikan bahwa jika Anda menggunakan beberapa pustaka Firebase di aplikasi Anda, kami sangat menyarankan penggunaan BoM untuk mengelola versi pustaka, yang memastikan bahwa semua versi kompatibel.

    dependencies {
        // Add 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.2.1'
    }
    

Dart

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

  2. Dari root project Flutter Anda, jalankan perintah berikut untuk menginstal plugin:

    flutter pub add cloud_functions
    
  3. Setelah selesai, buat ulang aplikasi Flutter Anda:

    flutter run
    
  4. Setelah terinstal, Anda dapat mengakses plugin cloud_functions dengan mengimpornya ke dalam kode Dart Anda:

    import 'package:cloud_functions/cloud_functions.dart';
    

C++

Untuk C++ dengan Android :

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

Untuk C++ dengan platform Apple :

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

Persatuan

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

Inisialisasi SDK klien

Menginisialisasi instance Cloud Functions:

Cepat

lazy var functions = Functions.functions()

Objective-C

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

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

Dart

final functions = FirebaseFunctions.instance;

C++

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

Persatuan

functions = Firebase.Functions.DefaultInstance;

Panggil fungsinya

Cepat

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 isEqual:@"com.firebase.functions"]) {
      FIRFunctionsErrorCode code = error.code;
      NSString *message = error.localizedDescription;
      NSObject *details = error.userInfo[@"details"];
    }
    // ...
  }
  self->_resultField.text = result.data[@"text"];
}];

Web version 8

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

Web version 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
        }
}

Dart

final result =
    await FirebaseFunctions.instance.httpsCallable('addMessage').call();

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

Persatuan

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 kesalahan pada klien

Klien menerima kesalahan jika server melakukan kesalahan atau jika janji yang dihasilkan ditolak.

Jika kesalahan yang dikembalikan oleh fungsi bertipe function.https.HttpsError , maka klien menerima code kesalahan , message , dan details dari kesalahan server. Jika tidak, kesalahan berisi pesan INTERNAL dan kode INTERNAL . Lihat panduan tentang cara menangani kesalahan dalam fungsi yang dapat dipanggil.

Cepat

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 isEqual:@"com.firebase.functions"]) {
    FIRFunctionsErrorCode code = error.code;
    NSString *message = error.localizedDescription;
    NSObject *details = error.userInfo[@"details"];
  }
  // ...
}

Web version 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 version 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 { task ->
        if (!task.isSuccessful) {
            val e = task.exception
            if (e is FirebaseFunctionsException) {
                val code = e.code
                val details = e.details
            }
        }
    }

Dart

try {
  final result =
      await FirebaseFunctions.instance.httpsCallable('addMessage').call();
} on FirebaseFunctionsException catch (error) {
  print(error.code);
  print(error.details);
  print(error.message);
}

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);
  // ...

Persatuan

 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, Anda harus mengaktifkan App Check untuk membantu memastikan bahwa hanya aplikasi Anda yang dapat mengakses endpoint fungsi yang dapat dipanggil.