Google 程式碼掃描器 (僅限 Android)

Google 程式碼掃描器 API 提供完整的掃描程式碼解決方案,無需應用程式要求相機權限,同時保護使用者隱私。具體做法是將掃描程式碼的工作委派給 Google Play 服務,並只將掃描結果傳回至應用程式中 (影片 1)。所有圖片處理作業會在裝置端進行,Google 不會儲存結果或圖片資料。API 支援與 ML Kit Barcode Scanning API 相同的程式碼格式,並傳回相同的 Barcode 物件。

如果應用程式不需要自訂 UI 或相機體驗,即可順暢掃描程式碼,就很適合採用這個 API。這個實作完全存在於 Google Play 服務中,確保對應用程式大小的影響降到最低。

從 16.1.0 版開始,您可以啟用自動縮放功能,讓 Google 程式碼掃描器自動掃描距離相機遠處的條碼。當使用者將裝置放在條碼上時,掃描器就會智慧偵測並放大條碼。如此一來,就不必手動調整縮放設定,讓條碼掃描速度更快、更準確,且更方便存取 (請參閱影片 2)。

影片 1. Google 程式碼掃描器整合 影片 2. 自動縮放效果

如果是需要自訂 UI 的複雜用途,建議您直接使用 ML Kit Barcode Scanning API

如有任何疑問、想要提交錯誤或需要協助,請造訪 ML Kit 社群頁面

事前準備

如要讓應用程式做好準備,請完成下列各節的步驟。

設定應用程式

  1. 在頂層 settings.gradle 檔案的 dependencyResolutionManagement 區塊下方,加入 Google Maven 存放區Maven 中央存放區

    dependencyResolutionManagement {
      repositories {
        google()
        mavenCentral()
      }
    }
    
  2. play-services-code-scanner SDK 的 Google Play 服務依附元件,新增至模組的 Gradle 建構檔案,通常為 app/build.gradle

    dependencies {
      implementation 'com.google.android.gms:play-services-code-scanner:16.1.0'
    }
    
  3. 您可以設定應用程式,讓 Google Play 服務在使用者從 Play 商店安裝應用程式時,自動將掃描器模組下載至裝置。

    <application ...>
      ...
      <meta-data
          android:name="com.google.mlkit.vision.DEPENDENCIES"
          android:value="barcode_ui"/>
      ...
    </application>
    

    您也可以透過 Google Play 服務 ModuleInstallClient API 明確檢查掃描器模組的可用性並要求下載。

    如果您沒有啟用安裝期間模組下載或要求明確下載,且掃描器模組尚未安裝以用於其他用途,Google Play 服務會在首次使用時下載掃描器模組。

掃描 QR code

請執行下列步驟來掃描條碼。

  1. 選用:設定程式碼掃描器。

    如果您知道預期讀取的條碼格式,可以將其設定為僅偵測這些格式,以改善條碼偵測工具的速度。舉例來說,如果只要偵測 Aztec 代碼和 QR code,請建構 GmsBarcodeScannerOptions 物件,如以下範例所示:

    Kotlin

    val options = GmsBarcodeScannerOptions.Builder()
       .setBarcodeFormats(
           Barcode.FORMAT_QR_CODE,
           Barcode.FORMAT_AZTEC)
       .build()
    

    Java

    GmsBarcodeScannerOptions options = new GmsBarcodeScannerOptions.Builder()
       .setBarcodeFormats(
           Barcode.FORMAT_QR_CODE,
           Barcode.FORMAT_AZTEC)
       .build();
    

    自動縮放功能預設為關閉。如要從 16.1.0 版開始啟用自動縮放功能,請呼叫 enableAutoZoom(),如以下程式碼範例所示。

    Kotlin

    val options = GmsBarcodeScannerOptions.Builder()
       .setBarcodeFormats(...)
       .enableAutoZoom() // available on 16.1.0 and higher
       .build()
    

    Java

    GmsBarcodeScannerOptions options = new GmsBarcodeScannerOptions.Builder()
       .setBarcodeFormats(...)
       .enableAutoZoom() // available on 16.1.0 and higher
       .build();
    
  2. 取得 GmsBarcodeScanner 的執行個體,如程式碼範例所示:

    Kotlin

    val scanner = GmsBarcodeScanning.getClient(this)
    // Or with a configured options
    // val scanner = GmsBarcodeScanning.getClient(this, options)
    

    Java

    GmsBarcodeScanner scanner = GmsBarcodeScanning.getClient(this);
    // Or with a configured options
    // GmsBarcodeScanner scanner = GmsBarcodeScanning.getClient(context, options);
    
  3. 呼叫 startScan() 要求掃描程式碼。

    Kotlin

    scanner.startScan()
       .addOnSuccessListener { barcode ->
           // Task completed successfully
       }
       .addOnCanceledListener {
           // Task canceled
       }
       .addOnFailureListener { e ->
           // Task failed with an exception
       }
    

    Java

    scanner
       .startScan()
       .addOnSuccessListener(
           barcode -> {
             // Task completed successfully
           })
       .addOnCanceledListener(
           () -> {
             // Task canceled
           })
       .addOnFailureListener(
           e -> {
             // Task failed with an exception
           });
    
  4. 處理產生的 Barcode

    Kotlin

    val rawValue: String? = barcode.rawValue
    

    Java

    String rawValue = barcode.getRawValue();