تنظيم دوال متعددة

الجيل الثاني الجيل الأول

عند دمج Cloud Functions في مشروعك، يمكن توسيع الرمز البرمجي ليتضمّن العديد من الوظائف المستقلة. قد يكون لديك عدد كبير جدًا من الدوال التي لا تتناسب بشكل معقول مع ملف واحد، أو قد تنشر فرق مختلفة مجموعات مختلفة من الدوال، مما يؤدي إلى خطر استبدال فريق ما بوظائف فريق آخر أو حذفه عن طريق الخطأ. توفر دوال السحابة طرقًا مختلفة لتنظيم التعليمات البرمجية لتسهيل التنقل في الوظائف والحفاظ عليها.

تنظيم الدوال في قواعد الرموز

يمكنك استخدام السمة codebase لكائن إعداد الدوال في firebase.json لإدارة مجموعة كبيرة من الدوال على مستوى مستودعات متعددة أو حزم فرعية متعددة ضمن إعداد مستودع واحد لمستودع واحد:

# firebase.json
"functions": {
  "codebase": "my-codebase"
  # NOTE: Codebase must be less than 63 characters and can contain only
  # lowercase letters, numeric characters, underscores, and dashes.
}

تتوافق السمة codebase مع الإصدار 10.7.1 من Firebase CLI والإصدارات الأحدث.

إدارة مستودعات متعددة

ويمكن أن تساعد السمة codebase في تبسيط إدارة المستودعات المتعددة. دعنا نفحص حالة يكون لديك فيها مستودعان مختلفان ينشران الوظائف في مشروع Firebase نفسه:

$  tree .
├── repoA
│   ├── firebase.json
│   └── functions
│       ├── index.js
│       └── package.json
└── repoB
    ├── firebase.json
    └── functions
        ├── index.js
        └── package.json

بدون التعليقات التوضيحية لقاعدة الرموز، كان واجهة سطر الأوامر في Firebase سيطلب منك حذف الوظائف المحددة في المستودع الآخر في وقت النشر:

$ (cd repoA && firebase deploy --only functions)
...
i  functions: preparing functions directory for uploading...
✔  functions: functions folder uploaded successfully
The following functions are found in your project but do not exist in your local source code:
        fn1FromRepoB
        fn2FromRepoB
        ...
? Would you like to proceed with deletion? Selecting no will continue the rest of the deployments. (y/N)

يمكنك تجنُّب هذه المشكلة من خلال إضافة تعليق توضيحي فريد لقاعدة الرموز في قسم إعداد الدوال ضمن firebase.json في كل مستودع للمشاريع:

# repoA/firebase.json
"functions": {
  "codebase": "repo-a"
}

# repoB/firebase.json
"functions": {
  "codebase": "repo-b"
}

باستخدام التعليق التوضيحي لقاعدة الرموز، لم يعد يطالبك واجهة سطر الأوامر في Firebase بحذف الوظائف المحددة خارج مستودعك المباشر:

$ (cd repoA && firebase deploy --only functions)
...
i  functions: preparing functions directory for uploading...
✔  functions: functions folder uploaded successfully
#  Gleefully ignores functions from repoB
i  functions: creating Node.js 16 function fnFromRepoA (us-central1)...
✔  Deploy Complete!

إدارة حزم مصادر متعددة (Monrepo)

ويمكن أن تساعد السمة codebase في تبسيط إدارة حزم مصادر متعدّدة في مستودع واحد. لنفحص حالة يكون لديك فيها دليل مشروع firebase مع تعريفات وظائف موزَّعة على عدة حزم فرعية:

$  tree .
├── firebase.json
├── teamA
│   ├── index.js
│   └── package.json
└── teamB
    ├── index.js
    └── package.json

يناسب هذا الإعداد حالات الاستخدام التالية:

• لديك إعداد Monrepo ولديك فِرق مختلفة تدير تعريفات الدوال الخاصة بها في حزمة معزولة.
• لديك دالة ذات تبعية خارجية كبيرة وعملية إعداد طويلة الأمد، وتريد عزل هذه الدالة عن الدوال الأخرى التي تتأثر بوقت الاستجابة.

لإتاحة إعداد monrepo على هذا النحو، حدِّد إعدادات ضبط وظائف متعددة في firebase.json:

"functions": [
  {
    "source": "teamA",
    "codebase": "team-a"
  },
  {
    "source": "teamB",
    "codebase": "team-b"
  },
]

باستخدام هذه الإعدادات، ينشر واجهة سطر الأوامر في Firebase الدوال من جميع الحزم في أمر نشر واحد:

$ firebase deploy --only functions
i  deploying functions
i  functions: preparing codebase team-a for deployment
i  functions: preparing codebase team-b for deployment
i  functions: creating Node.js 16 function team-a:helloATeam(us-central1)...
i  functions: creating Node.js 16 function team-b:helloBTeam(us-central1)...
...

يمكنك أيضًا نشر قاعدة رموز برمجية محدَّدة:

$ firebase deploy --only functions:team-b
i  deploying functions
i  functions: preparing codebase team-b for deployment
i  functions: updating Node.js 16 function team-b:helloBTeam(us-central1)...
...

كتابة الدوال في ملفات متعدّدة

عند بدء استخدام "وظائف السحابة الإلكترونية"، يمكنك وضع الدوال القليلة الأولى في ملف واحد:

ملف index.js

const functions = require('firebase-functions');
exports.foo = functions.https.onRequest((request, response) => {
  // ...
});
exports.bar = functions.https.onRequest((request, response) => {
  // ...
});

رئيسي.py

from firebase_functions import https_fn

@https_fn.on_request()
def foo(req: https_fn.Request) -> https_fn.Response:
    return https_fn.Response("Hello foo!")

@https_fn.on_request()
def bar(req: https_fn.Request) -> https_fn.Response:
    return https_fn.Response("Hello bar!")

قد يصبح من الصعب إدارة هذا بأكثر من بضع وظائف. بدلاً من ذلك، يمكنك وضع كل المنطق لكل دالة في ملفها الخاص واستخدام الملف المصدر كقائمة بعمليات التصدير:

Node.js

foo.js

const functions = require('firebase-functions');
exports.foo = functions.https.onRequest((request, response) => {
  // ...
});

bar.js

const functions = require('firebase-functions');
exports.bar = functions.https.onRequest((request, response) => {
  // ...
});

index.js

const foo = require('./foo');
const bar = require('./bar');
exports.foo = foo.foo;
exports.bar = bar.bar;

Python

foo.py

from firebase_functions import https_fn

@https_fn.on_request()
def foo(req: https_fn.Request) -> https_fn.Response:
    return https_fn.Response("Hello foo!")

bar.py

from firebase_functions import https_fn

@https_fn.on_request()
def bar(req: https_fn.Request) -> https_fn.Response:
    return https_fn.Response("Hello foo!")

main.py

from fn_impl.foo import *
from fn_impl.bar import *

يفترض هذا الإعداد بنية دليل المشروع على النحو التالي:

my-project
├── firebase.json
└── functions
    ├── fn_impl
    │   ├── __init__.py
    │   ├── foo.py
    │   └── bar.py
    ├── main.py
    └── requirements.txt

fn_impl: يمكن أن يكون لأي اسم

__init__.py: مطلوبة، ولكن يمكن أن تكون فارغة

دوال التجميع

في العديد من المشروعات، يمكن فصل الدوال إلى مجموعات منطقية يجب نشرها وصيانتها معًا. على سبيل المثال، قد يكون لديك مجموعة من الدوال المستخدمة لمقاييس إعداد التقارير:

metrics.js

const functions = require('firebase-functions');
exports.usageStats = functions.https.onRequest((request, response) => {
  // ...
});
exports.nightlyReport = functions.https.onRequest((request, response) => {
  // ...
});

يمكنك وضع هذه الدوال في مجموعة عند تصديرها في ملف index.js:

index.js

// Export both functions from metrics.js in the "metrics" group:
//  - metrics-usageStats
//  - metrics-nightlyReport
exports.metrics = require('./metrics');

عند نشر الدوال، ستكون بادئة باسم مجموعتها، ولذلك في هذا المثال، ستتم تسمية الدوال باسم metrics-usageStats وmetrics-nightlyReport.

عند نشر الدوال، يمكنك حصر الإجراء على مجموعة واحدة:

firebase deploy --only functions:metrics

ملاحظة: على الرغم من أنّ #organizes_functions_in_codebases تتيح لك الاستفادة من خلال تخطي الدوال غير المعدَّلة أثناء النشر، ستظل دوال الكتابة في ملفات متعددة تؤثر في وحدة العقدة الخاصة بالدوال ولن تستفيد من عمليات النشر التي يتم تخطّيها.

الخطوات اللاحقة

لمزيد من المعلومات حول دوال السحابة، يُرجى الاطّلاع على:

• التعامل مع التبعيات:
• إدارة خيارات نشر الدوال وبيئة التشغيل