Вы можете использовать ML Kit для распознавания и декодирования штрихкодов.
| Функция | Без пакета | Пакетный |
|---|---|---|
| Реализация | Модель динамически скачивается через сервисы Google Play. | Модель статически связана с приложением во время сборки. |
| Размер приложения | Размер увеличивается примерно на 200 КБ. | Размер увеличивается примерно на 2,4 МБ. |
| Время инициализации | Перед первым использованием может потребоваться дождаться скачивания модели. | Модель доступна сразу. |
Попробовать
- Попробуйте поработать с примером приложения, чтобы понять, как использовать этот API.
- Пример полной реализации этого API можно посмотреть в приложении Material Design.
Подготовка
В файле
build.gradleна уровне проекта добавьте репозиторий Maven от Google в разделыbuildscriptиallprojects.Добавьте зависимости для библиотек ML Kit для Android в файл Gradle на уровне приложения, который обычно называется
app/build.gradle. Выберите одну из следующих зависимостей в соответствии со своими потребностями:Если вы хотите встроить модель в приложение:
dependencies { // ... // Use this dependency to bundle the model with your app implementation 'com.google.mlkit:barcode-scanning:17.3.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.1' }Если вы решите использовать модель в сервисах Google Play, то можете настроить приложение так, чтобы оно автоматически скачивало модель на устройство после установки из Google Play. Для этого добавьте в файл
AndroidManifest.xmlприложения следующую декларацию:<application ...> ... <meta-data android:name="com.google.mlkit.vision.DEPENDENCIES" android:value="barcode" > <!-- To use multiple models: android:value="barcode,model2,model3" --> </application>Вы также можете проверить доступность модели и запросить ее скачивание через ModuleInstallClient API сервисов Google Play.
Если вы не включите скачивание модели при установке или не запросите явное скачивание, модель будет скачана при первом запуске сканера. Запросы, сделанные до завершения скачивания, не принесут результатов.
Требования к исходным изображениям
-
Чтобы ML Kit мог точно считывать штрих-коды, входные изображения должны содержать штрих-коды, представленные достаточным количеством пиксельных данных.
Требования к пикселям зависят от типа штрихкода и объема закодированных в нем данных, поскольку многие штрихкоды поддерживают полезную нагрузку переменного размера. Как правило, наименьшая значимая единица штрихкода должна быть не менее 2 пикселей в ширину, а для двумерных кодов – 2 пикселя в высоту.
Например, штрихкоды EAN-13 состоят из полос и пробелов шириной 1, 2, 3 или 4 единицы, поэтому в идеале на изображении штрихкода EAN-13 должны быть полосы и пробелы шириной не менее 2, 4, 6 и 8 пикселей. Поскольку ширина штрихкода EAN-13 составляет 95 единиц, его ширина должна быть не менее 190 пикселей.
Для более плотных форматов, таких как PDF417, требуются большие размеры пикселей, чтобы ML Kit мог надежно их считывать. Например, код PDF417 может содержать до 34 "слов" шириной 17 единиц в одной строке, что в идеале должно быть не менее 1156 пикселей в ширину.
-
Плохая фокусировка может повлиять на точность сканирования. Если приложение не получает приемлемых результатов, попросите пользователя сделать снимок повторно.
-
Для обычных приложений рекомендуется использовать изображения с более высоким разрешением, например 1280 x 720 или 1920 x 1080. Это позволит сканировать штрихкоды с большего расстояния.
Однако в приложениях, где задержка критична, вы можете повысить производительность, захватывая изображения с более низким разрешением, но требуя, чтобы штрих-код составлял большую часть входного изображения. Также ознакомьтесь с советами по повышению эффективности в реальном времени.
1. Настройте сканер штрихкодов
Если вы знаете, какие форматы штрихкодов вы ожидаете прочитать, вы можете повысить скорость детектора штрихкодов, настроив его на обнаружение только этих форматов.Например, чтобы распознавать только коды Aztec и QR-коды, создайте объект BarcodeScannerOptions, как показано ниже.
Kotlin
val options = BarcodeScannerOptions.Builder() .setBarcodeFormats( Barcode.FORMAT_QR_CODE, Barcode.FORMAT_AZTEC) .build()
Java
BarcodeScannerOptions options = new BarcodeScannerOptions.Builder() .setBarcodeFormats( Barcode.FORMAT_QR_CODE, Barcode.FORMAT_AZTEC) .build();
Поддерживаются следующие форматы:
- Code 128 (
FORMAT_CODE_128) - Code 39 (
FORMAT_CODE_39) - Code 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) - QR-код (
FORMAT_QR_CODE) - PDF417 (
FORMAT_PDF417) - Aztec (
FORMAT_AZTEC) - Data Matrix (
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 anInputImage 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 }
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)
Java
InputImage image = InputImage.fromMediaImage(mediaImage, rotation);
Использование URI файла
Чтобы создать объект InputImage из URI файла, передайте контекст приложения и URI файла в InputImage.fromFilePath(). Это полезно, когда вы используете намерение ACTION_GET_CONTENT, чтобы предложить пользователю выбрать изображение из галереи.
Kotlin
val image: InputImage try { image = InputImage.fromFilePath(context, uri) } catch (e: IOException) { e.printStackTrace() }
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 ) // Or: val image = InputImage.fromByteArray( byteArray, /* image width */ 480, /* image height */ 360, rotationDegrees, InputImage.IMAGE_FORMAT_NV21 // or IMAGE_FORMAT_YV12 )
Java
InputImage image = InputImage.fromByteBuffer(byteBuffer, /* image width */ 480, /* image height */ 360, rotationDegrees, InputImage.IMAGE_FORMAT_NV21 // or IMAGE_FORMAT_YV12 ); // Or: InputImage image = InputImage.fromByteArray( byteArray, /* image width */480, /* image height */360, rotation, InputImage.IMAGE_FORMAT_NV21 // or IMAGE_FORMAT_YV12 );
Использование Bitmap
Чтобы создать объект InputImage из объекта Bitmap, добавьте следующий код:
Kotlin
val image = InputImage.fromBitmap(bitmap, 0)
Java
InputImage image = InputImage.fromBitmap(bitmap, rotationDegree);
Изображение представлено объектом Bitmap и углом поворота.
3. Получите экземпляр BarcodeScanner
Kotlin
val scanner = BarcodeScanning.getClient() // Or, to specify the formats to recognize: // val scanner = BarcodeScanning.getClient(options)
Java
BarcodeScanner scanner = BarcodeScanning.getClient(); // Or, to specify the formats to recognize: // BarcodeScanner scanner = BarcodeScanning.getClient(options);
4. Обработка изображения
Передайте изображение в методprocess:
Kotlin
val result = scanner.process(image) .addOnSuccessListener { barcodes -> // Task completed successfully // ... } .addOnFailureListener { // Task failed with an exception // ... }
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 // ... } });
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 } } }
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; } }
Советы по повышению эффективности в реальном времени
Если вы хотите сканировать штрихкоды в приложении реального времени, следуйте этим рекомендациям, чтобы добиться наилучшей частоты кадров:
-
Не записывайте видео в исходном разрешении камеры. На некоторых устройствах захват входных данных с исходным разрешением приводит к получению изображений очень большого размера (более 10 мегапикселей), что приводит к очень низкой задержке без повышения точности. Вместо этого запрашивайте у камеры только размер, необходимый для обнаружения штрихкода, который обычно составляет не более 2 мегапикселей.
Если скорость сканирования имеет значение, вы можете снизить разрешение. Однако не забывайте о минимальных требованиях к размеру штрихкода, описанных выше.
Если вы пытаетесь распознать штрихкоды из последовательности кадров потокового видео, распознаватель может выдавать разные результаты от кадра к кадру. Дождитесь, пока вы не получите последовательную серию одинаковых значений, чтобы быть уверенными в том, что вы возвращаете хороший результат.
Контрольная цифра не поддерживается для ITF и CODE-39.
- Если вы используете API
Cameraилиcamera2, ограничьте вызовы детектора. Если во время работы детектора становится доступен новый кадр видео, отбросьте его. Пример можно найти в классеVisionProcessorBaseв примере приложения из краткого руководства. - Если вы используете API
CameraX, убедитесь, что для стратегии противодавления задано значение по умолчаниюImageAnalysis.STRATEGY_KEEP_ONLY_LATEST. Это гарантирует, что для анализа будет отправляться только одно изображение за раз. Если во время работы анализатора будут созданы дополнительные изображения, они будут автоматически удалены и не будут поставлены в очередь на доставку. После того как анализируемое изображение будет закрыто вызовом ImageProxy.close(), будет доставлено следующее последнее изображение. - Если вы используете выходные данные детектора для наложения графики на входное изображение, сначала получите результат от ML Kit, а затем визуализируйте изображение и наложение за один шаг. Это приводит к отрисовке на поверхности экрана только один раз для каждого входного кадра. Пример можно найти в классах
CameraSourcePreviewиGraphicOverlayв примере приложения из краткого руководства. - Если вы используете Camera2 API, делайте снимки в формате
ImageFormat.YUV_420_888. Если вы используете старый Camera API, делайте снимки в форматеImageFormat.NV21.
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons "С указанием авторства 4.0", а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2026-10-27 UTC.