با Firebase Remote Config شروع کنید


برای تعریف پارامترها در برنامه خود می توانید از Firebase Remote Config استفاده کنید و مقادیر آنها را در ابر به روز کنید و به شما امکان می دهد بدون توزیع به روزرسانی برنامه ، ظاهر و رفتار برنامه خود را تغییر دهید. این راهنما شما را از طریق مراحل شروع کار می کند و برخی از کد های نمونه را ارائه می دهد ، که همه آنها برای کلون یا بارگیری از مخزن Firebase/QuickStart-IIS در دسترس است.

مرحله 1: Remote Config به برنامه خود اضافه کنید

  1. اگر قبلاً این کار را نکرده اید ، Firebase را به پروژه اپل خود اضافه کنید .

  2. برای Remote Config ، Google Analytics برای هدف قرار دادن مشروط نمونه های برنامه به خصوصیات کاربر و مخاطبان مورد نیاز است. اطمینان حاصل کنید که Google Analytics در پروژه خود فعال کرده اید.

  3. همانطور که در مثال زیر نشان داده شده است ، شیء Remote Config Singleton را ایجاد کنید:

    سویفت 

    remoteConfig = RemoteConfig.remoteConfig()
let settings = RemoteConfigSettings()
settings.minimumFetchInterval = 0
remoteConfig.configSettings = settings
    ViewController.swift

    هدف-C 

    self.remoteConfig = [FIRRemoteConfig remoteConfig];
FIRRemoteConfigSettings *remoteConfigSettings = [[FIRRemoteConfigSettings alloc] init];
remoteConfigSettings.minimumFetchInterval = 0;
self.remoteConfig.configSettings = remoteConfigSettings;
    ViewController.m

از این شی برای ذخیره مقادیر پارامتر پیش فرض درون برنامه ، واکشی مقادیر پارامتر به روز شده از پشتی Remote Config ، و هنگامی که مقادیر واکشی در اختیار برنامه شما قرار می گیرد ، کنترل می شود.

در حین توسعه ، توصیه می شود فاصله کمتری نسبتاً کم تنظیم کنید. برای کسب اطلاعات بیشتر به لرزش مراجعه کنید.

مرحله 2: مقادیر پارامتر پیش فرض درون برنامه را تنظیم کنید

شما می توانید مقادیر پارامتر پیش فرض درون برنامه را در شیء Remote Config تنظیم کنید ، به طوری که برنامه شما قبل از اتصال به پس زمینه Remote Config ، همانطور که در نظر گرفته شده است رفتار می کند ، و در صورت تنظیم هیچ یک از مقادیر پیش فرض در دسترس است.

  1. مجموعه ای از نام پارامترها و مقادیر پارامتر پیش فرض را با استفاده از یک شیء NSDictionary یا یک فایل PLIST تعریف کنید.

    اگر قبلاً مقادیر پارامتر با حمایت Remote Config را پیکربندی کرده اید ، می توانید یک فایل تولید شده تولید شده plist بارگیری کنید که شامل تمام مقادیر پیش فرض و ذخیره آن در پروژه Xcode خود است.

    استراحت 

    curl --compressed -D headers -H "Authorization: Bearer token -X GET https://firebaseremoteconfig.googleapis.com/v1/projects/my-project-id/remoteConfig:downloadDefaults?format=PLIST -o RemoteConfigDefaults.plist

    کنسول Firebase

    1. در برگه Parameters ، منوی را باز کنید و مقادیر Dealnd Dealue را انتخاب کنید.

    2. در صورت درخواست ، .plist را برای iOS فعال کنید ، سپس روی فایل بارگیری کلیک کنید.

  2. این مقادیر را با استفاده از setDefaults: به شیء Remote Config اضافه کنید :. مثال زیر مقادیر پیش فرض درون برنامه را از یک پرونده plist تنظیم می کند:

    سویفت 

    remoteConfig.setDefaults(fromPlist: "RemoteConfigDefaults")
    ViewController.swift

    هدف-C 

    [self.remoteConfig setDefaultsFromPlistFileName:@"RemoteConfigDefaults"];
    ViewController.m

مرحله 3: مقادیر پارامتر را برای استفاده در برنامه خود دریافت کنید

اکنون می توانید مقادیر پارامتر را از شیء Remote Config دریافت کنید. اگر بعداً مقادیر را در پشتوانه Remote Config تنظیم کنید ، آنها را واکشی کنید و سپس آنها را فعال کنید ، این مقادیر در دسترس برنامه شما هستند. در غیر این صورت ، مقادیر پارامتر درون برنامه را با استفاده از setDefaults: . برای به دست آوردن این مقادیر ، با روش configValueForKey: Method ، با ارائه کلید پارامتر به عنوان یک آرگومان تماس بگیرید. 

let remoteConfig = RemoteConfig.remoteConfig()

// Retrieve a parameter value using configValueForKey
let welcomeMessageValue = remoteConfig.configValue(forKey: "welcome_message")
let welcomeMessage = welcomeMessageValue.stringValue

let featureFlagValue = remoteConfig.configValue(forKey: "new_feature_flag")
let isFeatureEnabled = featureFlagValue.boolValue

یک روش خواندنی و راحت تر برای دسترسی به این مقادیر در Swift از طریق نماد اشتراک Swift است: 

let remoteConfig = RemoteConfig.remoteConfig()

// Retrieve a string parameter value
let welcomeMessage = remoteConfig["welcome_message"].stringValue

// Retrieve a boolean parameter value
let isFeatureEnabled = remoteConfig["new_feature_flag"].boolValue

// Retrieve a number parameter value
let maxItemCount = remoteConfig["max_items"].numberValue.intValue

برای پیکربندی ایمن از نوع از Codable استفاده کنید

برای پیکربندی های پیچیده تر ، می توانید از پروتکل Codable Swift برای رمزگشایی داده های ساختار یافته از Remote Config استفاده کنید. این کار مدیریت پیکربندی ایمن را فراهم می کند و کار با اشیاء پیچیده را ساده می کند. 

// Define a Codable struct for your configuration
struct AppFeatureConfig: Codable {
  let isNewFeatureEnabled: Bool
  let maxUploadSize: Int
  let themeColors: [String: String]
}

// Fetch and decode the configuration
func configureAppFeatures() {
  let remoteConfig = RemoteConfig.remoteConfig()
  remoteConfig.fetchAndActivate { status, error in
    guard error == nil else { return }

    do {
      let featureConfig = try remoteConfig["app_feature_config"].decoded(asType: AppFeatureConfig.self)
      configureApp(with: featureConfig)
    } catch {
      // Handle decoding errors
      print("Failed to decode configuration: \(error)")
    }
  }
}

این روش به شما امکان می دهد:

  • ساختارهای پیکربندی پیچیده را تعریف کنید.
  • به طور خودکار تنظیمات JSON را تجزیه کنید.
  • هنگام دسترسی به مقادیر Remote Config از نوع ایمنی نوع اطمینان حاصل کنید.
  • برای رسیدگی به الگوهای Remote Config ساختاری ، کد تمیز و قابل خواندن را تهیه کنید.

برای پیکربندی اعلامیه در Swiftui از بسته بندی های خاص استفاده کنید

بسته بندی های املاک یک ویژگی Swift قدرتمند هستند که به شما امکان می دهد رفتار سفارشی را به اعلامیه های املاک اضافه کنید. در Swiftui ، از بسته بندی های املاک برای مدیریت دولت ، اتصالات و سایر رفتارهای خاصیت استفاده می شود. برای اطلاعات بیشتر ، به راهنمای زبان Swift مراجعه کنید. 

struct ContentView: View {
  @RemoteConfigProperty(key: "cardColor", fallback: "#f05138")
  var cardColor

  var body: some View {
    VStack {
      Text("Dynamic Configuration")
        .background(Color(hex: cardColor))
    }
    .onAppear {
      RemoteConfig.remoteConfig().fetchAndActivate()
    }
  }
}

هنگامی که می خواهید یک روش اعلانی برای دسترسی به مقادیر Remote Config در Swiftui ، با پشتیبانی داخلی برای مقادیر پیش فرض و مدیریت پیکربندی ساده ، از بسته بندی ویژگی های @RemoteConfigProperty استفاده کنید.

مرحله 4: مقادیر پارامتر را تنظیم کنید

با استفاده از کنسول Firebase یا API های Backend Remote Config ، می توانید مقادیر پیش فرض جدید Backend را ایجاد کنید که با توجه به منطق شرطی مورد نظر یا هدف قرار دادن کاربر ، مقادیر درون برنامه را نادیده می گیرد. این بخش شما را از طریق مراحل کنسول Firebase برای ایجاد این مقادیر طی می کند.

  1. در کنسول Firebase ، پروژه خود را باز کنید.
  2. برای مشاهده داشبورد Remote Config Remote Config از منو انتخاب کنید.
  3. پارامترها را با همان نام هایی با پارامترهایی که در برنامه خود تعریف کرده اید تعریف کنید. برای هر پارامتر ، می توانید یک مقدار پیش فرض (که در نهایت مقدار پیش فرض درون برنامه را نادیده می گیرد) تنظیم کنید و می توانید مقادیر شرطی را نیز تنظیم کنید. برای کسب اطلاعات بیشتر ، به پارامترها و شرایط Remote Config مراجعه کنید.

  4. در صورت استفاده از شرایط سیگنال سفارشی ، ویژگی ها و مقادیر آنها را تعریف کنید. مثالهای زیر نحوه تعریف یک وضعیت سیگنال سفارشی را نشان می دهد.

    سویفت 

      Task {
      let customSignals: [String: CustomSignalValue?] = [
      "city": .string("Tokyo"),
      "preferred_event_category": .string("sports")
    ]

    do {
      try await remoteConfig.setCustomSignals(customSignals)
      print("Custom signals set successfully!")
      } catch {
          print("Error setting custom signals: \(error)")
      }
}

    هدف-C 

      dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
    NSDictionary *customSignals = @{
      @"city": @"Tokyo",
      @"preferred_event_category": @"sports"
    };

    [self.remoteConfig setCustomSignals:customSignals withCompletion:^(NSError * _Nullable error) {
        if (error) {
            NSLog(@"Error setting custom signals: %@", error);
        } else {
            NSLog(@"Custom signals set successfully!");
        }
  }];
});

مرحله 5: مقادیر را واکشی و فعال کنید

برای واکشی مقادیر پارامتر از Remote Config ، با fetchWithCompletionHandler: یا fetchWithExpirationDuration:completionHandler: METHORE. هر مقداری که در پس زمینه تنظیم کرده اید ، در شیء Remote Config قرار گرفته و ذخیره می شوند.

برای مواردی که می خواهید مقادیر را در یک تماس واکشی و فعال کنید ، از fetchAndActivateWithCompletionHandler: .

این مثال مقادیر را از پس زمینه Remote Config (نه مقادیر ذخیره شده) دریافت می کند و تماس های activateWithCompletionHandler: برای اینکه آنها را در دسترس برنامه قرار دهید:

سویفت 

remoteConfig.fetch { (status, error) -> Void in
  if status == .success {
    print("Config fetched!")
    self.remoteConfig.activate { changed, error in
      // ...
    }
  } else {
    print("Config not fetched")
    print("Error: \(error?.localizedDescription ?? "No error available.")")
  }
  self.displayWelcome()
}
ViewController.swift

هدف-C 

[self.remoteConfig fetchWithCompletionHandler:^(FIRRemoteConfigFetchStatus status, NSError *error) {
    if (status == FIRRemoteConfigFetchStatusSuccess) {
        NSLog(@"Config fetched!");
      [self.remoteConfig activateWithCompletion:^(BOOL changed, NSError * _Nullable error) {
        if (error != nil) {
          NSLog(@"Activate error: %@", error.localizedDescription);
        } else {
          dispatch_async(dispatch_get_main_queue(), ^{
            [self displayWelcome];
          });
        }
      }];
    } else {
        NSLog(@"Config not fetched");
        NSLog(@"Error %@", error.localizedDescription);
    }
}];
ViewController.m

از آنجا که این مقادیر پارامتر به روز شده بر رفتار و ظاهر برنامه شما تأثیر می گذارد ، باید مقادیر واکشی را در زمانی فعال کنید که تجربه ای صاف را برای کاربر شما تضمین می کند ، مانند دفعه بعد که کاربر برنامه شما را باز می کند. برای اطلاعات بیشتر و مثال ، به استراتژی های بارگیری پیکربندی از راه دور مراجعه کنید.

مرحله ششم: به روزرسانی ها را در زمان واقعی گوش دهید

پس از واکشی مقادیر پارامتر ، می توانید از Remote Config Time برای گوش دادن به روزرسانی از Remote Config Backend استفاده کنید. سیگنال های Remote Config در زمان واقعی هنگامی که به روزرسانی ها در دسترس هستند و به طور خودکار تغییرات را پس از انتشار نسخه جدید Remote Config دریافت می کنند.

به روزرسانی های زمان واقعی توسط Firebase SDK برای Apple Platforms V10.7.0+ و بالاتر پشتیبانی می شود.

  1. در برنامه خود با addOnConfigUpdateListener تماس بگیرید تا گوش دادن به روزرسانی ها را شروع کنید و به طور خودکار مقادیر پارامتر جدید یا به روز شده را بدست آورید. مثال زیر برای به روزرسانی ها گوش می دهد و هنگامی که activateWithCompletionHandler فراخوانی می شود ، از مقادیر تازه دریافت شده برای نمایش یک پیام خوش آمدید به روز شده استفاده می کند.

    سویفت 

    remoteConfig.addOnConfigUpdateListener { configUpdate, error in
  guard let configUpdate, error == nil else {
    print("Error listening for config updates: \(error)")
  }

  print("Updated keys: \(configUpdate.updatedKeys)")

  self.remoteConfig.activate { changed, error in
    guard error == nil else { return self.displayError(error) }
    DispatchQueue.main.async {
      self.displayWelcome()
    }
  }
}

    هدف-C 

    __weak __typeof__(self) weakSelf = self;
[self.remoteConfig addOnConfigUpdateListener:^(FIRRemoteConfigUpdate * _Nonnull configUpdate, NSError * _Nullable error) {
  if (error != nil) {
    NSLog(@"Error listening for config updates %@", error.localizedDescription);
  } else {
    NSLog(@"Updated keys: %@", configUpdate.updatedKeys);

    __typeof__(self) strongSelf = weakSelf;
    [strongSelf.remoteConfig activateWithCompletion:^(BOOL changed, NSError * _Nullable error) {
      if (error != nil) {
        NSLog(@"Activate error %@", error.localizedDescription);
      }

      dispatch_async(dispatch_get_main_queue(), ^{
        [strongSelf displayWelcome];
      });
    }];
  }
}];

  2. دفعه بعد که نسخه جدیدی از Remote Config خود را منتشر می کنید ، دستگاه هایی که برنامه شما را اجرا می کنند و به تغییرات گوش می دهند ، با کنترل کننده تکمیل تماس می گیرند.

گاز دادن

اگر یک برنامه در یک دوره زمانی کوتاه بارها و بارها واگذار شود ، تماس های واکشی از بین می روند و SDK FIRRemoteConfigFetchStatusThrottled را برمی گرداند. قبل از نسخه SDK 6.3.0 ، حد 5 درخواست واکشی در یک پنجره 60 دقیقه ای بود (نسخه های جدیدتر محدودیت های مجاز بیشتری دارند).

در حین توسعه برنامه ، ممکن است بخواهید بیشتر اوقات به شما واکشی کنید تا حافظه نهان را به طور مکرر (چندین بار در ساعت) تازه کنید تا به شما اجازه دهد تا هنگام تهیه و آزمایش برنامه خود به سرعت تکرار کنید. به روزرسانی های پیکربندی Remote Remote Time Time به طور خودکار هنگام بروزرسانی پیکربندی روی سرور ، حافظه نهان را دور می زنند. برای قرار دادن تکرار سریع در یک پروژه با توسعه دهندگان بیشمار ، می توانید به طور موقت یک ویژگی FIRRemoteConfigSettings با حداقل فاصله دریافتی کم ( MinimumFetchInterval ) در برنامه خود اضافه کنید.

فاصله قبل از تولید پیش فرض و توصیه شده برای Remote Config 12 ساعت است ، به این معنی که پیکربندی ها بیش از یک بار در یک پنجره 12 ساعته ، بدون در نظر گرفتن چند تماس واکشی در واقع ، از پس زمینه خارج نمی شوند. به طور خاص ، حداقل فاصله واکشی در این ترتیب زیر تعیین می شود:

  1. پارامتر در fetch(long)
  2. پارامتر در FIRRemoteConfigSettings.MinimumFetchInterval
  3. مقدار پیش فرض 12 ساعت

مراحل بعدی

اگر قبلاً این کار را نکرده اید ، موارد استفاده Remote Config را کاوش کنید و به برخی از مفاهیم کلیدی و مستندات استراتژی های پیشرفته ، از جمله: