Check out what’s new from Firebase at Google I/O 2022. Learn more

在 Apple 平台上使用 Firebase Auth 和 Functions 通過 Cloud Vision 安全地識別地標

為了從您的應用程序調用 Google Cloud API,您需要創建一個中間 REST API 來處理授權並保護 API 密鑰等秘密值。然後,您需要在您的移動應用程序中編寫代碼來驗證此中間服務並與之通信。

創建此 REST API 的一種方法是使用 Firebase 身份驗證和函數,它為您提供了一個託管的、無服務器的 Google Cloud API 網關,該網關處理身份驗證,並且可以使用預構建的 SDK 從您的移動應用程序中調用。

本指南演示如何使用此技術從您的應用調用 Cloud Vision API。此方法將允許所有經過身份驗證的用戶通過您的 Cloud 項目訪問 Cloud Vision 計費服務,因此請在繼續之前考慮此身份驗證機制是否足以滿足您的用例。

在你開始之前

配置您的項目

如果您尚未將 Firebase 添加到您的應用,請按照入門指南中的步驟進行操作。

使用 Swift Package Manager 安裝和管理 Firebase 依賴項。

  1. 在 Xcode 中,打開您的應用項目,導航到File > Add Packages
  2. 出現提示時,添加 Firebase Apple 平台 SDK 存儲庫:
  3.   https://github.com/firebase/firebase-ios-sdk
  4. 選擇 Firebase ML 庫。
  5. 完成後,Xcode 將在後台自動開始解析和下載您的依賴項。

接下來,執行一些應用內設置:

  1. 在您的應用中,導入 Firebase:

    迅速

    import FirebaseMLModelDownloader

    Objective-C

    @import FirebaseMLModelDownloader;

再進行一些配置步驟,我們就可以開始了:

  1. 如果您尚未為您的項目啟用基於雲的 API,請立即執行此操作:

    1. 打開 Firebase 控制台的Firebase ML API 頁面
    2. 如果您尚未將項目升級到 Blaze 定價計劃,請單擊升級以執行此操作。 (僅當您的項目不在 Blaze 計劃中時,系統才會提示您升級。)

      只有 Blaze 級項目可以使用基於雲的 API。

    3. 如果尚未啟用基於雲的 API,請單擊啟用基於雲的 API
  2. 配置您現有的 Firebase API 密鑰以禁止訪問 Cloud Vision API:
    1. 打開雲控制台的憑據頁面。
    2. 對於列表中的每個 API 密鑰,打開編輯視圖,然後在密鑰限制部分中,將Cloud Vision API 之外的所有可用 API 添加到列表中。

部署可調用函數

接下來,部署您將用於橋接您的應用程序和 Cloud Vision API 的 Cloud Functions 函數。 functions-samples存儲庫包含一個您可以使用的示例。

默認情況下,通過此函數訪問 Cloud Vision API 將只允許您應用的經過身份驗證的用戶訪問 Cloud Vision API。您可以根據不同的要求修改功能。

部署功能:

  1. 克隆或下載functions-samples repo並更改到vision-annotate-image目錄:
    git clone https://github.com/firebase/functions-samples
    cd vision-annotate-image
    
  2. 安裝依賴:
    cd functions
    npm install
    cd ..
    
  3. 如果您沒有 Firebase CLI,請安裝它
  4. vision-annotate-image目錄中初始化一個 Firebase 項目。出現提示時,在列表中選擇您的項目。
    firebase init
  5. 部署函數:
    firebase deploy --only functions:annotateImage

將 Firebase 身份驗證添加到您的應用

上面部署的可調用函數將拒絕來自您應用程序的未經身份驗證的用戶的任何請求。如果您尚未這樣做,則需要將 Firebase Auth 添加到您的應用中。

為您的應用添加必要的依賴項

使用 Swift Package Manager 安裝 Cloud Functions for Firebase 庫。

1.準備輸入圖像

為了調用 Cloud Vision,圖像必須格式化為 base64 編碼的字符串。處理UIImage

迅速

guard let imageData = uiImage.jpegData(compressionQuality: 1.0f) else { return }
let base64encodedImage = imageData.base64EncodedString()

Objective-C

NSData *imageData = UIImageJPEGRepresentation(uiImage, 1.0f);
NSString *base64encodedImage =
  [imageData base64EncodedStringWithOptions:NSDataBase64Encoding76CharacterLineLength];

2.調用可調用函數來識別地標

要識別圖像中的地標,請調用傳遞JSON Cloud Vision 請求的可調用函數。

  1. 首先,初始化一個 Cloud Functions 實例:

    迅速

    lazy var functions = Functions.functions()
    

    Objective-C

    @property(strong, nonatomic) FIRFunctions *functions;
    
  2. 創建一個類型設置為LANDMARK_DETECTION的請求:

    迅速

    let requestData = [
      "image": ["content": base64encodedImage],
      "features": ["maxResults": 5, "type": "LANDMARK_DETECTION"]
    ]
    

    Objective-C

    NSDictionary *requestData = @{
      @"image": @{@"content": base64encodedImage},
      @"features": @{@"maxResults": @5, @"type": @"LANDMARK_DETECTION"}
    };
    
  3. 最後,調用函數:

    迅速

    functions.httpsCallable("annotateImage").call(requestData) { (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]
        }
        // ...
      }
      // Function completed succesfully
    }
    

    Objective-C

    [[_functions HTTPSCallableWithName:@"annotateImage"]
                              callWithObject:requestData
                                  completion:^(FIRHTTPSCallableResult * _Nullable result, NSError * _Nullable error) {
            if (error) {
              if (error.domain == FIRFunctionsErrorDomain) {
                FIRFunctionsErrorCode code = error.code;
                NSString *message = error.localizedDescription;
                NSObject *details = error.userInfo[FIRFunctionsErrorDetailsKey];
              }
              // ...
            }
            // Function completed succesfully
            // Get information about labeled objects
    
          }];
    

3. 獲取有關已識別地標的信息

如果地標識別操作成功,任務結果中會返回一個BatchAnnotateImagesResponse的 JSON 響應。 landmarkAnnotations數組中的每個對像都表示在圖像中識別的一個地標。對於每個地標,您可以獲得其在輸入圖像中的邊界坐標、地標的名稱、其緯度和經度、其知識圖實體 ID(如果可用)以及匹配的置信度分數。例如:

迅速

if let labelArray = (result?.data as? [String: Any])?["landmarkAnnotations"] as? [[String:Any]] {
  for labelObj in labelArray {
    let landmarkName = labelObj["description"]
    let entityId = labelObj["mid"]
    let score = labelObj["score"]
    let bounds = labelObj["boundingPoly"]
    // Multiple locations are possible, e.g., the location of the depicted
    // landmark and the location the picture was taken.
    guard let locations = labelObj["locations"] as? [[String: [String: Any]]] else { continue }
    for location in locations {
      let latitude = location["latLng"]?["latitude"]
      let longitude = location["latLng"]?["longitude"]
    }
  }
}

Objective-C

NSArray *labelArray = result.data[@"landmarkAnnotations"];
for (NSDictionary *labelObj in labelArray) {
  NSString *landmarkName = labelObj[@"description"];
  NSString *entityId = labelObj[@"mid"];
  NSNumber *score = labelObj[@"score"];
  NSArray *bounds = labelObj[@"boundingPoly"];
  // Multiple locations are possible, e.g., the location of the depicted
  // landmark and the location the picture was taken.
  NSArray *locations = labelObj[@"locations"];
  for (NSDictionary *location in locations) {
    NSNumber *latitude = location[@"latLng"][@"latitude"];
    NSNumber *longitude = location[@"latLng"][@"longitude"];
  }
}