此页面由 Cloud Translation API 翻译。

使用机器学习套件扫描条形码 (Android)

您可以使用机器学习套件识别和解码条形码。

功能	不分类显示	捆绑
实现	模型通过 Google Play 服务动态下载。	模型在构建时静态关联到您的应用。
应用大小	大小增加约 200 KB。	大小增加约 2.4 MB。
初始化时间	可能需要等到模型下载完毕后才能首次使用。	模型立即可用。

试试看

您可以试用示例应用，请查看此 API 的用法示例。
请参阅 Material Design 展示区 app 获取此 API 的端到端实现。

准备工作

此 API 需要 Android API 级别 21 或更高级别。确保应用的构建版本文件使用的 minSdkVersion 值为 21 或更高。

请务必在您的项目级 build.gradle 文件中添加 Google 的 buildscript 和 allprojects 部分中的 Maven 制品库。

将 Android 版机器学习套件库的依赖项添加到模块的应用级 Gradle 文件，通常为 app/build.gradle。请选择以下其中一项：以下依赖项：

如需将模型与应用捆绑，请执行以下操作：

dependencies {
  // ...
  // Use this dependency to bundle the model with your app
  implementation 'com.google.mlkit:barcode-scanning:17.2.0'
}

对于在 Google Play 服务中使用模型的情况：

dependencies {
  // ...
  // Use this dependency to use the dynamically downloaded model in Google Play Services
  implementation 'com.google.android.gms:play-services-mlkit-barcode-scanning:18.3.0'
}

如果您选择在 Google Play 服务中使用该模型，则可以配置在应用下载完毕后，自动将模型下载到设备上从 Play 商店安装的应用。为此，请将以下声明添加到应用的 AndroidManifest.xml 文件：
```
<application ...>
      ...
      <meta-data
          android:name="com.google.mlkit.vision.DEPENDENCIES"
          android:value="barcode" >
      
</application>
```
您还可以明确检查模型可用性，并请求通过 Google Play 服务 ModuleInstallClient API。

如果您不启用安装时模型下载或请求明确下载，则模型会在您首次运行扫描器时下载。您提出的请求在下载完成之前未产生任何结果。

输入图片准则

为了使机器学习套件准确读取条形码，输入图片必须包含用足够像素数据表示的条形码。

具体的像素数据要求取决于因为很多条形码中的内容都与条形码之间支持可变大小的载荷一般来说，最小的条形码的单元宽度应至少为 2 像素，并且二维代码，高 2 像素。

例如，EAN-13 条形码由条形和空格组成，分别为 1、宽度为 2、3 或 4 个单位，因此理想情况下，EAN-13 条形码图片应具有宽度至少为 2、4、6 和 8 像素的空间。因为有一个 EAN-13 条形码总共为 95 个单位，条形码应至少为 190 像素宽。

较密集的格式（如 PDF417）需要更大的像素尺寸机器学习套件可靠地读取这些数据。例如，一个 PDF417 代码最多可包含 34 个 17 个单位的宽“单词”最好是至少宽度为 1156 像素。
图片聚焦不良会影响扫描准确性。如果您的应用没有可以要求用户重新拍摄图片。
对于典型应用，建议为例如 1280x720 或 1920x1080，距离摄像头较远的屏幕即可扫描。

不过，在对延迟至关重要的应用中，您可以以较低分辨率捕获图像，但要求条形码构成了输入图片的大部分。另请参阅提高实时性能的相关提示。

1. 配置条形码扫描器

如果您知道要读取哪些格式的条形码，就可以提高方法是将条形码检测器配置为仅检测这些格式。

例如，要仅检测 Aztec 码和 QR 码，请构建 BarcodeScannerOptions 对象，如以下示例所示：

Kotlin

val options = BarcodeScannerOptions.Builder()
        .setBarcodeFormats(
                Barcode.FORMAT_QR_CODE,
                Barcode.FORMAT_AZTEC)
        .build()BarcodeScanningActivity.kt

Java

BarcodeScannerOptions options =
        new BarcodeScannerOptions.Builder()
        .setBarcodeFormats(
                Barcode.FORMAT_QR_CODE,
                Barcode.FORMAT_AZTEC)
        .build();BarcodeScanningActivity.java

支持以下格式：

代码 128 (FORMAT_CODE_128)
代码 39 (FORMAT_CODE_39)
代码 93 (FORMAT_CODE_93)
Codabar（FORMAT_CODABAR）
EAN-13（FORMAT_EAN_13）
EAN-8（FORMAT_EAN_8）
ITF (FORMAT_ITF)
UPC-A (FORMAT_UPC_A)
UPC-E (FORMAT_UPC_E)
二维码 (FORMAT_QR_CODE)
PDF417（FORMAT_PDF417）
阿兹特克语 (FORMAT_AZTEC)
数据矩阵 (FORMAT_DATA_MATRIX)

。

从捆绑模型 17.1.0 和未捆绑模型 18.2.0 开始，您还可以调用 enableAllPotentialBarcodes() 会返回所有可能的条形码，即使无法解码。这可用于协助进一步检测，例如放大后，可以更清晰地看到返回的中的条形码边界框任务

Kotlin

val options = BarcodeScannerOptions.Builder()
        .setBarcodeFormats(...)
        .enableAllPotentialBarcodes() // Optional
        .build()

Java

BarcodeScannerOptions options =
        new BarcodeScannerOptions.Builder()
        .setBarcodeFormats(...)
        .enableAllPotentialBarcodes() // Optional
        .build();

Further on, starting from bundled library 17.2.0 and unbundled library 18.3.0, a new feature called auto-zoom has been introduced to further enhance the barcode scanning experience. With this feature enabled, the app is notified when all barcodes within the view are too distant for decoding. As a result, the app can effortlessly adjust the camera's zoom ratio to the recommended setting provided by the library, ensuring optimal focus and readability. This feature will significantly enhance the accuracy and success rate of barcode scanning, making it easier for apps to capture information precisely.

To enable auto-zooming and customize the experience, you can utilize the setZoomSuggestionOptions() method along with your own ZoomCallback handler and desired maximum zoom ratio, as demonstrated in the code below.

Kotlin

val options = BarcodeScannerOptions.Builder()
        .setBarcodeFormats(...)
        .setZoomSuggestionOptions(
            new ZoomSuggestionOptions.Builder(zoomCallback)
                .setMaxSupportedZoomRatio(maxSupportedZoomRatio)
                .build()) // Optional
        .build()

Java

BarcodeScannerOptions options =
        new BarcodeScannerOptions.Builder()
        .setBarcodeFormats(...)
        .setZoomSuggestionOptions(
            new ZoomSuggestionOptions.Builder(zoomCallback)
                .setMaxSupportedZoomRatio(maxSupportedZoomRatio)
                .build()) // Optional
        .build();

zoomCallback is required to be provided to handle whenever the library suggests a zoom should be performed and this callback will always be called on the main thread.

The following code snippet shows an example of defining a simple callback.

Kotlin

fun setZoom(ZoomRatio: Float): Boolean {
    if (camera.isClosed()) return false
    camera.getCameraControl().setZoomRatio(zoomRatio)
    return true
}

Java

boolean setZoom(float zoomRatio) {
    if (camera.isClosed()) {
        return false;
    }
    camera.getCameraControl().setZoomRatio(zoomRatio);
    return true;
}

maxSupportedZoomRatio is related to the camera hardware, and different camera libraries have different ways to fetch it (see the javadoc of the setter method). In case this is not provided, an unbounded zoom ratio might be produced by the library which might not be supported. Refer to the setMaxSupportedZoomRatio() method introduction to see how to get the max supported zoom ratio with different Camera libraries.

When auto-zooming is enabled and no barcodes are successfully decoded within the view, BarcodeScanner triggers your zoomCallback with the requested zoomRatio. If the callback correctly adjusts the camera to this zoomRatio, it is highly probable that the most centered potential barcode will be decoded and returned.

A barcode may remain undecodable even after a successful zoom-in. In such cases, BarcodeScanner may either invoke the callback for another round of zoom-in until the maxSupportedZoomRatio is reached, or provide an empty list (or a list containing potential barcodes that were not decoded, if enableAllPotentialBarcodes() was called) to the OnSuccessListener (which will be defined in step 4. Process the image).

2. Prepare the input image

To recognize barcodes in an image, create an InputImage object from either a Bitmap, media.Image, ByteBuffer, byte array, or a file on the device. Then, pass the InputImage object to the BarcodeScanner's process method.

You can create an InputImage object from different sources, each is explained below.

Using a `media.Image`

To create an InputImage object from a media.Image object, such as when you capture an image from a device's camera, pass the media.Image object and the image's rotation to InputImage.fromMediaImage().

If you use the CameraX library, the OnImageCapturedListener and ImageAnalysis.Analyzer classes calculate the rotation value for you.

Kotlin

private class YourImageAnalyzer : ImageAnalysis.Analyzer {

    override fun analyze(imageProxy: ImageProxy) {
        val mediaImage = imageProxy.image
        if (mediaImage != null) {
            val image = InputImage.fromMediaImage(mediaImage, imageProxy.imageInfo.rotationDegrees)
            // Pass image to an ML Kit Vision API
            // ...
        }
    }
}

Java

private class YourAnalyzer implements ImageAnalysis.Analyzer {

    @Override
    public void analyze(ImageProxy imageProxy) {
        Image mediaImage = imageProxy.getImage();
        if (mediaImage != null) {
          InputImage image =
                InputImage.fromMediaImage(mediaImage, imageProxy.getImageInfo().getRotationDegrees());
          // Pass image to an ML Kit Vision API
          // ...
        }
    }
}

如果您不使用可提供图片旋转角度的相机库，可以根据设备的旋转角度和镜头方向来计算设备传感器：

Kotlin

private val ORIENTATIONS = SparseIntArray()

init {
    ORIENTATIONS.append(Surface.ROTATION_0, 0)
    ORIENTATIONS.append(Surface.ROTATION_90, 90)
    ORIENTATIONS.append(Surface.ROTATION_180, 180)
    ORIENTATIONS.append(Surface.ROTATION_270, 270)
}

/**
 * Get the angle by which an image must be rotated given the device's current
 * orientation.
 */
@RequiresApi(api = Build.VERSION_CODES.LOLLIPOP)
@Throws(CameraAccessException::class)
private fun getRotationCompensation(cameraId: String, activity: Activity, isFrontFacing: Boolean): Int {
    // Get the device's current rotation relative to its "native" orientation.
    // Then, from the ORIENTATIONS table, look up the angle the image must be
    // rotated to compensate for the device's rotation.
    val deviceRotation = activity.windowManager.defaultDisplay.rotation
    var rotationCompensation = ORIENTATIONS.get(deviceRotation)

    // Get the device's sensor orientation.
    val cameraManager = activity.getSystemService(CAMERA_SERVICE) as CameraManager
    val sensorOrientation = cameraManager
            .getCameraCharacteristics(cameraId)
            .get(CameraCharacteristics.SENSOR_ORIENTATION)!!

    if (isFrontFacing) {
        rotationCompensation = (sensorOrientation + rotationCompensation) % 360
    } else { // back-facing
        rotationCompensation = (sensorOrientation - rotationCompensation + 360) % 360
    }
    return rotationCompensation
}MLKitVisionImage.kt

Java

private static final SparseIntArray ORIENTATIONS = new SparseIntArray();
static {
    ORIENTATIONS.append(Surface.ROTATION_0, 0);
    ORIENTATIONS.append(Surface.ROTATION_90, 90);
    ORIENTATIONS.append(Surface.ROTATION_180, 180);
    ORIENTATIONS.append(Surface.ROTATION_270, 270);
}

/**
 * Get the angle by which an image must be rotated given the device's current
 * orientation.
 */
@RequiresApi(api = Build.VERSION_CODES.LOLLIPOP)
private int getRotationCompensation(String cameraId, Activity activity, boolean isFrontFacing)
        throws CameraAccessException {
    // Get the device's current rotation relative to its "native" orientation.
    // Then, from the ORIENTATIONS table, look up the angle the image must be
    // rotated to compensate for the device's rotation.
    int deviceRotation = activity.getWindowManager().getDefaultDisplay().getRotation();
    int rotationCompensation = ORIENTATIONS.get(deviceRotation);

    // Get the device's sensor orientation.
    CameraManager cameraManager = (CameraManager) activity.getSystemService(CAMERA_SERVICE);
    int sensorOrientation = cameraManager
            .getCameraCharacteristics(cameraId)
            .get(CameraCharacteristics.SENSOR_ORIENTATION);

    if (isFrontFacing) {
        rotationCompensation = (sensorOrientation + rotationCompensation) % 360;
    } else { // back-facing
        rotationCompensation = (sensorOrientation - rotationCompensation + 360) % 360;
    }
    return rotationCompensation;
}

然后，传递 media.Image 对象和将旋转角度值设为 InputImage.fromMediaImage()：

Kotlin

val image = InputImage.fromMediaImage(mediaImage, rotation)MLKitVisionImage.kt

Java

InputImage image = InputImage.fromMediaImage(mediaImage, rotation);

使用文件 URI

如需创建 InputImage，请执行以下操作：对象时，请将应用上下文和文件 URI 传递给 InputImage.fromFilePath()。在需要满足特定条件时使用 ACTION_GET_CONTENT intent 提示用户进行选择从图库应用中获取图片

Kotlin

val image: InputImage
try {
    image = InputImage.fromFilePath(context, uri)
} catch (e: IOException) {
    e.printStackTrace()
}MLKitVisionImage.kt

Java

InputImage image;
try {
    image = InputImage.fromFilePath(context, uri);
} catch (IOException e) {
    e.printStackTrace();
}

使用 `ByteBuffer` 或 `ByteArray`

如需创建 InputImage，请执行以下操作：对象ByteBuffer或ByteArray时，首先计算图像旋转角度。media.Image 然后，创建带有缓冲区或数组的 InputImage 对象以及图片的高度、宽度、颜色编码格式和旋转角度：

Kotlin

val image = InputImage.fromByteBuffer(
        byteBuffer,
        /* image width */ 480,
        /* image height */ 360,
        rotationDegrees,
        InputImage.IMAGE_FORMAT_NV21 // or IMAGE_FORMAT_YV12
)MLKitVisionImage.kt
// Or:
val image = InputImage.fromByteArray(
        byteArray,
        /* image width */ 480,
        /* image height */ 360,
        rotationDegrees,
        InputImage.IMAGE_FORMAT_NV21 // or IMAGE_FORMAT_YV12
)
MLKitVisionImage.kt

Java

InputImage image = InputImage.fromByteBuffer(byteBuffer,
        /* image width */ 480,
        /* image height */ 360,
        rotationDegrees,
        InputImage.IMAGE_FORMAT_NV21 // or IMAGE_FORMAT_YV12
);MLKitVisionImage.java
// Or:
InputImage image = InputImage.fromByteArray(
        byteArray,
        /* image width */480,
        /* image height */360,
        rotation,
        InputImage.IMAGE_FORMAT_NV21 // or IMAGE_FORMAT_YV12
);MLKitVisionImage.java

使用 `Bitmap`

如需创建 InputImage，请执行以下操作：对象时，请进行以下声明：Bitmap

Kotlin

val image = InputImage.fromBitmap(bitmap, 0)MLKitVisionImage.kt

Java

InputImage image = InputImage.fromBitmap(bitmap, rotationDegree);MLKitVisionImage.java

图片由 Bitmap 对象和旋转角度表示。

3. 获取 BarcodeScanner 的实例

Kotlin

val scanner = BarcodeScanning.getClient()
// Or, to specify the formats to recognize:
// val scanner = BarcodeScanning.getClient(options)BarcodeScanningActivity.kt

Java

BarcodeScanner scanner = BarcodeScanning.getClient();
// Or, to specify the formats to recognize:
// BarcodeScanner scanner = BarcodeScanning.getClient(options);BarcodeScanningActivity.java

4. 处理图片

将图片传递给 process 方法：

Kotlin

val result = scanner.process(image)
        .addOnSuccessListener { barcodes ->
            // Task completed successfully
            // ...
        }
        .addOnFailureListener {
            // Task failed with an exception
            // ...
        }BarcodeScanningActivity.kt

Java

Task<List<Barcode>> result = scanner.process(image)
        .addOnSuccessListener(new OnSuccessListener<List<Barcode>>() {
            @Override
            public void onSuccess(List<Barcode> barcodes) {
                // Task completed successfully
                // ...
            }
        })
        .addOnFailureListener(new OnFailureListener() {
            @Override
            public void onFailure(@NonNull Exception e) {
                // Task failed with an exception
                // ...
            }
        });BarcodeScanningActivity.java

注意：如果您使用的是 CameraX API，请确保在用完 ImageProxy 后将其关闭，例如，通过向从返回的 Task 添加 OnCompleteListener， process 方法。请参阅 VisionProcessorBase 类。

5. 从条形码中获取信息

如果条形码识别操作成功，系统会显示 Barcode 列表，对象传递给成功监听器。每个 Barcode 对象代表在图片中检测到的条形码。对于每个条形码，您可以输入图像中的边界坐标以及由条形码。此外，如果条形码扫描器能够确定数据的类型，您可以获取一个包含已解析数据的对象。

例如：

Kotlin

for (barcode in barcodes) {
    val bounds = barcode.boundingBox
    val corners = barcode.cornerPoints

    val rawValue = barcode.rawValue

    val valueType = barcode.valueType
    // See API reference for complete list of supported types
    when (valueType) {
        Barcode.TYPE_WIFI -> {
            val ssid = barcode.wifi!!.ssid
            val password = barcode.wifi!!.password
            val type = barcode.wifi!!.encryptionType
        }
        Barcode.TYPE_URL -> {
            val title = barcode.url!!.title
            val url = barcode.url!!.url
        }
    }
}BarcodeScanningActivity.kt

Java

for (Barcode barcode: barcodes) {
    Rect bounds = barcode.getBoundingBox();
    Point[] corners = barcode.getCornerPoints();

    String rawValue = barcode.getRawValue();

    int valueType = barcode.getValueType();
    // See API reference for complete list of supported types
    switch (valueType) {
        case Barcode.TYPE_WIFI:
            String ssid = barcode.getWifi().getSsid();
            String password = barcode.getWifi().getPassword();
            int type = barcode.getWifi().getEncryptionType();
            break;
        case Barcode.TYPE_URL:
            String title = barcode.getUrl().getTitle();
            String url = barcode.getUrl().getUrl();
            break;
    }
}BarcodeScanningActivity.java

提高实时性能的相关提示

如果要在实时应用中扫描条形码，请按以下说明操作实现最佳帧速率的准则：

请勿以相机的原始分辨率捕获输入内容。在某些设备上以原始分辨率捕获输入会产生极大的（超过 10 而这导致非常糟糕的延迟时间，对准确率。正确做法是，仅从相机中请求所需的尺寸通常不超过 200 万像素。

如果扫描速度很重要，您可以进一步降低图片拍摄速度分辨率。不过，请注意最小条形码尺寸要求。

如果您要尝试从一系列流式视频中识别条形码识别器在不同视频帧之间生成不同的结果帧。您应该等到收到同一系列的值以确保您会返回良好的结果。

ITF 和 CODE-39 不支持校验和数字。
如果您使用 Camera 或 camera2 API、限制对检测器的调用。如果新视频当检测器运行时有可用的帧时，请丢弃该帧。请参阅 VisionProcessorBase 类。
如果您使用 CameraX API，确保将 backpressure 策略设置为默认值 ImageAnalysis.STRATEGY_KEEP_ONLY_LATEST。这可保证一次只传送一张图片进行分析。如果有更多图片在分析器繁忙时生成，它们会被自动丢弃，不会排队等待。通过调用 ImageProxy.close()，将传递下一张图片。
如果您使用检测器的输出在图像上叠加显示输入图片，首先从机器学习套件获取结果，和叠加层。这会渲染到每个输入帧只执行一次。请参阅 CameraSourcePreview和 GraphicOverlay 类。
如果您使用 Camera2 API，请以 ImageFormat.YUV_420_888 格式。如果您使用旧版 Camera API，请使用 ImageFormat.NV21 格式。

使用机器学习套件扫描条形码 (Android)

试试看

准备工作

输入图片准则

1. 配置条形码扫描器

Kotlin

Java

Kotlin

Java

Kotlin

Java

Kotlin

Java

2. Prepare the input image

Using a media.Image

Kotlin

Java

Kotlin

Java

Kotlin

Java

使用文件 URI

Kotlin

Java

使用 ByteBuffer 或 ByteArray

Kotlin

Java

使用 Bitmap

Kotlin

Java

3. 获取 BarcodeScanner 的实例

Kotlin

Java

4. 处理图片

Kotlin

Java

5. 从条形码中获取信息

Kotlin

Java

提高实时性能的相关提示

Using a `media.Image`

使用 `ByteBuffer` 或 `ByteArray`

使用 `Bitmap`