Bắt đầu sử dụng Remote Config trên iOS

Chọn nền tảng: iOS+ Android Web Flutter Unity C++


Bạn có thể sử dụng Firebase Remote Config để xác định các tham số trong ứng dụng và cập nhật giá trị của các tham số đó trên đám mây, cho phép bạn sửa đổi giao diện và hành vi của ứng dụng mà không cần phân phối bản cập nhật ứng dụng. Hướng dẫn này sẽ hướng dẫn bạn các bước để bắt đầu và cung cấp một số mã mẫu. Bạn có thể sao chép hoặc tải tất cả mã mẫu này xuống từ kho lưu trữ firebase/quickstart-ios trên GitHub.

Bước 1: Thêm Remote Config vào ứng dụng

  1. Nếu bạn chưa thực hiện, hãy thêm Firebase vào dự án Apple của bạn.

  2. Đối với Remote Config, Google Analytics là bắt buộc để nhắm mục tiêu các phiên bản ứng dụng đến thuộc tính người dùng và đối tượng một cách có điều kiện. Hãy nhớ bật Google Analytics trong dự án của bạn.

  3. Tạo đối tượng Remote Config singleton, như trong ví dụ sau:

    Swift

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

    Objective-C

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

Đối tượng này được dùng để lưu trữ các giá trị tham số mặc định trong ứng dụng, tìm nạp các giá trị tham số đã cập nhật từ phần phụ trợ của Remote Config và kiểm soát thời điểm cung cấp các giá trị đã tìm nạp cho ứng dụng của bạn.

Trong quá trình phát triển, bạn nên đặt khoảng thời gian tìm nạp tối thiểu tương đối thấp. Hãy xem Điều tiết để biết thêm thông tin.

Bước 2: Đặt giá trị tham số mặc định trong ứng dụng

Bạn có thể đặt giá trị tham số mặc định trong ứng dụng trong đối tượng Remote Config để ứng dụng hoạt động như dự định trước khi kết nối với phần phụ trợ Remote Configvà để các giá trị mặc định có sẵn nếu không có giá trị nào được đặt trong phần phụ trợ.

  1. Xác định một tập hợp tên tham số và giá trị tham số mặc định bằng cách sử dụng một NSDictionary đối tượng hoặc một tệp plist.

    Nếu đã định cấu hình các giá trị tham số phụ trợ Remote Config, bạn có thể tải tệp plist đã tạo xuống (tệp này bao gồm tất cả các giá trị mặc định) và lưu tệp đó vào dự án Xcode.

    Kiến trúc chuyển trạng thái đại diện (REST)

    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
    

    Bạn có thể tạo mã thông báo người mang bằng cách chạy lệnh sau bằng Google Cloud CLI hoặc Cloud Shell:

    gcloud auth print-access-token
    

    Mã thông báo này chỉ tồn tại trong thời gian ngắn, vì vậy, bạn có thể cần tạo lại mã thông báo này nếu gặp lỗi xác thực.

    Bảng điều khiển Firebase

    1. Trong bảng điều khiển Firebase, hãy chuyển đến trang DevOps & Engagement > Cấu hình từ xa > Tham số.

    2. Mở Menu , rồi chọn Download default values.

    3. Khi được nhắc, hãy bật .plist for iOS, sau đó nhấp vào Download file.

  2. Thêm các giá trị này vào đối tượng Remote Config bằng cách sử dụng setDefaults:. Ví dụ sau đây sẽ đặt các giá trị mặc định trong ứng dụng từ tệp plist:

    Swift

    RemoteConfig.remoteConfig().setDefaults(fromPlist: "RemoteConfigDefaults")

    Objective-C

    [remoteConfig setDefaultsFromPlistFileName:@"RemoteConfigDefaults"];

Bước 3: Nhận giá trị tham số để sử dụng trong ứng dụng

Bây giờ, bạn có thể nhận giá trị tham số từ đối tượng Remote Config. Nếu sau này bạn đặt giá trị trong phần phụ trợ của Remote Config, hãy tìm nạp các giá trị đó rồi kích hoạt. Các giá trị đó sẽ có sẵn cho ứng dụng của bạn. Nếu không, bạn sẽ nhận được các giá trị tham số trong ứng dụng được định cấu hình bằng cách sử dụng setDefaults:. Để nhận các giá trị này, hãy gọi phương thức configValueForKey:, cung cấp khoá tham số làm đối số.

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

Một cách dễ đọc và thuận tiện hơn để truy cập các giá trị này trong Swift là thông qua ký hiệu chỉ số dưới của 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

Sử dụng Codable để định cấu hình đảm bảo an toàn về kiểu

Đối với các cấu hình phức tạp hơn, bạn có thể sử dụng giao thức Codable của Swift để giải mã dữ liệu có cấu trúc từ Remote Config. Giao thức này cung cấp tính năng quản lý cấu hình đảm bảo an toàn về kiểu và đơn giản hoá việc sử dụng các đối tượng phức tạp.

// 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)")
    }
  }
}

Phương thức này cho phép bạn:

  • Xác định các cấu trúc cấu hình phức tạp.
  • Tự động phân tích cú pháp các cấu hình JSON.
  • Đảm bảo an toàn về kiểu khi truy cập vào các giá trị Remote Config.
  • Cung cấp mã rõ ràng, dễ đọc để xử lý các mẫu Cấu hình từ xa có cấu trúc Remote Config.

Sử dụng Trình bao bọc thuộc tính để định cấu hình khai báo trong SwiftUI

Trình bao bọc thuộc tính là một tính năng mạnh mẽ của Swift cho phép bạn thêm hành vi tuỳ chỉnh vào các khai báo thuộc tính. Trong SwiftUI, trình bao bọc thuộc tính được dùng để quản lý trạng thái, liên kết và các hành vi thuộc tính khác. Để biết thêm thông tin, hãy xem Hướng dẫn về ngôn ngữ 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()
    }
  }
}

Sử dụng trình bao bọc thuộc tính @RemoteConfigProperty khi bạn muốn có một cách khai báo để truy cập vào các giá Remote Config trong SwiftUI, có hỗ trợ tích hợp cho các giá trị mặc định và quản lý cấu hình đơn giản.

Bước 4: Đặt giá trị tham số

Bằng cách sử dụng bảng điều khiển Firebase hoặc Remote Config API phụ trợ, bạn có thể tạo các giá trị mặc định mới cho phần phụ trợ để ghi đè các giá trị trong ứng dụng theo logic có điều kiện hoặc nhắm mục tiêu đến người dùng mà bạn muốn. Phần này sẽ hướng dẫn bạn các bước trong bảng điều khiển Firebase để tạo các giá trị này.

  1. Trong bảng điều khiển Firebase, hãy chuyển đến trang DevOps & Engagement > Cấu hình từ xa > Tham số.

  2. Xác định các tham số có cùng tên với các tham số mà bạn đã xác định trong ứng dụng. Đối với mỗi tham số, bạn có thể đặt giá trị mặc định (giá trị này sẽ ghi đè giá trị mặc định trong ứng dụng) và bạn cũng có thể đặt các giá trị có điều kiện. Để tìm hiểu thêm, hãy xem bài viết Remote Config Tham số và Điều kiện.

  3. Nếu bạn sử dụng các điều kiện tín hiệu tuỳ chỉnh , hãy xác định các thuộc tính và giá trị của chúng. Các ví dụ sau đây cho thấy cách xác định điều kiện tín hiệu tuỳ chỉnh.

    Swift

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

    Objective-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!");
              }
        }];
    });

Bước 5: Tìm nạp và kích hoạt các giá trị

Để tìm nạp các giá trị tham số từ Remote Config, hãy gọi phương thức fetchWithCompletionHandler: hoặc fetchWithExpirationDuration:completionHandler:. Mọi giá trị mà bạn đặt trên phần phụ trợ đều được tìm nạp và lưu vào bộ nhớ đệm trong đối tượng Remote Config.

Đối với những trường hợp bạn muốn tìm nạp và kích hoạt các giá trị trong một lệnh gọi, hãy sử dụng fetchAndActivateWithCompletionHandler:.

Ví dụ này tìm nạp các giá trị từ phần phụ trợ của Remote Config (không phải các giá trị được lưu vào bộ nhớ đệm ) và gọiactivateWithCompletionHandler: để cung cấp các giá trị đó cho ứng dụng:

Swift

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

Objective-C

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

Vì các giá trị tham số đã cập nhật này ảnh hưởng đến hành vi và giao diện của ứng dụng, nên bạn cần kích hoạt các giá trị đã tìm nạp vào thời điểm đảm bảo trải nghiệm mượt mà cho người dùng, chẳng hạn như lần tiếp theo người dùng mở ứng dụng của bạn. Hãy xem bài viết Chiến lược tải Cấu hình từ xa để biết thêm thông tin và ví dụ.

Bước 6: Theo dõi các bản cập nhật theo thời gian thực

Sau khi tìm nạp các giá trị tham số, bạn có thể sử dụng Remote Config để theo dõi các bản cập nhật từ phần phụ trợ của Remote Config. Theo thời gian thực Remote Config sẽ gửi tín hiệu đến các thiết bị được kết nối khi có bản cập nhật và tự động tìm nạp các thay đổi sau khi bạn xuất bản phiên bản Remote Config mới.

SDK Firebase cho các nền tảng Apple phiên bản 10.7.0 trở lên hỗ trợ các bản cập nhật theo thời gian thực.

  1. Trong ứng dụng, hãy gọi addOnConfigUpdateListener để bắt đầu theo dõi các bản cập nhật và tự động tìm nạp mọi giá trị tham số mới hoặc đã cập nhật. Ví dụ sau đây theo dõi các bản cập nhật và khi activateWithCompletionHandler được gọi, sẽ sử dụng các giá trị mới tìm nạp để hiển thị thông điệp chào mừng đã cập nhật.

    Swift

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

    Objective-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. Vào lần tiếp theo bạn xuất bản phiên bản mới của Remote Config, các thiết bị đang chạy ứng dụng của bạn và theo dõi các thay đổi sẽ gọi trình xử lý hoàn tất.

Điều tiết

Nếu một ứng dụng tìm nạp quá nhiều lần trong một khoảng thời gian ngắn, thì các lệnh gọi tìm nạp sẽ bị điều tiết và SDK sẽ trả về FIRRemoteConfigFetchStatusThrottled. Trước SDK phiên bản 6.3.0, giới hạn là 5 yêu cầu tìm nạp trong khoảng thời gian 60 phút (các phiên bản mới hơn có giới hạn cho phép nhiều hơn).

Trong quá trình phát triển ứng dụng,bạn có thể muốn tìm nạp thường xuyên hơn để làm mới bộ nhớ đệm (nhiều lần mỗi giờ) nhằm nhanh chóng lặp lại khi phát triển và kiểm thử ứng dụng. Các bản cập nhật của Cấu hình từ xa theo thời gian thực sẽ tự động bỏ qua bộ nhớ đệm khi cấu hình được cập nhật trên máy chủ. Để đáp ứng việc lặp lại nhanh chóng trên một dự án có nhiều nhà phát triển, bạn có thể tạm thời thêm thuộc tính FIRRemoteConfigSettings có khoảng thời gian tìm nạp tối thiểu thấp (MinimumFetchInterval) vào ứng dụng của mình.

Khoảng thời gian tìm nạp mặc định và được đề xuất cho Remote Config là 12 giờ. Điều này có nghĩa là các cấu hình sẽ không được tìm nạp từ phần phụ trợ nhiều hơn một lần trong khoảng thời gian 12 giờ, bất kể số lệnh gọi tìm nạp thực tế được thực hiện. Cụ thể, khoảng thời gian tìm nạp tối thiểu được xác định theo thứ tự sau:

  1. Tham số trong fetch(long)
  2. Tham số trong FIRRemoteConfigSettings.MinimumFetchInterval
  3. Giá trị mặc định là 12 giờ