پارامترها را در برنامه افزودنی خود تنظیم و استفاده کنید

پارامترها مکانیزمی هستند که از طریق آن کاربر هر نمونه نصب شده یک برنامه افزودنی را سفارشی می کند. پارامترها مانند متغیرهای محیطی برای یک برنامه افزودنی هستند. مقادیر پارامترها می‌توانند به صورت خودکار (پس از نصب توسط Firebase ارائه می‌شوند) یا توسط کاربر پیکربندی شوند (توسط کاربر در حین نصب مشخص شده است).

این پارامترها برای ارجاع به کد منبع توابع برنامه افزودنی، فایل extension.yaml و فایل POSTINSTALL.md در دسترس شما هستند. در اینجا نحو نحوه ارجاع به پارامتری به نام PARAMETER_NAME آمده است:

• در کد منبع توابع خود، از ماژول params (به عنوان مثال params.defineInt(" PARAMETER_NAME ") ) یا process.env. PARAMETER_NAME .

• در extension.yaml و POSTINSTALL.md ، از ${param: PARAMETER_NAME } استفاده کنید.

  پس از نصب، کنسول Firebase محتویات فایل POSTINSTALL.md را نمایش می دهد و هر مرجع پارامتر را با مقادیر واقعی نمونه نصب شده پر می کند.

پارامترهای تکمیل خودکار

هر نمونه نصب شده از یک برنامه افزودنی به طور خودکار به چندین پارامتر تکمیل خودکار پیش فرض ارائه شده توسط Firebase دسترسی دارد (به جدول زیر مراجعه کنید). این مقادیر پارامتر یا مقادیر پیش‌فرض پروژه Firebase هستند (مانند سطل ذخیره‌سازی پیش‌فرض ) یا برای برنامه‌های افزودنی خاص هستند (مانند شناسه نمونه برنامه افزودنی).

همه مقادیر پارامترهای تکمیل شده خودکار تغییرناپذیر هستند. آنها در زمان ایجاد پروژه یا نصب الحاقیه تنظیم می شوند.

حتی اگر Firebase این مقادیر پارامتر را برای برنامه افزودنی به طور خودکار پر می کند، Firebase محصولات مرتبط را در حین نصب به طور خودکار برای کاربر ارائه نمی کند . کاربری که برنامه افزودنی را نصب می کند باید محصول(های) مرتبط و قابل اجرا را در پروژه خود قبل از نصب فعال کند. به عنوان مثال، اگر برنامه افزودنی شما شامل Cloud Firestore باشد، کاربر باید Cloud Firestore را در پروژه خود راه اندازی کند . توصیه می کنیم در فایل PREINSTALL.md به کاربران خود در مورد این الزامات اطلاع دهید.

پارامترهای پیکربندی شده توسط کاربر

برای اینکه کاربر بتواند هر نمونه نصب شده یک برنامه افزودنی را سفارشی کند، می توانید از کاربر بخواهید که مقادیر پارامتر را در حین نصب مشخص کند. برای درخواست این مقادیر، دستورات را در بخش params فایل extension.yaml خود تنظیم می کنید.

در اینجا یک بخش params نمونه وجود دارد که به دنبال آن یک جدول تمام فیلدهای پارامتر موجود را توصیف می کند.

# extension.yaml
...

# Parameters (environment variables) for which the user specifies values during installation
params:
  - param: DB_PATH
    label: Realtime Database path
    description: >-
      What is the Realtime Database path where you will write new text
      for sentiment analysis?
    type: string
    validationRegex: ^\S+$
    validationErrorMessage: Realtime Database path cannot contain spaces.
    example: path/to/posts
    required: true

  - param: TEXT_KEY
    label: Key for text
    description: What is the name of the key that will contain text to be analyzed?
    type: string
    default: textToAnalyze
    required: true

در بخش params فایل extension.yaml خود، از فیلدهای زیر برای تعریف یک پارامتر پیکربندی شده توسط کاربر استفاده کنید:

options:
  - label:
    value:
  - label:
    value:
  - label:
    value:

اعتبارسنجی و ارسال پیام خطا برای مقادیر پیکربندی شده توسط کاربر

هنگامی که پارامتری را با type string تنظیم می کنید، باید اعتبار سنجی regex مناسب را از طریق قسمت validationRegex پارامتر تعریف کنید.

همچنین، برای بسیاری از برنامه‌های افزودنی، یک مقدار پارامتر درخواستی معمولاً یک مسیر پایگاه داده یا سطل ذخیره‌سازی ابری است. توجه داشته باشید که در حین نصب، پیکربندی مجدد یا به روز رسانی، سرویس Extensions موارد زیر را در زمان وارد کردن مقدار پارامتر تأیید نمی کند:

• این که آیا پایگاه داده مشخص شده یا سطل فضای ذخیره سازی ابری در پروژه Firebase کاربر تنظیم شده است
• آیا مسیر پایگاه داده مشخص شده در پایگاه داده کاربر وجود دارد یا خیر

با این حال، هنگامی که برنامه افزودنی واقعاً منابع خود را مستقر می کند، کنسول Firebase یا Firebase CLI یک پیام خطا نشان می دهد اگر پایگاه داده مرجع یا سطل Cloud Storage هنوز در پروژه راه اندازی نشده باشد.

اکیداً توصیه می‌کنیم که کاربران را در فایل PREINSTALL در مورد این الزامات مطلع کنید تا وقتی برنامه افزودنی شما را نصب می‌کنند، با موفقیت نصب شود و همانطور که انتظار می‌رود کار کند.

پارامترهای سیستم

پارامترهای سیستم پیکربندی اساسی منابع یک برنامه افزودنی را کنترل می کنند. از آنجایی که آنها برای کنترل پیکربندی منابع هستند، به عنوان متغیرهای محیطی از داخل کد تابع شما قابل دسترسی نیستند.

معمولاً نیازی نیست که چیزی برای این پارامترها در extension.yaml اعلام کنید. آنها به طور خودکار برای هر نمونه برنامه افزودنی تعریف می شوند و کاربران این فرصت را دارند که هنگام نصب برنامه افزودنی شما مقادیر سفارشی را تنظیم کنند.

با این حال، اگر برنامه افزودنی شما نیاز به منابع خاصی دارد، می‌توانید مقادیر خاصی را در سطح هر منبع در extension.yaml تنظیم کنید. این تنظیمات پیکربندی هر منبع، تنظیمات نمونه برنامه افزودنی کاربر را لغو می کند. مثلا:

resources:
- name: high_memory_function
  type: firebaseextensions.v1beta.function
  description: >-
    This function needs at least 1GB of memory!
  properties:
    httpsTrigger: {}
    runtime: nodejs18
    availableMemoryMb: 1024
- name: normal_function
  type: firebaseextensions.v1beta.function
  description: >-
    This function has no special memory requirements. It will use the
    default value, or the value of `firebaseextension.v1beta.function/memory`
  properties:
    httpsTrigger: {}
    runtime: nodejs18

پارامترهای سیستم موجود عبارتند از: